SFML 2.5.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Classes | Public Types | Static Public Member Functions | List of all members
sf::Joystick Class Reference
Window module

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

`#include <Joystick.hpp>`

## Classes
struct | Identification
| Structure holding a joystick's identification. More...

## Public Types
enum | { Count = 8 , ButtonCount = 32 , AxisCount = 8 }
| Constants related to joysticks capabilities. More...
enum | Axis { X , Y , Z , R , U , V , PovX , PovY }
| Axes supported by SFML joysticks. More...

## Static Public Member Functions
static bool | isConnected (unsigned int joystick)
| Check if a joystick is connected. More...
static unsigned int | getButtonCount (unsigned int joystick)
| Return the number of buttons supported by a joystick. More...
static bool | hasAxis (unsigned int joystick, Axis axis)
| Check if a joystick supports a given axis. More...
static bool | isButtonPressed (unsigned int joystick, unsigned int button)
| Check if a joystick button is pressed. More...
static float | getAxisPosition (unsigned int joystick, Axis axis)
| Get the current position of a joystick axis. More...
static Identification | getIdentification (unsigned int joystick)
| Get the joystick information. More...
static void | update ()
| Update the states of all joysticks. More...

## Detailed 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?
unsigned int buttons = sf::Joystick::getButtonCount(0);
// Does joystick #0 define a X axis?
bool hasX = sf::Joystick::hasAxis(0, sf::Joystick::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::Joystick::Y);
sf::Joystick::hasAxis
static bool hasAxis(unsigned int joystick, Axis axis)
Check if a joystick supports a given axis.
sf::Joystick::Y
@ Y
The Y axis.
Definition: Joystick.hpp:63
sf::Joystick::X
@ X
The X axis.
Definition: Joystick.hpp:62
sf::Joystick::getButtonCount
static unsigned int getButtonCount(unsigned int joystick)
Return the number of buttons supported by a joystick.
sf::Joystick::isConnected
static bool isConnected(unsigned int joystick)
Check if a joystick is connected.
sf::Joystick::isButtonPressed
static bool isButtonPressed(unsigned int joystick, unsigned int button)
Check if a joystick button is pressed.
sf::Joystick::getAxisPosition
static float getAxisPosition(unsigned int joystick, Axis axis)
Get the current position of a joystick axis.

See also
  sf::Keyboard, sf::Mouse

Definition at line 41 of file Joystick.hpp.

## Member Enumeration Documentation

## ◆ anonymous enum

anonymous enum

Constants related to joysticks capabilities.

Enumerator
Count | Maximum number of supported joysticks.
ButtonCount | Maximum number of supported buttons.
AxisCount | Maximum number of supported axes.

Definition at line 49 of file Joystick.hpp.

## ◆ Axis

enum sf::Joystick::Axis

Axes supported by SFML joysticks.

Enumerator
X | The X axis.
Y | The Y axis.
Z | The Z axis.
R | The R axis.
U | The U axis.
V | The V axis.
PovX | The X axis of the point-of-view hat.
PovY | The Y axis of the point-of-view hat.

Definition at line 60 of file Joystick.hpp.

## Member Function Documentation

## ◆ getAxisPosition()

static float sf::Joystick::getAxisPosition | ( | unsigned int | joystick,
|  | Axis | axis
| ) |  |
| static

Get the current position of a joystick axis.

If the joystick is not connected, this function returns 0.

Parameters

  joystick | Index of the joystick
  axis | Axis to check

Returns
  Current position of the axis, in range [-100 .. 100]

## ◆ getButtonCount()

static unsigned int sf::Joystick::getButtonCount | ( | unsigned int | joystick | ) |
| static

Return the number of buttons supported by a joystick.

If the joystick is not connected, this function returns 0.

Parameters

  joystick | Index of the joystick

Returns
  Number of buttons supported by the joystick

## ◆ getIdentification()

static Identification sf::Joystick::getIdentification | ( | unsigned int | joystick | ) |
| static

Get the joystick information.

Parameters

  joystick | Index of the joystick

Returns
  Structure containing joystick information.

## ◆ hasAxis()

static bool sf::Joystick::hasAxis | ( | unsigned int | joystick,
|  | Axis | axis
| ) |  |
| static

Check if a joystick supports a given axis.

If the joystick is not connected, this function returns false.

Parameters

  joystick | Index of the joystick
  axis | Axis to check

Returns
  True if the joystick supports the axis, false otherwise

## ◆ isButtonPressed()

static bool sf::Joystick::isButtonPressed | ( | unsigned int | joystick,
|  | unsigned int | button
| ) |  |
| static

Check if a joystick button is pressed.

If the joystick is not connected, this function returns false.

Parameters

  joystick | Index of the joystick
  button | Button to check

Returns
  True if the button is pressed, false otherwise

## ◆ isConnected()

static bool sf::Joystick::isConnected | ( | unsigned int | joystick | ) |
| static

Check if a joystick is connected.

Parameters

  joystick | Index of the joystick to check

Returns
  True if the joystick is connected, false otherwise

## ◆ update()

static void sf::Joystick::update | ( |  | ) |
| static

Update the states of all joysticks.

This function is used internally by SFML, so you normally don't have to call it explicitly. However, you may need to call it if you have no window yet (or no window at all): in this case the joystick states are not updated automatically.

The documentation for this class was generated from the following file:

- Joystick.hpp