Skip to content
This repository has been archived by the owner. It is now read-only.
Permalink
Browse files

Clarified SDL_GetWindowSurface() documentation

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.
  • Loading branch information
slouken committed Apr 22, 2011
1 parent 6d5cfdf commit 22e5aa5716466c67bbe6cece4b12f4833956c961
Showing with 5 additions and 2 deletions.
  1. +5 −2 include/SDL_video.h
@@ -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.
*

0 comments on commit 22e5aa5

Please sign in to comment.