(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_SetRenderColorScale

Set the color scale used for render operations.

Header File

Syntax

bool SDL_SetRenderColorScale(SDL_Renderer *renderer, float scale);

Function Parameters

SDL_Renderer *	renderer	the rendering context.
float	scale	the color scale value.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

The color scale is an additional scale multiplied into the pixel color value while rendering. This can be used to adjust the brightness of colors during HDR rendering, or changing HDR video brightness when playing on an SDR display.

The color scale does not affect the alpha channel, only the color brightness.

Thread Safety

This function should only be called on the main thread.

Version

This function is available since SDL 3.1.3.