sdlGetDisplayProperties function

int sdlGetDisplayProperties(
  1. int displayId
)

Get the properties associated with a display.

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.

\param displayID the instance ID of the display to query. \returns a valid property ID on success or 0 on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

\since This function is available since SDL 3.1.3.

extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetDisplayProperties(SDL_DisplayID displayID)

Implementation

int sdlGetDisplayProperties(int displayId) {
  final sdlGetDisplayPropertiesLookupFunction = libSdl3.lookupFunction<
      Uint32 Function(Uint32 displayId),
      int Function(int displayId)>('SDL_GetDisplayProperties');
  return sdlGetDisplayPropertiesLookupFunction(displayId);
}