logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

SDL_GetWindowSurface - Get the SDL surface associated with the window.

Availability

       This function is available since SDL 3.2.0.

Description

       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.

Function Parameters

window the window to query.

Name

       SDL_GetWindowSurface - Get the SDL surface associated with the window.

Return Value

       Returns  the  surface  associated  with  the  window,  or  NULL  on failure; call SDL_GetError() for more
       information.

See Also

SDL_DestroyWindowSurface(3),             SDL_WindowHasSurface(3),             SDL_UpdateWindowSurface(3),
       SDL_UpdateWindowSurfaceRects(3)

Simple Directmedia Layer                           SDL 3.2.20                            SDL_GetWindowSurface(3)

Synopsis

#include<SDL3/SDL_video.h>SDL_Surface*SDL_GetWindowSurface(SDL_Window*window);

Thread Safety

       This function should only be called on the main thread.

See Also