Struct InputKeyData

Namespace

Gloam.Core.Input

Assembly

Gloam.Core.dll

Represents input key data that can be implemented by different input systems (Console, MonoGame, etc.)

public readonly struct InputKeyData : IEquatable<InputKeyData>

Implements

IEquatable<InputKeyData>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

InputKeyData(int, InputModifiers, string?)

public InputKeyData(int keyCode, InputModifiers modifiers = InputModifiers.None, string? name = null)

Parameters

keyCode int

modifiers InputModifiers

name string

InputKeyData(int, string)

public InputKeyData(int keyCode, string name)

Parameters

keyCode int

name string

Properties

KeyCode

The key code identifier

public int KeyCode { get; }

Property Value

int

Modifiers

Optional modifier flags (Shift, Ctrl, Alt, etc.)

public InputModifiers Modifiers { get; }

Property Value

InputModifiers

Name

Human-readable name for debugging

public string Name { get; }

Property Value

string

Methods

Equals(InputKeyData)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(InputKeyData other)

Parameters

other InputKeyData

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object?)

Indicates whether this instance and a specified object are equal.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current instance.

Returns

bool

true if obj and this instance are the same type and represent the same value; otherwise, false.

GetHashCode()

Returns the hash code for this instance.

public override int GetHashCode()

Returns

int

A 32-bit signed integer that is the hash code for this instance.

ToString()

Returns the fully qualified type name of this instance.

public override string ToString()

Returns

string

The fully qualified type name.

Operators

operator ==(InputKeyData, InputKeyData)

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

Parameters

left InputKeyData

right InputKeyData

Returns

bool

operator !=(InputKeyData, InputKeyData)

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

Parameters

left InputKeyData

right InputKeyData

Returns

bool