com.github.strikerx3.jxinput

Class XInputDevice14

java.lang.Object

com.github.strikerx3.jxinput.XInputDevice

com.github.strikerx3.jxinput.XInputDevice14

public class XInputDevice14
extends XInputDevice

Provides extended functionality available on XInput 1.4.

As with XInputDevice, certain methods in this class are not thread-safe. It is not recommended to share an instance of XInputDevice14 across multiple threads.

Author:

Ivan "StrikerX3" Oliveira

Field Summary

Fields inherited from class com.github.strikerx3.jxinput.XInputDevice

playerNum

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XInputDevice14(int playerNum)

Method Summary

Modifier and Type	Method and Description
static XInputDevice14[]	getAllDevices() Returns an array containing all registered XInput devices.
XInputBatteryInformation	getBatteryInformation(XInputBatteryDeviceType deviceType) Retrieves the device's battery information.
XInputCapabilities	getCapabilities() Retrieves the capabilities of the device.
static XInputDevice14	getDeviceFor(int playerNum) Returns the XInput device for the specified player.
XInputCapabilities	getGamepadCapabilities() Retrieves the capabilities of the gamepad.
XInputKeystroke	getKeystroke() Retrieves the next keystroke from this device, or null if there are no more keystrokes or the device is not connected.
static boolean	isAvailable() Determines if the XInput devices are available on this platform.
static void	setEnabled(boolean enabled) Enables or disables the reporting state of XInput.

Methods inherited from class com.github.strikerx3.jxinput.XInputDevice

addListener, checkReturnCode, checkReturnCode, getComponents, getDelta, getLastComponents, getLibraryVersion, getPlayerNum, isConnected, isGuideButtonSupported, newBuffer, poll, removeListener, setPreProcessData, setVibration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XInputDevice14

protected XInputDevice14(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

getAllDevices

public static XInputDevice14[] getAllDevices()
                                      throws XInputNotLoadedException

Returns an array containing all registered XInput devices.

The XInputDevice14 objects are not thread-safe.

Returns:

all XInput devices

Throws:

XInputNotLoadedException - if the native library failed to load

getDeviceFor

public static XInputDevice14 getDeviceFor(int playerNum)
                                   throws XInputNotLoadedException

Returns the XInput device for the specified player.

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

setEnabled

public static void setEnabled(boolean enabled)

Enables or disables the reporting state of XInput. Disabling this will cause XInput to send neutral data in response to polls and not send vibration to the device. This is meant to be used when the application loses focus so as to prevent the application from reading data while it is in the background.

Parameters:

enabled - true to enable XInput to send and receive data to/from the device, false to force it to return neutral data and prevent sending data to the device

getCapabilities

public XInputCapabilities getCapabilities()

Retrieves the capabilities of the device.

This method is not thread-safe.

Returns:

the device's capabilities, or null if the device is not connected

Throws:

IllegalStateException - if there is an error trying to read the device state

getGamepadCapabilities

public XInputCapabilities getGamepadCapabilities()

Retrieves the capabilities of the gamepad.

This method is not thread-safe.

Returns:

the gamepad's capabilities, or null if the device is not connected

Throws:

IllegalStateException - if there is an error trying to read the device state

getBatteryInformation

public XInputBatteryInformation getBatteryInformation(XInputBatteryDeviceType deviceType)

Retrieves the device's battery information.

This method is not thread-safe.

Parameters:

deviceType - the type of device to obtain battery information from

Returns:

an XInputBatteryInformation or null if the device is not connected

Throws:

IllegalStateException - if there is an error trying to read the device state

getKeystroke

public XInputKeystroke getKeystroke()

Retrieves the next keystroke from this device, or null if there are no more keystrokes or the device is not connected.

This method is not thread-safe.

Returns:

the next keystroke, or null if the device is not connected or there was no keystroke