docs/html/sdldisplayyuvoverlay.html

   1 <HTML
   2 ><HEAD
   3 ><TITLE
   4 >SDL_DisplayYUVOverlay</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_UnlockYUVOverlay"
  17 HREF="sdlunlockyuvoverlay.html"><LINK
  18 REL="NEXT"
  19 TITLE="SDL_FreeYUVOverlay"
  20 HREF="sdlfreeyuvoverlay.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="sdlunlockyuvoverlay.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="sdlfreeyuvoverlay.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="SDLDISPLAYYUVOVERLAY"
  74 ></A
  75 >SDL_DisplayYUVOverlay</H1
  76 ><DIV
  77 CLASS="REFNAMEDIV"
  78 ><A
  79 NAME="AEN2908"
  80 ></A
  81 ><H2
  82 >Name</H2
  83 >SDL_DisplayYUVOverlay&nbsp;--&nbsp;Blit the overlay to the display</DIV
  84 ><DIV
  85 CLASS="REFSYNOPSISDIV"
  86 ><A
  87 NAME="AEN2911"
  88 ></A
  89 ><H2
  90 >Synopsis</H2
  91 ><DIV
  92 CLASS="FUNCSYNOPSIS"
  93 ><A
  94 NAME="AEN2912"
  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 >int <B
 106 CLASS="FSFUNC"
 107 >SDL_DisplayYUVOverlay</B
 108 ></CODE
 109 >(SDL_Overlay *overlay, SDL_Rect *dstrect);</CODE
 110 ></P
 111 ><P
 112 ></P
 113 ></DIV
 114 ></DIV
 115 ><DIV
 116 CLASS="REFSECT1"
 117 ><A
 118 NAME="AEN2918"
 119 ></A
 120 ><H2
 121 >Description</H2
 122 ><P
 123 >Blit the <TT
 124 CLASS="PARAMETER"
 125 ><I
 126 >overlay</I
 127 ></TT
 128 > to the surface specified when it was <A
 129 HREF="sdlcreateyuvoverlay.html"
 130 >created</A
 131 >. The <A
 132 HREF="sdlrect.html"
 133 ><SPAN
 134 CLASS="STRUCTNAME"
 135 >SDL_Rect</SPAN
 136 ></A
 137 > structure, <TT
 138 CLASS="PARAMETER"
 139 ><I
 140 >dstrect</I
 141 ></TT
 142 >, specifies the position and size of the destination. If the <TT
 143 CLASS="PARAMETER"
 144 ><I
 145 >dstrect</I
 146 ></TT
 147 > is a larger or smaller than the overlay then the overlay will be scaled, this is optimized for 2x scaling.</P
 148 ></DIV
 149 ><DIV
 150 CLASS="REFSECT1"
 151 ><A
 152 NAME="AEN2927"
 153 ></A
 154 ><H2
 155 >Return Values</H2
 156 ><P
 157 >Returns 0 on success</P
 158 ></DIV
 159 ><DIV
 160 CLASS="REFSECT1"
 161 ><A
 162 NAME="AEN2930"
 163 ></A
 164 ><H2
 165 >See Also</H2
 166 ><P
 167 ><A
 168 HREF="sdloverlay.html"
 169 ><SPAN
 170 CLASS="STRUCTNAME"
 171 >SDL_Overlay</SPAN
 172 ></A
 173 >,
 174 <A
 175 HREF="sdlcreateyuvoverlay.html"
 176 ><TT
 177 CLASS="FUNCTION"
 178 >SDL_CreateYUVOverlay</TT
 179 ></A
 180 ></P
 181 ></DIV
 182 ><DIV
 183 CLASS="NAVFOOTER"
 184 ><HR
 185 ALIGN="LEFT"
 186 WIDTH="100%"><TABLE
 187 SUMMARY="Footer navigation table"
 188 WIDTH="100%"
 189 BORDER="0"
 190 CELLPADDING="0"
 191 CELLSPACING="0"
 192 ><TR
 193 ><TD
 194 WIDTH="33%"
 195 ALIGN="left"
 196 VALIGN="top"
 197 ><A
 198 HREF="sdlunlockyuvoverlay.html"
 199 ACCESSKEY="P"
 200 >Prev</A
 201 ></TD
 202 ><TD
 203 WIDTH="34%"
 204 ALIGN="center"
 205 VALIGN="top"
 206 ><A
 207 HREF="index.html"
 208 ACCESSKEY="H"
 209 >Home</A
 210 ></TD
 211 ><TD
 212 WIDTH="33%"
 213 ALIGN="right"
 214 VALIGN="top"
 215 ><A
 216 HREF="sdlfreeyuvoverlay.html"
 217 ACCESSKEY="N"
 218 >Next</A
 219 ></TD
 220 ></TR
 221 ><TR
 222 ><TD
 223 WIDTH="33%"
 224 ALIGN="left"
 225 VALIGN="top"
 226 >SDL_UnlockYUVOverlay</TD
 227 ><TD
 228 WIDTH="34%"
 229 ALIGN="center"
 230 VALIGN="top"
 231 ><A
 232 HREF="video.html"
 233 ACCESSKEY="U"
 234 >Up</A
 235 ></TD
 236 ><TD
 237 WIDTH="33%"
 238 ALIGN="right"
 239 VALIGN="top"
 240 >SDL_FreeYUVOverlay</TD
 241 ></TR
 242 ></TABLE
 243 ></DIV
 244 ></BODY
 245 ></HTML
 246 >