Show / Hide Table of Contents

Struct GamePadCapabilities

Describes the capabilities of a GamePad input device.

Implements
System.IEquatable<GamePadCapabilities>
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: OpenTK.Input
Assembly: cs.temp.dll.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 GamePadType GamePadType { get; }
Property Value
Type Description
GamePadType

The GamePadType of the connected input device.

HasAButton

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

Declaration
public bool HasAButton { get; }
Property Value
Type Description
System.Boolean

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

HasBackButton

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

Declaration
public bool HasBackButton { get; }
Property Value
Type Description
System.Boolean

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

HasBButton

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

Declaration
public bool HasBButton { get; }
Property Value
Type Description
System.Boolean

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

HasBigButton

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

Declaration
public bool HasBigButton { get; }
Property Value
Type Description
System.Boolean

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

HasDPadDownButton

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

Declaration
public bool HasDPadDownButton { get; }
Property Value
Type Description
System.Boolean

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

HasDPadLeftButton

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

Declaration
public bool HasDPadLeftButton { get; }
Property Value
Type Description
System.Boolean

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

HasDPadRightButton

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

Declaration
public bool HasDPadRightButton { get; }
Property Value
Type Description
System.Boolean

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

HasDPadUpButton

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

Declaration
public bool HasDPadUpButton { get; }
Property Value
Type Description
System.Boolean

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

HasLeftShoulderButton

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

Declaration
public bool HasLeftShoulderButton { get; }
Property Value
Type Description
System.Boolean

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

HasLeftStickButton

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

Declaration
public bool HasLeftStickButton { get; }
Property Value
Type Description
System.Boolean

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

HasLeftTrigger

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

Declaration
public bool HasLeftTrigger { get; }
Property Value
Type Description
System.Boolean

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

HasLeftVibrationMotor

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

Declaration
public bool HasLeftVibrationMotor { get; }
Property Value
Type Description
System.Boolean

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

HasLeftXThumbStick

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

Declaration
public bool HasLeftXThumbStick { get; }
Property Value
Type Description
System.Boolean

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

HasLeftYThumbStick

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

Declaration
public bool HasLeftYThumbStick { get; }
Property Value
Type Description
System.Boolean

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

HasRightShoulderButton

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

Declaration
public bool HasRightShoulderButton { get; }
Property Value
Type Description
System.Boolean

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

HasRightStickButton

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

Declaration
public bool HasRightStickButton { get; }
Property Value
Type Description
System.Boolean

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

HasRightTrigger

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

Declaration
public bool HasRightTrigger { get; }
Property Value
Type Description
System.Boolean

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

HasRightVibrationMotor

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

Declaration
public bool HasRightVibrationMotor { get; }
Property Value
Type Description
System.Boolean

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

HasRightXThumbStick

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

Declaration
public bool HasRightXThumbStick { get; }
Property Value
Type Description
System.Boolean

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

HasRightYThumbStick

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

Declaration
public bool HasRightYThumbStick { get; }
Property Value
Type Description
System.Boolean

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

HasStartButton

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

Declaration
public bool HasStartButton { get; }
Property Value
Type Description
System.Boolean

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

HasVoiceSupport

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

Declaration
public bool HasVoiceSupport { get; }
Property Value
Type Description
System.Boolean

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

HasXButton

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

Declaration
public bool HasXButton { get; }
Property Value
Type Description
System.Boolean

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

HasYButton

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

Declaration
public bool HasYButton { get; }
Property Value
Type Description
System.Boolean

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

IsConnected

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

Declaration
public bool IsConnected { get; }
Property Value
Type Description
System.Boolean

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

IsMapped

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

Declaration
public bool IsMapped { get; }
Property Value
Type Description
System.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
System.Boolean

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

Equals(Object)

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

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj

The System.Object to compare with the current GamePadCapabilities.

Returns
Type Description
System.Boolean

true if the specified System.Object is equal to the current GamePadCapabilities; otherwise, false.

Overrides
System.ValueType.Equals(System.Object)

GetHashCode()

Serves as a hash function for a GamePadCapabilities object.

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

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

Overrides
System.ValueType.GetHashCode()

ToString()

Returns a System.String that represents the current GamePadCapabilities.

Declaration
public override string ToString()
Returns
Type Description
System.String

A System.String that represents the current GamePadCapabilities.

Overrides
System.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
System.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
System.Boolean

Implements

System.IEquatable<T>
Back to top Copyright © 2015-2017 Microsoft
Generated by DocFX