|
Size: 1345
Comment: update formatting - enums, structs, the/an
|
Size: 1067
Comment: update content - w/ Sam
|
| 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 18: | Line 17: |
| ||'''rect'''||the [[SDL_Rect]] structure defining the clipping rectangle^, or NULL for the entire render target/to disable clipping???^|| | ||'''rect'''||the [[SDL_Rect]] structure defining the clipping rectangle, or NULL to disable clipping|| |
| Line 21: | Line 20: |
| 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. | Returns SDL_TRUE if the rectangle intersects the surface or SDL_FALSE and blits will be completely clipped if not. |
| Line 29: | Line 28: |
| If the clip rectangle is NULL, clipping will be disabled. <<Color2(green,Can this be moved to params?)>> | 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_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
Returns SDL_TRUE if the rectangle intersects the surface or SDL_FALSE and blits will be completely clipped if not.
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.
