Section 3: library functions
SDL_CreateMutex – Create a mutex Synopsis #include "SDL.h" #include "SDL_thread.h" SDL_mutex *SDL_CreateMutex(void); Description Create a new, unlocked mutex. Examples SDL_mutex *mut; mut=SDL_CreateMutex(); . . if(SDL_mutexP(mut)==-1){ fprintf(stderr, "Couldn’t lock mutex "); exit(-1); } . /* Do stuff while mutex is locked */ . . if(SDL_mutexV(mut)==-1){ fprintf(stderr, "Couldn’t unlock mutex "); exit(-1); } SDL_DestroyMutex(mut); See Also SDL_mutexP,…
SDL_CreateCursor – Creates a new mouse cursor. Synopsis #include "SDL.h" SDL_Cursor *SDL_CreateCursor(Uint8 *data, Uint8 *mask, int w, int h, int hot_x, int hot_y); Description Create a cursor using the specified data and mask (in MSB format). The cursor width must be a multiple of 8 bits. The cursor is created in black and white according…
SDL_CreateCond – Create a condition variable Synopsis #include "SDL.h" #include "SDL_thread.h" SDL_cond *SDL_CreateCond(void); Description Creates a condition variable. Examples SDL_cond *cond; cond=SDL_CreateCond(); . . /* Do stuff */ . . SDL_DestroyCond(cond); See Also SDL_DestroyCond, SDL_CondWait, SDL_CondSignal
SDL_ConvertSurface – Converts a surface to the same format as another surface. Synopsis #include "SDL/SDL.h" SDL_Surface *SDL_ConvertSurface(SDL_Surface *src, SDL_PixelFormat *fmt, Uint32 flags); Description Creates a new surface of the specified format, and then copies and maps the given surface to it. If this function fails, it returns NULL. The flags parameter is passed to SDL_CreateRGBSurface…
SDL_ConvertAudio – Convert audio data to a desired audio format. Synopsis #include "SDL.h" int SDL_ConvertAudio(SDL_AudioCVT *cvt); Description SDL_ConvertAudio takes one parameter, cvt, which was previously initilized. Initilizing a SDL_AudioCVT is a two step process. First of all, the structure must be passed to SDL_BuildAudioCVT along with source and destination format parameters. Secondly, the cvt->buf and…
SDL_CondWaitTimeout – Wait on a condition variable, with timeout Synopsis #include "SDL.h" #include "SDL_thread.h" int SDL_CondWaitTimeout(SDL_cond *cond, SDL_mutex *mutex, Uint32 ms); Description Wait on the condition variable cond for, at most, ms milliseconds. mut is unlocked so it must be locked when the function is called. Returns SDL_MUTEX_TIMEDOUT if the condition is not signalled in…
SDL_CondWait – Wait on a condition variable Synopsis #include "SDL.h" #include "SDL_thread.h" int SDL_CondWait(SDL_cond *cond, SDL_mutex *mut); Description Wait on the condition variable cond and unlock the provided mutex. The mutex must the locked before entering this function. Returns 0 when it is signalled, or -1 on an error. See Also SDL_CondWaitTimeout, SDL_CondSignal, SDL_mutexP
SDL_CondSignal – Restart a thread wait on a condition variable Synopsis #include "SDL.h" #include "SDL_thread.h" int SDL_CondSignal(SDL_cond *cond); Description Restart one of the threads that are waiting on the condition variable, cond. Returns 0 on success of -1 on an error. See Also SDL_CondWait, SDL_CondBroadcast
SDL_CondBroadcast – Restart all threads waiting on a condition variable Synopsis #include "SDL.h" #include "SDL_thread.h" int SDL_CondBroadcast(SDL_cond *cond); Description Restarts all threads that are waiting on the condition variable, cond. Returns 0 on success, or -1 on an error. See Also SDL_CondSignal, SDL_CondWait
SDL_Color – Format independent color description Structure Definition typedef struct{ Uint8 r; Uint8 g; Uint8 b; Uint8 unused; } SDL_Color; Structure Data r Red intensity g Green intensity b Blue intensity unused Unused Description SDL_Color describes a color in a format independent way. You can convert a SDL_Color to a pixel value for a certain…
SDL_CloseAudio – Shuts down audio processing and closes the audio device. Synopsis #include "SDL.h" void SDL_CloseAudio(void) Description This function shuts down audio processing and closes the audio device. See Also SDL_OpenAudio
SDL_CDtrack – CD Track Information Structure Structure Definition typedef struct{ Uint8 id; Uint8 type; Uint32 length; Uint32 offset; } SDL_CDtrack; Structure Data id Track number (0-99) type SDL_AUDIO_TRACK or SDL_DATA_TRACK length Length, in frames, of this track offset Frame offset to the beginning of this track Description SDL_CDtrack stores data on each track on a…
SDL_CDStop – Stops a CDROM Synopsis #include "SDL.h" int SDL_CDStop(SDL_CD *cdrom); Description Stops play on the given cdrom. Return Value Returns 0 on success, or -1 on an error. See Also SDL_CDPlay,
SDL_CDStatus – Returns the current status of the given drive. Synopsis #include "SDL.h" CDstatus SDL_CDStatus(SDL_CD *cdrom); /* Given a status, returns true if there’s a disk in the drive */ #define CD_INDRIVE(status) ((int)status > 0) Description This function returns the current status of the given drive. Status is described like so: typedef enum { CD_TRAYEMPTY,…
SDL_CDResume – Resumes a CDROM Synopsis #include "SDL.h" int SDL_CDResume(SDL_CD *cdrom); Description Resumes play on the given cdrom. Return Value Returns 0 on success, or -1 on an error. See Also SDL_CDPlay, SDL_CDPause
SDL_CDPlayTracks – Play the given CD track(s) Synopsis #include "SDL.h" int SDL_CDPlayTracks(SDL_CD *cdrom, int start_track, int start_frame, int ntracks, int nframes)); Description SDL_CDPlayTracks plays the given CD starting at track start_track, for ntracks tracks. start_frame is the frame offset, from the beginning of the start_track, at which to start. nframes is the frame offset, from…
SDL_CDPlay – Play a CD Synopsis #include "SDL.h" int SDL_CDPlay(SDL_CD *cdrom, int start, int length); Description Plays the given cdrom, starting a frame start for length frames. Return Values Returns 0 on success, or -1 on an error. See Also SDL_CDPlayTracks, SDL_CDStop
SDL_CDPause – Pauses a CDROM Synopsis #include "SDL.h" int SDL_CDPause(SDL_CD *cdrom); Description Pauses play on the given cdrom. Return Value Returns 0 on success, or -1 on an error. See Also SDL_CDPlay, SDL_CDResume
SDL_CDOpen – Opens a CD-ROM drive for access. Synopsis #include "SDL.h" SDL_CD *SDL_CDOpen(int drive); Description Opens a CD-ROM drive for access. It returns a SDL_CD structure on success, or NULL if the drive was invalid or busy. This newly opened CD-ROM becomes the default CD used when other CD functions are passed a NULL CD-ROM…
SDL_CDNumDrives – Returns the number of CD-ROM drives on the system. Synopsis #include "SDL.h" int SDL_CDNumDrives(void) Description Returns the number of CD-ROM drives on the system. See Also SDL_CDOpen