Struct GamePadCapabilities

Namespace

Microsoft.Xna.Framework.Input

Assembly

MonoGame.Framework.dll

A stuct that represents the controller capabilities.

public struct GamePadCapabilities

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

DisplayName

Gets the gamepad display name.

This property is not available in XNA.

public readonly string DisplayName { get; }

Property Value

string

String representing the display name of the gamepad.

GamePadType

Gets the type of the controller.

public readonly GamePadType GamePadType { get; }

Property Value

GamePadType

A GamePadType representing the controller type..

HasAButton

Gets a value indicating whether the controller has the button A.

public readonly bool HasAButton { get; }

Property Value

bool

true if it has the button A; otherwise, false.

HasBButton

Gets a value indicating whether the controller has the button B.

public readonly bool HasBButton { get; }

Property Value

bool

true if it has the button B; otherwise, false.

HasBackButton

Gets a value indicating whether the controller has the button Back.

public readonly bool HasBackButton { get; }

Property Value

bool

true if it has the button Back; otherwise, false.

HasBigButton

Gets a value indicating whether the controller has the guide button.

public readonly bool HasBigButton { get; }

Property Value

bool

true if it has the guide button; otherwise, false.

HasDPadDownButton

Gets a value indicating whether the controller has the directional pad down button.

public readonly bool HasDPadDownButton { get; }

Property Value

bool

true if it has the directional pad down button; otherwise, false.

HasDPadLeftButton

Gets a value indicating whether the controller has the directional pad left button.

public readonly bool HasDPadLeftButton { get; }

Property Value

bool

true if it has the directional pad left button; otherwise, false.

HasDPadRightButton

Gets a value indicating whether the controller has the directional pad right button.

public readonly bool HasDPadRightButton { get; }

Property Value

bool

true if it has the directional pad right button; otherwise, false.

HasDPadUpButton

Gets a value indicating whether the controller has the directional pad up button.

public readonly bool HasDPadUpButton { get; }

Property Value

bool

true if it has the directional pad up button; otherwise, false.

HasLeftShoulderButton

Gets a value indicating whether the controller has the left shoulder button.

public readonly bool HasLeftShoulderButton { get; }

Property Value

bool

true if it has the left shoulder button; otherwise, false.

HasLeftStickButton

Gets a value indicating whether the controller has the left stick button.

public readonly bool HasLeftStickButton { get; }

Property Value

bool

true if it has the left stick button; otherwise, false.

HasLeftTrigger

Gets a value indicating whether the controller has the left trigger button.

public readonly bool HasLeftTrigger { get; }

Property Value

bool

true if it has the left trigger button; otherwise, false.

HasLeftVibrationMotor

Gets a value indicating whether the controller has the left vibration motor.

public readonly bool HasLeftVibrationMotor { get; }

Property Value

bool

true if it has the left vibration motor; otherwise, false.

HasLeftXThumbStick

Gets a value indicating whether the controller has X axis for the left stick (thumbstick) button.

public readonly bool HasLeftXThumbStick { get; }

Property Value

bool

true if it has X axis for the left stick (thumbstick) button; otherwise, false.

HasLeftYThumbStick

Gets a value indicating whether the controller has Y axis for the left stick (thumbstick) button.

public readonly bool HasLeftYThumbStick { get; }

Property Value

bool

true if it has Y axis for the left stick (thumbstick) button; otherwise, false.

HasRightShoulderButton

Gets a value indicating whether the controller has the right shoulder button.

public readonly bool HasRightShoulderButton { get; }

Property Value

bool

true if it has the right shoulder button; otherwise, false.

HasRightStickButton

Gets a value indicating whether the controller has the right stick button.

public readonly bool HasRightStickButton { get; }

Property Value

bool

true if it has the right stick button; otherwise, false.

HasRightTrigger

Gets a value indicating whether the controller has the right trigger button.

public readonly bool HasRightTrigger { get; }

Property Value

bool

true if it has the right trigger button; otherwise, false.

HasRightVibrationMotor

Gets a value indicating whether the controller has the right vibration motor.

public readonly bool HasRightVibrationMotor { get; }

Property Value

bool

true if it has the right vibration motor; otherwise, false.

HasRightXThumbStick

Gets a value indicating whether the controller has X axis for the right stick (thumbstick) button.

public readonly bool HasRightXThumbStick { get; }

Property Value

bool

true if it has X axis for the right stick (thumbstick) button; otherwise, false.

HasRightYThumbStick

Gets a value indicating whether the controller has Y axis for the right stick (thumbstick) button.

public readonly bool HasRightYThumbStick { get; }

Property Value

bool

true if it has Y axis for the right stick (thumbstick) button; otherwise, false.

HasStartButton

Gets a value indicating whether the controller has the button Start.

public readonly bool HasStartButton { get; }

Property Value

bool

true if it has the button Start; otherwise, false.

HasVoiceSupport

Gets a value indicating whether the controller has a microphone.

public readonly bool HasVoiceSupport { get; }

Property Value

bool

true if it has a microphone; otherwise, false.

HasXButton

Gets a value indicating whether the controller has the button X.

public readonly bool HasXButton { get; }

Property Value

bool

true if it has the button X; otherwise, false.

HasYButton

Gets a value indicating whether the controller has the button Y.

public readonly bool HasYButton { get; }

Property Value

bool

true if it has the button Y; otherwise, false.

Identifier

Gets the unique identifier of the gamepad.

This property is not available in XNA.

public readonly string Identifier { get; }

Property Value

string

String representing the unique identifier of the gamepad.

IsConnected

Gets a value indicating if the controller is connected.

public readonly bool IsConnected { get; }

Property Value

bool

true if it is connected; otherwise, false.

Methods

Equals(object)

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

public override bool Equals(object obj)

Parameters

obj object

The object to compare with the current GamePadCapabilities.

Returns

bool

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

GetHashCode()

Serves as a hash function for a GamePadCapabilities object.

public override int GetHashCode()

Returns

int

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

ToString()

Returns a string that represents the current GamePadCapabilities.

public override string ToString()

Returns

string

A string that represents the current GamePadCapabilities.

Operators

operator ==(GamePadCapabilities, GamePadCapabilities)

Determines whether a specified instance of GamePadCapabilities is equal to another specified GamePadCapabilities.

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

Parameters

left GamePadCapabilities

The first GamePadCapabilities to compare.

right GamePadCapabilities

The second GamePadCapabilities to compare.

Returns

bool

true if left and right are equal; otherwise, false.

operator !=(GamePadCapabilities, GamePadCapabilities)

Determines whether a specified instance of GamePadCapabilities is not equal to another specified GamePadCapabilities.

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

Parameters

left GamePadCapabilities

The first GamePadCapabilities to compare.

right GamePadCapabilities

The second GamePadCapabilities to compare.

Returns

bool

true if left and right are not equal; otherwise, false.