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.


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

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 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 / 255)

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.

Code Examples

SDL_Texture* pTexture = SDL_CreateTextureFromSurface( renderer, loadedSurface );
SDL_SetTextureColorMod( pTexture, 64, 64, 64 );

CategoryAPI, 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.