comparison docs/man3/SDL_mutexP.3 @ 0:74212992fb08

Initial revision
author Sam Lantinga <slouken@lokigames.com>
date Thu, 26 Apr 2001 16:45:43 +0000
parents
children 55f1f1b3e27d
comparison
equal deleted inserted replaced
-1:000000000000 0:74212992fb08
1 .TH "SDL_mutexP" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference"
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
18 ...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04