XInput

All Superinterfaces:

com.sun.jna.Library
```
public interface XInput
extends com.sun.jna.Library
```
XInput Game Controller API enables applications to receive input from the Xbox 360 Controller for Windows.
Source: Microsoft Documentation

Since:

1.0.0

Version:

1.1.0

Author:

Ralph Niemitz/RalleYTN(ralph.niemitz@gmx.de)

Nested Class Summary
- Nested classes/interfaces inherited from interface com.sun.jna.Library
  com.sun.jna.Library.Handler

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BATTERY_DEVTYPE_GAMEPAD`
`static int`	`BATTERY_DEVTYPE_HEADSET`
`static int`	`BATTERY_LEVEL_EMPTY`
`static int`	`BATTERY_LEVEL_FULL`
`static int`	`BATTERY_LEVEL_LOW`
`static int`	`BATTERY_LEVEL_MEDIUM`
`static int`	`BATTERY_TYPE_ALKALINE`
`static int`	`BATTERY_TYPE_DISCONNECTED`
`static int`	`BATTERY_TYPE_NIMH`
`static int`	`BATTERY_TYPE_UNKNOWN`
`static int`	`BATTERY_TYPE_WIRED`
`static int`	`ERROR_DEVICE_NOT_CONNECTED`
`static int`	`ERROR_EMPTY`
`static int`	`ERROR_SUCCESS`
`static Info`	`INFO` Contains informations about the loaded DLL and the available functions.
`static int`	`VK_PAD_A`
`static int`	`VK_PAD_B`
`static int`	`VK_PAD_BACK`
`static int`	`VK_PAD_DPAD_DOWN`
`static int`	`VK_PAD_DPAD_LEFT`
`static int`	`VK_PAD_DPAD_RIGHT`
`static int`	`VK_PAD_DPAD_UP`
`static int`	`VK_PAD_LSHOULDER`
`static int`	`VK_PAD_LTHUMB_DOWN`
`static int`	`VK_PAD_LTHUMB_DOWNLEFT`
`static int`	`VK_PAD_LTHUMB_DOWNRIGHT`
`static int`	`VK_PAD_LTHUMB_LEFT`
`static int`	`VK_PAD_LTHUMB_PRESS`
`static int`	`VK_PAD_LTHUMB_RIGHT`
`static int`	`VK_PAD_LTHUMB_UP`
`static int`	`VK_PAD_LTHUMB_UPLEFT`
`static int`	`VK_PAD_LTHUMB_UPRIGHT`
`static int`	`VK_PAD_LTRIGGER`
`static int`	`VK_PAD_RSHOULDER`
`static int`	`VK_PAD_RTHUMB_DOWN`
`static int`	`VK_PAD_RTHUMB_DOWNLEFT`
`static int`	`VK_PAD_RTHUMB_DOWNRIGHT`
`static int`	`VK_PAD_RTHUMB_LEFT`
`static int`	`VK_PAD_RTHUMB_PRESS`
`static int`	`VK_PAD_RTHUMB_RIGHT`
`static int`	`VK_PAD_RTHUMB_UP`
`static int`	`VK_PAD_RTHUMB_UPLEFT`
`static int`	`VK_PAD_RTHUMB_UPRIGHT`
`static int`	`VK_PAD_RTRIGGER`
`static int`	`VK_PAD_START`
`static int`	`VK_PAD_X`
`static int`	`VK_PAD_Y`
`static int`	`XINPUT_CAPS_FFB_SUPPORTED`
`static int`	`XINPUT_CAPS_NO_NAVIGATION`
`static int`	`XINPUT_CAPS_PMD_SUPPORTED`
`static int`	`XINPUT_CAPS_VOICE_SUPPORTED`
`static int`	`XINPUT_CAPS_WIRELESS`
`static int`	`XINPUT_DEVSUBTYPE_ARCADE_PAD`
`static int`	`XINPUT_DEVSUBTYPE_ARCADE_STICK`
`static int`	`XINPUT_DEVSUBTYPE_DANCE_PAD`
`static int`	`XINPUT_DEVSUBTYPE_DRUM_KIT`
`static int`	`XINPUT_DEVSUBTYPE_FLIGHT_STICK`
`static int`	`XINPUT_DEVSUBTYPE_GAMEPAD`
`static int`	`XINPUT_DEVSUBTYPE_GUITAR`
`static int`	`XINPUT_DEVSUBTYPE_GUITAR_ALTERNATE`
`static int`	`XINPUT_DEVSUBTYPE_GUITAR_BASS`
`static int`	`XINPUT_DEVSUBTYPE_UNKNOWN`
`static int`	`XINPUT_DEVSUBTYPE_WHEEL`
`static int`	`XINPUT_DEVTYPE_GAMEPAD`
`static int`	`XINPUT_FLAG_GAMEPAD`
`static int`	`XINPUT_GAMEPAD_A`
`static int`	`XINPUT_GAMEPAD_B`
`static int`	`XINPUT_GAMEPAD_BACK`
`static int`	`XINPUT_GAMEPAD_DPAD_DOWN`
`static int`	`XINPUT_GAMEPAD_DPAD_LEFT`
`static int`	`XINPUT_GAMEPAD_DPAD_RIGHT`
`static int`	`XINPUT_GAMEPAD_DPAD_UP`
`static int`	`XINPUT_GAMEPAD_LEFT_SHOULDER`
`static int`	`XINPUT_GAMEPAD_LEFT_THUMB`
`static int`	`XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE`
`static int`	`XINPUT_GAMEPAD_RIGHT_SHOULDER`
`static int`	`XINPUT_GAMEPAD_RIGHT_THUMB`
`static int`	`XINPUT_GAMEPAD_RIGHT_THUMB_DEADZONE`
`static int`	`XINPUT_GAMEPAD_START`
`static int`	`XINPUT_GAMEPAD_TRIGGER_THRESHOLD`
`static int`	`XINPUT_GAMEPAD_X`
`static int`	`XINPUT_GAMEPAD_Y`
`static int`	`XINPUT_KEYSTROKE_KEYDOWN`
`static int`	`XINPUT_KEYSTROKE_KEYUP`
`static int`	`XINPUT_KEYSTROKE_REPEAT`
`static int`	`XUSER_INDEX_ANY`
`static int`	`XUSER_MAX_COUNT`

Fields inherited from interface com.sun.jna.Library
OPTION_ALLOW_OBJECTS, OPTION_CALLING_CONVENTION, OPTION_CLASSLOADER, OPTION_FUNCTION_MAPPER, OPTION_INVOCATION_MAPPER, OPTION_OPEN_FLAGS, OPTION_STRING_ENCODING, OPTION_STRUCTURE_ALIGNMENT, OPTION_TYPE_MAPPER

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`static XInput`	`create()` Creates a new instance of XInput.
`void`	`XInputEnable(boolean enable)` Sets the reporting state of XInput.
`int`	`XInputGetAudioDeviceIds(int dwUserIndex, char[] pRenderDeviceId, com.sun.jna.ptr.LongByReference pRenderCount, char[] pCaptureDeviceId, com.sun.jna.ptr.LongByReference pCaptureCount)` Retrieves the sound rendering and sound capture audio device IDs that are associated with the headset connected to the specified controller.
`int`	`XInputGetBatteryInformation(int dwUserIndex, int devType, XInputBatteryInformation pBatteryInformation)` Retrieves the battery type and charge status of a wireless controller.
`int`	`XInputGetCapabilities(int dwUserIndex, int dwFlags, XInputCapabilities pCapabilities)` Retrieves the capabilities and features of a connected controller.
`int`	`XInputGetDSoundAudioDeviceGuids(int dwUserIndex, char[] pDSoundRenderGuid, char[] pdSoundCaptureGuid)` Deprecated. `XInputGetDSoundAudioDeviceGuids(int, char[], char[])` is deprecated because it isn't supported by Windows 8 (XInput 1.4).
`int`	`XInputGetKeystroke(int dwUserIndex, int dwReserved, XInputKeystroke pKeystroke)` Retrieves a gamepad input event.
`int`	`XInputGetState(int dwUserIndex, XInputState pState)` Retrieves the current state of the specified controller.
`int`	`XInputSetState(int dwUserIndex, XInputVibration pVibration)` Sends data to a connected controller.

- Field Detail
  - ERROR_SUCCESS
```
static final int ERROR_SUCCESS
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - ERROR_EMPTY
```
static final int ERROR_EMPTY
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - ERROR_DEVICE_NOT_CONNECTED
```
static final int ERROR_DEVICE_NOT_CONNECTED
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_KEYSTROKE_KEYDOWN
```
static final int XINPUT_KEYSTROKE_KEYDOWN
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_KEYSTROKE_KEYUP
```
static final int XINPUT_KEYSTROKE_KEYUP
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_KEYSTROKE_REPEAT
```
static final int XINPUT_KEYSTROKE_REPEAT
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_DEVSUBTYPE_UNKNOWN
```
static final int XINPUT_DEVSUBTYPE_UNKNOWN
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_DEVSUBTYPE_GAMEPAD
```
static final int XINPUT_DEVSUBTYPE_GAMEPAD
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_DEVSUBTYPE_WHEEL
```
static final int XINPUT_DEVSUBTYPE_WHEEL
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_DEVSUBTYPE_ARCADE_STICK
```
static final int XINPUT_DEVSUBTYPE_ARCADE_STICK
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_DEVSUBTYPE_FLIGHT_STICK
```
static final int XINPUT_DEVSUBTYPE_FLIGHT_STICK
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_DEVSUBTYPE_DANCE_PAD
```
static final int XINPUT_DEVSUBTYPE_DANCE_PAD
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_DEVSUBTYPE_GUITAR
```
static final int XINPUT_DEVSUBTYPE_GUITAR
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_DEVSUBTYPE_GUITAR_ALTERNATE
```
static final int XINPUT_DEVSUBTYPE_GUITAR_ALTERNATE
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_DEVSUBTYPE_DRUM_KIT
```
static final int XINPUT_DEVSUBTYPE_DRUM_KIT
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_DEVSUBTYPE_GUITAR_BASS
```
static final int XINPUT_DEVSUBTYPE_GUITAR_BASS
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_DEVSUBTYPE_ARCADE_PAD
```
static final int XINPUT_DEVSUBTYPE_ARCADE_PAD
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_A
```
static final int VK_PAD_A
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_B
```
static final int VK_PAD_B
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_X
```
static final int VK_PAD_X
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_Y
```
static final int VK_PAD_Y
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_RSHOULDER
```
static final int VK_PAD_RSHOULDER
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_LSHOULDER
```
static final int VK_PAD_LSHOULDER
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_LTRIGGER
```
static final int VK_PAD_LTRIGGER
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_RTRIGGER
```
static final int VK_PAD_RTRIGGER
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_DPAD_UP
```
static final int VK_PAD_DPAD_UP
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_DPAD_DOWN
```
static final int VK_PAD_DPAD_DOWN
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_DPAD_LEFT
```
static final int VK_PAD_DPAD_LEFT
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_DPAD_RIGHT
```
static final int VK_PAD_DPAD_RIGHT
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_START
```
static final int VK_PAD_START
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_BACK
```
static final int VK_PAD_BACK
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_LTHUMB_PRESS
```
static final int VK_PAD_LTHUMB_PRESS
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_RTHUMB_PRESS
```
static final int VK_PAD_RTHUMB_PRESS
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_LTHUMB_UP
```
static final int VK_PAD_LTHUMB_UP
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_LTHUMB_DOWN
```
static final int VK_PAD_LTHUMB_DOWN
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_LTHUMB_RIGHT
```
static final int VK_PAD_LTHUMB_RIGHT
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_LTHUMB_LEFT
```
static final int VK_PAD_LTHUMB_LEFT
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_LTHUMB_UPLEFT
```
static final int VK_PAD_LTHUMB_UPLEFT
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_LTHUMB_UPRIGHT
```
static final int VK_PAD_LTHUMB_UPRIGHT
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_LTHUMB_DOWNRIGHT
```
static final int VK_PAD_LTHUMB_DOWNRIGHT
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_LTHUMB_DOWNLEFT
```
static final int VK_PAD_LTHUMB_DOWNLEFT
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_RTHUMB_UP
```
static final int VK_PAD_RTHUMB_UP
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_RTHUMB_DOWN
```
static final int VK_PAD_RTHUMB_DOWN
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_RTHUMB_RIGHT
```
static final int VK_PAD_RTHUMB_RIGHT
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_RTHUMB_LEFT
```
static final int VK_PAD_RTHUMB_LEFT
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_RTHUMB_UPLEFT
```
static final int VK_PAD_RTHUMB_UPLEFT
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_RTHUMB_UPRIGHT
```
static final int VK_PAD_RTHUMB_UPRIGHT
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_RTHUMB_DOWNRIGHT
```
static final int VK_PAD_RTHUMB_DOWNRIGHT
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - VK_PAD_RTHUMB_DOWNLEFT
```
static final int VK_PAD_RTHUMB_DOWNLEFT
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_DEVTYPE_GAMEPAD
```
static final int XINPUT_DEVTYPE_GAMEPAD
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_GAMEPAD_DPAD_UP
```
static final int XINPUT_GAMEPAD_DPAD_UP
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_GAMEPAD_DPAD_DOWN
```
static final int XINPUT_GAMEPAD_DPAD_DOWN
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_GAMEPAD_DPAD_LEFT
```
static final int XINPUT_GAMEPAD_DPAD_LEFT
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_GAMEPAD_DPAD_RIGHT
```
static final int XINPUT_GAMEPAD_DPAD_RIGHT
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_GAMEPAD_START
```
static final int XINPUT_GAMEPAD_START
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_GAMEPAD_BACK
```
static final int XINPUT_GAMEPAD_BACK
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_GAMEPAD_LEFT_THUMB
```
static final int XINPUT_GAMEPAD_LEFT_THUMB
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE
```
static final int XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_GAMEPAD_RIGHT_THUMB
```
static final int XINPUT_GAMEPAD_RIGHT_THUMB
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_GAMEPAD_RIGHT_THUMB_DEADZONE
```
static final int XINPUT_GAMEPAD_RIGHT_THUMB_DEADZONE
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_GAMEPAD_LEFT_SHOULDER
```
static final int XINPUT_GAMEPAD_LEFT_SHOULDER
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_GAMEPAD_RIGHT_SHOULDER
```
static final int XINPUT_GAMEPAD_RIGHT_SHOULDER
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_GAMEPAD_A
```
static final int XINPUT_GAMEPAD_A
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_GAMEPAD_B
```
static final int XINPUT_GAMEPAD_B
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_GAMEPAD_X
```
static final int XINPUT_GAMEPAD_X
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_GAMEPAD_Y
```
static final int XINPUT_GAMEPAD_Y
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_GAMEPAD_TRIGGER_THRESHOLD
```
static final int XINPUT_GAMEPAD_TRIGGER_THRESHOLD
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - BATTERY_TYPE_DISCONNECTED
```
static final int BATTERY_TYPE_DISCONNECTED
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - BATTERY_TYPE_WIRED
```
static final int BATTERY_TYPE_WIRED
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - BATTERY_TYPE_ALKALINE
```
static final int BATTERY_TYPE_ALKALINE
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - BATTERY_TYPE_NIMH
```
static final int BATTERY_TYPE_NIMH
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - BATTERY_TYPE_UNKNOWN
```
static final int BATTERY_TYPE_UNKNOWN
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - BATTERY_DEVTYPE_GAMEPAD
```
static final int BATTERY_DEVTYPE_GAMEPAD
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - BATTERY_DEVTYPE_HEADSET
```
static final int BATTERY_DEVTYPE_HEADSET
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - BATTERY_LEVEL_EMPTY
```
static final int BATTERY_LEVEL_EMPTY
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - BATTERY_LEVEL_LOW
```
static final int BATTERY_LEVEL_LOW
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - BATTERY_LEVEL_MEDIUM
```
static final int BATTERY_LEVEL_MEDIUM
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - BATTERY_LEVEL_FULL
```
static final int BATTERY_LEVEL_FULL
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_CAPS_FFB_SUPPORTED
```
static final int XINPUT_CAPS_FFB_SUPPORTED
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_CAPS_WIRELESS
```
static final int XINPUT_CAPS_WIRELESS
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_CAPS_VOICE_SUPPORTED
```
static final int XINPUT_CAPS_VOICE_SUPPORTED
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_CAPS_PMD_SUPPORTED
```
static final int XINPUT_CAPS_PMD_SUPPORTED
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_CAPS_NO_NAVIGATION
```
static final int XINPUT_CAPS_NO_NAVIGATION
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XINPUT_FLAG_GAMEPAD
```
static final int XINPUT_FLAG_GAMEPAD
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XUSER_INDEX_ANY
```
static final int XUSER_INDEX_ANY
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - XUSER_MAX_COUNT
```
static final int XUSER_MAX_COUNT
```
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - INFO
```
static final Info INFO
```
    Contains informations about the loaded DLL and the available functions. All values in it will be null if the create() method wasn't called yet.
    
    Since:
    
    1.1.0
