sf.Joystick


Description:

Give access to the real-time state of the joysticks.

sf.Joystick provides an interface to the state of the joysticks.

It only contains static functions, so it's not meant to be instantiated. Instead, each joystick is identified by an index that is passed to the functions of this class.

This class allows users to query the state of joysticks at any time and directly, without having to deal with a window and its events. Compared to the JoystickMoved, JoystickButtonPressed and JoystickButtonReleased events, sf.Joystick can retrieve the state of axes and buttons of joysticks at any time (you don't need to store and update a boolean on your side in order to know if a button is pressed or released), and you always get the real state of joysticks, even if they are moved, pressed or released when your window is out of focus and no event is triggered.

SFML supports:

8 joysticks (sf.Joystick.Count) 32 buttons per joystick (sf.Joystick.ButtonCount) 8 axes per joystick (sf.Joystick.AxisCount) Unlike the keyboard or mouse, the state of joysticks is sometimes not directly available (depending on the OS), therefore an update() function must be called in order to update the current state of joysticks. When you have a window with event handling, this is done automatically, you don't need to call anything. But if you have no window, or if you want to check joysticks state before creating one, you must call sf.Joystick.update explicitly.

Usage example:

// Is joystick #0 connected?
bool connected = sf.Joystick.isConnected(0);

// How many buttons does joystick #0 support?
uint buttons = sf.Joystick.getButtonCount(0);

// Does joystick #0 define a X axis?
bool hasX = sf.Joystick.hasAxis(0, sf.JoystickAxis.X);

// Is button #2 pressed on joystick #0?
bool pressed = sf.Joystick.isButtonPressed(0, 2);

// What's the current position of the Y axis on joystick #0?
float position = sf.Joystick.getAxisPosition(0, sf.JoystickAxis.Y);

See also:

sf.Keyboard, sf.Mouse

Content:

Functions: