API reference
Preparing search index…

ImGui.ImGuiKey

Const
ImGuiKey: Readonly<
    {
        "0": 536;
        "1": 537;
        "2": 538;
        "3": 539;
        "4": 540;
        "5": 541;
        "6": 542;
        "7": 543;
        "8": 544;
        "9": 545;
        A: 546;
        Apostrophe: 596;
        AppBack: 629;
        AppForward: 630;
        B: 547;
        Backslash: 604;
        Backspace: 523;
        C: 548;
        CapsLock: 607;
        Comma: 597;
        COUNT: 667;
        D: 549;
        Delete: 522;
        DownArrow: 516;
        E: 550;
        End: 520;
        Enter: 525;
        Equal: 602;
        Escape: 526;
        F: 551;
        F1: 572;
        F10: 581;
        F11: 582;
        F12: 583;
        F13: 584;
        F14: 585;
        F15: 586;
        F16: 587;
        F17: 588;
        F18: 589;
        F19: 590;
        F2: 573;
        F20: 591;
        F21: 592;
        F22: 593;
        F23: 594;
        F24: 595;
        F3: 574;
        F4: 575;
        F5: 576;
        F6: 577;
        F7: 578;
        F8: 579;
        F9: 580;
        G: 552;
        GamepadBack: 633;
        GamepadDpadDown: 641;
        GamepadDpadLeft: 638;
        GamepadDpadRight: 639;
        GamepadDpadUp: 640;
        GamepadFaceDown: 637;
        GamepadFaceLeft: 634;
        GamepadFaceRight: 635;
        GamepadFaceUp: 636;
        GamepadL1: 642;
        GamepadL2: 644;
        GamepadL3: 646;
        GamepadLStickDown: 651;
        GamepadLStickLeft: 648;
        GamepadLStickRight: 649;
        GamepadLStickUp: 650;
        GamepadR1: 643;
        GamepadR2: 645;
        GamepadR3: 647;
        GamepadRStickDown: 655;
        GamepadRStickLeft: 652;
        GamepadRStickRight: 653;
        GamepadRStickUp: 654;
        GamepadStart: 632;
        GraveAccent: 606;
        H: 553;
        Home: 519;
        I: 554;
        ImGuiMod_Alt: 16384;
        ImGuiMod_Ctrl: 4096;
        ImGuiMod_Mask_: 61440;
        ImGuiMod_None: 0;
        ImGuiMod_Shift: 8192;
        ImGuiMod_Shortcut: 4096;
        ImGuiMod_Super: 32768;
        Insert: 521;
        J: 555;
        K: 556;
        Keypad0: 612;
        Keypad1: 613;
        Keypad2: 614;
        Keypad3: 615;
        Keypad4: 616;
        Keypad5: 617;
        Keypad6: 618;
        Keypad7: 619;
        Keypad8: 620;
        Keypad9: 621;
        KeypadAdd: 626;
        KeypadDecimal: 622;
        KeypadDivide: 623;
        KeypadEnter: 627;
        KeypadEqual: 628;
        KeypadMultiply: 624;
        KeypadSubtract: 625;
        L: 557;
        LeftAlt: 529;
        LeftArrow: 513;
        LeftBracket: 603;
        LeftCtrl: 527;
        LeftShift: 528;
        LeftSuper: 530;
        M: 558;
        Menu: 535;
        Minus: 598;
        ModAlt: 16384;
        ModCtrl: 4096;
        ModShift: 8192;
        ModSuper: 32768;
        MouseLeft: 656;
        MouseMiddle: 658;
        MouseRight: 657;
        MouseWheelX: 661;
        MouseWheelY: 662;
        MouseX1: 659;
        MouseX2: 660;
        N: 559;
        NamedKey_BEGIN: 512;
        NamedKey_COUNT: 155;
        NamedKey_END: 667;
        None: 0;
        NumLock: 609;
        O: 560;
        Oem102: 631;
        P: 561;
        PageDown: 518;
        PageUp: 517;
        Pause: 611;
        Period: 599;
        PrintScreen: 610;
        Q: 562;
        R: 563;
        ReservedForModAlt: 665;
        ReservedForModCtrl: 663;
        ReservedForModShift: 664;
        ReservedForModSuper: 666;
        RightAlt: 533;
        RightArrow: 514;
        RightBracket: 605;
        RightCtrl: 531;
        RightShift: 532;
        RightSuper: 534;
        S: 564;
        ScrollLock: 608;
        Semicolon: 601;
        Slash: 600;
        Space: 524;
        T: 565;
        Tab: 512;
        U: 566;
        UpArrow: 515;
        V: 567;
        W: 568;
        X: 569;
        Y: 570;
        Z: 571;
    },
