blob: 456c9985dfb471f888fe8ca8c4439f1a8946e144 [file] [log] [blame]
<HTML
><HEAD
><TITLE
>SDL_DisplayYUVOverlay</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
"><LINK
REL="HOME"
TITLE="SDL Library Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="Video"
HREF="video.html"><LINK
REL="PREVIOUS"
TITLE="SDL_UnlockYUVOverlay"
HREF="sdlunlockyuvoverlay.html"><LINK
REL="NEXT"
TITLE="SDL_FreeYUVOverlay"
HREF="sdlfreeyuvoverlay.html"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFF8DC"
TEXT="#000000"
LINK="#0000ee"
VLINK="#551a8b"
ALINK="#ff0000"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation 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="sdlunlockyuvoverlay.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="sdlfreeyuvoverlay.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SDLDISPLAYYUVOVERLAY"
></A
>SDL_DisplayYUVOverlay</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2908"
></A
><H2
>Name</H2
>SDL_DisplayYUVOverlay&nbsp;--&nbsp;Blit the overlay to the display</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2911"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><A
NAME="AEN2912"
></A
><P
></P
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include "SDL.h"</PRE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int <B
CLASS="FSFUNC"
>SDL_DisplayYUVOverlay</B
></CODE
>(SDL_Overlay *overlay, SDL_Rect *dstrect);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2918"
></A
><H2
>Description</H2
><P
>Blit the <TT
CLASS="PARAMETER"
><I
>overlay</I
></TT
> to the surface specified when it was <A
HREF="sdlcreateyuvoverlay.html"
>created</A
>. The <A
HREF="sdlrect.html"
><SPAN
CLASS="STRUCTNAME"
>SDL_Rect</SPAN
></A
> structure, <TT
CLASS="PARAMETER"
><I
>dstrect</I
></TT
>, specifies the position and size of the destination. If the <TT
CLASS="PARAMETER"
><I
>dstrect</I
></TT
> is a larger or smaller than the overlay then the overlay will be scaled, this is optimized for 2x scaling.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2927"
></A
><H2
>Return Values</H2
><P
>Returns 0 on success</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2930"
></A
><H2
>See Also</H2
><P
><A
HREF="sdloverlay.html"
><SPAN
CLASS="STRUCTNAME"
>SDL_Overlay</SPAN
></A
>,
<A
HREF="sdlcreateyuvoverlay.html"
><TT
CLASS="FUNCTION"
>SDL_CreateYUVOverlay</TT
></A
></P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="sdlunlockyuvoverlay.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="sdlfreeyuvoverlay.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SDL_UnlockYUVOverlay</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="video.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>SDL_FreeYUVOverlay</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>