- Method Detail
  - create
```
static XInput create()
```
    Creates a new instance of XInput. It is recommended to call this method only once and save the result in a public constant. The instance will be destroyed on garbage collection.
    
    Returns:
    
    the created instance or null if the XInput API is not supported
    
    Since:
    
    1.0.0
  - XInputEnable
```
void XInputEnable(boolean enable)
```
    Sets the reporting state of XInput.
    Remarks
    
    This function is meant to be called when an application gains or loses focus (such as via WM_ACTIVATEAPP). Using this function, you will not have to change the XInput query loop in your application as neutral data will always be reported if XInput is disabled. In a controller that supports vibration effects:
    - Passing false will stop any vibration effects currently playing. In this state, calls to XInputSetState(int, XInputVibration) will be registered, but not passed to the device.
    - Passing true will pass the last vibration request (even if it is 0) sent to XInputSetState(int, XInputVibration) to the device.
    Platform Requirements
    Windows 8 (XInput 1.4), DirectX SDK (XInput 1.3)
    
    Requirements
    
    Header XInput.h
    
    Library Xinput.lib
    
    DLL Xinput1_4.dll
    
    Source: Microsoft Documentation
    Parameters:
    
    enable - [in]If enable is false, XInput will only send neutral data in response to XInputGetState(int, XInputState) (all buttons up, axes centered, and triggers at 0). XInputSetState(int, XInputVibration) calls will be registered but not sent to the device. Sending any value other than false will restore reading and writing functionality to normal.
    
    Since:
    
    1.0.0
    
    See Also:
    
    XInput Functions, XInputGetState(int, XInputState), XInputSetState(int, XInputVibration), XInputState, XInputGamepad
  - XInputGetCapabilities