> = ...

Named keyboard, gamepad and mouse inputs plus modifier bits for key chords. Native/legacy key codes below NamedKey_BEGIN are not named keys.

Type declaration

  • Readonly0: 536

    Main keyboard digit 0.

  • Readonly1: 537

    Main keyboard digit 1.

  • Readonly2: 538

    Main keyboard digit 2.

  • Readonly3: 539

    Main keyboard digit 3.

  • Readonly4: 540

    Main keyboard digit 4.

  • Readonly5: 541

    Main keyboard digit 5.

  • Readonly6: 542

    Main keyboard digit 6.

  • Readonly7: 543

    Main keyboard digit 7.

  • Readonly8: 544

    Main keyboard digit 8.

  • Readonly9: 545

    Main keyboard digit 9.

  • ReadonlyA: 546

    A key.

  • ReadonlyApostrophe: 596

    Apostrophe key.

  • ReadonlyAppBack: 629

    Application/browser Back key.

  • ReadonlyAppForward: 630

    Application/browser Forward key.

  • ReadonlyB: 547

    B key.

  • ReadonlyBackslash: 604

    Backslash key.

  • ReadonlyBackspace: 523

    Backspace key.

  • ReadonlyC: 548

    C key.

  • ReadonlyCapsLock: 607

    Caps Lock key.

  • ReadonlyComma: 597

    Comma key.

  • ReadonlyCOUNT: 667

    Obsolete exclusive-end sentinel; not the number of named keys.

  • ReadonlyD: 549

    D key.

  • ReadonlyDelete: 522

    Delete key.

  • ReadonlyDownArrow: 516

    Down arrow.

  • ReadonlyE: 550

    E key.

  • ReadonlyEnd: 520

    End key.

  • ReadonlyEnter: 525

    Enter/Return key.

  • ReadonlyEqual: 602

    Equals key.

  • ReadonlyEscape: 526

    Escape key.

  • ReadonlyF: 551

    F key.

  • ReadonlyF1: 572

    F1 function key.

  • ReadonlyF10: 581

    F10 function key.

  • ReadonlyF11: 582

    F11 function key.

  • ReadonlyF12: 583

    F12 function key.

  • ReadonlyF13: 584

    F13 function key.

  • ReadonlyF14: 585

    F14 function key.

  • ReadonlyF15: 586

    F15 function key.

  • ReadonlyF16: 587

    F16 function key.

  • ReadonlyF17: 588

    F17 function key.

  • ReadonlyF18: 589

    F18 function key.

  • ReadonlyF19: 590

    F19 function key.

  • ReadonlyF2: 573

    F2 function key.

  • ReadonlyF20: 591

    F20 function key.

  • ReadonlyF21: 592

    F21 function key.

  • ReadonlyF22: 593

    F22 function key.

  • ReadonlyF23: 594

    F23 function key.

  • ReadonlyF24: 595

    F24 function key.

  • ReadonlyF3: 574

    F3 function key.

  • ReadonlyF4: 575

    F4 function key.

  • ReadonlyF5: 576

    F5 function key.

  • ReadonlyF6: 577

    F6 function key.

  • ReadonlyF7: 578

    F7 function key.

  • ReadonlyF8: 579

    F8 function key.

  • ReadonlyF9: 580

    F9 function key.

  • ReadonlyG: 552

    G key.

  • ReadonlyGamepadBack: 633

    Gamepad Back/View button.

  • ReadonlyGamepadDpadDown: 641

    Gamepad D-pad down.

  • ReadonlyGamepadDpadLeft: 638

    Gamepad D-pad left.

  • ReadonlyGamepadDpadRight: 639

    Gamepad D-pad right.

  • ReadonlyGamepadDpadUp: 640

    Gamepad D-pad up.

  • ReadonlyGamepadFaceDown: 637

    Bottom face button (Xbox A, PlayStation Cross).

  • ReadonlyGamepadFaceLeft: 634

    Left face button (Xbox X, PlayStation Square).

  • ReadonlyGamepadFaceRight: 635

    Right face button (Xbox B, PlayStation Circle).

  • ReadonlyGamepadFaceUp: 636

    Top face button (Xbox Y, PlayStation Triangle).

  • ReadonlyGamepadL1: 642

    Left shoulder button (L1/LB).

  • ReadonlyGamepadL2: 644

    Left analog trigger (L2/LT).

  • ReadonlyGamepadL3: 646

    Left stick press (L3).

  • ReadonlyGamepadLStickDown: 651

    Left stick analog motion downward.

  • ReadonlyGamepadLStickLeft: 648

    Left stick analog motion to the left.

  • ReadonlyGamepadLStickRight: 649

    Left stick analog motion to the right.

  • ReadonlyGamepadLStickUp: 650

    Left stick analog motion upward.

  • ReadonlyGamepadR1: 643

    Right shoulder button (R1/RB).

  • ReadonlyGamepadR2: 645

    Right analog trigger (R2/RT).

  • ReadonlyGamepadR3: 647

    Right stick press (R3).

  • ReadonlyGamepadRStickDown: 655

    Right stick analog motion downward.

  • ReadonlyGamepadRStickLeft: 652

    Right stick analog motion to the left.

  • ReadonlyGamepadRStickRight: 653

    Right stick analog motion to the right.

  • ReadonlyGamepadRStickUp: 654

    Right stick analog motion upward.

  • ReadonlyGamepadStart: 632

    Gamepad Start/Menu button.

  • ReadonlyGraveAccent: 606

    Grave accent/backtick key.

  • ReadonlyH: 553

    H key.

  • ReadonlyHome: 519

    Home key.

  • ReadonlyI: 554

    I key.

  • ReadonlyImGuiMod_Alt: 16384

    Alt/Option chord modifier, either side.

  • ReadonlyImGuiMod_Ctrl: 4096

    Control chord modifier; maps to Command with macOS behaviors enabled.

  • ReadonlyImGuiMod_Mask_: 61440

    Internal mask extracting all key-chord modifier bits.

  • ReadonlyImGuiMod_None: 0

    No key-chord modifiers.

  • ReadonlyImGuiMod_Shift: 8192

    Shift chord modifier, either side.

  • ReadonlyImGuiMod_Shortcut: 4096

    Legacy alias of ImGuiKey.ImGuiMod_Ctrl, including macOS Command mapping.

  • ReadonlyImGuiMod_Super: 32768

    Super chord modifier; maps to Control with macOS behaviors enabled.

  • ReadonlyInsert: 521

    Insert key.

  • ReadonlyJ: 555

    J key.

  • ReadonlyK: 556

    K key.

  • ReadonlyKeypad0: 612

    Numeric keypad 0.

  • ReadonlyKeypad1: 613

    Numeric keypad 1.

  • ReadonlyKeypad2: 614

    Numeric keypad 2.

  • ReadonlyKeypad3: 615

    Numeric keypad 3.

  • ReadonlyKeypad4: 616

    Numeric keypad 4.

  • ReadonlyKeypad5: 617

    Numeric keypad 5.

  • ReadonlyKeypad6: 618

    Numeric keypad 6.

  • ReadonlyKeypad7: 619

    Numeric keypad 7.

  • ReadonlyKeypad8: 620

    Numeric keypad 8.

  • ReadonlyKeypad9: 621

    Numeric keypad 9.

  • ReadonlyKeypadAdd: 626

    Keypad addition key.

  • ReadonlyKeypadDecimal: 622

    Keypad decimal separator.

  • ReadonlyKeypadDivide: 623

    Keypad division key.

  • ReadonlyKeypadEnter: 627

    Keypad Enter key.

  • ReadonlyKeypadEqual: 628

    Keypad equals key.

  • ReadonlyKeypadMultiply: 624

    Keypad multiplication key.

  • ReadonlyKeypadSubtract: 625

    Keypad subtraction key.

  • ReadonlyL: 557

    L key.

  • ReadonlyLeftAlt: 529

    Left Alt/Option key.

  • ReadonlyLeftArrow: 513

    Left arrow.

  • ReadonlyLeftBracket: 603

    Left square bracket key.

  • ReadonlyLeftCtrl: 527

    Left Control key.

  • ReadonlyLeftShift: 528

    Left Shift key.

  • ReadonlyLeftSuper: 530

    Left Windows/Command/Super key.

  • ReadonlyM: 558

    M key.

  • ReadonlyMenu: 535

    Context-menu key.

  • ReadonlyMinus: 598

    Minus key.

  • ReadonlyModAlt: 16384

    Legacy Alt modifier alias; use ImGuiKey.ImGuiMod_Alt.

  • ReadonlyModCtrl: 4096

    Legacy Control modifier alias; use ImGuiKey.ImGuiMod_Ctrl.

  • ReadonlyModShift: 8192

    Legacy Shift modifier alias; use ImGuiKey.ImGuiMod_Shift.

  • ReadonlyModSuper: 32768

    Legacy Super modifier alias; use ImGuiKey.ImGuiMod_Super.

  • ReadonlyMouseLeft: 656

    Left mouse button as a named key.

  • ReadonlyMouseMiddle: 658

    Middle mouse button as a named key.

  • ReadonlyMouseRight: 657

    Right mouse button as a named key.

  • ReadonlyMouseWheelX: 661

    Horizontal mouse wheel axis.

  • ReadonlyMouseWheelY: 662

    Vertical mouse wheel axis.

  • ReadonlyMouseX1: 659

    First extra mouse button.

  • ReadonlyMouseX2: 660

    Second extra mouse button.

  • ReadonlyN: 559

    N key.

  • ReadonlyNamedKey_BEGIN: 512

    Internal inclusive start of named keys; shares Tab's value.

  • ReadonlyNamedKey_COUNT: 155

    Number of named-key slots, excluding the legacy range.

  • ReadonlyNamedKey_END: 667

    Internal exclusive end of named keys; not a key.

  • ReadonlyNone: 0

    No key.

  • ReadonlyNumLock: 609

    Num Lock key.

  • ReadonlyO: 560

    O key.

  • ReadonlyOem102: 631

    Extra ISO keyboard key between left Shift and Z.

  • ReadonlyP: 561

    P key.

  • ReadonlyPageDown: 518

    Page Down key.

  • ReadonlyPageUp: 517

    Page Up key.

  • ReadonlyPause: 611

    Pause key.

  • ReadonlyPeriod: 599

    Period key.

  • ReadonlyPrintScreen: 610

    Print Screen key.

  • ReadonlyQ: 562

    Q key.

  • ReadonlyR: 563

    R key.

  • ReadonlyReservedForModAlt: 665

    Internal key-state slot for the Alt modifier.

  • ReadonlyReservedForModCtrl: 663

    Internal key-state slot for the Control modifier.

  • ReadonlyReservedForModShift: 664

    Internal key-state slot for the Shift modifier.

  • ReadonlyReservedForModSuper: 666

    Internal key-state slot for the Super modifier.

  • ReadonlyRightAlt: 533

    Right Alt/Option key.

  • ReadonlyRightArrow: 514

    Right arrow.

  • ReadonlyRightBracket: 605

    Right square bracket key.

  • ReadonlyRightCtrl: 531

    Right Control key.

  • ReadonlyRightShift: 532

    Right Shift key.

  • ReadonlyRightSuper: 534

    Right Windows/Command/Super key.

  • ReadonlyS: 564

    S key.

  • ReadonlyScrollLock: 608

    Scroll Lock key.

  • ReadonlySemicolon: 601

    Semicolon key.

  • ReadonlySlash: 600

    Forward slash key.

  • ReadonlySpace: 524

    Space bar.

  • ReadonlyT: 565

    T key.

  • ReadonlyTab: 512

    Tab key.

  • ReadonlyU: 566

    U key.

  • ReadonlyUpArrow: 515

    Up arrow.

  • ReadonlyV: 567

    V key.

  • ReadonlyW: 568

    W key.

  • ReadonlyX: 569

    X key.

  • ReadonlyY: 570

    Y key.

  • ReadonlyZ: 571

    Z key.

Source & inheritance

Icons made by Lorc, Delapouite & Skoll · game-icons.net · CC BY 3.0