|
Size: 1121
Comment: update content - pointers, structs
|
Size: 1847
Comment: update formatting - enums, structs, the/an
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 17: | Line 17: |
| ||'''surface'''||^the [[SDL_Surface]] to clip / fill^ ''-or-'' ^the destination [[SDL_Surface]]^|| ||'''rect'''||must be ,,a pointer to ,,a valid ,,rectangle,, ^[[SDL_Rect]]^ which will be filled with the correct values|| |
||'''surface'''||the [[SDL_Surface]] structure representing the surface to be clipped|| ||'''rect'''||,,must be a pointer to a valid rectangle which will be filled with the correct values,, ''-or-'' an [[SDL_Rect]] structure filled in with the clipping rectangle for the surface^; see [[#Remarks|Remarks]] for details^|| |
| Line 32: | Line 32: |
| <<Color2(green,Should this state somewhere that the clipping rectangle is established by the blit function and not by this function? Is that correct? Does this function pull the info from `srcrect` or `dstrect` in [[SDL_BlitSurface]]() and fill '''rect''' here with it? Or from `rect` in [[SDL_SetClipRect]]()?)>><<BR>> <<Color2(green,Possible corresponding alternate text to replace the above between *?)>> When '''surface''' is the destination of a blit, '''rect''' is filled with the clipping rectangle for that surface from the `dstrect` component of [[SDL_BlitSurface]]() or `rect` from [[SDL_SetClipRect]](). |
DRAFT |
SDL_GetClipRect
Use this function to get the clipping rectangle for the destination surface in a blit.
Syntax
void SDL_GetClipRect(SDL_Surface* surface,
SDL_Rect* rect)
Function Parameters
surface |
the SDL_Surface structure representing the surface to be clipped |
rect |
must be a pointer to a valid rectangle which will be filled with the correct values -or- an SDL_Rect structure filled in with the clipping rectangle for the surface; see [[#Remarks|Remarks]] for details |
Code Examples
You can add your code example here
Remarks
You can add useful comments here
*
When this surface is the destination of a blit, only the area within the clip rectangle is drawn into.
The rectangle pointed to by rect will be filled with the clipping rectangle of the surface.
*
green
green
When surface is the destination of a blit, rect is filled with the clipping rectangle for that surface from the dstrect component of SDL_BlitSurface() or rect from SDL_SetClipRect().
