Section 3: library functions
SDL_ConvertAudio – Convert audio data to a desired audio format. Synopsis#include "SDL.h" int SDL_ConvertAudio(SDL_AudioCVT *cvt); DescriptionSDL_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 cvt->len fields…
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); DescriptionWait 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 the allotted…
SDL_CondWait – Wait on a condition variable Synopsis#include "SDL.h" #include "SDL_thread.h" int SDL_CondWait(SDL_cond *cond, SDL_mutex *mut); DescriptionWait 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 AlsoSDL_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); DescriptionRestart one of the threads that are waiting on the condition variable, cond. Returns 0 on success of -1 on an error. See AlsoSDL_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); DescriptionRestarts all threads that are waiting on the condition variable, cond. Returns 0 on success, or -1 on an error. See AlsoSDL_CondSignal, SDL_CondWait
SDL_Color – Format independent color description Structure Definitiontypedef struct{ Uint8 r; Uint8 g; Uint8 b; Uint8 unused; } SDL_Color;Structure Datar Red intensity g Green intensity b Blue intensity unused UnusedDescriptionSDL_Color describes a color in a format independent way. You can convert a SDL_Color to a pixel value for a certain pixel format using SDL_MapRGB. See…
SDL_CloseAudio – Shuts down audio processing and closes the audio device. Synopsis#include "SDL.h" void SDL_CloseAudio(void) DescriptionThis function shuts down audio processing and closes the audio device. See AlsoSDL_OpenAudio
SDL_CDtrack – CD Track Information Structure Structure Definitiontypedef struct{ Uint8 id; Uint8 type; Uint32 length; Uint32 offset; } SDL_CDtrack;Structure Dataid 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 trackDescriptionSDL_CDtrack stores data on each track on a CD, its fields should be…
SDL_CDStop – Stops a CDROM Synopsis#include "SDL.h" int SDL_CDStop(SDL_CD *cdrom); DescriptionStops play on the given cdrom. Return ValueReturns 0 on success, or -1 on an error. See AlsoSDL_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) DescriptionThis function returns the current status of the given drive. Status is described like so: typedef enum { CD_TRAYEMPTY, CD_STOPPED, CD_PLAYING,…
SDL_CDResume – Resumes a CDROM Synopsis#include "SDL.h" int SDL_CDResume(SDL_CD *cdrom); DescriptionResumes play on the given cdrom. Return ValueReturns 0 on success, or -1 on an error. See AlsoSDL_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)); DescriptionSDL_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 the beginning…
SDL_CDPlay – Play a CD Synopsis#include "SDL.h" int SDL_CDPlay(SDL_CD *cdrom, int start, int length); DescriptionPlays the given cdrom, starting a frame start for length frames. Return ValuesReturns 0 on success, or -1 on an error. See AlsoSDL_CDPlayTracks, SDL_CDStop
SDL_CDPause – Pauses a CDROM Synopsis#include "SDL.h" int SDL_CDPause(SDL_CD *cdrom); DescriptionPauses play on the given cdrom. Return ValueReturns 0 on success, or -1 on an error. See AlsoSDL_CDPlay, SDL_CDResume
SDL_CDOpen – Opens a CD-ROM drive for access. Synopsis#include "SDL.h" SDL_CD *SDL_CDOpen(int drive); DescriptionOpens 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 handle. Drives…
SDL_CDNumDrives – Returns the number of CD-ROM drives on the system. Synopsis#include "SDL.h" int SDL_CDNumDrives(void) DescriptionReturns the number of CD-ROM drives on the system. See AlsoSDL_CDOpen
SDL_CDName – Returns a human-readable, system-dependent identifier for the CD-ROM. Synopsis#include "SDL.h" const char *SDL_CDName(int drive); DescriptionReturns a human-readable, system-dependent identifier for the CD-ROM. drive is the index of the drive. Drive indices start to 0 and end at SDL_CDNumDrives()-1. Examples • "/dev/cdrom" • "E:" • "/dev/disk/ide/1/master"See AlsoSDL_CDNumDrives
SDL_CDEject – Ejects a CDROM Synopsis#include "SDL.h" int SDL_CDEject(SDL_CD *cdrom); DescriptionEjects the given cdrom. Return ValueReturns 0 on success, or -1 on an error. See AlsoSDL_CD
SDL_CDClose – Closes a SDL_CD handle Synopsis#include "SDL.h" void SDL_CDClose(SDL_CD *cdrom); DescriptionCloses the given cdrom handle. See AlsoSDL_CDOpen, SDL_CD
SDL_CD – CDROM Drive Information Structure Definitiontypedef struct{ int id; CDstatus status; int numtracks; int cur_track; int cur_frame; SDL_CDtrack track[SDL_MAX_TRACKS+1]; } SDL_CD;Structure Dataid Private drive identifier status Drive status numtracks Number of tracks on the CD cur_track Current track cur_frame Current frame offset within the track track[SDL_MAX_TRACKS+1] Array of track descriptions. (see SDL_CDtrack)DescriptionAn SDL_CD structure…