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 blit operations.


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

Function Parameters

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

Return Value

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


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)


This function is available since SDL 3.0.0.

CategoryAPI, CategorySurface

[ 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.