|
Size: 804
Comment: minor change for consistency - error to failure in RV
|
Size: 941
Comment: update content - w/ Sam; 4/22 cd2167525827
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 6: | Line 6: |
| Use this function to get an SDL surface associated with the window. | Use this function to get the SDL surface associated with the window. |
| Line 19: | Line 19: |
| Returns a surface in the optimal format for the window, or NULL on failure. | Returns the surface associated with the window, or NULL on failure. |
| Line 27: | Line 27: |
| 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. |
DRAFT |
SDL_GetWindowSurface
Use this function to get the SDL surface associated with the window.
Contents
Syntax
SDL_Surface* SDL_GetWindowSurface(SDL_Window* window)
Function Parameters
window |
the window to query |
Return Value
Returns the surface associated with the window, or NULL on failure.
Code Examples
You can add your code example here
Remarks
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.
You may not combine this with 3D or the rendering API on this window.
