SDL Wiki
(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)


Set an additional color value multiplied into render copy operations.

Header File

Defined in <SDL3/SDL_render.h>


int SDL_SetTextureColorModFloat(SDL_Texture *texture, float r, float g, float b);

Function Parameters

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

Return Value

(int) Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.


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


This function is available since SDL 3.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryRender

[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.