Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

SDL_JoyButtonEvent (3)

Name

SDL_JoyButtonEvent - Joystick button event structure

Synopsis

Please see following description for synopsis

Description

SDL_JoyButtonEvent(3)          SDL API Reference         SDL_JoyButtonEvent(3)



NAME
       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_JOYBUTTONDOWN or SDL_JOYBUTTONUP is reported.

       A SDL_JOYBUTTONDOWN or SDL_JOYBUTTONUP event occurs when  ever  a  user
       presses  or  releases  a  button  on a joystick. The field which is the
       index of the joystick that reported the event and button is  the  index
       of  the  button (for a more detailed explaination see the Joystick sec-
       tion). state is the  current  state  or  the  button  which  is  either
       SDL_PRESSED or SDL_RELEASED.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/sdl      |
       +---------------+------------------+
       |Stability      | Volatile         |
       +---------------+------------------+
SEE ALSO
       SDL_Event, Joystick Functions, SDL_JoystickEventState, SDL_JoystickGet-
       Button



NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source       was        downloaded        from         https://www.lib-
       sdl.org/release/SDL-1.2.15.tar.gz

       Further information about this software can be found on the open source
       community website at https://www.libsdl.org/.



SDL                         Tue 11 Sep 2001, 22:59       SDL_JoyButtonEvent(3)