This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
sdlmutexp.html
241 lines (241 loc) · 3.01 KB
1
2
3
4
5
6
<HTML
><HEAD
><TITLE
>SDL_mutexP</TITLE
><META
NAME="GENERATOR"
7
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
"><LINK
REL="HOME"
TITLE="SDL Library Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="Multi-threaded Programming"
HREF="thread.html"><LINK
REL="PREVIOUS"
TITLE="SDL_DestroyMutex"
HREF="sdldestroymutex.html"><LINK
REL="NEXT"
TITLE="SDL_mutexV"
HREF="sdlmutexv.html"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFF8DC"
TEXT="#000000"
LINK="#0000ee"
VLINK="#551a8b"
ALINK="#ff0000"
><DIV
CLASS="NAVHEADER"
><TABLE
31
SUMMARY="Header navigation table"
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
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="sdldestroymutex.html"
49
ACCESSKEY="P"
50
51
52
53
54
55
56
57
58
59
60
61
62
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="sdlmutexv.html"
63
ACCESSKEY="N"
64
65
66
67
68
69
70
71
72
73
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SDLMUTEXP"
74
75
></A
>SDL_mutexP</H1
76
77
78
><DIV
CLASS="REFNAMEDIV"
><A
79
NAME="AEN7872"
80
81
82
83
84
85
86
></A
><H2
>Name</H2
>SDL_mutexP -- Lock a mutex</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
87
NAME="AEN7875"
88
89
90
91
92
93
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><A
94
NAME="AEN7876"
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
></A
><P
></P
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include "SDL.h"
#include "SDL_thread.h"</PRE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int <B
CLASS="FSFUNC"
>SDL_mutexP</B
></CODE
>(SDL_mutex *mutex);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
119
NAME="AEN7882"
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
></A
><H2
>Description</H2
><P
>Locks the <TT
CLASS="PARAMETER"
><I
>mutex</I
></TT
>, which was previously created with <A
HREF="sdlcreatemutex.html"
><TT
CLASS="FUNCTION"
>SDL_CreateMutex</TT
></A
>. If the mutex is already locked then <TT
CLASS="FUNCTION"
>SDL_mutexP</TT
> will not return until it is <A
HREF="sdlmutexv.html"
>unlocked</A
>. Returns <SPAN
CLASS="RETURNVALUE"
>0</SPAN
> on success, or <SPAN
CLASS="RETURNVALUE"
>-1</SPAN
> on an error.</P
><P
>SDL also defines a macro <TT
CLASS="LITERAL"
>#define SDL_LockMutex(m) SDL_mutexP(m)</TT
>.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
157
NAME="AEN7894"
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
></A
><H2
>See Also</H2
><P
><A
HREF="sdlcreatemutex.html"
><TT
CLASS="FUNCTION"
>SDL_CreateMutex</TT
></A
>,
<A
HREF="sdlmutexv.html"
><TT
CLASS="FUNCTION"
>SDL_mutexV</TT
></A
></P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
182
SUMMARY="Footer navigation table"
183
184
185
186
187
188
189
190
191
192
193
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="sdldestroymutex.html"
194
ACCESSKEY="P"
195
196
197
198
199
200
201
202
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
203
ACCESSKEY="H"
204
205
206
207
208
209
210
211
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="sdlmutexv.html"
212
ACCESSKEY="N"
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SDL_DestroyMutex</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="thread.html"
228
ACCESSKEY="U"
229
230
231
232
233
234
235
236
237
238
239
240
241
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>SDL_mutexV</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>