diff 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
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/man3/SDL_mutexP.3	Thu Apr 26 16:45:43 2001 +0000
@@ -0,0 +1,18 @@
+.TH "SDL_mutexP" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" 
+.SH "NAME"
+SDL_mutexP\- Lock a mutex
+.SH "SYNOPSIS"
+.PP
+\fB#include "SDL\&.h"
+#include "SDL_thread\&.h"
+.sp
+\fBint \fBSDL_mutexP\fP\fR(\fBSDL_mutex *mutex\fR);
+.SH "DESCRIPTION"
+.PP
+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\&.
+.PP
+SDL also defines a macro \fB#define SDL_LockMutex(m) SDL_mutexP(m)\fP\&.
+.SH "SEE ALSO"
+.PP
+\fI\fBSDL_CreateMutex\fP\fR, \fI\fBSDL_mutexV\fP\fR
+...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04