Scroll to navigation

SDL_SetTextureColorModFloat(3) SDL3 FUNCTIONS SDL_SetTextureColorModFloat(3)

NAME

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

HEADER FILE

Defined in SDL3/SDL_render.h

SYNOPSIS

#include "SDL3/SDL.h"
bool SDL_SetTextureColorModFloat(SDL_Texture *texture, float r, float g, float 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 Color modulation is not always supported by the renderer; it will return false 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 true on success or false on failure; call

SDL_GetError () for more information.

THREAD SAFETY

You may only call this function from the main thread.

AVAILABILITY

This function is available since SDL 3.1.3.

SEE ALSO

(3), SDL_GetTextureColorModFloat(3), (3), SDL_SetTextureAlphaModFloat(3), (3), SDL_SetTextureColorMod(3)

SDL 3.1.6 Simple Directmedia Layer