docs/man3/SDL_SetClipRect.3
author Sam Lantinga <slouken@libsdl.org>
Wed, 08 Mar 2006 18:30:12 +0000
changeset 1486 9d77fc9d0ace
parent 181 e5bc29de3f0a
child 2283 546f7c1eb755
permissions -rw-r--r--
Re-added C runtime support for Visual C++ 5,6
     1 .TH "SDL_SetClipRect" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" 
     2 .SH "NAME"
     3 SDL_SetClipRect\- Sets the clipping rectangle for a surface\&.
     4 .SH "SYNOPSIS"
     5 .PP
     6 \fB#include "SDL\&.h"
     7 .sp
     8 \fBvoid \fBSDL_SetClipRect\fP\fR(\fBSDL_Surface *surface, SDL_Rect *rect\fR);
     9 .SH "DESCRIPTION"
    10 .PP
    11 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\&.
    12 .PP
    13 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\&.
    14 .PP
    15 If \fBrect\fR is \fBNULL\fP the clipping rectangle will be set to the full size of the surface\&.
    16 .SH "SEE ALSO"
    17 .PP
    18 \fI\fBSDL_GetClipRect\fP\fR, \fI\fBSDL_BlitSurface\fP\fR, \fI\fBSDL_Surface\fR\fR
    19 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01