public final class ImGuiKey
extends java.lang.Object
>=
512. Keys value 0 to 511 are left unused as legacy native/opaque key values (<
1.87).
Since >=
1.89 we increased typing (went from int to enum), some legacy code may need a cast to ImGuiKey.
Read details about the 1.87 and 1.89 transition : https://github.com/ocornut/imgui/issues/4921
Note that "Keys" related to physical keys and are not the same concept as input "Characters", the later are submitted via io.AddInputCharacter().Modifier and Type | Field and Description |
---|---|
static int |
_0 |
static int |
_1 |
static int |
_2 |
static int |
_3 |
static int |
_4 |
static int |
_5 |
static int |
_6 |
static int |
_7 |
static int |
_8 |
static int |
_9 |
static int |
A |
static int |
Apostrophe
'
|
static int |
AppBack
Available on some keyboard/mouses.
|
static int |
AppForward |
static int |
B |
static int |
Backslash
\ (this text inhibit multiline comment caused by backslash)
|
static int |
Backspace |
static int |
C |
static int |
CapsLock |
static int |
Comma
,
|
static int |
COUNT
[Internal] Reserved for mod storage
|
static int |
D |
static int |
Delete |
static int |
DownArrow |
static int |
E |
static int |
End |
static int |
Enter |
static int |
Equal
=
|
static int |
Escape |
static int |
F |
static int |
F1 |
static int |
F10 |
static int |
F11 |
static int |
F12 |
static int |
F13 |
static int |
F14 |
static int |
F15 |
static int |
F16 |
static int |
F17 |
static int |
F18 |
static int |
F19 |
static int |
F2 |
static int |
F20 |
static int |
F21 |
static int |
F22 |
static int |
F23 |
static int |
F24 |
static int |
F3 |
static int |
F4 |
static int |
F5 |
static int |
F6 |
static int |
F7 |
static int |
F8 |
static int |
F9 |
static int |
G |
static int |
GamepadBack
View (Xbox) - (Switch) Share (PS)
|
static int |
GamepadDpadDown
D-pad Down // Move / Tweak / Resize Window (in Windowing mode)
|
static int |
GamepadDpadLeft
D-pad Left // Move / Tweak / Resize Window (in Windowing mode)
|
static int |
GamepadDpadRight
D-pad Right // Move / Tweak / Resize Window (in Windowing mode)
|
static int |
GamepadDpadUp
D-pad Up // Move / Tweak / Resize Window (in Windowing mode)
|
static int |
GamepadFaceDown
A (Xbox) B (Switch) Cross (PS) // Activate / Open / Toggle / Tweak
|
static int |
GamepadFaceLeft
X (Xbox) Y (Switch) Square (PS) // Tap: Toggle Menu.
|
static int |
GamepadFaceRight
B (Xbox) A (Switch) Circle (PS) // Cancel / Close / Exit
|
static int |
GamepadFaceUp
Y (Xbox) X (Switch) Triangle (PS) // Text Input / On-screen Keyboard
|
static int |
GamepadL1
L Bumper (Xbox) L (Switch) L1 (PS) // Tweak Slower / Focus Previous (in Windowing mode)
|
static int |
GamepadL2
L Trig.
|
static int |
GamepadL3
L Stick (Xbox) L3 (Switch) L3 (PS)
|
static int |
GamepadLStickDown
[Analog] // Move Window (in Windowing mode)
|
static int |
GamepadLStickLeft
[Analog] // Move Window (in Windowing mode)
|
static int |
GamepadLStickRight
[Analog] // Move Window (in Windowing mode)
|
static int |
GamepadLStickUp
[Analog] // Move Window (in Windowing mode)
|
static int |
GamepadR1
R Bumper (Xbox) R (Switch) R1 (PS) // Tweak Faster / Focus Next (in Windowing mode)
|
static int |
GamepadR2
R Trig.
|
static int |
GamepadR3
R Stick (Xbox) R3 (Switch) R3 (PS)
|
static int |
GamepadRStickDown
[Analog]
|
static int |
GamepadRStickLeft
[Analog]
|
static int |
GamepadRStickRight
[Analog]
|
static int |
GamepadRStickUp
[Analog]
|
static int |
GamepadStart
Menu (Xbox) + (Switch) Start/Options (PS)
|
static int |
GraveAccent
`
|
static int |
H |
static int |
Home |
static int |
I |
static int |
ImGuiMod_Alt
Option/Menu
|
static int |
ImGuiMod_Ctrl
Ctrl (non-macOS), Cmd (macOS)
|
static int |
ImGuiMod_Mask_
4-bits
|
static int |
ImGuiMod_None
Keyboard Modifiers (explicitly submitted by backend via AddKeyEvent() calls) - This is mirroring the data also written to io.KeyCtrl, io.KeyShift, io.KeyAlt, io.KeySuper, in a format allowing them to be accessed via standard key API, allowing calls such as IsKeyPressed(), IsKeyReleased(), querying duration etc.
|
static int |
ImGuiMod_Shift
Shift
|
static int |
ImGuiMod_Shortcut
Removed in 1.90.7, you can now simply use ImGuiMod_Ctrl
|
static int |
ImGuiMod_Super
Windows/Super (non-macOS), Ctrl (macOS)
|
static int |
Insert |
static int |
J |
static int |
K |
static int |
Keypad0 |
static int |
Keypad1 |
static int |
Keypad2 |
static int |
Keypad3 |
static int |
Keypad4 |
static int |
Keypad5 |
static int |
Keypad6 |
static int |
Keypad7 |
static int |
Keypad8 |
static int |
Keypad9 |
static int |
KeypadAdd |
static int |
KeypadDecimal |
static int |
KeypadDivide |
static int |
KeypadEnter |
static int |
KeypadEqual |
static int |
KeypadMultiply |
static int |
KeypadSubtract |
static int |
KeysData_OFFSET
Accesses to io.KeysData[] must use (key - ImGuiKey_KeysData_OFFSET) index.
|
static int |
KeysData_SIZE
Size of KeysData[]: hold legacy 0..512 keycodes + named keys
|
static int |
L |
static int |
LeftAlt |
static int |
LeftArrow |
static int |
LeftBracket
[
|
static int |
LeftCtrl |
static int |
LeftShift |
static int |
LeftSuper |
static int |
M |
static int |
Menu |
static int |
Minus
-
|
static int |
ModAlt
Renamed in 1.89
|
static int |
ModCtrl
Renamed in 1.89
|
static int |
ModShift
Renamed in 1.89
|
static int |
ModSuper
Renamed in 1.89
|
static int |
MouseLeft
Aliases: Mouse Buttons (auto-submitted from AddMouseButtonEvent() calls) - This is mirroring the data also written to io.MouseDown[], io.MouseWheel, in a format allowing them to be accessed via standard key API.
|
static int |
MouseMiddle
Aliases: Mouse Buttons (auto-submitted from AddMouseButtonEvent() calls) - This is mirroring the data also written to io.MouseDown[], io.MouseWheel, in a format allowing them to be accessed via standard key API.
|
static int |
MouseRight
Aliases: Mouse Buttons (auto-submitted from AddMouseButtonEvent() calls) - This is mirroring the data also written to io.MouseDown[], io.MouseWheel, in a format allowing them to be accessed via standard key API.
|
static int |
MouseWheelX
Aliases: Mouse Buttons (auto-submitted from AddMouseButtonEvent() calls) - This is mirroring the data also written to io.MouseDown[], io.MouseWheel, in a format allowing them to be accessed via standard key API.
|
static int |
MouseWheelY
Aliases: Mouse Buttons (auto-submitted from AddMouseButtonEvent() calls) - This is mirroring the data also written to io.MouseDown[], io.MouseWheel, in a format allowing them to be accessed via standard key API.
|
static int |
MouseX1
Aliases: Mouse Buttons (auto-submitted from AddMouseButtonEvent() calls) - This is mirroring the data also written to io.MouseDown[], io.MouseWheel, in a format allowing them to be accessed via standard key API.
|
static int |
MouseX2
Aliases: Mouse Buttons (auto-submitted from AddMouseButtonEvent() calls) - This is mirroring the data also written to io.MouseDown[], io.MouseWheel, in a format allowing them to be accessed via standard key API.
|
static int |
N |
static int |
NamedKey_BEGIN
[Internal] Prior to 1.87 we required user to fill io.KeysDown[512] using their own native index + the io.KeyMap[] array.
|
static int |
NamedKey_COUNT
[Internal] Prior to 1.87 we required user to fill io.KeysDown[512] using their own native index + the io.KeyMap[] array.
|
static int |
NamedKey_END
[Internal] Prior to 1.87 we required user to fill io.KeysDown[512] using their own native index + the io.KeyMap[] array.
|
static int |
None
Keyboard
|
static int |
NumLock |
static int |
O |
static int |
P |
static int |
PageDown |
static int |
PageUp |
static int |
Pause |
static int |
Period
.
|
static int |
PrintScreen |
static int |
Q |
static int |
R |
static int |
ReservedForModAlt
[Internal] Reserved for mod storage
|
static int |
ReservedForModCtrl
[Internal] Reserved for mod storage
|
static int |
ReservedForModShift
[Internal] Reserved for mod storage
|
static int |
ReservedForModSuper
[Internal] Reserved for mod storage
|
static int |
RightAlt |
static int |
RightArrow |
static int |
RightBracket
]
|
static int |
RightCtrl |
static int |
RightShift |
static int |
RightSuper |
static int |
S |
static int |
ScrollLock |
static int |
Semicolon
;
|
static int |
Slash
/
|
static int |
Space |
static int |
T |
static int |
Tab
== ImGuiKey_NamedKey_BEGIN
|
static int |
U |
static int |
UpArrow |
static int |
V |
static int |
W |
static int |
X |
static int |
Y |
static int |
Z |
public static final int None
Definition: 0
public static final int Tab
Definition: 512
public static final int LeftArrow
public static final int RightArrow
public static final int UpArrow
public static final int DownArrow
public static final int PageUp
public static final int PageDown
public static final int Home
public static final int End
public static final int Insert
public static final int Delete
public static final int Backspace
public static final int Space
public static final int Enter
public static final int Escape
public static final int LeftCtrl
public static final int LeftShift
public static final int LeftAlt
public static final int LeftSuper
public static final int RightCtrl
public static final int RightShift
public static final int RightAlt
public static final int RightSuper
public static final int Menu
public static final int _0
public static final int _1
public static final int _2
public static final int _3
public static final int _4
public static final int _5
public static final int _6
public static final int _7
public static final int _8
public static final int _9
public static final int A
public static final int B
public static final int C
public static final int D
public static final int E
public static final int F
public static final int G
public static final int H
public static final int I
public static final int J
public static final int K
public static final int L
public static final int M
public static final int N
public static final int O
public static final int P
public static final int Q
public static final int R
public static final int S
public static final int T
public static final int U
public static final int V
public static final int W
public static final int X
public static final int Y
public static final int Z
public static final int F1
public static final int F2
public static final int F3
public static final int F4
public static final int F5
public static final int F6
public static final int F7
public static final int F8
public static final int F9
public static final int F10
public static final int F11
public static final int F12
public static final int F13
public static final int F14
public static final int F15
public static final int F16
public static final int F17
public static final int F18
public static final int F19
public static final int F20
public static final int F21
public static final int F22
public static final int F23
public static final int F24
public static final int Apostrophe
public static final int Comma
public static final int Minus
public static final int Period
public static final int Slash
public static final int Semicolon
public static final int Equal
public static final int LeftBracket
public static final int Backslash
public static final int RightBracket
public static final int GraveAccent
public static final int CapsLock
public static final int ScrollLock
public static final int NumLock
public static final int PrintScreen
public static final int Pause
public static final int Keypad0
public static final int Keypad1
public static final int Keypad2
public static final int Keypad3
public static final int Keypad4
public static final int Keypad5
public static final int Keypad6
public static final int Keypad7
public static final int Keypad8
public static final int Keypad9
public static final int KeypadDecimal
public static final int KeypadDivide
public static final int KeypadMultiply
public static final int KeypadSubtract
public static final int KeypadAdd
public static final int KeypadEnter
public static final int KeypadEqual
public static final int AppBack
public static final int AppForward
public static final int GamepadStart
public static final int GamepadBack
public static final int GamepadFaceLeft
public static final int GamepadFaceRight
public static final int GamepadFaceUp
public static final int GamepadFaceDown
public static final int GamepadDpadLeft
public static final int GamepadDpadRight
public static final int GamepadDpadUp
public static final int GamepadDpadDown
public static final int GamepadL1
public static final int GamepadR1
public static final int GamepadL2
public static final int GamepadR2
public static final int GamepadL3
public static final int GamepadR3
public static final int GamepadLStickLeft
public static final int GamepadLStickRight
public static final int GamepadLStickUp
public static final int GamepadLStickDown
public static final int GamepadRStickLeft
public static final int GamepadRStickRight
public static final int GamepadRStickUp
public static final int GamepadRStickDown
public static final int MouseLeft
public static final int MouseRight
public static final int MouseMiddle
public static final int MouseX1
public static final int MouseX2
public static final int MouseWheelX
public static final int MouseWheelY
public static final int ReservedForModCtrl
public static final int ReservedForModShift
public static final int ReservedForModAlt
public static final int ReservedForModSuper
public static final int COUNT
public static final int ImGuiMod_None
Definition: 0
public static final int ImGuiMod_Ctrl
Definition: 1 << 12
public static final int ImGuiMod_Shift
Definition: 1 << 13
public static final int ImGuiMod_Alt
Definition: 1 << 14
public static final int ImGuiMod_Super
Definition: 1 << 15
public static final int ImGuiMod_Mask_
Definition: 0xF000
public static final int NamedKey_BEGIN
Definition: 512
public static final int NamedKey_END
Definition: ImGuiKey_COUNT
public static final int NamedKey_COUNT
Definition: ImGuiKey_NamedKey_END - ImGuiKey_NamedKey_BEGIN
public static final int KeysData_SIZE
Definition: ImGuiKey_COUNT
public static final int KeysData_OFFSET
Definition: 0
public static final int ImGuiMod_Shortcut
Definition: ImGuiMod_Ctrl
public static final int ModCtrl
Definition: ImGuiMod_Ctrl
public static final int ModShift
Definition: ImGuiMod_Shift
public static final int ModAlt
Definition: ImGuiMod_Alt
public static final int ModSuper
Definition: ImGuiMod_Super