Home | History | Annotate | Download | only in html
      1 <HTML
      2 ><HEAD
      3 ><TITLE
      4 >SDL_SetClipRect</TITLE
      5 ><META
      6 NAME="GENERATOR"
      7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
      8 "><LINK
      9 REL="HOME"
     10 TITLE="SDL Library Documentation"
     11 HREF="index.html"><LINK
     12 REL="UP"
     13 TITLE="Video"
     14 HREF="video.html"><LINK
     15 REL="PREVIOUS"
     16 TITLE="SDL_SetAlpha"
     17 HREF="sdlsetalpha.html"><LINK
     18 REL="NEXT"
     19 TITLE="SDL_GetClipRect"
     20 HREF="sdlgetcliprect.html"></HEAD
     21 ><BODY
     22 CLASS="REFENTRY"
     23 BGCOLOR="#FFF8DC"
     24 TEXT="#000000"
     25 LINK="#0000ee"
     26 VLINK="#551a8b"
     27 ALINK="#ff0000"
     28 ><DIV
     29 CLASS="NAVHEADER"
     30 ><TABLE
     31 SUMMARY="Header navigation table"
     32 WIDTH="100%"
     33 BORDER="0"
     34 CELLPADDING="0"
     35 CELLSPACING="0"
     36 ><TR
     37 ><TH
     38 COLSPAN="3"
     39 ALIGN="center"
     40 >SDL Library Documentation</TH
     41 ></TR
     42 ><TR
     43 ><TD
     44 WIDTH="10%"
     45 ALIGN="left"
     46 VALIGN="bottom"
     47 ><A
     48 HREF="sdlsetalpha.html"
     49 ACCESSKEY="P"
     50 >Prev</A
     51 ></TD
     52 ><TD
     53 WIDTH="80%"
     54 ALIGN="center"
     55 VALIGN="bottom"
     56 ></TD
     57 ><TD
     58 WIDTH="10%"
     59 ALIGN="right"
     60 VALIGN="bottom"
     61 ><A
     62 HREF="sdlgetcliprect.html"
     63 ACCESSKEY="N"
     64 >Next</A
     65 ></TD
     66 ></TR
     67 ></TABLE
     68 ><HR
     69 ALIGN="LEFT"
     70 WIDTH="100%"></DIV
     71 ><H1
     72 ><A
     73 NAME="SDLSETCLIPRECT"
     74 ></A
     75 >SDL_SetClipRect</H1
     76 ><DIV
     77 CLASS="REFNAMEDIV"
     78 ><A
     79 NAME="AEN2199"
     80 ></A
     81 ><H2
     82 >Name</H2
     83 >SDL_SetClipRect&nbsp;--&nbsp;Sets the clipping rectangle for a surface.</DIV
     84 ><DIV
     85 CLASS="REFSYNOPSISDIV"
     86 ><A
     87 NAME="AEN2202"
     88 ></A
     89 ><H2
     90 >Synopsis</H2
     91 ><DIV
     92 CLASS="FUNCSYNOPSIS"
     93 ><A
     94 NAME="AEN2203"
     95 ></A
     96 ><P
     97 ></P
     98 ><PRE
     99 CLASS="FUNCSYNOPSISINFO"
    100 >#include "SDL.h"</PRE
    101 ><P
    102 ><CODE
    103 ><CODE
    104 CLASS="FUNCDEF"
    105 >void <B
    106 CLASS="FSFUNC"
    107 >SDL_SetClipRect</B
    108 ></CODE
    109 >(SDL_Surface *surface, SDL_Rect *rect);</CODE
    110 ></P
    111 ><P
    112 ></P
    113 ></DIV
    114 ></DIV
    115 ><DIV
    116 CLASS="REFSECT1"
    117 ><A
    118 NAME="AEN2209"
    119 ></A
    120 ><H2
    121 >Description</H2
    122 ><P
    123 >Sets the clipping rectangle for a surface.  When this surface is the
    124 destination of a blit, only the area within the clip rectangle will be
    125 drawn into.</P
    126 ><P
    127 >The rectangle pointed to by <TT
    128 CLASS="PARAMETER"
    129 ><I
    130 >rect</I
    131 ></TT
    132 > will be
    133 clipped to the edges of the surface so that the clip rectangle for a
    134 surface can never fall outside the edges of the surface.</P
    135 ><P
    136 >If <TT
    137 CLASS="PARAMETER"
    138 ><I
    139 >rect</I
    140 ></TT
    141 > is <TT
    142 CLASS="LITERAL"
    143 >NULL</TT
    144 > the clipping
    145 rectangle will be set to the full size of the surface.</P
    146 ></DIV
    147 ><DIV
    148 CLASS="REFSECT1"
    149 ><A
    150 NAME="AEN2217"
    151 ></A
    152 ><H2
    153 >See Also</H2
    154 ><P
    155 ><A
    156 HREF="sdlgetcliprect.html"
    157 ><TT
    158 CLASS="FUNCTION"
    159 >SDL_GetClipRect</TT
    160 ></A
    161 >,
    162 <A
    163 HREF="sdlblitsurface.html"
    164 ><TT
    165 CLASS="FUNCTION"
    166 >SDL_BlitSurface</TT
    167 ></A
    168 >,
    169 <A
    170 HREF="sdlsurface.html"
    171 ><SPAN
    172 CLASS="STRUCTNAME"
    173 >SDL_Surface</SPAN
    174 ></A
    175 ></P
    176 ></DIV
    177 ><DIV
    178 CLASS="NAVFOOTER"
    179 ><HR
    180 ALIGN="LEFT"
    181 WIDTH="100%"><TABLE
    182 SUMMARY="Footer navigation table"
    183 WIDTH="100%"
    184 BORDER="0"
    185 CELLPADDING="0"
    186 CELLSPACING="0"
    187 ><TR
    188 ><TD
    189 WIDTH="33%"
    190 ALIGN="left"
    191 VALIGN="top"
    192 ><A
    193 HREF="sdlsetalpha.html"
    194 ACCESSKEY="P"
    195 >Prev</A
    196 ></TD
    197 ><TD
    198 WIDTH="34%"
    199 ALIGN="center"
    200 VALIGN="top"
    201 ><A
    202 HREF="index.html"
    203 ACCESSKEY="H"
    204 >Home</A
    205 ></TD
    206 ><TD
    207 WIDTH="33%"
    208 ALIGN="right"
    209 VALIGN="top"
    210 ><A
    211 HREF="sdlgetcliprect.html"
    212 ACCESSKEY="N"
    213 >Next</A
    214 ></TD
    215 ></TR
    216 ><TR
    217 ><TD
    218 WIDTH="33%"
    219 ALIGN="left"
    220 VALIGN="top"
    221 >SDL_SetAlpha</TD
    222 ><TD
    223 WIDTH="34%"
    224 ALIGN="center"
    225 VALIGN="top"
    226 ><A
    227 HREF="video.html"
    228 ACCESSKEY="U"
    229 >Up</A
    230 ></TD
    231 ><TD
    232 WIDTH="33%"
    233 ALIGN="right"
    234 VALIGN="top"
    235 >SDL_GetClipRect</TD
    236 ></TR
    237 ></TABLE
    238 ></DIV
    239 ></BODY
    240 ></HTML
    241 >