```
int XInputGetCapabilities(int dwUserIndex,
                          int dwFlags,
                          XInputCapabilities pCapabilities)
```
    Retrieves the capabilities and features of a connected controller.
    
    Remarks
    
    The legacy XINPUT 9.1.0 version (included in Windows Vista and later) always returned a fixed set of capabilities regardless of attached device.
    
    Platform Requirements
    Windows 8 (XInput 1.4), DirectX SDK (XInput 1.3), Windows Vista (XInput 9.1.0)
    
    Requirements
    
    Header XInput.h
    
    Library Xinput.lib;
    Xinput9_1_0.lib
    
    DLL Xinput1_4.dll;
    Xinput9_1_0.dll
    
    Source: Microsoft Documentation
    
    Parameters:
    
    dwUserIndex - [in] Index of the user's controller. Can be a value from 0 to 3. For information about how this value is determined and how the value maps to indicators on the controller, see Multiple Controllers.
    
    dwFlags - [in] Input flags that identify the controller type. If this value is 0, then the capabilities of all controllers connected to the system are returned. Currently, only one value is supported:
    
    Value Description
    
    XINPUT_FLAG_GAMEPAD Limit query to devices of Xbox 360 Controller type.
    
    Any value of dwFlags other than the above or 0 is illegal and will result in an error break when debugging.
    
    pCapabilities - [out] Pointer to an XInputCapabilities structure that receives the controller capabilities.
    
    Returns:
    
    If the function succeeds, the return value is ERROR_SUCCESS.
    If the controller is not connected, the return value is ERROR_DEVICE_NOT_CONNECTED.
    If the function fails, the return value is an error code defined in WinError.h.
    The function does not use SetLastError to set the calling thread's last-error code.
    
    Since:
    
    1.0.0
    
    See Also:
    
    XInput Functions, XInputGetState(int, XInputState), XInputSetState(int, XInputVibration)
  - XInputGetAudioDeviceIds
