Mercurial > sdl-ios-xcode
view docs/man3/SDL_SetClipRect.3 @ 2848:8a3aa505ecba
Comment cleanup.
author | Ryan C. Gordon <icculus@icculus.org> |
---|---|
date | Sun, 07 Dec 2008 07:16:40 +0000 |
parents | 546f7c1eb755 |
children | 1238da4a7112 |
line wrap: on
line source
.TH "SDL_SetClipRect" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" .SH "NAME" SDL_SetClipRect \- Sets the clipping rectangle for a surface\&. .SH "SYNOPSIS" .PP \fB#include "SDL\&.h" .sp \fBvoid \fBSDL_SetClipRect\fP\fR(\fBSDL_Surface *surface, SDL_Rect *rect\fR); .SH "DESCRIPTION" .PP Sets the clipping rectangle for a surface\&. When this surface is the destination of a blit, only the area within the clip rectangle will be drawn into\&. .PP The rectangle pointed to by \fBrect\fR will be clipped to the edges of the surface so that the clip rectangle for a surface can never fall outside the edges of the surface\&. .PP If \fBrect\fR is \fBNULL\fP the clipping rectangle will be set to the full size of the surface\&. .SH "SEE ALSO" .PP \fI\fBSDL_GetClipRect\fP\fR, \fI\fBSDL_BlitSurface\fP\fR, \fI\fBSDL_Surface\fR\fR ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01