SDL_SetRenderHDRHeadroom

Set the HDR headroom for render output.

Header File

Syntax

bool SDL_SetRenderHDRHeadroom(SDL_Renderer *renderer, float headroom);

Function Parameters

SDL_Renderer *	renderer	the rendering context.
float	headroom	the HDR headroom to use, or 0 to use the window headroom.

Return Value

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

Remarks

The HDR headroom is used to set the HDR metadata for HDR10 output and for tone mapping textures that are set to a higher headroom.

By default the HDR headroom comes from the window associated with the renderer, but this function allows you to override that and set a specific value.

Thread Safety

This function should only be called on the main thread.

Version

This function is available since SDL 3.6.0.