TTF_CreateText - Man Page

Create a text object from UTF-8 text and a text engine.

Header File

Defined in SDL3_ttf/SDL_ttf.h

Synopsis

#include "SDL3_ttf/SDL_ttf.h"

TTF_Text * TTF_CreateText(TTF_TextEngine *engine, TTF_Font *font, const char *text, size_t length);

Function Parameters

engine

the text engine to use when creating the text object, may be NULL.

font

the font to render with.

text

the text to use, in UTF-8 encoding.

length

the length of the text, in bytes, or 0 for null terminated text.

Return Value

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

Thread Safety

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

Availability

This function is available since SDL_ttf 3.0.0.

See Also

·(3), TTF_DestroyText(3)

Referenced By

TTF_DestroyText(3), TTF_DrawRendererText(3), TTF_DrawSurfaceText(3), TTF_GetGPUTextDrawData(3), TTF_Text.3type(3).

SDL_ttf 3.2.2 SDL_ttf3 FUNCTIONS