(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable version.)

SDL_SetSurfaceColorMod

Set an additional color value multiplied into blit operations.

Header File

Syntax

int SDL_SetSurfaceColorMod(SDL_Surface * surface,
                           Uint8 r, Uint8 g, Uint8 b);

Function Parameters

SDL_Surface *	surface	the SDL_Surface structure to update.
Uint8	r	the red color value multiplied into blit operations.
Uint8	g	the green color value multiplied into blit operations.
Uint8	b	the blue color value multiplied into blit operations.

Return Value

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

Remarks

When this surface is blitted, during the blit operation each source color channel is modulated by the appropriate color value according to the following formula:

srcC = srcC * (color / 255)

Version

This function is available since SDL 2.0.0.