Interface IGameControllerDevice

Namespace

Stride.Input

Assembly

Stride.Input.dll

This interface is used for interacting with game controller devices.

public interface IGameControllerDevice : IInputDevice

Inherited Members

IInputDevice.Name

IInputDevice.Id

IInputDevice.Priority

IInputDevice.Source

IInputDevice.Update(List<InputEvent>)

Extension Methods

GameControllerDeviceExtensions.IsButtonDown(IGameControllerDevice, int)

GameControllerDeviceExtensions.IsButtonPressed(IGameControllerDevice, int)

GameControllerDeviceExtensions.IsButtonReleased(IGameControllerDevice, int)

GameControllerExtensions.GetAxisCount(IGameControllerDevice)

GameControllerExtensions.GetButtonCount(IGameControllerDevice)

GameControllerExtensions.GetDPad(IGameControllerDevice, int)

GameControllerExtensions.GetDirectionCount(IGameControllerDevice)

Properties

AxisInfos

Information about the axes on this game controller

IReadOnlyList<GameControllerAxisInfo> AxisInfos { get; }

Property Value

IReadOnlyList<GameControllerAxisInfo>

ButtonInfos

Information about the buttons on this game controller

IReadOnlyList<GameControllerButtonInfo> ButtonInfos { get; }

Property Value

IReadOnlyList<GameControllerButtonInfo>

DirectionInfos

Information about the direction controllers on this game controller

IReadOnlyList<GameControllerDirectionInfo> DirectionInfos { get; }

Property Value

IReadOnlyList<GameControllerDirectionInfo>

DownButtons

The buttons that are down

IReadOnlySet<int> DownButtons { get; }

Property Value

IReadOnlySet<int>

PressedButtons

The buttons that have been pressed since the last frame

IReadOnlySet<int> PressedButtons { get; }

Property Value

IReadOnlySet<int>

ProductId

Product Id of the device

Guid ProductId { get; }

Property Value

Guid

ReleasedButtons

The buttons that have been released since the last frame

IReadOnlySet<int> ReleasedButtons { get; }

Property Value

IReadOnlySet<int>

Methods

GetAxis(int)

Retrieves the state of a single axis

float GetAxis(int index)

Parameters

index int

The axis' index, as exposed in AxisInfos

Returns

float

The value read directly from the axis

GetDirection(int)

Retrieves the state of a single point of direction controller

Direction GetDirection(int index)

Parameters

index int

The direction controller's index, as exposed in DirectionInfos

Returns

Direction

The current state of the direction controller