TTF_SetTextColor - Man Page

Set the color of a text object.

Header File

Defined in SDL3_ttf/SDL_ttf.h

Synopsis

#include "SDL3_ttf/SDL_ttf.h"

bool TTF_SetTextColor(TTF_Text *text, Uint8 r, Uint8 g, Uint8 b, Uint8 a);

Description

The default text color is white (255, 255, 255, 255).

Function Parameters

text

the TTF_Text
to modify.

r

the red color value in the range of 0-255.

g

the green color value in the range of 0-255.

b

the blue color value in the range of 0-255.

a

the alpha value in the range of 0-255.

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

Availability

This function is available since SDL_ttf 3.0.0.

See Also

·(3), TTF_GetTextColor(3), ·(3), TTF_SetTextColorFloat(3)

Referenced By

TTF_GetTextColor(3), TTF_SetTextColorFloat(3).

SDL_ttf 3.2.2 SDL_ttf3 FUNCTIONS