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

Describes the state of a GamePad directional pad. More...

Inherits IEquatable< GamePadDPad >.

Public Types

enum  DPadButtons : byte { Up = Buttons.DPadUp, Down = Buttons.DPadDown, Left = Buttons.DPadLeft, Right = Buttons.DPadRight }
 

Public Member Functions

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

Static Public Member Functions

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

Public Attributes

DPadButtons buttons
 

Properties

ButtonState Up [get]
 Gets the ButtonState for the up button. More...
 
ButtonState Down [get]
 Gets the ButtonState for the down button. More...
 
ButtonState Left [get]
 Gets the ButtonState for the left button. More...
 
ButtonState Right [get]
 Gets the ButtonState for the right button. More...
 
bool IsUp [get, set]
 Gets a value indicating whether the up button is pressed. More...
 
bool IsDown [get, set]
 Gets a value indicating whether the down button is pressed. More...
 
bool IsLeft [get, set]
 Gets a value indicating whether the left button is pressed. More...
 
bool IsRight [get, set]
 Gets a value indicating whether the right button is pressed. More...
 

Detailed Description

Describes the state of a GamePad directional pad.

Member Function Documentation

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

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

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

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

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

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

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

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

Property Documentation

ButtonState OpenTK.Input.GamePadDPad.Down
get

Gets the ButtonState for the down button.

ButtonState.Pressed if the down button is pressed; otherwise, ButtonState.Released.

bool OpenTK.Input.GamePadDPad.IsDown
getset

Gets a value indicating whether the down button is pressed.

true if the down button is pressed; otherwise, false.

bool OpenTK.Input.GamePadDPad.IsLeft
getset

Gets a value indicating whether the left button is pressed.

true if the left button is pressed; otherwise, false.

bool OpenTK.Input.GamePadDPad.IsRight
getset

Gets a value indicating whether the right button is pressed.

true if the right button is pressed; otherwise, false.

bool OpenTK.Input.GamePadDPad.IsUp
getset

Gets a value indicating whether the up button is pressed.

true if the up button is pressed; otherwise, false.

ButtonState OpenTK.Input.GamePadDPad.Left
get

Gets the ButtonState for the left button.

ButtonState.Pressed if the left button is pressed; otherwise, ButtonState.Released.

ButtonState OpenTK.Input.GamePadDPad.Right
get

Gets the ButtonState for the right button.

ButtonState.Pressed if the right button is pressed; otherwise, ButtonState.Released.

ButtonState OpenTK.Input.GamePadDPad.Up
get

Gets the ButtonState for the up button.

ButtonState.Pressed if the up button is pressed; otherwise, ButtonState.Released.