Struct GamePadCapabilities

Describes the capabilities of a GamePad input device.

Implements

IEquatable<GamePadCapabilities>

Inherited Members

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetType()

Namespace: OpenTK.Input

Assembly: OpenTK.dll

Syntax

public struct GamePadCapabilities : IEquatable<GamePadCapabilities>

Properties

GamePadType

Gets a GamePadType value describing the type of a GamePad input device. This value depends on the connected device and the drivers in use. If IsConnected is false, then this value will be GamePadType.Unknown.

Declaration

public readonly GamePadType GamePadType { get; }

Property Value

Type	Description
GamePadType	The GamePadType of the connected input device.

HasAButton

Gets a Boolean value describing whether this GamePad has an A button.

Declaration

public readonly bool HasAButton { get; }

Property Value

Type	Description
Boolean	true if this instance has an A button; otherwise, false.

HasBackButton

Gets a Boolean value describing whether this GamePad has a back button.

Declaration

public readonly bool HasBackButton { get; }

Property Value

Type	Description
Boolean	true if this instance has a back button; otherwise, false.

HasBButton

Gets a Boolean value describing whether this GamePad has a B button.

Declaration

public readonly bool HasBButton { get; }

Property Value

Type	Description
Boolean	true if this instance has a B button; otherwise, false.

HasBigButton

Gets a Boolean value describing whether this GamePad has a big button. (also known as "guide" or "home" button).

Declaration

public readonly bool HasBigButton { get; }

Property Value

Type	Description
Boolean	true if this instance has a big button; otherwise, false.

HasDPadDownButton

Gets a Boolean value describing whether this GamePad has a down digital pad button.

Declaration

public readonly bool HasDPadDownButton { get; }

Property Value

Type	Description
Boolean	true if this instance has a down digital pad button; otherwise, false.

HasDPadLeftButton

Gets a Boolean value describing whether this GamePad has a left digital pad button.

Declaration

public readonly bool HasDPadLeftButton { get; }

Property Value

Type	Description
Boolean	true if this instance has a left digital pad button; otherwise, false.

HasDPadRightButton

Gets a Boolean value describing whether this GamePad has a right digital pad button.

Declaration

public readonly bool HasDPadRightButton { get; }

Property Value

Type	Description
Boolean	true if this instance has a right digital pad button; otherwise, false.

HasDPadUpButton

Gets a Boolean value describing whether this GamePad has an up digital pad button.

Declaration

public readonly bool HasDPadUpButton { get; }

Property Value

Type	Description
Boolean	true if this instance has an up digital pad button; otherwise, false.

HasLeftShoulderButton

Gets a Boolean value describing whether this GamePad has a left shoulder button.

Declaration

public readonly bool HasLeftShoulderButton { get; }

Property Value

Type	Description
Boolean	true if this instance has a left shoulder button; otherwise, false.

HasLeftStickButton

Gets a Boolean value describing whether this GamePad has a left stick button.

Declaration

public readonly bool HasLeftStickButton { get; }

Property Value

Type	Description
Boolean	true if this instance has a left stick button; otherwise, false.

HasLeftTrigger

Gets a Boolean value describing whether this GamePad has a left trigger.

Declaration

public readonly bool HasLeftTrigger { get; }

Property Value

Type	Description
Boolean	true if this instance has a left trigger; otherwise, false.

HasLeftVibrationMotor

Gets a Boolean value describing whether this GamePad has a low-frequency vibration motor.

Declaration

public readonly bool HasLeftVibrationMotor { get; }

Property Value

Type	Description
Boolean	true if this instance has a low-frequency vibration motor; otherwise, false.

HasLeftXThumbStick

Gets a Boolean value describing whether this GamePad has a left thumbstick with a x-axis.

Declaration

public readonly bool HasLeftXThumbStick { get; }

Property Value

Type	Description
Boolean	true if this instance has a left thumbstick with a x-axis; otherwise, false.

HasLeftYThumbStick

Gets a Boolean value describing whether this GamePad has a left thumbstick with a y-axis.

Declaration

public readonly bool HasLeftYThumbStick { get; }

Property Value

Type	Description
Boolean	true if this instance has a left thumbstick with a y-axis; otherwise, false.

HasRightShoulderButton

Gets a Boolean value describing whether this GamePad has a right shoulder button.

Declaration

public readonly bool HasRightShoulderButton { get; }

Property Value

Type	Description
Boolean	true if this instance has a right shoulder button; otherwise, false.

HasRightStickButton

Gets a Boolean value describing whether this GamePad has a right stick button.

