docs/html/sdloverlay.html
changeset 3352 6dc250ebdd80
parent 3351 8e0182c236d8
child 3353 6b14223dd5c7
     1.1 --- a/docs/html/sdloverlay.html	Wed Oct 07 06:11:53 2009 +0000
     1.2 +++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.3 @@ -1,362 +0,0 @@
     1.4 -<HTML
     1.5 -><HEAD
     1.6 -><TITLE
     1.7 ->SDL_Overlay</TITLE
     1.8 -><META
     1.9 -NAME="GENERATOR"
    1.10 -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
    1.11 -"><LINK
    1.12 -REL="HOME"
    1.13 -TITLE="SDL Library Documentation"
    1.14 -HREF="index.html"><LINK
    1.15 -REL="UP"
    1.16 -TITLE="Video"
    1.17 -HREF="video.html"><LINK
    1.18 -REL="PREVIOUS"
    1.19 -TITLE="SDL_VideoInfo"
    1.20 -HREF="sdlvideoinfo.html"><LINK
    1.21 -REL="NEXT"
    1.22 -TITLE="Window Management"
    1.23 -HREF="wm.html"></HEAD
    1.24 -><BODY
    1.25 -CLASS="REFENTRY"
    1.26 -BGCOLOR="#FFF8DC"
    1.27 -TEXT="#000000"
    1.28 -LINK="#0000ee"
    1.29 -VLINK="#551a8b"
    1.30 -ALINK="#ff0000"
    1.31 -><DIV
    1.32 -CLASS="NAVHEADER"
    1.33 -><TABLE
    1.34 -SUMMARY="Header navigation table"
    1.35 -WIDTH="100%"
    1.36 -BORDER="0"
    1.37 -CELLPADDING="0"
    1.38 -CELLSPACING="0"
    1.39 -><TR
    1.40 -><TH
    1.41 -COLSPAN="3"
    1.42 -ALIGN="center"
    1.43 ->SDL Library Documentation</TH
    1.44 -></TR
    1.45 -><TR
    1.46 -><TD
    1.47 -WIDTH="10%"
    1.48 -ALIGN="left"
    1.49 -VALIGN="bottom"
    1.50 -><A
    1.51 -HREF="sdlvideoinfo.html"
    1.52 -ACCESSKEY="P"
    1.53 ->Prev</A
    1.54 -></TD
    1.55 -><TD
    1.56 -WIDTH="80%"
    1.57 -ALIGN="center"
    1.58 -VALIGN="bottom"
    1.59 -></TD
    1.60 -><TD
    1.61 -WIDTH="10%"
    1.62 -ALIGN="right"
    1.63 -VALIGN="bottom"
    1.64 -><A
    1.65 -HREF="wm.html"
    1.66 -ACCESSKEY="N"
    1.67 ->Next</A
    1.68 -></TD
    1.69 -></TR
    1.70 -></TABLE
    1.71 -><HR
    1.72 -ALIGN="LEFT"
    1.73 -WIDTH="100%"></DIV
    1.74 -><H1
    1.75 -><A
    1.76 -NAME="SDLOVERLAY"
    1.77 -></A
    1.78 ->SDL_Overlay</H1
    1.79 -><DIV
    1.80 -CLASS="REFNAMEDIV"
    1.81 -><A
    1.82 -NAME="AEN3464"
    1.83 -></A
    1.84 -><H2
    1.85 ->Name</H2
    1.86 ->SDL_Overlay&nbsp;--&nbsp;YUV video overlay</DIV
    1.87 -><DIV
    1.88 -CLASS="REFSECT1"
    1.89 -><A
    1.90 -NAME="AEN3467"
    1.91 -></A
    1.92 -><H2
    1.93 ->Structure Definition</H2
    1.94 -><PRE
    1.95 -CLASS="PROGRAMLISTING"
    1.96 ->typedef struct{
    1.97 -  Uint32 format;
    1.98 -  int w, h;
    1.99 -  int planes;
   1.100 -  Uint16 *pitches;
   1.101 -  Uint8 **pixels;
   1.102 -  Uint32 hw_overlay:1;
   1.103 -} SDL_Overlay;</PRE
   1.104 -></DIV
   1.105 -><DIV
   1.106 -CLASS="REFSECT1"
   1.107 -><A
   1.108 -NAME="AEN3470"
   1.109 -></A
   1.110 -><H2
   1.111 ->Structure Data</H2
   1.112 -><DIV
   1.113 -CLASS="INFORMALTABLE"
   1.114 -><A
   1.115 -NAME="AEN3472"
   1.116 -></A
   1.117 -><P
   1.118 -></P
   1.119 -><TABLE
   1.120 -BORDER="0"
   1.121 -CLASS="CALSTABLE"
   1.122 -><TBODY
   1.123 -><TR
   1.124 -><TD
   1.125 -ALIGN="LEFT"
   1.126 -VALIGN="TOP"
   1.127 -><TT
   1.128 -CLASS="STRUCTFIELD"
   1.129 -><I
   1.130 ->format</I
   1.131 -></TT
   1.132 -></TD
   1.133 -><TD
   1.134 -ALIGN="LEFT"
   1.135 -VALIGN="TOP"
   1.136 ->Overlay format (see below)</TD
   1.137 -></TR
   1.138 -><TR
   1.139 -><TD
   1.140 -ALIGN="LEFT"
   1.141 -VALIGN="TOP"
   1.142 -><TT
   1.143 -CLASS="STRUCTFIELD"
   1.144 -><I
   1.145 ->w, h</I
   1.146 -></TT
   1.147 -></TD
   1.148 -><TD
   1.149 -ALIGN="LEFT"
   1.150 -VALIGN="TOP"
   1.151 ->Width and height of overlay</TD
   1.152 -></TR
   1.153 -><TR
   1.154 -><TD
   1.155 -ALIGN="LEFT"
   1.156 -VALIGN="TOP"
   1.157 -><TT
   1.158 -CLASS="STRUCTFIELD"
   1.159 -><I
   1.160 ->planes</I
   1.161 -></TT
   1.162 -></TD
   1.163 -><TD
   1.164 -ALIGN="LEFT"
   1.165 -VALIGN="TOP"
   1.166 ->Number of planes in the overlay. Usually either 1 or 3</TD
   1.167 -></TR
   1.168 -><TR
   1.169 -><TD
   1.170 -ALIGN="LEFT"
   1.171 -VALIGN="TOP"
   1.172 -><TT
   1.173 -CLASS="STRUCTFIELD"
   1.174 -><I
   1.175 ->pitches</I
   1.176 -></TT
   1.177 -></TD
   1.178 -><TD
   1.179 -ALIGN="LEFT"
   1.180 -VALIGN="TOP"
   1.181 ->An array of pitches, one for each plane. Pitch is the length of a row in bytes.</TD
   1.182 -></TR
   1.183 -><TR
   1.184 -><TD
   1.185 -ALIGN="LEFT"
   1.186 -VALIGN="TOP"
   1.187 -><TT
   1.188 -CLASS="STRUCTFIELD"
   1.189 -><I
   1.190 ->pixels</I
   1.191 -></TT
   1.192 -></TD
   1.193 -><TD
   1.194 -ALIGN="LEFT"
   1.195 -VALIGN="TOP"
   1.196 ->An array of pointers to teh data of each plane. The overlay should be locked before these pointers are used.</TD
   1.197 -></TR
   1.198 -><TR
   1.199 -><TD
   1.200 -ALIGN="LEFT"
   1.201 -VALIGN="TOP"
   1.202 -><TT
   1.203 -CLASS="STRUCTFIELD"
   1.204 -><I
   1.205 ->hw_overlay</I
   1.206 -></TT
   1.207 -></TD
   1.208 -><TD
   1.209 -ALIGN="LEFT"
   1.210 -VALIGN="TOP"
   1.211 ->This will be set to 1 if the overlay is hardware accelerated.</TD
   1.212 -></TR
   1.213 -></TBODY
   1.214 -></TABLE
   1.215 -><P
   1.216 -></P
   1.217 -></DIV
   1.218 -></DIV
   1.219 -><DIV
   1.220 -CLASS="REFSECT1"
   1.221 -><A
   1.222 -NAME="AEN3499"
   1.223 -></A
   1.224 -><H2
   1.225 ->Description</H2
   1.226 -><P
   1.227 ->A <SPAN
   1.228 -CLASS="STRUCTNAME"
   1.229 ->SDL_Overlay</SPAN
   1.230 -> is similar to a <A
   1.231 -HREF="sdlsurface.html"
   1.232 -><SPAN
   1.233 -CLASS="STRUCTNAME"
   1.234 ->SDL_Surface</SPAN
   1.235 -></A
   1.236 -> except it stores a YUV overlay. All the fields are read only, except for <TT
   1.237 -CLASS="STRUCTFIELD"
   1.238 -><I
   1.239 ->pixels</I
   1.240 -></TT
   1.241 -> which should be <A
   1.242 -HREF="sdllockyuvoverlay.html"
   1.243 ->locked</A
   1.244 -> before use. The <TT
   1.245 -CLASS="STRUCTFIELD"
   1.246 -><I
   1.247 ->format</I
   1.248 -></TT
   1.249 -> field stores the format of the overlay which is one of the following:
   1.250 -<PRE
   1.251 -CLASS="PROGRAMLISTING"
   1.252 ->#define SDL_YV12_OVERLAY  0x32315659  /* Planar mode: Y + V + U */
   1.253 -#define SDL_IYUV_OVERLAY  0x56555949  /* Planar mode: Y + U + V */
   1.254 -#define SDL_YUY2_OVERLAY  0x32595559  /* Packed mode: Y0+U0+Y1+V0 */
   1.255 -#define SDL_UYVY_OVERLAY  0x59565955  /* Packed mode: U0+Y0+V0+Y1 */
   1.256 -#define SDL_YVYU_OVERLAY  0x55595659  /* Packed mode: Y0+V0+Y1+U0 */</PRE
   1.257 ->
   1.258 -More information on YUV formats can be found at <A
   1.259 -HREF="http://www.webartz.com/fourcc/indexyuv.htm"
   1.260 -TARGET="_top"
   1.261 ->http://www.webartz.com/fourcc/indexyuv.htm</A
   1.262 ->.</P
   1.263 -></DIV
   1.264 -><DIV
   1.265 -CLASS="REFSECT1"
   1.266 -><A
   1.267 -NAME="AEN3510"
   1.268 -></A
   1.269 -><H2
   1.270 ->See Also</H2
   1.271 -><P
   1.272 -><A
   1.273 -HREF="sdlcreateyuvoverlay.html"
   1.274 -><TT
   1.275 -CLASS="FUNCTION"
   1.276 ->SDL_CreateYUVOverlay</TT
   1.277 -></A
   1.278 ->,
   1.279 -<A
   1.280 -HREF="sdllockyuvoverlay.html"
   1.281 -><TT
   1.282 -CLASS="FUNCTION"
   1.283 ->SDL_LockYUVOverlay</TT
   1.284 -></A
   1.285 ->,
   1.286 -<A
   1.287 -HREF="sdlunlockyuvoverlay.html"
   1.288 -><TT
   1.289 -CLASS="FUNCTION"
   1.290 ->SDL_UnlockYUVOverlay</TT
   1.291 -></A
   1.292 ->,
   1.293 -<A
   1.294 -HREF="sdlfreeyuvoverlay.html"
   1.295 -><TT
   1.296 -CLASS="FUNCTION"
   1.297 ->SDL_FreeYUVOverlay</TT
   1.298 -></A
   1.299 -></P
   1.300 -></DIV
   1.301 -><DIV
   1.302 -CLASS="NAVFOOTER"
   1.303 -><HR
   1.304 -ALIGN="LEFT"
   1.305 -WIDTH="100%"><TABLE
   1.306 -SUMMARY="Footer navigation table"
   1.307 -WIDTH="100%"
   1.308 -BORDER="0"
   1.309 -CELLPADDING="0"
   1.310 -CELLSPACING="0"
   1.311 -><TR
   1.312 -><TD
   1.313 -WIDTH="33%"
   1.314 -ALIGN="left"
   1.315 -VALIGN="top"
   1.316 -><A
   1.317 -HREF="sdlvideoinfo.html"
   1.318 -ACCESSKEY="P"
   1.319 ->Prev</A
   1.320 -></TD
   1.321 -><TD
   1.322 -WIDTH="34%"
   1.323 -ALIGN="center"
   1.324 -VALIGN="top"
   1.325 -><A
   1.326 -HREF="index.html"
   1.327 -ACCESSKEY="H"
   1.328 ->Home</A
   1.329 -></TD
   1.330 -><TD
   1.331 -WIDTH="33%"
   1.332 -ALIGN="right"
   1.333 -VALIGN="top"
   1.334 -><A
   1.335 -HREF="wm.html"
   1.336 -ACCESSKEY="N"
   1.337 ->Next</A
   1.338 -></TD
   1.339 -></TR
   1.340 -><TR
   1.341 -><TD
   1.342 -WIDTH="33%"
   1.343 -ALIGN="left"
   1.344 -VALIGN="top"
   1.345 ->SDL_VideoInfo</TD
   1.346 -><TD
   1.347 -WIDTH="34%"
   1.348 -ALIGN="center"
   1.349 -VALIGN="top"
   1.350 -><A
   1.351 -HREF="video.html"
   1.352 -ACCESSKEY="U"
   1.353 ->Up</A
   1.354 -></TD
   1.355 -><TD
   1.356 -WIDTH="33%"
   1.357 -ALIGN="right"
   1.358 -VALIGN="top"
   1.359 ->Window Management</TD
   1.360 -></TR
   1.361 -></TABLE
   1.362 -></DIV
   1.363 -></BODY
   1.364 -></HTML
   1.365 ->
   1.366 \ No newline at end of file