• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<HTML
2><HEAD
3><TITLE
4>SDL_LockYUVOverlay</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_CreateYUVOverlay"
17HREF="sdlcreateyuvoverlay.html"><LINK
18REL="NEXT"
19TITLE="SDL_UnlockYUVOverlay"
20HREF="sdlunlockyuvoverlay.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="sdlcreateyuvoverlay.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="sdlunlockyuvoverlay.html"
63ACCESSKEY="N"
64>Next</A
65></TD
66></TR
67></TABLE
68><HR
69ALIGN="LEFT"
70WIDTH="100%"></DIV
71><H1
72><A
73NAME="SDLLOCKYUVOVERLAY"
74></A
75>SDL_LockYUVOverlay</H1
76><DIV
77CLASS="REFNAMEDIV"
78><A
79NAME="AEN2844"
80></A
81><H2
82>Name</H2
83>SDL_LockYUVOverlay&nbsp;--&nbsp;Lock an overlay</DIV
84><DIV
85CLASS="REFSYNOPSISDIV"
86><A
87NAME="AEN2847"
88></A
89><H2
90>Synopsis</H2
91><DIV
92CLASS="FUNCSYNOPSIS"
93><A
94NAME="AEN2848"
95></A
96><P
97></P
98><PRE
99CLASS="FUNCSYNOPSISINFO"
100>#include "SDL.h"</PRE
101><P
102><CODE
103><CODE
104CLASS="FUNCDEF"
105>int <B
106CLASS="FSFUNC"
107>SDL_LockYUVOverlay</B
108></CODE
109>(SDL_Overlay *overlay);</CODE
110></P
111><P
112></P
113></DIV
114></DIV
115><DIV
116CLASS="REFSECT1"
117><A
118NAME="AEN2854"
119></A
120><H2
121>Description</H2
122><P
123>Much the same as <A
124HREF="sdllocksurface.html"
125><TT
126CLASS="FUNCTION"
127>SDL_LockSurface</TT
128></A
129>, <TT
130CLASS="FUNCTION"
131>SDL_LockYUVOverlay</TT
132> locks the <A
133HREF="sdloverlay.html"
134><TT
135CLASS="PARAMETER"
136><I
137>overlay</I
138></TT
139></A
140> for direct access to pixel data.</P
141></DIV
142><DIV
143CLASS="REFSECT1"
144><A
145NAME="AEN2862"
146></A
147><H2
148>Return Value</H2
149><P
150>Returns <SPAN
151CLASS="RETURNVALUE"
152>0</SPAN
153> on success, or <SPAN
154CLASS="RETURNVALUE"
155>-1</SPAN
156> on an error.</P
157></DIV
158><DIV
159CLASS="REFSECT1"
160><A
161NAME="AEN2867"
162></A
163><H2
164>See Also</H2
165><P
166><A
167HREF="sdlunlockyuvoverlay.html"
168><TT
169CLASS="FUNCTION"
170>SDL_UnlockYUVOverlay</TT
171></A
172>,
173<A
174HREF="sdlcreateyuvoverlay.html"
175><TT
176CLASS="FUNCTION"
177>SDL_CreateYUVOverlay</TT
178></A
179>,
180<A
181HREF="sdloverlay.html"
182><SPAN
183CLASS="STRUCTNAME"
184>SDL_Overlay</SPAN
185></A
186></P
187></DIV
188><DIV
189CLASS="NAVFOOTER"
190><HR
191ALIGN="LEFT"
192WIDTH="100%"><TABLE
193SUMMARY="Footer navigation table"
194WIDTH="100%"
195BORDER="0"
196CELLPADDING="0"
197CELLSPACING="0"
198><TR
199><TD
200WIDTH="33%"
201ALIGN="left"
202VALIGN="top"
203><A
204HREF="sdlcreateyuvoverlay.html"
205ACCESSKEY="P"
206>Prev</A
207></TD
208><TD
209WIDTH="34%"
210ALIGN="center"
211VALIGN="top"
212><A
213HREF="index.html"
214ACCESSKEY="H"
215>Home</A
216></TD
217><TD
218WIDTH="33%"
219ALIGN="right"
220VALIGN="top"
221><A
222HREF="sdlunlockyuvoverlay.html"
223ACCESSKEY="N"
224>Next</A
225></TD
226></TR
227><TR
228><TD
229WIDTH="33%"
230ALIGN="left"
231VALIGN="top"
232>SDL_CreateYUVOverlay</TD
233><TD
234WIDTH="34%"
235ALIGN="center"
236VALIGN="top"
237><A
238HREF="video.html"
239ACCESSKEY="U"
240>Up</A
241></TD
242><TD
243WIDTH="33%"
244ALIGN="right"
245VALIGN="top"
246>SDL_UnlockYUVOverlay</TD
247></TR
248></TABLE
249></DIV
250></BODY
251></HTML
252>