TTF_CreateGPUTextEngineWithProperties(3)

TTF_CreateGPUTextEngineWithProperties3

Create a text engine for drawing text with the sdl gpu api, with the specified properties.

Usage

#include "SDL3_ttf/SDL_ttf.h"

TTF_TextEngine * TTF_CreateGPUTextEngineWithProperties(SDL_PropertiesID props); #define TTF_PROP_GPU_TEXT_ENGINE_DEVICE SDL_ttf.gpu_text_engine.create.device" #define TTF_PROP_GPU_TEXT_ENGINE_ATLAS_TEXTURE_SIZE SDL_ttf.gpu_text_engine.create.atlas_texture_size"

Header file

Defined in SDL3_ttf/SDL_ttf.h

Overview

These are the supported properties:

• TTF_PROP_GPU_TEXT_ENGINE_DEVICE : the
SDL_GPUDevice to use for creating textures and drawing text.

• TTF_PROP_GPU_TEXT_ENGINE_ATLAS_TEXTURE_SIZE :
the size of the texture atlas

Function parameters

props

the properties to use.

Return value

( TTF_TextEngine
*) Returns a

TTF_TextEngine
object or NULL on failure; call SDL_GetError() for more information.

Thread safety

This function should be called on the thread that created the device.

Availability

This function is available since SDL_ttf 3.0.0.

From libsdl3-ttf-doc 3.2.2+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.