Mercurial > sdl-ios-xcode
annotate docs/man3/SDL_mutexP.3 @ 2213:59a667370c57
make indent
author | Bob Pendleton <bob@pendleton.com> |
---|---|
date | Tue, 24 Jul 2007 18:46:45 +0000 |
parents | e5bc29de3f0a |
children | 546f7c1eb755 |
rev | line source |
---|---|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
1 .TH "SDL_mutexP" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" |
0 | 2 .SH "NAME" |
3 SDL_mutexP\- Lock a mutex | |
4 .SH "SYNOPSIS" | |
5 .PP | |
6 \fB#include "SDL\&.h" | |
7 #include "SDL_thread\&.h" | |
8 .sp | |
9 \fBint \fBSDL_mutexP\fP\fR(\fBSDL_mutex *mutex\fR); | |
10 .SH "DESCRIPTION" | |
11 .PP | |
12 Locks the \fBmutex\fR, which was previously created with \fI\fBSDL_CreateMutex\fP\fR\&. If the mutex is already locked then \fBSDL_mutexP\fP will not return until it is \fIunlocked\fR\&. Returns \fB0\fR on success, or \fB-1\fR on an error\&. | |
13 .PP | |
14 SDL also defines a macro \fB#define SDL_LockMutex(m) SDL_mutexP(m)\fP\&. | |
15 .SH "SEE ALSO" | |
16 .PP | |
17 \fI\fBSDL_CreateMutex\fP\fR, \fI\fBSDL_mutexV\fP\fR | |
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
18 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 |