NAME¶

SDL_SetRenderColorScale - Set the color scale used for render operations.

HEADER FILE¶

Defined in SDL3/SDL_render.h

SYNOPSIS¶

#include "SDL3/SDL.h"

bool SDL_SetRenderColorScale(SDL_Renderer *renderer, float scale);

DESCRIPTION¶

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.

FUNCTION PARAMETERS¶

renderer

the rendering context.

scale

the color scale value.

RETURN VALUE¶

Returns true on success or false on failure; call

SDL_GetError () for more information.

THREAD SAFETY¶

You may only call this function from the main thread.

AVAILABILITY¶

This function is available since SDL 3.1.3.

SEE ALSO¶

•(3), SDL_GetRenderColorScale(3)