```
int XInputGetAudioDeviceIds(int dwUserIndex,
                            char[] pRenderDeviceId,
                            com.sun.jna.ptr.LongByReference pRenderCount,
                            char[] pCaptureDeviceId,
                            com.sun.jna.ptr.LongByReference pCaptureCount)
```
    Retrieves the sound rendering and sound capture audio device IDs that are associated with the headset connected to the specified controller.
    Remarks
    
    Callers must allocate the memory for the buffers passed to XInputGetAudioDeviceIds(int, char[], LongByReference, char[], LongByReference). The resulting strings can be of arbitrary length.
    
    Platform Requirements
    Windows 8 (XInput 1.4)
    
    Requirements
    
    Header XInput.h
    
    Library Xinput.lib
    
    DLL Xinput1_4.dll
    
    Source: Microsoft Documentation
    
    Parameters:
    
    dwUserIndex - [in] Index of the gamer associated with the device.
    
    pRenderDeviceId - [out, optional] Windows Core Audio device ID string for render (speakers).
    
    pRenderCount - [in, out, optional] Size, in wide-chars, of the render device ID string buffer.
    
    pCaptureDeviceId - [out, optional] Windows Core Audio device ID string for capture (microphone).
    
    pCaptureCount - [in, out, optional] Size, in wide-chars, of capture device ID string buffer.
    
    Returns:
    
    If the function successfully retrieves the device IDs for render and capture, the return code is ERROR_SUCCESS. If there is no headset connected to the controller, the function will also retrieve ERROR_SUCCESS with null as the values for pRenderDeviceId and pCaptureDeviceId. If the controller port device is not physically connected, the function will return ERROR_DEVICE_NOT_CONNECTED. If the function fails, it will return a valid Win32 error code.
    
    Since:
    
    1.0.0
    
    See Also:
    
    Core Audio APIs, XInput Functions, XInputGetDSoundAudioDeviceGuids(int, char[], char[])
  - XInputGetBatteryInformation
