SDL_GetWindowSurface(3)

Usage

#include "SDL3/SDL.h"

SDL_Surface * SDL_GetWindowSurface(SDL_Window *window);

Header file

Defined in SDL3/SDL_video.h

Overview

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.

Return value

( SDL_Surface
*) 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.

Referred to by

SDL_WindowHasSurface(3) Return whether the window has a surface associated with it. SDL_UpdateWindowSurface(3) Copy the window surface to the screen. SDL_DestroyWindowSurface(3) Destroy the surface associated with the window. SDL_UpdateWindowSurfaceRects(3) Copy areas of the window surface to the screen.