Gamepad Gamepad Gamepad Gamepad Gamepad Class

Definition

Represents a gamepad.

public : sealed class Gamepad : IGameController, IGameControllerBatteryInfo, IGamepad, IGamepad2
struct winrt::Windows::Gaming::Input::Gamepad : IGameController, IGameControllerBatteryInfo, IGamepad, IGamepad2
public sealed class Gamepad : IGameController, IGameControllerBatteryInfo, IGamepad, IGamepad2
Public NotInheritable Class Gamepad Implements IGameController, IGameControllerBatteryInfo, IGamepad, IGamepad2
// This class does not provide a public constructor.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

Instances of the Gamepad class cannot be created directly; instead, instances of the Gamepad class are retrieved through the Gamepad.Gamepads property listing all connected gamepads or through the Gamepad.GamepadAdded event.

Supported Devices

Gamepad supports any Xbox One certified or Xbox 360 compatible gamepad.

Properties

Gamepads Gamepads Gamepads Gamepads Gamepads

The list of all connected gamepads.

Headset Headset Headset Headset Headset

The audio headset attached to the gamepad.

IsWireless IsWireless IsWireless IsWireless IsWireless

Gets a value that indicates the wireless state of the gamepad.

User User User User User

The user associated with the gamepad.

Vibration Vibration Vibration Vibration Vibration

Describes the gamepad motor speed.

Methods

FromGameController(IGameController) FromGameController(IGameController) FromGameController(IGameController) FromGameController(IGameController) FromGameController(IGameController)

Returns the given game controller as a gamepad.

GetButtonLabel(GamepadButtons) GetButtonLabel(GamepadButtons) GetButtonLabel(GamepadButtons) GetButtonLabel(GamepadButtons) GetButtonLabel(GamepadButtons)

Retrieves the button label for the specified button.

GetCurrentReading() GetCurrentReading() GetCurrentReading() GetCurrentReading() GetCurrentReading()

Gets a snapshot of the gamepad state.

TryGetBatteryReport() TryGetBatteryReport() TryGetBatteryReport() TryGetBatteryReport() TryGetBatteryReport()

Gets information about the gamepad's current battery state.

Events

GamepadAdded GamepadAdded GamepadAdded GamepadAdded GamepadAdded

Signals when a new gamepad is connected.

GamepadRemoved GamepadRemoved GamepadRemoved GamepadRemoved GamepadRemoved

Signals when a gamepad is disconnected.

HeadsetConnected HeadsetConnected HeadsetConnected HeadsetConnected HeadsetConnected

Signals when a headset is attached to the gamepad.

HeadsetDisconnected HeadsetDisconnected HeadsetDisconnected HeadsetDisconnected HeadsetDisconnected

Signals when a headset is disconnected from the gamepad.

UserChanged UserChanged UserChanged UserChanged UserChanged

Signals when the user associated with the gamepad has changed.

See Also