SDL_SetTextureColorMod(3)

SDL_SetTextureColorMod3

Set an additional color value multiplied into render copy operations.

Usage

#include "SDL3/SDL.h"

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

Header file

Defined in SDL3/SDL_render.h

Overview

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.

Function parameters

texture

the texture to update.

r

the red color value multiplied into copy operations.

g

the green color value multiplied into copy operations.

b

the blue color value multiplied into copy operations.

Return value

Returns true on success or false on failure; call

SDL_GetError () for more information.

Thread safety

This function should only be called on the main thread.

Availability

This function is available since SDL 3.2.0.

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