pandory500/SDL-mirror
2
0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Clarified SDL_GetWindowSurface() documentation

Browse source 
Matthew Orlando to Sam

Someone asked in IRC whether they should free the surface from SDL_GetWindowSurface. The doc comment is a bit vague so i checked the code and revised the comment.
This commit is contained in:
Sam Lantinga 2011-04-22 09:06:29 -07:00
parent 401e97ad0c
commit b62273437c
1 changed files with 5 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

7
include/SDL_video.h
View file

@ -551,9 +551,12 @@ extern DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_Window * window,
SDL_bool fullscreen);
/**
* \brief Get an SDL surface associated with the window.
* \brief Get the SDL surface associated with the window.
*
* \return A surface in the optimal format for the window, or NULL on error.
* \return The window's framebuffer surface, or NULL on error.
*
* 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.
*
* \note You may not combine this with 3D or the rendering API on this window.
*