Scroll to navigation

SDL_SetTextureColorMod(3) SDL3 FUNCTIONS SDL_SetTextureColorMod(3)

NAME

SDL_SetTextureColorMod - Set an additional color value multiplied into render copy operations.

SYNOPSIS

#include "SDL3/SDL.h"
int SDL_SetTextureColorMod(SDL_Texture *texture, Uint8 r, Uint8 g, Uint8 b);

DESCRIPTION

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 -1 if color modulation is not supported.

FUNCTION PARAMETERS

the texture to update
the red color value multiplied into copy operations
the green color value multiplied into copy operations
the blue color value multiplied into copy operations

RETURN VALUE

Returns 0 on success or a negative error code on failure; call

SDL_GetError () for more information.

AVAILABILITY

This function is available since SDL 3.0.0.

SEE ALSO

SDL_GetTextureColorMod(3), SDL_SetTextureAlphaMod(3), SDL_SetTextureColorModFloat(3)

SDL 3.1.0 SDL