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_Quit – Shut down SDL Synopsis#include "SDL.h" void SDL_Quit(void); DescriptionSDL_Quit shuts down all SDL subsystems and frees the resources allocated to them. This should always be called before you exit. For the sake of simplicity you can set SDL_Quit as your atexit call, like: SDL_Init(SDL_INIT_VIDEO|SDL_INIT_AUDIO); atexit(SDL_Quit); . .Note: While using atexit maybe be fine for…
SDL_PushEvent – Pushes an event onto the event queue Synopsis#include "SDL.h" int SDL_PushEvent(SDL_Event *event); DescriptionThe event queue can actually be used as a two way communication channel. Not only can events be read from the queue, but the user can also push their own events onto it. event is a pointer to the event structure…
SDL_PumpEvents – Pumps the event loop, gathering events from the input devices. Synopsis#include "SDL.h" void SDL_PumpEvents(void); DescriptionPumps the event loop, gathering events from the input devices. SDL_PumpEvents gathers all the pending input information from devices and places it on the event queue. Without calls to SDL_PumpEvents no events would ever be placed on the queue….
SDL_PollEvent – Polls for currently pending events. Synopsis#include "SDL.h" int SDL_PollEvent(SDL_Event *event); DescriptionPolls for currently pending events, and returns 1 if there are any pending events, or 0 if there are none available. If event is not NULL, the next event is removed from the queue and stored in that area. ExamplesSDL_Event event; /* Event…
SDL_PixelFormat – Stores surface format information Structure Definitiontypedef struct SDL_PixelFormat { SDL_Palette *palette; Uint8 BitsPerPixel; Uint8 BytesPerPixel; Uint8 Rloss, Gloss, Bloss, Aloss; Uint8 Rshift, Gshift, Bshift, Ashift; Uint32 Rmask, Gmask, Bmask, Amask; Uint32 colorkey; Uint8 alpha; } SDL_PixelFormat;Structure Datapalette Pointer to the palette, or NULL if the BitsPerPixel>8 BitsPerPixel The number of bits used to…
SDL_PeepEvents – Checks the event queue for messages and optionally returns them. Synopsis#include "SDL.h" int SDL_PeepEvents(SDL_Event *events, int numevents, SDL_eventaction action, Uint32 mask); DescriptionChecks the event queue for messages and optionally returns them. If action is SDL_ADDEVENT, up to numevents events will be added to the back of the event queue. If action is SDL_PEEKEVENT,…
SDL_PauseAudio – Pauses and unpauses the audio callback processing Synopsis#include "SDL.h" void SDL_PauseAudio(int pause_on); DescriptionThis function pauses and unpauses the audio callback processing. It should be called with pause_on=0 after opening the audio device to start playing sound. This is so you can safely initialize data for your callback function after opening the audio device….
SDL_Palette – Color palette for 8-bit pixel formats Structure Definitiontypedef struct{ int ncolors; SDL_Color *colors; } SDL_Palette;Structure Datancolors Number of colors used in this palette colors Pointer to SDL_Color structures that make up the palette.DescriptionEach pixel in an 8-bit surface is an index into the colors field of the SDL_Palette structure store in SDL_PixelFormat. A…
SDL_Overlay – YUV video overlay Structure Definitiontypedef struct{ Uint32 format; int w, h; int planes; Uint16 *pitches; Uint8 **pixels; Uint32 hw_overlay:1; } SDL_Overlay;Structure Dataformat Overlay format (see below) w, h Width and height of overlay planes Number of planes in the overlay. Usually either 1 or 3 pitches An array of pitches, one for each…
SDL_OpenAudio – Opens the audio device with the desired parameters. Synopsis#include "SDL.h" int SDL_OpenAudio(SDL_AudioSpec *desired, SDL_AudioSpec *obtained); DescriptionThis function opens the audio device with the desired parameters, and returns 0 if successful, placing the actual hardware parameters in the structure pointed to by obtained. If obtained is NULL, the audio data passed to the callback…
SDL_NumJoysticks – Count available joysticks. Synopsis#include "SDL.h" int SDL_NumJoysticks(void); DescriptionCounts the number of joysticks attached to the system. Return ValueReturns the number of attached joysticks See AlsoSDL_JoystickName, SDL_JoystickOpen
SDL_MouseMotionEvent – Mouse motion event structure Structure Definitiontypedef struct{ Uint8 type; Uint8 state; Uint16 x, y; Sint16 xrel, yrel; } SDL_MouseMotionEvent;Structure Datatype SDL_MOUSEMOTION state The current button state x, y The X/Y coordinates of the mouse xrel, yrel Relative motion in the X/Y directionDescriptionSDL_MouseMotionEvent is a member of the SDL_Event union and is used when…
SDL_MouseButtonEvent – Mouse button event structure Structure Definitiontypedef struct{ Uint8 type; Uint8 button; Uint8 state; Uint16 x, y; } SDL_MouseButtonEvent;Structure Datatype SDL_MOUSEBUTTONDOWN or SDL_MOUSEBUTTONUP button The mouse button index (SDL_BUTTON_LEFT, SDL_BUTTON_MIDDLE, SDL_BUTTON_RIGHT) state SDL_PRESSED or SDL_RELEASED x, y The X/Y coordinates of the mouse at press/release timeDescriptionSDL_MouseButtonEvent is a member of the SDL_Event union and…
SDL_MixAudio – Mix audio data Synopsis#include "SDL.h" void SDL_MixAudio(Uint8 *dst, Uint8 *src, Uint32 len, int volume); DescriptionThis function takes two audio buffers of len bytes each of the playing audio format and mixes them, performing addition, volume adjustment, and overflow clipping. The volume ranges from 0 to SDL_MIX_MAXVOLUME and should be set to the maximum…
SDL_MapRGBA – Map a RGBA color value to a pixel format. Synopsis#include "SDL.h" Uint32 SDL_MapRGBA(SDL_PixelFormat *fmt, Uint8 r, Uint8 g, Uint8 b, Uint8 a); DescriptionMaps the RGBA color value to the specified pixel format and returns the pixel value as a 32-bit int. If the format has a palette (8-bit) the index of the closest…
SDL_MapRGB – Map a RGB color value to a pixel format. Synopsis#include "SDL.h" Uint32 SDL_MapRGB(SDL_PixelFormat *fmt, Uint8 r, Uint8 g, Uint8 b); DescriptionMaps the RGB color value to the specified pixel format and returns the pixel value as a 32-bit int. If the format has a palette (8-bit) the index of the closest matching color…
SDL_LockYUVOverlay – Lock an overlay Synopsis#include "SDL.h" int SDL_LockYUVOverlay(SDL_Overlay *overlay); DescriptionMuch the same as SDL_LockSurface, SDL_LockYUVOverlay locks the overlay for direct access to pixel data. Return ValueReturns 0 on success, or -1 on an error. See AlsoSDL_UnlockYUVOverlay, SDL_CreateYUVOverlay, SDL_Overlay
SDL_LockSurface – Lock a surface for directly access. Synopsis#include "SDL.h" int SDL_LockSurface(SDL_Surface *surface); DescriptionSDL_LockSurface sets up a surface for directly accessing the pixels. Between calls to SDL_LockSurface and SDL_UnlockSurface, you can write to and read from surface->pixels, using the pixel format stored in surface->format. Once you are done accessing the surface, you should use SDL_UnlockSurface…
SDL_LockAudio – Lock out the callback function Synopsis#include "SDL.h" void SDL_LockAudio(void) DescriptionThe lock manipulated by these functions protects the callback function. During a LockAudio period, you can be guaranteed that the callback function is not running. Do not call these from the callback function or you will cause deadlock. See AlsoSDL_OpenAudio
SDL_LoadWAV – Load a WAVE file Synopsis#include "SDL.h" SDL_AudioSpec *SDL_LoadWAV(const char *file, SDL_AudioSpec *spec, Uint8 **audio_buf, Uint32 *audio_len); DescriptionSDL_LoadWAV This function loads a WAVE file into memory. If this function succeeds, it returns the given SDL_AudioSpec, filled with the audio data format of the wave data, and sets audio_buf to a malloc‘d buffer containing the…