(This function is part of SDL_ttf, a separate library from SDL.)

TTF_CreateGPUTextEngineWithProperties

Create a text engine for drawing text with the SDL GPU API, with the specified properties.

Header File

Syntax

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"

Function Parameters

SDL_PropertiesID

props

the properties to use.

Return Value

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

Remarks

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

Thread Safety

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

Version

This function is available since SDL_ttf 3.0.0.