The Linux Manuals (man pages) document is an important part of Linux documents. Linux Manuals are organized as several sections. Each section has a group of commands for a specific area in Linux usage, administration or development.
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); DescriptionCreates an SDL_Surface from the provided pixel data. The data stored in pixels is assumed to be of the depth specified in the parameter list. The…
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); DescriptionAllocate 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 using the…
SDL_CreateMutex – Create a mutex Synopsis#include "SDL.h" #include "SDL_thread.h" SDL_mutex *SDL_CreateMutex(void); DescriptionCreate a new, unlocked mutex. ExamplesSDL_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 AlsoSDL_mutexP, SDL_mutexV, SDL_DestroyMutex
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); DescriptionCreate 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 to the…
SDL_CreateCond – Create a condition variable Synopsis#include "SDL.h" #include "SDL_thread.h" SDL_cond *SDL_CreateCond(void); DescriptionCreates a condition variable. ExamplesSDL_cond *cond; cond=SDL_CreateCond(); . . /* Do stuff */ . . SDL_DestroyCond(cond);See AlsoSDL_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); DescriptionCreates 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 and has…
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