Reinstate a lot of the original build environment
[msysgit.git] / mingw / man / man3 / SDL_mutexP.3
blob612bfde76de23a48dd06b54f633a2fb044dbad61
1 .TH "SDL_mutexP" "3" "Tue 11 Sep 2001, 23:01" "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, Tue 11 Sep 2001, 23:01