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

TTF_GetGPUTextDrawData

Get the geometry data needed for drawing the text.

Header File

Syntax

TTF_GPUAtlasDrawSequence * TTF_GetGPUTextDrawData(TTF_Text *text);

Function Parameters

TTF_Text *

text

the text to draw.

Return Value

(TTF_GPUAtlasDrawSequence *) Returns a NULL terminated linked list of TTF_GPUAtlasDrawSequence objects or NULL if the passed text is empty or in case of failure; call SDL_GetError() for more information.

Remarks

text must have been created using a TTF_TextEngine from TTF_CreateGPUTextEngine().

The positive X-axis is taken towards the right and the positive Y-axis is taken upwards for both the vertex and the texture coordinates, i.e, it follows the same convention used by the SDL_GPU API. If you want to use a different coordinate system you will need to transform the vertices yourself.

If the text looks blocky use linear filtering.

Thread Safety

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

Version

This function is available since SDL_ttf 3.0.0.