SDL_SetSurfaceColorMod(3)

SDL_SetSurfaceColorMod3

Set an additional color value multiplied into blit operations.

Usage

#include "SDL3/SDL.h"

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

Header file

Defined in SDL3/SDL_surface.h

Overview

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)

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 true on success or false on failure; call

SDL_GetError () for more information.

Thread safety

This function is not thread safe.

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.