Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

SDL_CreateSemaphore (3)

Name

SDL_CreateSemaphore - Creates a new semaphore and assigns an initial value to it.

Synopsis

#include "SDL.h" #include "SDL_thread.h"

SDL_sem *SDL_CreateSemaphore(Uint32 initial_value);

Description

SDL_CreateSemaphore(3)         SDL API Reference        SDL_CreateSemaphore(3)



NAME
       SDL_CreateSemaphore  -  Creates  a new semaphore and assigns an initial
       value to it.

SYNOPSIS
       #include "SDL.h" #include "SDL_thread.h"

       SDL_sem *SDL_CreateSemaphore(Uint32 initial_value);

DESCRIPTION
       SDL_CreateSemaphore() creates a new semaphore and initializes  it  with
       the  value  initial_value.  Each  locking operation on the semaphore by
       SDL_SemWait,  SDL_SemTryWait  or  SDL_SemWaitTimeout  will   atomically
       decrement the semaphore value. The locking operation will be blocked if
       the semaphore value is not positive (greater than  zero).  Each  unlock
       operation by SDL_SemPost will atomically increment the semaphore value.

RETURN VALUE
       Returns  a  pointer to an initialized semaphore or NULL if there was an
       error.

EXAMPLES
       SDL_sem *my_sem;

       my_sem = SDL_CreateSemaphore(INITIAL_SEM_VALUE);

       if (my_sem == NULL) {
               return CREATE_SEM_FAILED;
       }

ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/sdl      |
       +---------------+------------------+
       |Stability      | Volatile         |
       +---------------+------------------+
SEE ALSO
       SDL_DestroySemaphore, SDL_SemWait, SDL_SemTryWait,  SDL_SemWaitTimeout,
       SDL_SemPost, SDL_SemValue



NOTES
       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source        was        downloaded        from        https://www.lib-
       sdl.org/release/SDL-1.2.15.tar.gz

       Further information about this software can be found on the open source
       community website at https://www.libsdl.org/.



SDL                         Tue 11 Sep 2001, 23:00      SDL_CreateSemaphore(3)