Section 3: library functions
SDL_InitSubSystem – Initialize subsystems Synopsis #include "SDL.h" int SDL_InitSubSystem(Uint32 flags); Description After SDL has been initialized with SDL_Init you may initialize uninitialized subsystems with SDL_InitSubSystem. The flags parameter is the same as that used in SDL_Init. Examples /* Seperating Joystick and Video initialization. */ SDL_Init(SDL_INIT_VIDEO); . . SDL_SetVideoMode(640, 480, 16, SDL_DOUBLEBUF|SDL_FULLSCREEN); . /* Do Some…
SDL_Init – Initializes SDL Synopsis #include "SDL.h" int SDL_Init(Uint32 flags); Description Initializes SDL. This should be called before all other SDL functions. The flags parameter specifies what part(s) of SDL to initialize. SDL_INIT_TIMER Initializes the timer subsystem. SDL_INIT_AUDIO Initializes the audio subsystem. SDL_INIT_VIDEO Initializes the video subsystem. SDL_INIT_CDROM Initializes the cdrom subsystem. SDL_INIT_JOYSTICK Initializes the…
SDL_GetVideoSurface – returns a pointer to the current display surface Synopsis #include "SDL.h" SDL_Surface *SDL_GetVideoSurface(void); Description This function returns a pointer to the current display surface. If SDL is doing format conversion on the display surface, this function returns the publicly visible surface, not the real video surface. See Also SDL_Surface
SDL_GetVideoInfo – returns a pointer to information about the video hardware Synopsis #include "SDL.h" SDL_VideoInfo *SDL_GetVideoInfo(void); Description This function returns a read-only pointer to information about the video hardware. If this is called before SDL_SetVideoMode, the vfmt member of the returned structure will contain the pixel format of the "best" video mode. See Also SDL_SetVideoMode,…
SDL_GetTicks – Get the number of milliseconds since the SDL library initialization. Synopsis #include "SDL.h" Uint32 SDL_GetTicks(void) Description Get the number of milliseconds since the SDL library initialization. Note that this value wraps if the program runs for more than ~49 days. See Also SDL_Delay
SDL_GetThreadID – Get the SDL thread ID of a SDL_Thread Synopsis #include "SDL.h" #include "SDL_thread.h" Uint32 SDL_GetThreadID(SDL_Thread *thread); Description Returns the ID of a SDL_Thread created by SDL_CreateThread. See Also SDL_CreateThread
SDL_GetRelativeMouseState – Retrieve the current state of the mouse Synopsis #include "SDL.h" Uint8 SDL_GetRelativeMouseState(int *x, int *y); Description The current button state is returned as a button bitmask, which can be tested using the SDL_BUTTON(X) macros, and x and y are set to the change in the mouse position since the last call to SDL_GetRelativeMouseState…
SDL_GetRGBA – Get RGBA values from a pixel in the specified pixel format. Synopsis #include "SDL.h" void SDL_GetRGBA(Uint32 pixel, SDL_PixelFormat *fmt, Uint8 *r, Uint8 *g, Uint8 *b, Uint8 *a); Description Get RGBA component values from a pixel stored in the specified pixel format. This function uses the entire 8-bit [0..255] range when converting color components…
SDL_GetRGB – Get RGB values from a pixel in the specified pixel format. Synopsis #include "SDL.h" void SDL_GetRGB(Uint32 pixel, SDL_PixelFormat *fmt, Uint8 *r, Uint8 *g, Uint8 *b); Description Get RGB component values from a pixel stored in the specified pixel format. This function uses the entire 8-bit [0..255] range when converting color components from pixel…
SDL_GetMouseState – Retrieve the current state of the mouse Synopsis #include "SDL.h" Uint8 SDL_GetMouseState(int *x, int *y); Description The current button state is returned as a button bitmask, which can be tested using the SDL_BUTTON(X) macros, and x and y are set to the current mouse cursor position. You can pass NULL for either x…
SDL_GetModState – Get the state of modifier keys. Synopsis #include "SDL.h" SDLMod SDL_GetModState(void); Description Returns the current state of the modifier keys (CTRL, ALT, etc.). Return Value The return value can be an OR’d combination of the SDLMod enum. SDLMod typedef enum { KMOD_NONE = 0x0000, KMOD_LSHIFT= 0x0001, KMOD_RSHIFT= 0x0002, KMOD_LCTRL = 0x0040, KMOD_RCTRL =…
SDL_GetKeyState – Get a snapshot of the current keyboard state Synopsis #include "SDL.h" Uint8 *SDL_GetKeyState(int *numkeys); Description Gets a snapshot of the current keyboard state. The current state is return as a pointer to an array, the size of this array is stored in numkeys. The array is indexed by the SDLK_* symbols. A value…
SDL_GetKeyName – Get the name of an SDL virtual keysym Synopsis #include "SDL.h" char *SDL_GetKeyName(SDLKey key); Description Returns the SDL-defined name of the SDLKey key. See Also SDLKey
SDL_GetGammaRamp – Gets the color gamma lookup tables for the display Synopsis #include "SDL.h" int SDL_GetGammaRamp(Uint16 *redtable, Uint16 *greentable, Uint16 *bluetable); Description Gets the gamma translation lookup tables currently used by the display. Each table is an array of 256 Uint16 values. Not all display hardware is able to change gamma. Return Value Returns -1…
SDL_GetGamma – Gets the gamma of the display Synopsis #include "SDL.h" int SDL_GetGamma(float *red, float *green, float *blue); Description Gets the color gamma of the display. The gamma value for each color component will be place in the parameters red, green and blue. The values can range from 0.1 to 10. Note: This function currently…
SDL_GetEventFilter – Retrieves a pointer to he event filter Synopsis #include "SDL.h" SDL_EventFilter SDL_GetEventFilter(void); Description This function retrieces a pointer to the event filter that was previously set using SDL_SetEventFilter. An SDL_EventFilter function is defined as: typedef int (*SDL_EventFilter)(const SDL_Event *event); Return Value Returns a pointer to the event filter or NULL if no filter…
SDL_GetError – Get SDL error string Synopsis #include "SDL/SDL.h" char *SDL_GetError(void); Description SDL_GetError returns a NULL terminated string containing information about the last internal SDL error. Return Value SDL_GetError returns a string containing the last error.
SDL_GetAudioStatus – Get the current audio state Synopsis #include "SDL.h" SDL_audiostatusSDL_GetAudioStatus(void); Description typedef enum{ SDL_AUDIO_STOPPED, SDL_AUDIO_PAUSED, SDL_AUDIO_PLAYING } SDL_audiostatus; Returns either SDL_AUDIO_STOPPED, SDL_AUDIO_PAUSED or SDL_AUDIO_PLAYING depending on the current audio state. See Also SDL_PauseAudio
SDL_GetAudioStatus – Get the current audio state Synopsis #include "SDL.h" SDL_audiostatusSDL_GetAudioStatus(void); Description typedef enum{ SDL_AUDIO_STOPPED, SDL_AUDIO_PAUSED, SDL_AUDIO_PLAYING } SDL_audiostatus; Returns either SDL_AUDIO_STOPPED, SDL_AUDIO_PAUSED or SDL_AUDIO_PLAYING depending on the current audio state. See Also SDL_PauseAudio
SDL_GetAppState – Get the state of the application Synopsis #include "SDL.h" Uint8 SDL_GetAppState(void); Description This function returns the current state of the application. The value returned is a bitwise combination of: SDL_APPMOUSEFOCUS The application has mouse focus. SDL_APPINPUTFOCUS The application has keyboard focus SDL_APPACTIVE The application is visible See Also SDL_ActiveEvent