Skip to content

Class KeyNames

Namespace: Apogee.Input
Assembly: Apogee.Input.dll

The names keys go by in bindings. They name the physical key by its place on a US QWERTY keyboard (SDL's scancodes), so a binding means the same place on every layout. The left and right Ctrl, Shift, Alt and Meta share a name.

public static class KeyNames

Inheritance

object ← KeyNames

Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()

Properties

All

Every name, once (the left key stands for a pair).

public static IEnumerable<string> All { get; }

Property Value

IEnumerable<string>

Methods

IsModifier(string)

True for Ctrl, Shift, Alt and Meta, which are modifiers when held with another input.

public static bool IsModifier(string name)

Parameters

name string

Returns

bool

NameOf(Scancode)

The name of a key, or null for one that bindings do not name (media keys, international keys…).

public static string? NameOf(Scancode key)

Parameters

key Scancode

Returns

string?

TryParse(string, out Scancode, out string?)

Reads a name (any case) into the key (the left one of a pair) and the name as it is written.

public static bool TryParse(string text, out Scancode key, out string? name)

Parameters

text string

key Scancode

name string?

Returns

bool