```
int XInputGetBatteryInformation(int dwUserIndex,
                                int devType,
                                XInputBatteryInformation pBatteryInformation)
```
    Retrieves the battery type and charge status of a wireless controller.
    Platform Requirements
    Windows 8 (XInput 1.4), DirectX SDK (XInput 1.3)
    
    Requirements
    
    Header XInput.h
    
    Library Xinput.lib
    
    DLL Xinput1_4.dll
    
    Source: Microsoft Documentation
    
    Parameters:
    
    dwUserIndex - [in] Index of the user's controller. Can be a value from 0 to 3. For information about how this value is determined and how the value maps to indicators on the controller, see Multiple Controllers.
    
    devType - [in] Specifies which device associated with this user index should be queried. Must be BATTERY_DEVTYPE_GAMEPAD or BATTERY_DEVTYPE_HEADSET.
    
    pBatteryInformation - [out] Pointer to an XInputBatteryInformation structure that receives the battery information.
    
    Returns:
    
    If the function succeeds, the return value is ERROR_SUCCESS.
    
    Since:
    
    1.0.0
    
    See Also:
    
    XInput Functions
  - XInputGetDSoundAudioDeviceGuids
```
@Deprecated
int XInputGetDSoundAudioDeviceGuids(int dwUserIndex,
                                                 char[] pDSoundRenderGuid,
                                                 char[] pdSoundCaptureGuid)
```
    Deprecated. XInputGetDSoundAudioDeviceGuids(int, char[], char[]) is deprecated because it isn't supported by Windows 8 (XInput 1.4).
    
    Gets the sound rendering and sound capture device GUIDs that are associated with the headset connected to the specified controller.
    Remarks
    
    Use of legacy DirectSound is not recommended, and DirectSound is not available for Windows Store apps.
    
    Platform Requirements
    DirectX SDK (XInput 1.3), Windows Vista (XInput 9.1.0)
    
    Requirements
    
    Header XInput.h
    
    Library Xinput.lib;
    Xinput9_1_0.lib
    
    DLL Xinput9_1_0.dll
    
    Source: Microsoft Documentation
    
    Parameters:
    
    dwUserIndex - [in] Index of the user's controller. Can be a value from 0 to 3. For information about how this value is determined and how the value maps to indicators on the controller, see Multiple Controllers.
    
    pDSoundRenderGuid - [out] Pointer that receives the GUID of the headset sound rendering device.
    
    pdSoundCaptureGuid - [out] Pointer that receives the GUID of the headset sound capture device.
    
    Returns:
    
    If the function successfully retrieves the device IDs for render and capture, the return code is ERROR_SUCCESS. If there is no headset connected to the controller, the function also retrieves ERROR_SUCCESS with GUID_NULL as the values for pDSoundRenderGuid and pDSoundCaptureGuid. If the controller port device is not physically connected, the function returns ERROR_DEVICE_NOT_CONNECTED. If the function fails, it returns a valid Win32 error code.
    
    Since:
    
    1.0.0
    
    See Also:
    
    XInput Functions, XInputGetState(int, XInputState)
  - XInputGetState
