view docs/man3/SDL_SetClipRect.3 @ 1964:071b6598d48f

1.3 API proposals for audio subsystem. Nothing in here is guaranteed to stay as-is! And none of it is implemented yet! Use at own risk!
author Ryan C. Gordon <icculus@icculus.org>
date Thu, 03 Aug 2006 19:34:05 +0000
parents e5bc29de3f0a
children 546f7c1eb755
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