Tao.Sdl SDK Documentation

Sdl.SDL_JoystickGetAxis Method 

Get the current state of an axis.

[Visual Basic]
Public Shared Function SDL_JoystickGetAxis( _
   ByVal joystick As IntPtr, _
   ByVal axis As Integer _
) As Short
[C#]
public static short SDL_JoystickGetAxis(
   IntPtr joystick,
   int axis
);

Parameters

joystick
axis

Return Value

Returns a short representing the current position of the axis.

Remarks

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_JoystickGetAxis is a signed integer (-32768 to 32768) representing the current position of the axis, it maybe necessary to impose certain tolerances on these values to account for jitter. It is worth noting that some joysticks use axes 2 and 3 for extra buttons.

Binds to C-function in SDL_joystick.h

Sint16 SDL_JoystickGetAxis(SDL_Joystick *joystick, int axis);
            

Example

            Sint16 x_move, y_move;
                    SDL_Joystick *joy1;
                    .
                    .
                    x_move=SDL_JoystickGetAxis(joy1, 0);
                    y_move=SDL_JoystickGetAxis(joy1, 1);
            

See Also

Sdl Class | Tao.Sdl Namespace | SDL_JoystickNumAxes