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.GamePadButtons Struct Reference

Describes the ButtonState of GamePad Buttons. More...

Inherits IEquatable< GamePadButtons >.

Public Member Functions

 GamePadButtons (Buttons state)
 Initializes a new instance of the OpenTK.Input.GamePadButtons structure. More...
 
override string ToString ()
 Returns a System.String that represents the current OpenTK.Input.GamePadButtons. More...
 
override int GetHashCode ()
 Serves as a hash function for a OpenTK.Input.GamePadButtons object. More...
 
override bool Equals (object obj)
 Determines whether the specified System.Object is equal to the current OpenTK.Input.GamePadButtons. More...
 
bool Equals (GamePadButtons other)
 Determines whether the specified OpenTK.Input.GamePadButtons is equal to the current OpenTK.Input.GamePadButtons. More...
 
ButtonState GetButton (Buttons b)
 

Static Public Member Functions

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

Public Attributes

Buttons buttons
 

Properties

ButtonState A [get]
 Gets the ButtonState for the A button. More...
 
ButtonState B [get]
 Gets the ButtonState for the B button. More...
 
ButtonState X [get]
 Gets the ButtonState for the X button. More...
 
ButtonState Y [get]
 Gets the ButtonState for the Y button. More...
 
ButtonState Back [get]
 Gets the ButtonState for the Back button. More...
 
ButtonState BigButton [get]
 Gets the ButtonState for the big button. This button is also known as Home or Guide. More...
 
ButtonState LeftShoulder [get]
 Gets the ButtonState for the left shoulder button. More...
 
ButtonState LeftStick [get]
 Gets the ButtonState for the left stick button. This button represents a left stick that is pressed in. More...
 
ButtonState RightShoulder [get]
 Gets the ButtonState for the right shoulder button. More...
 
ButtonState RightStick [get]
 Gets the ButtonState for the right stick button. This button represents a right stick that is pressed in. More...
 
ButtonState Start [get]
 Gets the ButtonState for the starth button. More...
 

Detailed Description

Describes the ButtonState of GamePad Buttons.

Constructor & Destructor Documentation

OpenTK.Input.GamePadButtons.GamePadButtons ( Buttons  state)

Initializes a new instance of the OpenTK.Input.GamePadButtons structure.

Parameters
stateA bitmask containing the button state.

Member Function Documentation

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

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

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

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

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

Serves as a hash function for a OpenTK.Input.GamePadButtons 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.GamePadButtons.operator!= ( GamePadButtons  left,
GamePadButtons  right 
)
static
Parameters
leftA GamePadButtons instance to test for inequality.
rightA GamePadButtons instance to test for inequality.
static bool OpenTK.Input.GamePadButtons.operator== ( GamePadButtons  left,
GamePadButtons  right 
)
static
Parameters
leftA GamePadButtons instance to test for equality.
rightA GamePadButtons instance to test for equality.
override string OpenTK.Input.GamePadButtons.ToString ( )

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

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

Property Documentation

ButtonState OpenTK.Input.GamePadButtons.A
get

Gets the ButtonState for the A button.

ButtonState OpenTK.Input.GamePadButtons.B
get

Gets the ButtonState for the B button.

ButtonState OpenTK.Input.GamePadButtons.Back
get

Gets the ButtonState for the Back button.

ButtonState OpenTK.Input.GamePadButtons.BigButton
get

Gets the ButtonState for the big button. This button is also known as Home or Guide.

ButtonState OpenTK.Input.GamePadButtons.LeftShoulder
get

Gets the ButtonState for the left shoulder button.

ButtonState OpenTK.Input.GamePadButtons.LeftStick
get

Gets the ButtonState for the left stick button. This button represents a left stick that is pressed in.

ButtonState OpenTK.Input.GamePadButtons.RightShoulder
get

Gets the ButtonState for the right shoulder button.

ButtonState OpenTK.Input.GamePadButtons.RightStick
get

Gets the ButtonState for the right stick button. This button represents a right stick that is pressed in.

ButtonState OpenTK.Input.GamePadButtons.Start
get

Gets the ButtonState for the starth button.

ButtonState OpenTK.Input.GamePadButtons.X
get

Gets the ButtonState for the X button.

ButtonState OpenTK.Input.GamePadButtons.Y
get

Gets the ButtonState for the Y button.