.\" This manpage content is licensed under Creative Commons
.\"  Attribution 4.0 International (CC BY 4.0)
.\"   https://creativecommons.org/licenses/by/4.0/
.\" This manpage was generated from SDL's wiki page for SDL_GetDisplayProperties:
.\"   https://wiki.libsdl.org/SDL_GetDisplayProperties
.\" Generated with SDL/build-scripts/wikiheaders.pl
.\"  revision SDL-3.1.0
.\" Please report issues in this manpage's content at:
.\"   https://github.com/libsdl-org/sdlwiki/issues/new
.\" Please report issues in the generation of this manpage from the wiki at:
.\"   https://github.com/libsdl-org/SDL/issues/new?title=Misgenerated%20manpage%20for%20SDL_GetDisplayProperties
.\" SDL can be found at https://libsdl.org/
.de URL
\$2 \(laURL: \$1 \(ra\$3
..
.if \n[.g] .mso www.tmac
.TH SDL_GetDisplayProperties 3 "SDL 3.1.0" "SDL" "SDL3 FUNCTIONS"
.SH NAME
SDL_GetDisplayProperties \- Get the properties associated with a display\[char46]
.SH SYNOPSIS
.nf
.B #include \(dqSDL3/SDL.h\(dq
.PP
.BI "SDL_PropertiesID SDL_GetDisplayProperties(SDL_DisplayID displayID);
.fi
.SH DESCRIPTION
The following read-only properties are provided by SDL:


\(bu 
.BR
.BR SDL_PROP_DISPLAY_HDR_ENABLED_BOOLEAN
:
  true if the display has HDR headroom above the SDR white point\[char46] This
  property can change dynamically when
  
.BR SDL_EVENT_DISPLAY_HDR_STATE_CHANGED

  is sent\[char46]

\(bu 
.BR
.BR SDL_PROP_DISPLAY_SDR_WHITE_POINT_FLOAT
:
  the value of SDR white in the
  
.BR SDL_COLORSPACE_SRGB_LINEAR
 colorspace\[char46] On
  Windows this corresponds to the SDR white level in scRGB colorspace, and
  on Apple platforms this is always 1\[char46]0 for EDR content\[char46] This property can
  change dynamically when
  
.BR SDL_EVENT_DISPLAY_HDR_STATE_CHANGED

  is sent\[char46]

\(bu 
.BR
.BR SDL_PROP_DISPLAY_HDR_HEADROOM_FLOAT
:
  the additional high dynamic range that can be displayed, in terms of the
  SDR white point\[char46] When HDR is not enabled, this will be 1\[char46]0\[char46] This property
  can change dynamically when
  
.BR SDL_EVENT_DISPLAY_HDR_STATE_CHANGED

  is sent\[char46]

.SH FUNCTION PARAMETERS
.TP
.I displayID
the instance ID of the display to query
.SH RETURN VALUE
Returns a valid property ID on success or 0 on failure; call

.BR SDL_GetError
() for more information\[char46]

.SH AVAILABILITY
This function is available since SDL 3\[char46]0\[char46]0\[char46]

.SH SEE ALSO
.BR SDL_GetProperty (3),
.BR SDL_SetProperty (3)