SDL-1.2.14
[sdl_omap.git] / docs / man3 / SDL_CondWait.3
1 .TH "SDL_CondWait" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" 
2 .SH "NAME"
3 SDL_CondWait \- Wait on a condition variable
4 .SH "SYNOPSIS"
5 .PP
6 \fB#include "SDL\&.h"
7 #include "SDL_thread\&.h"
8 .sp
9 \fBint \fBSDL_CondWait\fP\fR(\fBSDL_cond *cond, SDL_mutex *mut\fR);
10 .SH "DESCRIPTION"
11 .PP
12 Wait on the condition variable \fBcond\fR and unlock the provided mutex\&. The mutex must the locked before entering this function\&. Returns \fB0\fR when it is signalled, or \fB-1\fR on an error\&.
13 .SH "SEE ALSO"
14 .PP
15 \fI\fBSDL_CondWaitTimeout\fP\fR, \fI\fBSDL_CondSignal\fP\fR, \fI\fBSDL_mutexP\fP\fR
16 .\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00