Jimcpp 2.1.0
Jimcpp is a high-performance c++ graphics engine.
Loading...
Searching...
No Matches
jpp::SJoystickInfo Class Reference

Information on a joystick, returned from jpp::JimcppDevice::activateJoysticks() More...

#include <jimcpp/core/engine/IEventReceiver.hpp>

Collaboration diagram for jpp::SJoystickInfo:
Collaboration graph

Public Types

enum  { POV_HAT_PRESENT , POV_HAT_ABSENT , POV_HAT_UNKNOWN }
 An indication of whether the joystick has a POV hat. More...
 

Public Attributes

jpp::u8 Joystick
 The ID of the joystick.
 
jpp::core::string Name
 The name that the joystick uses to identify itself.
 
jpp::u32 Buttons
 The number of buttons that the joystick has.
 
jpp::u32 Axes
 The number of axes that the joystick has, i.e. X, Y, Z, R, U, V.
 
enum jpp::SJoystickInfo:: { ... }  PovHat
 An indication of whether the joystick has a POV hat.
 

Detailed Description

Information on a joystick, returned from jpp::JimcppDevice::activateJoysticks()

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

An indication of whether the joystick has a POV hat.

A Windows device will identify the presence or absence of the POV hat. A Linux device cannot, and will always return POV_HAT_UNKNOWN.

Enumerator
POV_HAT_PRESENT 

A hat is definitely present.

POV_HAT_ABSENT 

A hat is definitely not present.

POV_HAT_UNKNOWN 

The presence or absence of a hat cannot be determined.

Member Data Documentation

◆ Axes

jpp::u32 jpp::SJoystickInfo::Axes

The number of axes that the joystick has, i.e. X, Y, Z, R, U, V.

Note: with a Linux device, the POV hat (if any) will use two axes. These will be included in this count.

◆ Joystick

jpp::u8 jpp::SJoystickInfo::Joystick

The ID of the joystick.

This is an internal Jimcpp index; it does not map directly to any particular hardware joystick. It corresponds to the jpp::SJoystickEvent Joystick ID.

◆ []

enum { ... } jpp::SJoystickInfo::PovHat

An indication of whether the joystick has a POV hat.

A Windows device will identify the presence or absence of the POV hat. A Linux device cannot, and will always return POV_HAT_UNKNOWN.


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

Jimcpp    @cppfx.xyz