SDL_GetRenderHDRHeadroom

Get the HDR headroom used for render output.

Header File

Defined in <SDL3/SDL_render.h>

Syntax

bool SDL_GetRenderHDRHeadroom(SDL_Renderer *renderer, float *headroom);

Function Parameters

SDL_Renderer *	renderer	the rendering context.
float *	headroom	a pointer filled in with the HDR headroom being used for rendering.

Return Value

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

Thread Safety

This function should only be called on the main thread.

Version

This function is available since SDL 3.6.0.

See Also

• SDL_SetRenderHDRHeadroom

---

CategoryAPI, CategoryAPIFunction, CategoryRender

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.