SDL Library Documentation
Prev |  | Next

# SDL_JoyAxisEvent

## Name

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 of type `SDL_JOYAXISMOTION` is reported.

A `SDL_JOYAXISMOTION` event occurs when ever a user moves an axis on the joystick. The field `which` is the index of the joystick that reported the event and `axis` is the index of the axis (for a more detailed explaination see the Joystick section). `value` is the current position of the axis.

## See Also

SDL_Event, Joystick Functions, `SDL_JoystickEventState`, `SDL_JoystickGetAxis`

Prev | Home | Next
SDL_MouseButtonEvent | Up | SDL_JoyButtonEvent