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

TTF_SetFontDirection

Set direction to be used for text shaping by a font.

Header File

Defined in <SDL3_ttf/SDL_ttf.h>

Syntax

bool TTF_SetFontDirection(TTF_Font *font, TTF_Direction direction);

Function Parameters

TTF_Font *	font	the font to specify a direction for.
TTF_Direction	direction	the new direction for text to flow.

Return Value

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

Remarks

Possible direction values are:

• TTF_DIRECTION_LTR (Left to Right)
• TTF_DIRECTION_RTL (Right to Left)
• TTF_DIRECTION_TTB (Top to Bottom)
• TTF_DIRECTION_BTT (Bottom to Top)

If SDL_ttf was not built with HarfBuzz support, this function returns false.

This updates any TTF_Text objects using this font.

Thread Safety

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

Version

This function is available since SDL_ttf 3.0.0.

---

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.