Section 3: library functions
SDL_KeyboardEvent – Keyboard event structure Structure Definition typedef struct{ Uint8 type; Uint8 state; SDL_keysym keysym; } SDL_KeyboardEvent; Structure Data type SDL_KEYDOWN or SDL_KEYUP state SDL_PRESSED or SDL_RELEASED keysym Contains key press information Description SDL_KeyboardEvent is a member of the SDL_Event union and is used when an event of type SDL_KEYDOWN or SDL_KEYUP is reported. The…
SDL_JoystickUpdate – Updates the state of all joysticks Synopsis #include "SDL.h" void SDL_JoystickUpdate(void); Description Updates the state(position, buttons, etc.) of all open joysticks. If joystick events have been enabled with SDL_JoystickEventState then this is called automatically in the event loop. See Also SDL_JoystickEventState
SDL_JoystickOpened – Determine if a joystick has been opened Synopsis #include "SDL.h" int SDL_JoystickOpened(int index); Description Determines whether a joystick has already been opened within the application. index refers to the N’th joystick on the system. Return Value Returns 1 if the joystick has been opened, or 0 if it has not. See Also SDL_JoystickOpen,…
SDL_JoystickOpen – Opens a joystick for use. Synopsis #include "SDL.h" SDL_Joystick *SDL_JoystickOpen(int index); Description Opens a joystick for use within SDL. The index refers to the N’th joystick in the system. A joystick must be opened before it game be used. Return Value Returns a SDL_Joystick structure on success. NULL on failure. Examples SDL_Joystick *joy;…
SDL_JoystickNumHats – Get the number of joystick hats Synopsis #include "SDL.h" int SDL_JoystickNumHats(SDL_Joystick *joystick); Description Return the number of hats available from a previously opened SDL_Joystick. Return Value Number of hats. See Also SDL_JoystickGetHat, SDL_JoystickOpen
SDL_JoystickNumButtons – Get the number of joysitck buttons Synopsis #include "SDL.h" int SDL_JoystickNumButtons(SDL_Joystick *joystick); Description Return the number of buttons available from a previously opened SDL_Joystick. Return Value Number of buttons. See Also SDL_JoystickGetButton, SDL_JoystickOpen
SDL_JoystickNumBalls – Get the number of joystick trackballs Synopsis #include "SDL.h" int SDL_JoystickNumBalls(SDL_Joystick *joystick); Description Return the number of trackballs available from a previously opened SDL_Joystick. Return Value Number of trackballs. See Also SDL_JoystickGetBall, SDL_JoystickOpen
SDL_JoystickNumAxes – Get the number of joystick axes Synopsis #include "SDL.h" int SDL_JoystickNumAxes(SDL_Joystick *joystick); Description Return the number of axes available from a previously opened SDL_Joystick. Return Value Number of axes. See Also SDL_JoystickGetAxis, SDL_JoystickOpen
SDL_JoystickName – Get joystick name. Synopsis #include "SDL.h" const char *SDL_JoystickName(int index); Description Get the implementation dependent name of joystick. The index parameter refers to the N’th joystick on the system. Return Value Returns a char pointer to the joystick name. Examples /* Print the names of all attached joysticks */ int num_joy, i; num_joy=SDL_NumJoysticks();…
SDL_JoystickIndex – Get the index of an SDL_Joystick. Synopsis #include "SDL.h" int SDL_JoystickIndex(SDL_Joystick *joystick); Description Returns the index of a given SDL_Joystick structure. Return Value Index number of the joystick. See Also SDL_JoystickOpen
SDL_JoystickGetHat – Get the current state of a joystick hat Synopsis #include "SDL.h" Uint8 SDL_JoystickGetHat(SDL_Joystick *joystick, int hat); Description SDL_JoystickGetHat returns the current state of the given hat on the given joystick. Return Value The current state is returned as a Uint8 which is defined as an OR’d combination of one or more of the…
SDL_JoystickGetButton – Get the current state of a given button on a given joystick Synopsis #include "SDL.h" Uint8 SDL_JoystickGetButton(SDL_Joystick *joystick, int button); Description SDL_JoystickGetButton returns the current state of the given button on the given joystick. Return Value 1 if the button is pressed. Otherwise, 0. See Also SDL_JoystickNumButtons
SDL_JoystickGetBall – Get relative trackball motion Synopsis #include "SDL.h" int SDL_JoystickGetBall(SDL_Joystick *joystick, int ball, int *dx, int *dy); Description Get the ball axis change. Trackballs can only return relative motion since the last call to SDL_JoystickGetBall, these motion deltas a placed into dx and dy. Return Value Returns 0 on success or -1 on failure…
SDL_JoystickGetAxis – Get the current state of an axis Synopsis #include "SDL.h" Sint16 SDL_JoystickGetAxis(SDL_Joystick *joystick, int axis); Description SDL_JoystickGetAxis returns the current state of the given axis on the given joystick. On most modern joysticks the X axis is usually represented by axis 0 and the Y axis by axis 1. The value returned by…
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…