NAME¶

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

HEADER FILE¶

Defined in SDL3_ttf/SDL_ttf.h

SYNOPSIS¶

#include "SDL3_ttf/SDL_ttf.h"

bool TTF_SetFontDirection(TTF_Font *font, TTF_Direction direction);

DESCRIPTION¶

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.

FUNCTION PARAMETERS¶

font

the font to specify a direction for.

direction

the new direction for text to flow.

RETURN VALUE¶

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

THREAD SAFETY¶

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

AVAILABILITY¶

This function is available since SDL_ttf 3.0.0.