Struct JoystickCapabilities

Namespace

Microsoft.Xna.Framework.Input

Assembly

MonoGame.Framework.dll

Describes joystick capabilities.

public struct JoystickCapabilities

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

AxisCount

Gets the axis count.

public readonly int AxisCount { get; }

Property Value

int

The number of axes that the joystick possesses.

ButtonCount

Gets the button count.

public readonly int ButtonCount { get; }

Property Value

int

The number of buttons that the joystick possesses.

DisplayName

Gets the joystick's display name.

public readonly string DisplayName { get; }

Property Value

string

String representing the display name of the joystick.

HatCount

Gets the hat count.

public readonly int HatCount { get; }

Property Value

int

The number of hats/dpads that the joystick possesses.

Identifier

Gets the unique identifier of the joystick.

public readonly string Identifier { get; }

Property Value

string

String representing the unique identifier of the joystick.

IsConnected

Gets a value indicating whether the joystick is connected.

public readonly bool IsConnected { get; }

Property Value

bool

true if the joystick is connected; otherwise, false.

IsGamepad

Gets a value indicating if the joystick is a gamepad.

public readonly bool IsGamepad { get; }

Property Value

bool

true if the joystick is a gamepad; otherwise, false.

Methods

Equals(object)

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

public override bool Equals(object obj)

Parameters

obj object

The object to compare with the current JoystickCapabilities.

Returns

bool

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

GetHashCode()

Serves as a hash function for a JoystickCapabilities 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 JoystickCapabilities.

public override string ToString()

Returns

string

A string that represents the current JoystickCapabilities.

Operators

operator ==(JoystickCapabilities, JoystickCapabilities)

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

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

Parameters

left JoystickCapabilities

The first JoystickCapabilities to compare.

right JoystickCapabilities

The second JoystickCapabilities to compare.

Returns

bool

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

operator !=(JoystickCapabilities, JoystickCapabilities)

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

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

Parameters

left JoystickCapabilities

The first JoystickCapabilities to compare.

right JoystickCapabilities

The second JoystickCapabilities to compare.

Returns

bool

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