(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_SetTextureColorMod

Set an additional color value multiplied into render copy operations.

Header File

Syntax

bool SDL_SetTextureColorMod(SDL_Texture *texture, Uint8 r, Uint8 g, Uint8 b);

Function Parameters

SDL_Texture *	texture	the texture to update.
Uint8	r	the red color value multiplied into copy operations.
Uint8	g	the green color value multiplied into copy operations.
Uint8	b	the blue color value multiplied into copy operations.

Return Value

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

Remarks

When this texture is rendered, during the copy operation each source color channel is modulated by the appropriate color value according to the following formula:

srcC = srcC * (color / 255)

Color modulation is not always supported by the renderer; it will return false if color modulation is not supported.

Thread Safety

You may only call this function from the main thread.

Version

This function is available since SDL 3.1.3.