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

Function SDL_GetWindowDisplayScale

pub unsafe extern "C" fn SDL_GetWindowDisplayScale(
    window: *mut SDL_Window,
) -> f32
Available on crate feature dep_sdl3 only.
Expand description

Get the content display scale relative to a window’s pixel size.

This is a combination of the window pixel density and the display content scale, and is the expected scale for displaying content in this window. For example, if a 3840x2160 window had a display scale of 2.0, the user expects the content to take twice as many pixels and be the same physical size as if it were being displayed in a 1920x1080 window with a display scale of 1.0.

Conceptually this value corresponds to the scale display setting, and is updated when that setting is changed, or the window moves to a display with a different scale setting.

§Parameters

  • window: the window to query.

§Return value

Returns the display scale, or 0.0f 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.