• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<HTML
2><HEAD
3><TITLE
4>SDL_CreateYUVOverlay</TITLE
5><META
6NAME="GENERATOR"
7CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8"><LINK
9REL="HOME"
10TITLE="SDL Library Documentation"
11HREF="index.html"><LINK
12REL="UP"
13TITLE="Video"
14HREF="video.html"><LINK
15REL="PREVIOUS"
16TITLE="SDL_GL_SwapBuffers"
17HREF="sdlglswapbuffers.html"><LINK
18REL="NEXT"
19TITLE="SDL_LockYUVOverlay"
20HREF="sdllockyuvoverlay.html"></HEAD
21><BODY
22CLASS="REFENTRY"
23BGCOLOR="#FFF8DC"
24TEXT="#000000"
25LINK="#0000ee"
26VLINK="#551a8b"
27ALINK="#ff0000"
28><DIV
29CLASS="NAVHEADER"
30><TABLE
31SUMMARY="Header navigation table"
32WIDTH="100%"
33BORDER="0"
34CELLPADDING="0"
35CELLSPACING="0"
36><TR
37><TH
38COLSPAN="3"
39ALIGN="center"
40>SDL Library Documentation</TH
41></TR
42><TR
43><TD
44WIDTH="10%"
45ALIGN="left"
46VALIGN="bottom"
47><A
48HREF="sdlglswapbuffers.html"
49ACCESSKEY="P"
50>Prev</A
51></TD
52><TD
53WIDTH="80%"
54ALIGN="center"
55VALIGN="bottom"
56></TD
57><TD
58WIDTH="10%"
59ALIGN="right"
60VALIGN="bottom"
61><A
62HREF="sdllockyuvoverlay.html"
63ACCESSKEY="N"
64>Next</A
65></TD
66></TR
67></TABLE
68><HR
69ALIGN="LEFT"
70WIDTH="100%"></DIV
71><H1
72><A
73NAME="SDLCREATEYUVOVERLAY"
74></A
75>SDL_CreateYUVOverlay</H1
76><DIV
77CLASS="REFNAMEDIV"
78><A
79NAME="AEN2808"
80></A
81><H2
82>Name</H2
83>SDL_CreateYUVOverlay&nbsp;--&nbsp;Create a YUV video overlay</DIV
84><DIV
85CLASS="REFSYNOPSISDIV"
86><A
87NAME="AEN2811"
88></A
89><H2
90>Synopsis</H2
91><DIV
92CLASS="FUNCSYNOPSIS"
93><A
94NAME="AEN2812"
95></A
96><P
97></P
98><PRE
99CLASS="FUNCSYNOPSISINFO"
100>#include "SDL.h"</PRE
101><P
102><CODE
103><CODE
104CLASS="FUNCDEF"
105>SDL_Overlay *<B
106CLASS="FSFUNC"
107>SDL_CreateYUVOverlay</B
108></CODE
109>(int width, int height, Uint32 format, SDL_Surface *display);</CODE
110></P
111><P
112></P
113></DIV
114></DIV
115><DIV
116CLASS="REFSECT1"
117><A
118NAME="AEN2818"
119></A
120><H2
121>Description</H2
122><P
123><TT
124CLASS="FUNCTION"
125>SDL_CreateYUVOverlay</TT
126> creates a YUV overlay of the specified <TT
127CLASS="PARAMETER"
128><I
129>width</I
130></TT
131>, <TT
132CLASS="PARAMETER"
133><I
134>height</I
135></TT
136> and <TT
137CLASS="PARAMETER"
138><I
139>format</I
140></TT
141> (see <A
142HREF="sdloverlay.html"
143><SPAN
144CLASS="STRUCTNAME"
145>SDL_Overlay</SPAN
146></A
147> for a list of available formats), for the provided <TT
148CLASS="PARAMETER"
149><I
150>display</I
151></TT
152>. A <A
153HREF="sdloverlay.html"
154><SPAN
155CLASS="STRUCTNAME"
156>SDL_Overlay</SPAN
157></A
158> structure is returned.</P
159><P
160>The term 'overlay' is a misnomer since, unless the overlay is created in hardware, the contents for the display surface underneath the area where the overlay is shown will be overwritten when the overlay is displayed.</P
161></DIV
162><DIV
163CLASS="REFSECT1"
164><A
165NAME="AEN2831"
166></A
167><H2
168>See Also</H2
169><P
170><A
171HREF="sdloverlay.html"
172><SPAN
173CLASS="STRUCTNAME"
174>SDL_Overlay</SPAN
175></A
176>,
177<A
178HREF="sdldisplayyuvoverlay.html"
179><TT
180CLASS="FUNCTION"
181>SDL_DisplayYUVOverlay</TT
182></A
183>,
184<A
185HREF="sdlfreeyuvoverlay.html"
186><TT
187CLASS="FUNCTION"
188>SDL_FreeYUVOverlay</TT
189></A
190></P
191></DIV
192><DIV
193CLASS="NAVFOOTER"
194><HR
195ALIGN="LEFT"
196WIDTH="100%"><TABLE
197SUMMARY="Footer navigation table"
198WIDTH="100%"
199BORDER="0"
200CELLPADDING="0"
201CELLSPACING="0"
202><TR
203><TD
204WIDTH="33%"
205ALIGN="left"
206VALIGN="top"
207><A
208HREF="sdlglswapbuffers.html"
209ACCESSKEY="P"
210>Prev</A
211></TD
212><TD
213WIDTH="34%"
214ALIGN="center"
215VALIGN="top"
216><A
217HREF="index.html"
218ACCESSKEY="H"
219>Home</A
220></TD
221><TD
222WIDTH="33%"
223ALIGN="right"
224VALIGN="top"
225><A
226HREF="sdllockyuvoverlay.html"
227ACCESSKEY="N"
228>Next</A
229></TD
230></TR
231><TR
232><TD
233WIDTH="33%"
234ALIGN="left"
235VALIGN="top"
236>SDL_GL_SwapBuffers</TD
237><TD
238WIDTH="34%"
239ALIGN="center"
240VALIGN="top"
241><A
242HREF="video.html"
243ACCESSKEY="U"
244>Up</A
245></TD
246><TD
247WIDTH="33%"
248ALIGN="right"
249VALIGN="top"
250>SDL_LockYUVOverlay</TD
251></TR
252></TABLE
253></DIV
254></BODY
255></HTML
256>