SysTutorials Posts

SDL_Event – General event structure Structure Definition typedef union{ Uint8 type; SDL_ActiveEvent active; SDL_KeyboardEvent key; SDL_MouseMotionEvent motion; SDL_MouseButtonEvent button; SDL_JoyAxisEvent jaxis; SDL_JoyBallEvent jball; SDL_JoyHatEvent jhat; SDL_JoyButtonEvent jbutton; SDL_ResizeEvent resize; SDL_ExposeEvent expose; SDL_QuitEvent quit; SDL_UserEvent user; SDL_SysWMEvent syswm; } SDL_Event; Structure Data type The type of event active Activation event key Keyboard event motion Mouse motion…

SDL_EnableUNICODE – Enable UNICODE translation Synopsis #include "SDL.h" int SDL_EnableUNICODE(int enable); Description Enables/Disables Unicode keyboard translation. To obtain the character codes corresponding to received keyboard events, Unicode translation must first be turned on using this function. The translation incurs a slight overhead for each keyboard event and is therefore disabled by default. For each subsequently…

SDL_CreateThread – Creates a new thread of execution that shares its parent’s properties. Synopsis #include "SDL.h" #include "SDL_thread.h" SDL_Thread *SDL_CreateThread(int (*fn)(void *), void *data); Description SDL_CreateThread creates a new thread of execution that shares all of its parent’s global memory, signal handlers, file descriptors, etc, and runs the function fn passed the void pointer data…

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…

SDL_CreateRGBSurfaceFrom – Create an SDL_Surface from pixel data Synopsis #include "SDL.h" SDL_Surface *SDL_CreateRGBSurfaceFrom(void *pixels, int width, int height, int depth, int pitch, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask); Description Creates an SDL_Surface from the provided pixel data. The data stored in pixels is assumed to be of the depth specified in the parameter…

SDL_CreateRGBSurface – Create an empty SDL_Surface Synopsis #include "SDL.h" SDL_Surface *SDL_CreateRGBSurface(Uint32 flags, int width, int height, int depth, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask); Description Allocate an empty surface (must be called after SDL_SetVideoMode) If depth is 8 bits an empty palette is allocated for the surface, otherwise a ‘packed-pixel’ SDL_PixelFormat is created…

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,…