|
Size: 1178
Comment: create page, add content (Rev 5540)
|
Size: 1227
Comment: update content - w/ Sam; remove draft
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 3: | Line 3: |
| ||<tablewidth="100%" style="color: #FF0000;" :> DRAFT|| | |
| Line 6: | Line 5: |
| Use this function to set the clipping rectangle for the destination surface in a blit. | Use this function to set the clipping rectangle for a surface. |
| Line 17: | Line 16: |
| ||'''surface'''||the surface to be updated|| ||'''rect'''||a pointer to the [[SDL_Rect]] to be applied|| |
||'''surface'''||the [[SDL_Surface]] structure to be clipped|| ||'''rect'''||the [[SDL_Rect]] structure defining the clipping rectangle, or NULL to disable clipping|| |
| Line 29: | Line 28: |
| If the clip rectangle is NULL, clipping will be disabled. | When '''surface''' is the destination of a blit, only the area within the clip rectangle is drawn into. |
| Line 34: | Line 33: |
| .[[SDL_BlitSurface]] |
SDL_SetClipRect
Use this function to set the clipping rectangle for a surface.
Contents
Syntax
SDL_bool SDL_SetClipRect(SDL_Surface* surface,
const SDL_Rect* rect)
Function Parameters
surface |
the SDL_Surface structure to be clipped |
rect |
the SDL_Rect structure defining the clipping rectangle, or NULL to disable clipping |
Return Value
If the clip rectangle doesn't intersect the surface, the function will return SDL_FALSE and blits will be completely clipped. Otherwise the function returns SDL_TRUE and blits to the surface will be clipped to the intersection of the surface area and the clipping rectangle.
Code Examples
You can add your code example here
Remarks
When surface is the destination of a blit, only the area within the clip rectangle is drawn into.
Note that blits are automatically clipped to the edges of the source and destination surfaces.
