Mercurial > sdl-ios-xcode
annotate docs/html/sdlcondwaittimeout.html @ 81:1a2723474f12
Added the SDL_VIDEO_YUV_DIRECT hack for better performance when the
requested video mode is 16 bpp but the real video mode is 32 bpp.
author | Sam Lantinga <slouken@lokigames.com> |
---|---|
date | Mon, 25 Jun 2001 22:16:44 +0000 |
parents | 55f1f1b3e27d |
children | e5bc29de3f0a |
rev | line source |
---|---|
0 | 1 <HTML |
2 ><HEAD | |
3 ><TITLE | |
4 >SDL_CondWaitTimeout</TITLE | |
5 ><META | |
6 NAME="GENERATOR" | |
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.64 |
0 | 8 "><LINK |
9 REL="HOME" | |
10 TITLE="SDL Library Documentation" | |
11 HREF="index.html"><LINK | |
12 REL="UP" | |
13 TITLE="Multi-threaded Programming" | |
14 HREF="thread.html"><LINK | |
15 REL="PREVIOUS" | |
16 TITLE="SDL_CondWait" | |
17 HREF="sdlcondwait.html"><LINK | |
18 REL="NEXT" | |
19 TITLE="Time" | |
20 HREF="time.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 WIDTH="100%" | |
32 BORDER="0" | |
33 CELLPADDING="0" | |
34 CELLSPACING="0" | |
35 ><TR | |
36 ><TH | |
37 COLSPAN="3" | |
38 ALIGN="center" | |
39 >SDL Library Documentation</TH | |
40 ></TR | |
41 ><TR | |
42 ><TD | |
43 WIDTH="10%" | |
44 ALIGN="left" | |
45 VALIGN="bottom" | |
46 ><A | |
47 HREF="sdlcondwait.html" | |
48 >Prev</A | |
49 ></TD | |
50 ><TD | |
51 WIDTH="80%" | |
52 ALIGN="center" | |
53 VALIGN="bottom" | |
54 ></TD | |
55 ><TD | |
56 WIDTH="10%" | |
57 ALIGN="right" | |
58 VALIGN="bottom" | |
59 ><A | |
60 HREF="time.html" | |
61 >Next</A | |
62 ></TD | |
63 ></TR | |
64 ></TABLE | |
65 ><HR | |
66 ALIGN="LEFT" | |
67 WIDTH="100%"></DIV | |
68 ><H1 | |
69 ><A | |
70 NAME="SDLCONDWAITTIMEOUT" | |
71 >SDL_CondWaitTimeout</A | |
72 ></H1 | |
73 ><DIV | |
74 CLASS="REFNAMEDIV" | |
75 ><A | |
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
76 NAME="AEN7844" |
0 | 77 ></A |
78 ><H2 | |
79 >Name</H2 | |
80 >SDL_CondWaitTimeout -- Wait on a condition variable, with timeout</DIV | |
81 ><DIV | |
82 CLASS="REFSYNOPSISDIV" | |
83 ><A | |
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
84 NAME="AEN7847" |
0 | 85 ></A |
86 ><H2 | |
87 >Synopsis</H2 | |
88 ><DIV | |
89 CLASS="FUNCSYNOPSIS" | |
90 ><A | |
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
91 NAME="AEN7848" |
0 | 92 ></A |
93 ><P | |
94 ></P | |
95 ><PRE | |
96 CLASS="FUNCSYNOPSISINFO" | |
97 >#include "SDL.h" | |
98 #include "SDL_thread.h"</PRE | |
99 ><P | |
100 ><CODE | |
101 ><CODE | |
102 CLASS="FUNCDEF" | |
103 >int <B | |
104 CLASS="FSFUNC" | |
105 >SDL_CondWaitTimeout</B | |
106 ></CODE | |
107 >(SDL_cond *cond, SDL_mutex *mutex, Uint32 ms);</CODE | |
108 ></P | |
109 ><P | |
110 ></P | |
111 ></DIV | |
112 ></DIV | |
113 ><DIV | |
114 CLASS="REFSECT1" | |
115 ><A | |
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
116 NAME="AEN7854" |
0 | 117 ></A |
118 ><H2 | |
119 >Description</H2 | |
120 ><P | |
121 >Wait on the condition variable <TT | |
122 CLASS="PARAMETER" | |
123 ><I | |
124 >cond</I | |
125 ></TT | |
126 > for, at most, <TT | |
127 CLASS="PARAMETER" | |
128 ><I | |
129 >ms</I | |
130 ></TT | |
131 > milliseconds. <TT | |
132 CLASS="PARAMETER" | |
133 ><I | |
134 >mut</I | |
135 ></TT | |
136 > is unlocked so it must be locked when the function is called. Returns <TT | |
137 CLASS="LITERAL" | |
138 >SDL_MUTEX_TIMEDOUT</TT | |
139 > if the condition is not signalled in the allotted time, <SPAN | |
140 CLASS="RETURNVALUE" | |
141 >0</SPAN | |
142 > if it was signalled or <SPAN | |
143 CLASS="RETURNVALUE" | |
144 >-1</SPAN | |
145 > on an error.</P | |
146 ></DIV | |
147 ><DIV | |
148 CLASS="REFSECT1" | |
149 ><A | |
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
150 NAME="AEN7863" |
0 | 151 ></A |
152 ><H2 | |
153 >See Also</H2 | |
154 ><P | |
155 ><A | |
156 HREF="sdlcondwait.html" | |
157 ><TT | |
158 CLASS="FUNCTION" | |
159 >SDL_CondWait</TT | |
160 ></A | |
161 ></P | |
162 ></DIV | |
163 ><DIV | |
164 CLASS="NAVFOOTER" | |
165 ><HR | |
166 ALIGN="LEFT" | |
167 WIDTH="100%"><TABLE | |
168 WIDTH="100%" | |
169 BORDER="0" | |
170 CELLPADDING="0" | |
171 CELLSPACING="0" | |
172 ><TR | |
173 ><TD | |
174 WIDTH="33%" | |
175 ALIGN="left" | |
176 VALIGN="top" | |
177 ><A | |
178 HREF="sdlcondwait.html" | |
179 >Prev</A | |
180 ></TD | |
181 ><TD | |
182 WIDTH="34%" | |
183 ALIGN="center" | |
184 VALIGN="top" | |
185 ><A | |
186 HREF="index.html" | |
187 >Home</A | |
188 ></TD | |
189 ><TD | |
190 WIDTH="33%" | |
191 ALIGN="right" | |
192 VALIGN="top" | |
193 ><A | |
194 HREF="time.html" | |
195 >Next</A | |
196 ></TD | |
197 ></TR | |
198 ><TR | |
199 ><TD | |
200 WIDTH="33%" | |
201 ALIGN="left" | |
202 VALIGN="top" | |
203 >SDL_CondWait</TD | |
204 ><TD | |
205 WIDTH="34%" | |
206 ALIGN="center" | |
207 VALIGN="top" | |
208 ><A | |
209 HREF="thread.html" | |
210 >Up</A | |
211 ></TD | |
212 ><TD | |
213 WIDTH="33%" | |
214 ALIGN="right" | |
215 VALIGN="top" | |
216 >Time</TD | |
217 ></TR | |
218 ></TABLE | |
219 ></DIV | |
220 ></BODY | |
221 ></HTML | |
222 > |