```
int XInputGetState(int dwUserIndex,
                   XInputState pState)
```
    Retrieves the current state of the specified controller.
    Remarks
    When XInputGetState(int, XInputState) is used to retrieve controller data, the left and right triggers are each reported separately. For legacy reasons, when DirectInput retrieves controller data, the two triggers share the same axis. The legacy behavior is noticeable in the current Game Device Control Panel, which uses DirectInput for controller state.
    Platform Requirements
    Windows 8 (XInput 1.4), DirectX SDK (XInput 1.3), Windows Vista (XInput 9.1.0)
    
    Requirements
    
    Header XInput.h
    
    Library Xinput.lib;
    Xinput9_1_0.lib
    
    DLL Xinput1_4.dll;
    Xinput9_1_0.dll;
    Xinputuap.dll
    
    Source: Microsoft Documentation
    
    Parameters:
    
    dwUserIndex - [in] Index of the user's controller. Can be a value from 0 to 3. For information about how this value is determined and how the value maps to indicators on the controller, see Multiple Controllers.
    
    pState - [out] Pointer to an XInputState structure that receives the current state of the controller.
    
    Returns:
    
    If the function succeeds, the return value is ERROR_SUCCESS.
    If the controller is not connected, the return value is ERROR_DEVICE_NOT_CONNECTED.
    If the function fails, the return value is an error code defined in WinError.h.
    The function does not use SetLastError to set the calling thread's last-error code.
    
    Since:
    
    1.0.0
    
    See Also:
    
    XInput Functions, XInputSetState(int, XInputVibration), XInputState, XInputGamepad
  - XInputSetState
