Class InputBinding

Namespace

Gloam.Core.Input

Assembly

Gloam.Core.dll

Represents a key combination bound to an input action

public record InputBinding : IEquatable<InputBinding>

Inheritance

object

InputBinding

Implements

IEquatable<InputBinding>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

InputBinding(InputAction, InputKeyData, KeyModifiers)

Represents a key combination bound to an input action

public InputBinding(InputAction Action, InputKeyData Key, KeyModifiers Modifiers = KeyModifiers.None)

Parameters

Action InputAction

Key InputKeyData

Modifiers KeyModifiers

Properties

Action

public InputAction Action { get; init; }

Property Value

InputAction

Key

public InputKeyData Key { get; init; }

Property Value

InputKeyData

Modifiers

public KeyModifiers Modifiers { get; init; }

Property Value

KeyModifiers

Methods

Create(InputAction, InputKeyData)

Creates a simple key binding without modifiers

public static InputBinding Create(InputAction action, InputKeyData key)

Parameters

action InputAction

key InputKeyData

Returns

InputBinding

Create(InputAction, InputKeyData, KeyModifiers)

Creates a key binding with modifiers

public static InputBinding Create(InputAction action, InputKeyData key, KeyModifiers modifiers)

Parameters

action InputAction

key InputKeyData

modifiers KeyModifiers

Returns

InputBinding

Matches(IInputDevice, InputKeyData, KeyModifiers)

Checks if this binding matches the current input state

public bool Matches(IInputDevice inputDevice, InputKeyData pressedKey, KeyModifiers currentModifiers)

Parameters

inputDevice IInputDevice

pressedKey InputKeyData

currentModifiers KeyModifiers

Returns

bool