Wiki Page Content

Revision 4 as of 2010-12-22 00:35:37

Clear message

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().


CategoryAPI, CategorySurface

(Page Info.)
Feedback
Please include your contact information if you'd like to receive a reply.
Submit