[sdl_omap.git] / docs / html / sdllockyuvoverlay.html

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