```
int XInputSetState(int dwUserIndex,
                   XInputVibration pVibration)
```
    Sends data to a connected controller. This function is used to activate the vibration function of a controller.
    
    Platform Requirements
    Windows 8 (XInput 1.4), DirectX SDK (XInput 1.3), Windows Vista (XInput 9.1.0)
    
    Requirements
    
    Header XInput.h
    
    Library Xinput.lib;
    Xinput9_1_0.lib
    
    DLL Xinput1_4.dll;
    Xinput9_1_0.dll
    
    Source: Microsoft Documentation
    
    Parameters:
    
    dwUserIndex - [in] Index of the user's controller. Can be a value from 0 to 3. For information about how this value is determined and how the value maps to indicators on the controller, see Multiple Controllers.
    
    pVibration - [in, out] Pointer to an XInputVibration structure containing the vibration information to send to the controller.
    
    Returns:
    
    If the function succeeds, the return value is ERROR_SUCCESS.
    If the controller is not connected, the return value is ERROR_DEVICE_NOT_CONNECTED.
    If the function fails, the return value is an error code defined in WinError.h.
    The function does not use SetLastError to set the calling thread's last-error code.
    
    Since:
    
    1.0.0
    
    See Also:
    
    XInput Functions, XInputGetState(int, XInputState), XInputVibration
  - XInputGetKeystroke
```
int XInputGetKeystroke(int dwUserIndex,
                       int dwReserved,
                       XInputKeystroke pKeystroke)
```
    Retrieves a gamepad input event.
    Remarks
    
    Wireless controllers are not considered active upon system startup, and calls to any of the XInput functions before a wireless controller is made active return ERROR_DEVICE_NOT_CONNECTED. Game titles must examine the return code and be prepared to handle this condition. Wired controllers are automatically activated when they are inserted. Wireless controllers are activated when the user presses the START or Xbox Guide button to power on the controller.
    
    Platform Requirements
    Windows 8 (XInput 1.4), DirectX SDK (XInput 1.3)
    
    Requirements
    
    Header XInput.h
    
    Library Xinput.lib
    
    DLL Xinput1_4.dll
    
    Source: Microsoft Documentation
    
    Parameters:
    
    dwUserIndex - [in] Index of the user's controller. Can be a value from 0 to 3. For information about how this value is determined and how the value maps to indicators on the controller, see Multiple Controllers.
    
    dwReserved - [in] Reserved
    
    pKeystroke - [out] Pointer to an XInputKeystroke structure that receives an input event.
    
    Returns:
    
    If the function succeeds, the return value is ERROR_SUCCESS.
    If the controller is not connected, the return value is ERROR_DEVICE_NOT_CONNECTED.
    If the function fails, the return value is an error code defined in WinError.h.
    The function does not use SetLastError to set the calling thread's last-error code.
    
    Since:
    
    1.0.0
    
    See Also:
    
    XInput Functions, XInputKeystroke

