SDL_JoystickEventState – Enable/disable joystick event polling Synopsis #include "SDL.h" int SDL_JoystickEventState(int state); Description This function is used to enable or disable joystick event processing. With joystick event processing disabled you will have to update joystick states with SDL_JoystickUpdate and read the joystick information manually. state is either SDL_QUERY, SDL_ENABLE or SDL_IGNORE. Note: Joystick event handling…
SDL_JoystickClose – Closes a previously opened joystick Synopsis #include "SDL.h" void SDL_JoystickClose(SDL_Joystick *joystick); Description Close a joystick that was previously opened with SDL_JoystickOpen. See Also SDL_JoystickOpen, SDL_JoystickOpened
SDL_JoyHatEvent – Joystick hat position change event structure Structure Definition typedef struct{ Uint8 type; Uint8 which; Uint8 hat; Uint8 value; } SDL_JoyHatEvent; Structure Data type SDL_JOY which Joystick device index hat Joystick hat index value Hat position Description SDL_JoyHatEvent is a member of the SDL_Event union and is used when an event of type SDL_JOYHATMOTION…
SDL_JoyButtonEvent – Joystick button event structure Structure Definition typedef struct{ Uint8 type; Uint8 which; Uint8 button; Uint8 state; } SDL_JoyButtonEvent; Structure Data type SDL_JOYBUTTONDOWN or SDL_JOYBUTTONUP which Joystick device index button Joystick button index state SDL_PRESSED or SDL_RELEASED Description SDL_JoyButtonEvent is a member of the SDL_Event union and is used when an event of type…
SDL_JoyBallEvent – Joystick trackball motion event structure Structure Definition typedef struct{ Uint8 type; Uint8 which; Uint8 ball; Sint16 xrel, yrel; } SDL_JoyBallEvent; Structure Data type SDL_JOYBALLMOTION which Joystick device index ball Joystick trackball index xrel, yrel The relative motion in the X/Y direction Description SDL_JoyBallEvent is a member of the SDL_Event union and is used…
SDL_JoyAxisEvent – Joystick axis motion event structure Structure Definition typedef struct{ Uint8 type; Uint8 which; Uint8 axis; Sint16 value; } SDL_JoyAxisEvent; Structure Data type SDL_JOYAXISMOTION which Joystick device index axis Joystick axis index value Axis value (range: -32768 to 32767) Description SDL_JoyAxisEvent is a member of the SDL_Event union and is used when an event…
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…