Wiki Page Content

Revision 1 as of 2010-06-07 00:09:01

Clear message

DRAFT

SDL_CondWaitTimeout

Use this function to wait on a condition variable for a fixed delay.

green

Contents

  1. SDL_CondWaitTimeout
    1. Syntax
    2. Function Parameters
    3. Return Value
    4. Code Examples
    5. Remarks
    6. Related Functions

Syntax

int SDL_CondWaitTimeout(SDL_cond*  cond,
                        SDL_mutex* mutex,
                        Uint32     ms)

Function Parameters

cond

a pointer to the SDL_cond structure that is being applied ???

mutex

a pointer to the SDL_mutex structure to be timed out ???

ms

the maximum number of milliseconds to wait

Return Value

Returns 0 if the condition variable is signaled, SDL_MUTEX_TIMEDOUT if the condition is not signaled in the allotted time, and -1 on error; call SDL_GetError() for more information.

Code Examples

You can add your code example here

Remarks

/!\ {i} On some platforms this function is implemented by looping with a delay of 1 ms, and so should be avoided if possible.

CategoryAPI, CategoryMutex

(Page Info.)
Feedback
Please include your contact information if you'd like to receive a reply.
Submit