The Open Toolkit library  1.1
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Static Public Member Functions | Public Attributes | Properties | List of all members
OpenTK.Input.GamePadCapabilities Struct Reference

Describes the capabilities of a GamePad input device. More...

Inherits IEquatable< GamePadCapabilities >.

Public Member Functions

override string ToString ()
 Returns a System.String that represents the current OpenTK.Input.GamePadCapabilities. More...
 
override int GetHashCode ()
 Serves as a hash function for a OpenTK.Input.GamePadCapabilities object. More...
 
override bool Equals (object obj)
 Determines whether the specified System.Object is equal to the current OpenTK.Input.GamePadCapabilities. More...
 
bool Equals (GamePadCapabilities other)
 Determines whether the specified OpenTK.Input.GamePadCapabilities is equal to the current OpenTK.Input.GamePadCapabilities. More...
 

Static Public Member Functions

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

Public Attributes

Buttons buttons
 
GamePadAxes axes
 
byte gamepad_type
 
bool is_connected
 

Properties

GamePadType GamePadType [get]
 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. More...
 
bool HasDPadUpButton [get]
 Gets a System.Boolean value describing whether this GamePad has an up digital pad button. More...
 
bool HasDPadDownButton [get]
 Gets a System.Boolean value describing whether this GamePad has a down digital pad button. More...
 
bool HasDPadLeftButton [get]
 Gets a System.Boolean value describing whether this GamePad has a left digital pad button. More...
 
bool HasDPadRightButton [get]
 Gets a System.Boolean value describing whether this GamePad has a right digital pad button. More...
 
bool HasAButton [get]
 Gets a System.Boolean value describing whether this GamePad has an A button. More...
 
bool HasBButton [get]
 Gets a System.Boolean value describing whether this GamePad has a B button. More...
 
bool HasXButton [get]
 Gets a System.Boolean value describing whether this GamePad has a X button. More...
 
bool HasYButton [get]
 Gets a System.Boolean value describing whether this GamePad has a Y button. More...
 
bool HasLeftStickButton [get]
 Gets a System.Boolean value describing whether this GamePad has a left stick button. More...
 
bool HasRightStickButton [get]
 Gets a System.Boolean value describing whether this GamePad has a right stick button. More...
 
bool HasLeftShoulderButton [get]
 Gets a System.Boolean value describing whether this GamePad has a left shoulder button. More...
 
bool HasRightShoulderButton [get]
 Gets a System.Boolean value describing whether this GamePad has a right shoulder button. More...
 
bool HasBackButton [get]
 Gets a System.Boolean value describing whether this GamePad has a back button. More...
 
bool HasBigButton [get]
 Gets a System.Boolean value describing whether this GamePad has a big button. (also known as "guide" or "home" button). More...
 
bool HasStartButton [get]
 Gets a System.Boolean value describing whether this GamePad has a start button. More...
 
bool HasLeftXThumbStick [get]
 Gets a System.Boolean value describing whether this GamePad has a left thumbstick with a x-axis. More...
 
bool HasLeftYThumbStick [get]
 Gets a System.Boolean value describing whether this GamePad has a left thumbstick with a y-axis. More...
 
bool HasRightXThumbStick [get]
 Gets a System.Boolean value describing whether this GamePad has a right thumbstick with a x-axis. More...
 
bool HasRightYThumbStick [get]
 Gets a System.Boolean value describing whether this GamePad has a right thumbstick with a y-axis. More...
 
bool HasLeftTrigger [get]
 Gets a System.Boolean value describing whether this GamePad has a left trigger. More...
 
bool HasRightTrigger [get]
 Gets a System.Boolean value describing whether this GamePad has a right trigger. More...
 
bool HasLeftVibrationMotor [get]
 Gets a System.Boolean value describing whether this GamePad has a low-frequency vibration motor. More...
 
bool HasRightVibrationMotor [get]
 Gets a System.Boolean value describing whether this GamePad has a high-frequency vibration motor. More...
 
bool HasVoiceSupport [get]
 Gets a System.Boolean value describing whether this GamePad has a microphone input. More...
 
bool IsConnected [get]
 Gets a System.Boolean value describing whether this GamePad is currently connected. More...
 

