From ceccf24519bedfdda9f80ebb7448773cf4ca1151 Mon Sep 17 00:00:00 2001 From: SDL Wiki Bot Date: Wed, 24 Jan 2024 01:20:29 +0000 Subject: [PATCH] Sync SDL3 wiki -> header --- include/SDL3/SDL_surface.h | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/include/SDL3/SDL_surface.h b/include/SDL3/SDL_surface.h index 6240d8abe..e6b59bd9d 100644 --- a/include/SDL3/SDL_surface.h +++ b/include/SDL3/SDL_surface.h @@ -262,11 +262,23 @@ extern DECLSPEC void SDLCALL SDL_DestroySurface(SDL_Surface *surface); * * The following properties are understood by SDL: * - * - `SDL_PROPERTY_SURFACE_HDR_BOOLEAN`: true if this surface has HDR properties - * - `SDL_PROPERTY_SURFACE_COLOR_PRIMARIES_NUMBER`: an SDL_ColorPrimaries value describing the surface colorspace - * - `SDL_PROPERTY_SURFACE_TRANSFER_CHARACTERISTICS_NUMBER`: an SDL_TransferCharacteristics value describing the surface colorspace - * - `SDL_PROPERTY_SURFACE_MAXCLL_NUMBER`: MaxCLL (Maximum Content Light Level) indicates the maximum light level of any single pixel (in cd/m2 or nits) of the entire playback sequence. MaxCLL is usually measured off the final delivered content after mastering. If one uses the full light level of the HDR mastering display and adds a hard clip at its maximum value, MaxCLL would be equal to the peak luminance of the mastering monitor. - * - `SDL_PROPERTY_SURFACE_MAXFALL_NUMBER`: MaxFALL (Maximum Frame Average Light Level) indicates the maximum value of the frame average light level (in cd/m2 or nits) of the entire playback sequence. MaxFALL is calculated by averaging the decoded luminance values of all the pixels within a frame. MaxFALL is usually much lower than MaxCLL. + * - `SDL_PROPERTY_SURFACE_HDR_BOOLEAN`: true if this surface has HDR + * properties + * - `SDL_PROPERTY_SURFACE_COLOR_PRIMARIES_NUMBER`: an SDL_ColorPrimaries + * value describing the surface colorspace + * - `SDL_PROPERTY_SURFACE_TRANSFER_CHARACTERISTICS_NUMBER`: an + * SDL_TransferCharacteristics value describing the surface colorspace + * - `SDL_PROPERTY_SURFACE_MAXCLL_NUMBER`: MaxCLL (Maximum Content Light + * Level) indicates the maximum light level of any single pixel (in cd/m2 or + * nits) of the entire playback sequence. MaxCLL is usually measured off the + * final delivered content after mastering. If one uses the full light level + * of the HDR mastering display and adds a hard clip at its maximum value, + * MaxCLL would be equal to the peak luminance of the mastering monitor. + * - `SDL_PROPERTY_SURFACE_MAXFALL_NUMBER`: MaxFALL (Maximum Frame Average + * Light Level) indicates the maximum value of the frame average light level + * (in cd/m2 or nits) of the entire playback sequence. MaxFALL is calculated + * by averaging the decoded luminance values of all the pixels within a + * frame. MaxFALL is usually much lower than MaxCLL. * * \param surface the SDL_Surface structure to query * \returns a valid property ID on success or 0 on failure; call