XInputDevice (JXInput 1.0.0 API)

java.lang.Object
- com.github.strikerx3.jxinput.XInputDevice

Direct Known Subclasses:

XInputDevice14
```
public class XInputDevice
extends Object
```
Represents all XInput devices registered in the system. Use the getAllDevices() or getDeviceFor(int) methods to start using the devices.
Certain methods in this class are not thread-safe and are documented as such. It is not recommended to share an instance of XInputDevice across multiple threads.

Author:

Ivan "StrikerX3" Oliveira

See Also:

XInputComponents, XInputComponentsDelta

Field Summary

Fields
Modifier and Type Field and Description

protected int playerNum

Fields
Modifier and Type	Field and Description
`protected int`	`playerNum`

Constructor Summary

Constructors
Modifier Constructor and Description

protected XInputDevice(int playerNum)

Constructors
Modifier	Constructor and Description
`protected`	`XInputDevice(int playerNum)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addListener(XInputDeviceListener listener)` Adds an event listener that will react to changes in the input.
`protected boolean`	`checkReturnCode(int ret)`
`protected boolean`	`checkReturnCode(int ret, int... validRetCodes)`
`static XInputDevice[]`	`getAllDevices()` Returns an array containing all registered XInput devices.
`XInputComponents`	`getComponents()` Returns the state of the XInput controller components at the last poll.
`XInputComponentsDelta`	`getDelta()` Returns the difference between the last two states of the XInput controller components.
`static XInputDevice`	`getDeviceFor(int playerNum)` Returns the XInput device for the specified player.
`XInputComponents`	`getLastComponents()` Returns the state of the XInput controller components before the last poll.
`static XInputLibraryVersion`	`getLibraryVersion()` Retrieves the loaded XInput library version.
`int`	`getPlayerNum()` Returns the player number that this device represents.
`static boolean`	`isAvailable()` Determines if the XInput devices are available on this platform.
`boolean`	`isConnected()` Returns a boolean indicating whether this device is connected.
`static boolean`	`isGuideButtonSupported()` Determines if polling the Guide button is supported.
`protected static ByteBuffer`	`newBuffer(int capacity)` Creates a new direct ByteBuffer to be used for communicating with the native library.
`boolean`	`poll()` Reads input from the device and updates components.
`void`	`removeListener(XInputDeviceListener listener)` Removes a registered event listener
`static void`	`setPreProcessData(boolean preprocess)` Defines whether to perform additional precalculations to the data.
`boolean`	`setVibration(int leftMotor, int rightMotor)` Sets the vibration of the controller.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - playerNum
```
protected final int playerNum
```
- Constructor Detail
  - XInputDevice
```
protected XInputDevice(int playerNum)
```
- Method Detail
  - isAvailable
```
public static boolean isAvailable()
```
    Determines if the XInput devices are available on this platform.
    
    Returns:
    
    true if the XInput devices are available, false if not
  - getLibraryVersion
```
public static XInputLibraryVersion getLibraryVersion()
```
    Retrieves the loaded XInput library version.
    
    Returns:
    
    one of the values of XInputLibraryVersion
  - isGuideButtonSupported
```
public static boolean isGuideButtonSupported()
```
    Determines if polling the Guide button is supported.
    
    Returns:
    
    true if the Guide button state can be read, false otherwise.
  - getAllDevices
```
public static XInputDevice[] getAllDevices()
                                    throws XInputNotLoadedException
```
    Returns an array containing all registered XInput devices.
    The XInputDevice objects are not thread-safe.
    
    Returns:
    
    all XInput devices
    
    Throws:
    
    XInputNotLoadedException - if the native library failed to load
  - getDeviceFor
```
public static XInputDevice getDeviceFor(int playerNum)
                                 throws XInputNotLoadedException
```
    Returns the XInput device for the specified player. An instance is created for each of the four players in a system.
    The returned object should not be shared among multiple threads.
    
    Parameters:
    
    playerNum - the player number
    
    Returns:
    
    the XInput device for the specified player
    
    Throws:
    
    XInputNotLoadedException - if the native library failed to load
  - setPreProcessData
```
public static void setPreProcessData(boolean preprocess)
```
    Defines whether to perform additional precalculations to the data. If enabled, in addition to filling in the raw values, the fields lx, ly, rx, ry, lt and rt in XInputAxes will be filled with non-zero float values ranging from -1 to 1 for the thumbsticks or 0 to 1 for the triggers, based on the raw values. If disabled, only the raw values will be filled. By default, the float values are calculated.
    
    Parameters:
    
    preprocess - whether to preprocess data into the XInputAxes's float fields (true) or just use raw data (false)
  - addListener
```
public void addListener(XInputDeviceListener listener)
```
    Adds an event listener that will react to changes in the input.
    
    Parameters:
    
    listener - the listener
  - removeListener
```
public void removeListener(XInputDeviceListener listener)
```
    Removes a registered event listener
    
    Parameters:
    
    listener - the listener
  - poll
```
public boolean poll()
```
    Reads input from the device and updates components.
    This method is not thread-safe.
    
    Returns:
    
    false if the device is not connected
    
    Throws:
    
    IllegalStateException - if there is an error trying to read the device state
  - checkReturnCode
```
protected boolean checkReturnCode(int ret)
```
  - checkReturnCode
```
protected boolean checkReturnCode(int ret,
                                  int... validRetCodes)
```
  - setVibration
```
public boolean setVibration(int leftMotor,
                            int rightMotor)
```
    Sets the vibration of the controller. Returns false if the device was not connected.
    This method is not thread-safe.
    
    Parameters:
    
    leftMotor - the left motor speed, from 0 to 65535
    
    rightMotor - the right motor speed, from 0 to 65535
    
    Returns:
    
    false if the device was not connected
    
    Throws:
    
    IllegalArgumentException - if either motor speed values lie out of the range 0..65535
  - getLastComponents
```
public XInputComponents getLastComponents()
```
    Returns the state of the XInput controller components before the last poll.
    
    Returns:
    
    the state of the XInput controller components before the last poll.
  - getComponents
```
public XInputComponents getComponents()
```
    Returns the state of the XInput controller components at the last poll.
    
    Returns:
    
    the state of the XInput controller components at the last poll.
  - getDelta
```
public XInputComponentsDelta getDelta()
```
    Returns the difference between the last two states of the XInput controller components.
    
    Returns:
    
    the difference between the last two states of the XInput controller components.
  - isConnected
```
public boolean isConnected()
```
    Returns a boolean indicating whether this device is connected.
    
    Returns:
    
    true if the device is connected, false otherwise
  - getPlayerNum
```
public int getPlayerNum()
```
    Returns the player number that this device represents.
    
    Returns:
    
    the player number that this device represents.
  - newBuffer
```
protected static ByteBuffer newBuffer(int capacity)
```
    Creates a new direct ByteBuffer to be used for communicating with the native library.
    
    Parameters:
    
    capacity - the buffer capacity
    
    Returns:
    
    a direct ByteBuffer with the specified capacity

Class XInputDevice

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

playerNum

Constructor Detail

XInputDevice

Method Detail

isAvailable

getLibraryVersion

isGuideButtonSupported

getAllDevices

getDeviceFor

setPreProcessData

addListener

removeListener

poll

checkReturnCode

checkReturnCode

setVibration

getLastComponents

getComponents

getDelta

isConnected

getPlayerNum

newBuffer