devela::_dep::sdl3::sys::video

Function SDL_GetDisplayProperties

pub unsafe extern "C" fn SDL_GetDisplayProperties(
    displayID: u32,
) -> u32 ⓘ
Available on crate feature dep_sdl3 only.
Expand description

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.

§Parameters

  • displayID: the instance ID of the display to query.

§Return value

Returns a valid property ID on success or 0 on failure; call SDL_GetError() for more information.

§Thread safety

This function should only be called on the main thread.

§Availability

This function is available since SDL 3.2.0.