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

Function SDL_GetWindowSurface

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

Get the SDL surface associated with the window.

A new surface will be created with the optimal format for the window, if necessary. This surface will be freed when the window is destroyed. Do not free this surface.

This surface will be invalidated if the window is resized. After resizing a window this function must be called again to return a valid surface.

You may not combine this with 3D or the rendering API on this window.

This function is affected by [SDL_HINT_FRAMEBUFFER_ACCELERATION].

§Parameters

  • window: the window to query.

§Return value

Returns the surface associated with the window, or NULL 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