Mercurial > sdl-ios-xcode
view docs/html/sdlsetcliprect.html @ 0:74212992fb08
Initial revision
author | Sam Lantinga <slouken@lokigames.com> |
---|---|
date | Thu, 26 Apr 2001 16:45:43 +0000 |
parents | |
children | 55f1f1b3e27d |
line wrap: on
line source
<HTML ><HEAD ><TITLE >SDL_SetClipRect</TITLE ><META NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.61 "><LINK REL="HOME" TITLE="SDL Library Documentation" HREF="index.html"><LINK REL="UP" TITLE="Video" HREF="video.html"><LINK REL="PREVIOUS" TITLE="SDL_SetAlpha" HREF="sdlsetalpha.html"><LINK REL="NEXT" TITLE="SDL_GetClipRect" HREF="sdlgetcliprect.html"></HEAD ><BODY CLASS="REFENTRY" BGCOLOR="#FFF8DC" TEXT="#000000" LINK="#0000ee" VLINK="#551a8b" ALINK="#ff0000" ><DIV CLASS="NAVHEADER" ><TABLE WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TH COLSPAN="3" ALIGN="center" >SDL Library Documentation</TH ></TR ><TR ><TD WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A HREF="sdlsetalpha.html" >Prev</A ></TD ><TD WIDTH="80%" ALIGN="center" VALIGN="bottom" ></TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A HREF="sdlgetcliprect.html" >Next</A ></TD ></TR ></TABLE ><HR ALIGN="LEFT" WIDTH="100%"></DIV ><H1 ><A NAME="SDLSETCLIPRECT" >SDL_SetClipRect</A ></H1 ><DIV CLASS="REFNAMEDIV" ><A NAME="AEN1707" ></A ><H2 >Name</H2 >SDL_SetClipRect -- Sets the clipping rectangle for a surface.</DIV ><DIV CLASS="REFSYNOPSISDIV" ><A NAME="AEN1710" ></A ><H2 >Synopsis</H2 ><DIV CLASS="FUNCSYNOPSIS" ><A NAME="AEN1711" ></A ><P ></P ><PRE CLASS="FUNCSYNOPSISINFO" >#include "SDL.h"</PRE ><P ><CODE ><CODE CLASS="FUNCDEF" >void <B CLASS="FSFUNC" >SDL_SetClipRect</B ></CODE >(SDL_Surface *surface, SDL_Rect *rect);</CODE ></P ><P ></P ></DIV ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN1717" ></A ><H2 >Description</H2 ><P >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.</P ><P >The rectangle pointed to by <TT CLASS="PARAMETER" ><I >rect</I ></TT > 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.</P ><P >If <TT CLASS="PARAMETER" ><I >rect</I ></TT > is <TT CLASS="LITERAL" >NULL</TT > the clipping rectangle will be set to the full size of the surface.</P ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN1725" ></A ><H2 >See Also</H2 ><P ><A HREF="sdlgetcliprect.html" ><TT CLASS="FUNCTION" >SDL_GetClipRect</TT ></A >, <A HREF="sdlblitsurface.html" ><TT CLASS="FUNCTION" >SDL_BlitSurface</TT ></A >, <A HREF="sdlsurface.html" ><SPAN CLASS="STRUCTNAME" >SDL_Surface</SPAN ></A ></P ></DIV ><DIV CLASS="NAVFOOTER" ><HR ALIGN="LEFT" WIDTH="100%"><TABLE WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" ><A HREF="sdlsetalpha.html" >Prev</A ></TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="index.html" >Home</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" ><A HREF="sdlgetcliprect.html" >Next</A ></TD ></TR ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" >SDL_SetAlpha</TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="video.html" >Up</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" >SDL_GetClipRect</TD ></TR ></TABLE ></DIV ></BODY ></HTML >