TTF_GetGPUTextDrawData(3)

TTF_GetGPUTextDrawData3

Get the geometry data needed for drawing the text.

Usage

#include "SDL3_ttf/SDL_ttf.h"

TTF_GPUAtlasDrawSequence * TTF_GetGPUTextDrawData(TTF_Text *text);

Header file

Defined in SDL3_ttf/SDL_ttf.h

Overview

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.

Function parameters

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.

Thread safety

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

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.