Show / Hide Table of Contents

Struct JoystickHatState

Describes the state of a joystick hat.

Implements
IEquatable<JoystickHatState>
Inherited Members
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetType()
Namespace: OpenTK.Input
Assembly: OpenTK.dll
Syntax
public struct JoystickHatState : IEquatable<JoystickHatState>

Properties

IsDown

Gets a Boolean indicating whether this hat lies in the bottom hemicircle.

Declaration
public readonly bool IsDown { get; }
Property Value
Type Description
Boolean

true if this hat lies in the bottom hemicircle; otherwise, false.

IsLeft

Gets a Boolean indicating whether this hat lies in the left hemicircle.

Declaration
public readonly bool IsLeft { get; }
Property Value
Type Description
Boolean

true if this hat lies in the left hemicircle; otherwise, false.

IsRight

Gets a Boolean indicating whether this hat lies in the right hemicircle.

Declaration
public readonly bool IsRight { get; }
Property Value
Type Description
Boolean

true if this hat lies in the right hemicircle; otherwise, false.

IsUp

Gets a Boolean indicating whether this hat lies in the top hemicircle.

Declaration
public readonly bool IsUp { get; }
Property Value
Type Description
Boolean

true if this hat lies in the top hemicircle; otherwise, false.

Position

Gets a HatPosition value indicating the position of this hat.

Declaration
public readonly HatPosition Position { get; }
Property Value
Type Description
HatPosition

The position.

Methods

Equals(JoystickHatState)

Determines whether the specified JoystickHatState is equal to the current JoystickHatState.

Declaration
public bool Equals(JoystickHatState other)
Parameters
Type Name Description
JoystickHatState other

The JoystickHatState to compare with the current JoystickHatState.

Returns
Type Description
Boolean

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

Equals(Object)

Determines whether the specified Object is equal to the current JoystickHatState.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj

The Object to compare with the current JoystickHatState.

Returns
Type Description
Boolean

true if the specified Object is equal to the current JoystickHatState; otherwise, false.

Overrides
ValueType.Equals(Object)

GetHashCode()

Serves as a hash function for a JoystickHatState object.

Declaration
public override int GetHashCode()
Returns
Type Description
Int32

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

Overrides
ValueType.GetHashCode()

ToString()

Returns a String that represents the current JoystickHatState.

Declaration
public override string ToString()
Returns
Type Description
String

A String that represents the current JoystickHatState.

Overrides
ValueType.ToString()

Implements

System.IEquatable<T>
In This Article
Back to top Generated by DocFX