SDL_GetDisplayProperties - Get the properties associated with a display.
Contents
Availability
This function is available since SDL 3.2.0.
Simple Directmedia Layer SDL 3.2.20 SDL_GetDisplayProperties(3)
Description
The following read-only properties are provided by SDL:
• SDL_PROP_DISPLAY_HDR_ENABLED_BOOLEAN: true if the display has HDR headroom above the SDR white point.
This is for informational and diagnostic purposes only, as not all platforms provide this information at
the display level.
On KMS/DRM:
• SDL_PROP_DISPLAY_KMSDRM_PANEL_ORIENTATION_NUMBER: the "panel orientation" property for the display in
degrees of clockwise rotation. Note that this is provided only as a hint, and the application is
responsible for any coordinate transformations needed to conform to the requested display orientation.
Function Parameters
displayID
the instance ID of the display to query.
Name
SDL_GetDisplayProperties - Get the properties associated with a display.
Return Value
Returns a valid property ID on success or 0 on failure; call SDL_GetError() for more information.
Synopsis
#include<SDL3/SDL_video.h>SDL_PropertiesIDSDL_GetDisplayProperties(SDL_DisplayIDdisplayID);
Thread Safety
This function should only be called on the main thread.
