Key.h

Go to the documentation of this file.

/**
 * @file Key.h
 * @ingroup mnd_input
 * @brief Strongly-typed key codes; values mirror GLFW.
 *
 * Underlying integer values are deliberately identical to `GLFW_KEY_*`
 * and `GLFW_MOUSE_BUTTON_*` (USB HID usage codes for letters/digits) so
 * an `mnd::Key` can be passed straight to GLFW callbacks without a
 * translation table, while still giving the C++ side type safety.
 *
 * @code
 *   if (input.IsKeyDown(mnd::Key::W)) { ... }
 *   if (input.IsMouseButtonPressed(mnd::Key::MouseLeft)) { ... }
 * @endcode
 */
 
#pragma once
 
#include "Types.h"
 
namespace mnd
{
 
/**
 * @ingroup mnd_input
 * @brief Keyboard key + mouse button identifier (GLFW-compatible values).
 */
enum class Key : i16
{
    Unknown = -1,
 
    Space      = 32,
    Apostrophe = 39,
    Comma      = 44,
    Minus      = 45,
    Period     = 46,
    Slash      = 47,
 
    Num0 = 48,
    Num1 = 49,
    Num2 = 50,
    Num3 = 51,
    Num4 = 52,
    Num5 = 53,
    Num6 = 54,
    Num7 = 55,
    Num8 = 56,
    Num9 = 57,
 
    Semicolon = 59,
    Equal     = 61,
 
    A = 65,
    B = 66,
    C = 67,
    D = 68,
    E = 69,
    F = 70,
    G = 71,
    H = 72,
    I = 73,
    J = 74,
    K = 75,
    L = 76,
    M = 77,
    N = 78,
    O = 79,
    P = 80,
    Q = 81,
    R = 82,
    S = 83,
    T = 84,
    U = 85,
    V = 86,
    W = 87,
    X = 88,
    Y = 89,
    Z = 90,
 
    LeftBracket  = 91,
    Backslash    = 92,
    RightBracket = 93,
    GraveAccent  = 96,
 
    Escape    = 256,
    Enter     = 257,
    Tab       = 258,
    Backspace = 259,
    Insert    = 260,
    Delete    = 261,
    Right     = 262,
    Left      = 263,
    Down      = 264,
    Up        = 265,
    PageUp    = 266,
    PageDown  = 267,
    Home      = 268,
    End       = 269,
 
    CapsLock    = 280,
    ScrollLock  = 281,
    NumLock     = 282,
    PrintScreen = 283,
    Pause       = 284,
 
    F1  = 290,
    F2  = 291,
    F3  = 292,
    F4  = 293,
    F5  = 294,
    F6  = 295,
    F7  = 296,
    F8  = 297,
    F9  = 298,
    F10 = 299,
    F11 = 300,
    F12 = 301,
 
    Kp0        = 320,
    Kp1        = 321,
    Kp2        = 322,
    Kp3        = 323,
    Kp4        = 324,
    Kp5        = 325,
    Kp6        = 326,
    Kp7        = 327,
    Kp8        = 328,
    Kp9        = 329,
    KpDecimal  = 330,
    KpDivide   = 331,
    KpMultiply = 332,
    KpSubtract = 333,
    KpAdd      = 334,
    KpEnter    = 335,
    KpEqual    = 336,
 
    LeftShift    = 340,
    LeftControl  = 341,
    LeftAlt      = 342,
    LeftSuper    = 343,
    RightShift   = 344,
    RightControl = 345,
    RightAlt     = 346,
    RightSuper   = 347,
    Menu         = 348,
};
 
enum class MouseButton : i8
{
    Left   = 0,
    Right  = 1,
    Middle = 2,
    Btn4   = 3,
    Btn5   = 4,
    Btn6   = 5,
    Btn7   = 6,
    Btn8   = 7,
};
 
}  // namespace mnd