Declaration

public readonly bool HasRightStickButton { get; }

Property Value

Type	Description
Boolean	true if this instance has a right stick button; otherwise, false.

HasRightTrigger

Gets a Boolean value describing whether this GamePad has a right trigger.

Declaration

public readonly bool HasRightTrigger { get; }

Property Value

Type	Description
Boolean	true if this instance has a right trigger; otherwise, false.

HasRightVibrationMotor

Gets a Boolean value describing whether this GamePad has a high-frequency vibration motor.

Declaration

public readonly bool HasRightVibrationMotor { get; }

Property Value

Type	Description
Boolean	true if this instance has a high frequency vibration motor; otherwise, false.

HasRightXThumbStick

Gets a Boolean value describing whether this GamePad has a right thumbstick with a x-axis.

Declaration

public readonly bool HasRightXThumbStick { get; }

Property Value

Type	Description
Boolean	true if this instance has a right thumbstick with a x-axis; otherwise, false.

HasRightYThumbStick

Gets a Boolean value describing whether this GamePad has a right thumbstick with a y-axis.

Declaration

public readonly bool HasRightYThumbStick { get; }

Property Value

Type	Description
Boolean	true if this instance has a right thumbstick with a y-axis; otherwise, false.

HasStartButton

Gets a Boolean value describing whether this GamePad has a start button.

Declaration

public readonly bool HasStartButton { get; }

Property Value

Type	Description
Boolean	true if this instance has a start button; otherwise, false.

HasVoiceSupport

Gets a Boolean value describing whether this GamePad has a microphone input.

Declaration

public readonly bool HasVoiceSupport { get; }

Property Value

Type	Description
Boolean	true if this instance has a microphone input; otherwise, false.

HasXButton

Gets a Boolean value describing whether this GamePad has a X button.

Declaration

public readonly bool HasXButton { get; }

Property Value

Type	Description
Boolean	true if this instance has a X button; otherwise, false.

HasYButton

Gets a Boolean value describing whether this GamePad has a Y button.

Declaration

public readonly bool HasYButton { get; }

Property Value

Type	Description
Boolean	true if this instance has a Y button; otherwise, false.

IsConnected

Gets a Boolean value describing whether this GamePad is currently connected.

Declaration

public readonly bool IsConnected { get; }

Property Value

Type	Description
Boolean	true if this instance is currently connected; otherwise, false.

IsMapped

Gets a Boolean value describing whether a valid button configuration exists for this GamePad in the GamePad configuration database.

Declaration

public readonly bool IsMapped { get; }

Property Value

Type	Description
Boolean

Methods

Equals(GamePadCapabilities)

Determines whether the specified GamePadCapabilities is equal to the current GamePadCapabilities.

Declaration

public bool Equals(GamePadCapabilities other)

Parameters

Type	Name	Description
GamePadCapabilities	other	The GamePadCapabilities to compare with the current GamePadCapabilities.

Returns

Type	Description
Boolean	true if the specified GamePadCapabilities is equal to the current GamePadCapabilities; otherwise, false.

Equals(Object)

Determines whether the specified Object is equal to the current GamePadCapabilities.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj	The Object to compare with the current GamePadCapabilities.

Returns

Type	Description
Boolean	true if the specified Object is equal to the current GamePadCapabilities; otherwise, false.

Overrides

ValueType.Equals(Object)

GetHashCode()

Serves as a hash function for a GamePadCapabilities object.

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32	A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a hash table.

Overrides

ValueType.GetHashCode()

ToString()

Returns a String that represents the current GamePadCapabilities.

Declaration

public override string ToString()

Returns

Type	Description
String	A String that represents the current GamePadCapabilities.

Overrides

ValueType.ToString()

Operators

Equality(GamePadCapabilities, GamePadCapabilities)

Declaration

public static bool operator ==(GamePadCapabilities left, GamePadCapabilities right)

Parameters

Type	Name	Description
GamePadCapabilities	left	A GamePadCapabilities structure to test for equality.
GamePadCapabilities	right	A GamePadCapabilities structure to test for equality.

Returns

Type	Description
Boolean

Inequality(GamePadCapabilities, GamePadCapabilities)

Declaration

public static bool operator !=(GamePadCapabilities left, GamePadCapabilities right)

Parameters

Type	Name	Description
GamePadCapabilities	left	A GamePadCapabilities structure to test for inequality.
GamePadCapabilities	right	A GamePadCapabilities structure to test for inequality.

Returns

Type	Description
Boolean

Implements

System.IEquatable<T>