Nirtcpp 2.0.0
Nirtcpp is a high-performance c++ graphics engine.
nirt::SJoystickInfo Struct Reference

Information on a joystick, returned from nirt::NirtcppDevice::activateJoysticks() More...

#include <nirtcpp/IEventReceiver.hpp>

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

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

Detailed Description

Information on a joystick, returned from nirt::NirtcppDevice::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

u32 nirt::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

u8 nirt::SJoystickInfo::Joystick

The ID of the joystick.

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

◆ 

enum { ... } nirt::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 struct was generated from the following file: