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

Function SDL_SetWindowFullscreen

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

Request that the window’s fullscreen state be changed.

By default a window in fullscreen state uses borderless fullscreen desktop mode, but a specific exclusive display mode can be set using SDL_SetWindowFullscreenMode().

On some windowing systems this request is asynchronous and the new fullscreen state may not have have been applied immediately upon the return of this function. If an immediate change is required, call SDL_SyncWindow() to block until the changes have taken effect.

When the window state changes, an [SDL_EVENT_WINDOW_ENTER_FULLSCREEN] or [SDL_EVENT_WINDOW_LEAVE_FULLSCREEN] event will be emitted. Note that, as this is just a request, it can be denied by the windowing system.

§Parameters

  • window: the window to change.
  • fullscreen: true for fullscreen mode, false for windowed mode.

§Return value

Returns true on success or false 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.

§See also