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

TTF_DrawSurfaceText

Draw text to an SDL surface.

Header File

Defined in <SDL3_ttf/SDL_ttf.h>

Syntax

bool TTF_DrawSurfaceText(TTF_Text *text, int x, int y, SDL_Surface *surface);

Function Parameters

TTF_Text *	text	the text to draw.
int	x	the x coordinate in pixels, positive from the left edge towards the right.
int	y	the y coordinate in pixels, positive from the top edge towards the bottom.
SDL_Surface *	surface	the surface to draw on.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

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

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.

See Also

• TTF_CreateSurfaceTextEngine
• TTF_CreateText

---

CategoryAPI, CategoryAPIFunction, CategorySDLTTF

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.