Header	XInput.h
Library	Xinput.lib; Xinput9_1_0.lib
DLL	Xinput1_4.dll; Xinput9_1_0.dll

Interface XInput

Nested Class Summary

Nested classes/interfaces inherited from interface com.sun.jna.Library

Field Summary

Fields inherited from interface com.sun.jna.Library

Method Summary

Field Detail

ERROR_SUCCESS

ERROR_EMPTY

ERROR_DEVICE_NOT_CONNECTED

XINPUT_KEYSTROKE_KEYDOWN

XINPUT_KEYSTROKE_KEYUP

XINPUT_KEYSTROKE_REPEAT

XINPUT_DEVSUBTYPE_UNKNOWN

XINPUT_DEVSUBTYPE_GAMEPAD

XINPUT_DEVSUBTYPE_WHEEL

XINPUT_DEVSUBTYPE_ARCADE_STICK

XINPUT_DEVSUBTYPE_FLIGHT_STICK

XINPUT_DEVSUBTYPE_DANCE_PAD

XINPUT_DEVSUBTYPE_GUITAR

XINPUT_DEVSUBTYPE_GUITAR_ALTERNATE

XINPUT_DEVSUBTYPE_DRUM_KIT

XINPUT_DEVSUBTYPE_GUITAR_BASS

XINPUT_DEVSUBTYPE_ARCADE_PAD

VK_PAD_A

VK_PAD_B

VK_PAD_X

VK_PAD_Y

VK_PAD_RSHOULDER

VK_PAD_LSHOULDER

VK_PAD_LTRIGGER

VK_PAD_RTRIGGER

VK_PAD_DPAD_UP

VK_PAD_DPAD_DOWN

VK_PAD_DPAD_LEFT

VK_PAD_DPAD_RIGHT

VK_PAD_START

VK_PAD_BACK

VK_PAD_LTHUMB_PRESS

VK_PAD_RTHUMB_PRESS

VK_PAD_LTHUMB_UP

VK_PAD_LTHUMB_DOWN

VK_PAD_LTHUMB_RIGHT

VK_PAD_LTHUMB_LEFT

VK_PAD_LTHUMB_UPLEFT

VK_PAD_LTHUMB_UPRIGHT

VK_PAD_LTHUMB_DOWNRIGHT

VK_PAD_LTHUMB_DOWNLEFT

VK_PAD_RTHUMB_UP

VK_PAD_RTHUMB_DOWN

VK_PAD_RTHUMB_RIGHT

VK_PAD_RTHUMB_LEFT

VK_PAD_RTHUMB_UPLEFT

VK_PAD_RTHUMB_UPRIGHT

VK_PAD_RTHUMB_DOWNRIGHT

VK_PAD_RTHUMB_DOWNLEFT

XINPUT_DEVTYPE_GAMEPAD

XINPUT_GAMEPAD_DPAD_UP

XINPUT_GAMEPAD_DPAD_DOWN

XINPUT_GAMEPAD_DPAD_LEFT

XINPUT_GAMEPAD_DPAD_RIGHT

XINPUT_GAMEPAD_START

XINPUT_GAMEPAD_BACK

XINPUT_GAMEPAD_LEFT_THUMB

XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE

XINPUT_GAMEPAD_RIGHT_THUMB

XINPUT_GAMEPAD_RIGHT_THUMB_DEADZONE

XINPUT_GAMEPAD_LEFT_SHOULDER

XINPUT_GAMEPAD_RIGHT_SHOULDER

XINPUT_GAMEPAD_A

XINPUT_GAMEPAD_B

XINPUT_GAMEPAD_X

XINPUT_GAMEPAD_Y

XINPUT_GAMEPAD_TRIGGER_THRESHOLD

BATTERY_TYPE_DISCONNECTED

BATTERY_TYPE_WIRED

BATTERY_TYPE_ALKALINE

BATTERY_TYPE_NIMH

BATTERY_TYPE_UNKNOWN

BATTERY_DEVTYPE_GAMEPAD