Detailed Description

Describes the capabilities of a GamePad input device.

Member Function Documentation

override bool OpenTK.Input.GamePadCapabilities.Equals ( object  obj)

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

Parameters
objThe System.Object to compare with the current OpenTK.Input.GamePadCapabilities.
Returns
true if the specified System.Object is equal to the current OpenTK.Input.GamePadCapabilities; otherwise, false.
bool OpenTK.Input.GamePadCapabilities.Equals ( GamePadCapabilities  other)

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

Parameters
otherThe OpenTK.Input.GamePadCapabilities to compare with the current OpenTK.Input.GamePadCapabilities.
Returns
true if the specified OpenTK.Input.GamePadCapabilities is equal to the current OpenTK.Input.GamePadCapabilities; otherwise, false.
override int OpenTK.Input.GamePadCapabilities.GetHashCode ( )

Serves as a hash function for a OpenTK.Input.GamePadCapabilities object.

Returns
A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a hash table.
static bool OpenTK.Input.GamePadCapabilities.operator!= ( GamePadCapabilities  left,
GamePadCapabilities  right 
)
static
Parameters
leftA GamePadCapabilities structure to test for inequality.
rightA GamePadCapabilities structure to test for inequality.
static bool OpenTK.Input.GamePadCapabilities.operator== ( GamePadCapabilities  left,
GamePadCapabilities  right 
)
static
Parameters
leftA GamePadCapabilities structure to test for equality.
rightA GamePadCapabilities structure to test for equality.
override string OpenTK.Input.GamePadCapabilities.ToString ( )

Returns a System.String that represents the current OpenTK.Input.GamePadCapabilities.

Returns
A System.String that represents the current OpenTK.Input.GamePadCapabilities.

Property Documentation

GamePadType OpenTK.Input.GamePadCapabilities.GamePadType
get

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.

The GamePadType of the connected input device.

bool OpenTK.Input.GamePadCapabilities.HasAButton
get

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

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

bool OpenTK.Input.GamePadCapabilities.HasBackButton
get

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

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

bool OpenTK.Input.GamePadCapabilities.HasBButton
get

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

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

bool OpenTK.Input.GamePadCapabilities.HasBigButton
get

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

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

bool OpenTK.Input.GamePadCapabilities.HasDPadDownButton
get

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

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

bool OpenTK.Input.GamePadCapabilities.HasDPadLeftButton
get

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

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

bool OpenTK.Input.GamePadCapabilities.HasDPadRightButton
get

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

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

bool OpenTK.Input.GamePadCapabilities.HasDPadUpButton
get

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

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

bool OpenTK.Input.GamePadCapabilities.HasLeftShoulderButton
get

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

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

bool OpenTK.Input.GamePadCapabilities.HasLeftStickButton
get

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

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

bool OpenTK.Input.GamePadCapabilities.HasLeftTrigger
get

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

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

bool OpenTK.Input.GamePadCapabilities.HasLeftVibrationMotor
get

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

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

bool OpenTK.Input.GamePadCapabilities.HasLeftXThumbStick
get

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

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

bool OpenTK.Input.GamePadCapabilities.HasLeftYThumbStick
get

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

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

bool OpenTK.Input.GamePadCapabilities.HasRightShoulderButton
get

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

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

bool OpenTK.Input.GamePadCapabilities.HasRightStickButton
get

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

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

bool OpenTK.Input.GamePadCapabilities.HasRightTrigger
get

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

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

bool OpenTK.Input.GamePadCapabilities.HasRightVibrationMotor
get

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

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

bool OpenTK.Input.GamePadCapabilities.HasRightXThumbStick
get

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

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

bool OpenTK.Input.GamePadCapabilities.HasRightYThumbStick
get

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

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

bool OpenTK.Input.GamePadCapabilities.HasStartButton
get

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

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

bool OpenTK.Input.GamePadCapabilities.HasVoiceSupport
get

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

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

bool OpenTK.Input.GamePadCapabilities.HasXButton
get

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

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

bool OpenTK.Input.GamePadCapabilities.HasYButton
get

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

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

bool OpenTK.Input.GamePadCapabilities.IsConnected
get

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

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