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

TTF_DrawRendererText

Draw text to an SDL renderer.

Header File

Defined in <SDL3_ttf/SDL_ttf.h>

Syntax

bool TTF_DrawRendererText(TTF_Text *text, float x, float y);

Function Parameters

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

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_CreateRendererTextEngine(), and will draw using the renderer passed to that function.

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_CreateRendererTextEngine
• TTF_CreateText

---

CategoryAPI, CategoryAPIFunction

[ 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.