TTF_SetTextColor(3)

TTF_SetTextColor3

Set the color of a text object.

Usage

#include "SDL3_ttf/SDL_ttf.h"

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

Header file

Defined in SDL3_ttf/SDL_ttf.h

Overview

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.

From libsdl3-ttf-doc 3.2.2+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.