using System;
using System.Runtime.InteropServices;
using UnityEngine.InputSystem.Controls;
using UnityEngine.InputSystem.LowLevel;
using UnityEngine.InputSystem.Utilities;
using Unity.Collections.LowLevel.Unsafe;
using UnityEngine.InputSystem.Layouts;
////FIXME: display names for keys should be localized key names, not just printable characters (e.g. "Space" should be called "Leertaste")
////TODO: usages on modifiers so they can be identified regardless of platform conventions
namespace UnityEngine.InputSystem.LowLevel
{
/// <summary>
/// Default state layout for keyboards.
/// </summary>
/// <remarks>
/// Can be used to update the state of <see cref="Keyboard"/> devices.
///
/// <example>
/// <code>
/// // Send input event with A key pressed on keyboard.
/// InputSystem.QueueStateEvent(Keyboard.current,
/// new KeyboardState(Key.A));
/// </code>
/// </example>
/// </remarks>
/// <seealso cref="Keyboard"/>
// NOTE: This layout has to match the KeyboardInputState layout used in native!
[StructLayout(LayoutKind.Sequential)]
public unsafe struct KeyboardState : IInputStateTypeInfo
{
/// <summary>
/// Memory format tag for KeybboardState.
/// </summary>
/// <value>Returns "KEYS".</value>
/// <seealso cref="InputStateBlock.format"/>
public static FourCC Format => new FourCC('K', 'E', 'Y', 'S');
private const int kSizeInBits = Keyboard.KeyCount;
internal const int kSizeInBytes = (kSizeInBits + 7) / 8;
[InputControl(name = "anyKey", displayName = "Any Key", layout = "AnyKey", sizeInBits = kSizeInBits - 1, synthetic = true)] // Exclude IMESelected.
[InputControl(name = "escape", displayName = "Escape", layout = "Key", usages = new[] {"Back", "Cancel"}, bit = (int)Key.Escape)]
[InputControl(name = "space", displayName = "Space", layout = "Key", bit = (int)Key.Space)]
[InputControl(name = "enter", displayName = "Enter", layout = "Key", usage = "Submit", bit = (int)Key.Enter)]
[InputControl(name = "tab", displayName = "Tab", layout = "Key", bit = (int)Key.Tab)]
[InputControl(name = "backquote", displayName = "`", layout = "Key", bit = (int)Key.Backquote)]
[InputControl(name = "quote", displayName = "'", layout = "Key", bit = (int)Key.Quote)]
[InputControl(name = "semicolon", displayName = ";", layout = "Key", bit = (int)Key.Semicolon)]
[InputControl(name = "comma", displayName = ",", layout = "Key", bit = (int)Key.Comma)]
[InputControl(name = "period", displayName = ".", layout = "Key", bit = (int)Key.Period)]
[InputControl(name = "slash", displayName = "/", layout = "Key", bit = (int)Key.Slash)]
[InputControl(name = "backslash", displayName = "\\", layout = "Key", bit = (int)Key.Backslash)]
[InputControl(name = "leftBracket", displayName = "[", layout = "Key", bit = (int)Key.LeftBracket)]
[InputControl(name = "rightBracket", displayName = "]", layout = "Key", bit = (int)Key.RightBracket)]
[InputControl(name = "minus", displayName = "-", layout = "Key", bit = (int)Key.Minus)]
[InputControl(name = "equals", displayName = "=", layout = "Key", bit = (int)Key.Equals)]
[InputControl(name = "upArrow", displayName = "Up Arrow", layout = "Key", bit = (int)Key.UpArrow)]
[InputControl(name = "downArrow", displayName = "Down Arrow", layout = "Key", bit = (int)Key.DownArrow)]
[InputControl(name = "leftArrow", displayName = "Left Arrow", layout = "Key", bit = (int)Key.LeftArrow)]
[InputControl(name = "rightArrow", displayName = "Right Arrow", layout = "Key", bit = (int)Key.RightArrow)]
[InputControl(name = "a", displayName = "A", layout = "Key", bit = (int)Key.A)]
[InputControl(name = "b", displayName = "B", layout = "Key", bit = (int)Key.B)]
[InputControl(name = "c", displayName = "C", layout = "Key", bit = (int)Key.C)]
[InputControl(name = "d", displayName = "D", layout = "Key", bit = (int)Key.D)]
[InputControl(name = "e", displayName = "E", layout = "Key", bit = (int)Key.E)]
[InputControl(name = "f", displayName = "F", layout = "Key", bit = (int)Key.F)]
[InputControl(name = "g", displayName = "G", layout = "Key", bit = (int)Key.G)]
[InputControl(name = "h", displayName = "H", layout = "Key", bit = (int)Key.H)]
[InputControl(name = "i", displayName = "I", layout = "Key", bit = (int)Key.I)]
[InputControl(name = "j", displayName = "J", layout = "Key", bit = (int)Key.J)]
[InputControl(name = "k", displayName = "K", layout = "Key", bit = (int)Key.K)]
[InputControl(name = "l", displayName = "L", layout = "Key", bit = (int)Key.L)]
[InputControl(name = "m", displayName = "M", layout = "Key", bit = (int)Key.M)]
[InputControl(name = "n", displayName = "N", layout = "Key", bit = (int)Key.N)]
[InputControl(name = "o", displayName = "O", layout = "Key", bit = (int)Key.O)]
[InputControl(name = "p", displayName = "P", layout = "Key", bit = (int)Key.P)]
[InputControl(name = "q", displayName = "Q", layout = "Key", bit = (int)Key.Q)]
[InputControl(name = "r", displayName = "R", layout = "Key", bit = (int)Key.R)]
[InputControl(name = "s", displayName = "S", layout = "Key", bit = (int)Key.S)]
[InputControl(name = "t", displayName = "T", layout = "Key", bit = (int)Key.T)]
[InputControl(name = "u", displayName = "U", layout = "Key", bit = (int)Key.U)]
[InputControl(name = "v", displayName = "V", layout = "Key", bit = (int)Key.V)]
[InputControl(name = "w", displayName = "W", layout = "Key", bit = (int)Key.W)]
[InputControl(name = "x", displayName = "X", layout = "Key", bit = (int)Key.X)]
[InputControl(name = "y", displayName = "Y", layout = "Key", bit = (int)Key.Y)]
[InputControl(name = "z", displayName = "Z", layout = "Key", bit = (int)Key.Z)]
[InputControl(name = "1", displayName = "1", layout = "Key", bit = (int)Key.Digit1)]
[InputControl(name = "2", displayName = "2", layout = "Key", bit = (int)Key.Digit2)]
[InputControl(name = "3", displayName = "3", layout = "Key", bit = (int)Key.Digit3)]
[InputControl(name = "4", displayName = "4", layout = "Key", bit = (int)Key.Digit4)]
[InputControl(name = "5", displayName = "5", layout = "Key", bit = (int)Key.Digit5)]
[InputControl(name = "6", displayName = "6", layout = "Key", bit = (int)Key.Digit6)]
[InputControl(name = "7", displayName = "7", layout = "Key", bit = (int)Key.Digit7)]
[InputControl(name = "8", displayName = "8", layout = "Key", bit = (int)Key.Digit8)]
[InputControl(name = "9", displayName = "9", layout = "Key", bit = (int)Key.Digit9)]
[InputControl(name = "0", displayName = "0", layout = "Key", bit = (int)Key.Digit0)]
[InputControl(name = "leftShift", displayName = "Left Shift", layout = "Key", usage = "Modifier", bit = (int)Key.LeftShift)]
[InputControl(name = "rightShift", displayName = "Right Shift", layout = "Key", usage = "Modifier", bit = (int)Key.RightShift)]
[InputControl(name = "shift", displayName = "Shift", layout = "DiscreteButton", usage = "Modifier", bit = (int)Key.LeftShift, sizeInBits = 2, synthetic = true, parameters = "minValue=1,maxValue=3,writeMode=1")]
[InputControl(name = "leftAlt", displayName = "Left Alt", layout = "Key", usage = "Modifier", bit = (int)Key.LeftAlt)]
[InputControl(name = "rightAlt", displayName = "Right Alt", layout = "Key", usage = "Modifier", bit = (int)Key.RightAlt, alias = "AltGr")]
[InputControl(name = "alt", displayName = "Alt", layout = "DiscreteButton", usage = "Modifier", bit = (int)Key.LeftAlt, sizeInBits = 2, synthetic = true, parameters = "minValue=1,maxValue=3,writeMode=1")]
[InputControl(name = "leftCtrl", displayName = "Left Control", layout = "Key", usage = "Modifier", bit = (int)Key.LeftCtrl)]
[InputControl(name = "rightCtrl", displayName = "Right Control", layout = "Key", usage = "Modifier", bit = (int)Key.RightCtrl)]
[InputControl(name = "ctrl", displayName = "Control", layout = "DiscreteButton", usage = "Modifier", bit = (int)Key.LeftCtrl, sizeInBits = 2, synthetic = true, parameters = "minValue=1,maxValue=3,writeMode=1")]
[InputControl(name = "leftMeta", displayName = "Left System", layout = "Key", usage = "Modifier", bit = (int)Key.LeftMeta, aliases = new[] { "LeftWindows", "LeftApple", "LeftCommand" })]
[InputControl(name = "rightMeta", displayName = "Right System", layout = "Key", usage = "Modifier", bit = (int)Key.RightMeta, aliases = new[] { "RightWindows", "RightApple", "RightCommand" })]
[InputControl(name = "contextMenu", displayName = "Context Menu", layout = "Key", usage = "Modifier", bit = (int)Key.ContextMenu)]
[InputControl(name = "backspace", displayName = "Backspace", layout = "Key", bit = (int)Key.Backspace)]
[InputControl(name = "pageDown", displayName = "Page Down", layout = "Key", bit = (int)Key.PageDown)]
[InputControl(name = "pageUp", displayName = "Page Up", layout = "Key", bit = (int)Key.PageUp)]
[InputControl(name = "home", displayName = "Home", layout = "Key", bit = (int)Key.Home)]
[InputControl(name = "end", displayName = "End", layout = "Key", bit = (int)Key.End)]
[InputControl(name = "insert", displayName = "Insert", layout = "Key", bit = (int)Key.Insert)]
[InputControl(name = "delete", displayName = "Delete", layout = "Key", bit = (int)Key.Delete)]
[InputControl(name = "capsLock", displayName = "Caps Lock", layout = "Key", bit = (int)Key.CapsLock)]
[InputControl(name = "numLock", displayName = "Num Lock", layout = "Key", bit = (int)Key.NumLock)]
[InputControl(name = "printScreen", displayName = "Print Screen", layout = "Key", bit = (int)Key.PrintScreen)]
[InputControl(name = "scrollLock", displayName = "Scroll Lock", layout = "Key", bit = (int)Key.ScrollLock)]
[InputControl(name = "pause", displayName = "Pause/Break", layout = "Key", bit = (int)Key.Pause)]
[InputControl(name = "numpadEnter", displayName = "Numpad Enter", layout = "Key", bit = (int)Key.NumpadEnter)]
[InputControl(name = "numpadDivide", displayName = "Numpad /", layout = "Key", bit = (int)Key.NumpadDivide)]
[InputControl(name = "numpadMultiply", displayName = "Numpad *", layout = "Key", bit = (int)Key.NumpadMultiply)]
[InputControl(name = "numpadPlus", displayName = "Numpad +", layout = "Key", bit = (int)Key.NumpadPlus)]
[InputControl(name = "numpadMinus", displayName = "Numpad -", layout = "Key", bit = (int)Key.NumpadMinus)]
[InputControl(name = "numpadPeriod", displayName = "Numpad .", layout = "Key", bit = (int)Key.NumpadPeriod)]
[InputControl(name = "numpadEquals", displayName = "Numpad =", layout = "Key", bit = (int)Key.NumpadEquals)]
[InputControl(name = "numpad1", displayName = "Numpad 1", layout = "Key", bit = (int)Key.Numpad1)]
[InputControl(name = "numpad2", displayName = "Numpad 2", layout = "Key", bit = (int)Key.Numpad2)]
[InputControl(name = "numpad3", displayName = "Numpad 3", layout = "Key", bit = (int)Key.Numpad3)]
[InputControl(name = "numpad4", displayName = "Numpad 4", layout = "Key", bit = (int)Key.Numpad4)]
[InputControl(name = "numpad5", displayName = "Numpad 5", layout = "Key", bit = (int)Key.Numpad5)]
[InputControl(name = "numpad6", displayName = "Numpad 6", layout = "Key", bit = (int)Key.Numpad6)]
[InputControl(name = "numpad7", displayName = "Numpad 7", layout = "Key", bit = (int)Key.Numpad7)]
[InputControl(name = "numpad8", displayName = "Numpad 8", layout = "Key", bit = (int)Key.Numpad8)]
[InputControl(name = "numpad9", displayName = "Numpad 9", layout = "Key", bit = (int)Key.Numpad9)]
[InputControl(name = "numpad0", displayName = "Numpad 0", layout = "Key", bit = (int)Key.Numpad0)]
[InputControl(name = "f1", displayName = "F1", layout = "Key", bit = (int)Key.F1)]
[InputControl(name = "f2", displayName = "F2", layout = "Key", bit = (int)Key.F2)]
[InputControl(name = "f3", displayName = "F3", layout = "Key", bit = (int)Key.F3)]
[InputControl(name = "f4", displayName = "F4", layout = "Key", bit = (int)Key.F4)]
[InputControl(name = "f5", displayName = "F5", layout = "Key", bit = (int)Key.F5)]
[InputControl(name = "f6", displayName = "F6", layout = "Key", bit = (int)Key.F6)]
[InputControl(name = "f7", displayName = "F7", layout = "Key", bit = (int)Key.F7)]
[InputControl(name = "f8", displayName = "F8", layout = "Key", bit = (int)Key.F8)]
[InputControl(name = "f9", displayName = "F9", layout = "Key", bit = (int)Key.F9)]
[InputControl(name = "f10", displayName = "F10", layout = "Key", bit = (int)Key.F10)]
[InputControl(name = "f11", displayName = "F11", layout = "Key", bit = (int)Key.F11)]
[InputControl(name = "f12", displayName = "F12", layout = "Key", bit = (int)Key.F12)]
[InputControl(name = "OEM1", layout = "Key", bit = (int)Key.OEM1)]
[InputControl(name = "OEM2", layout = "Key", bit = (int)Key.OEM2)]
[InputControl(name = "OEM3", layout = "Key", bit = (int)Key.OEM3)]
[InputControl(name = "OEM4", layout = "Key", bit = (int)Key.OEM4)]
[InputControl(name = "OEM5", layout = "Key", bit = (int)Key.OEM5)]
[InputControl(name = "IMESelected", layout = "Button", bit = (int)Key.IMESelected, synthetic = true)]
public fixed byte keys[kSizeInBytes];
public KeyboardState(params Key[] pressedKeys)
{
if (pressedKeys == null)
throw new ArgumentNullException(nameof(pressedKeys));
fixed(byte* keysPtr = keys)
{
UnsafeUtility.MemClear(keysPtr, kSizeInBytes);
for (var i = 0; i < pressedKeys.Length; ++i)
MemoryHelpers.WriteSingleBit(keysPtr, (uint)pressedKeys[i], true);
}
}
public void Set(Key key, bool state)
{
fixed(byte* keysPtr = keys)
MemoryHelpers.WriteSingleBit(keysPtr, (uint)key, state);
}
public void Press(Key key)
{
Set(key, true);
}
public void Release(Key key)
{
Set(key, false);
}
public FourCC format => Format;
}
}
namespace UnityEngine.InputSystem
{
/// <summary>
/// Enumeration of key codes.
/// </summary>
/// <remarks>
/// Named according to the US keyboard layout which is used as a reference layout. Note, however,
/// that keys are identified by physical location, not by the characters they generate. This means,
/// for example, that <see cref="A"/> is always the key to the right of <see cref="CapsLock"/>,
/// regardless of which key (if any) produces the "a" character on the current keyboard layout.
///
/// To find the text character (if any) generated by a key according to the currently active keyboard
/// layout, use the <see cref="InputControl.displayName"/> property of <see cref="KeyControl"/>.
///
/// <example>
/// <code>
/// // Look up key by key code.
/// var aKey = Keyboard.current[Key.A];
///
/// // Find out which text is produced by the key.
/// Debug.Log($"The '{aKey.keyCode}' key produces '{aKey.displayName}' as text input");
/// </code>
/// </example>
/// </remarks>
// NOTE: Has to match up with 'KeyboardInputState::KeyCode' in native.
// NOTE: In the keyboard code, we depend on the order of the keys in the various keyboard blocks.
public enum Key
{
/// <summary>
/// Invalid key. Does not represent a key on the keyboard and is only used to have a
/// default for the Key enumeration not represent any specific key.
/// </summary>
None,
// ---- Printable keys ----
/// <summary>
/// The <see cref="Keyboard.spaceKey"/>.
/// </summary>
Space,
/// <summary>
/// The <see cref="Keyboard.enterKey"/>.
/// </summary>
Enter,
/// <summary>
/// The <see cref="Keyboard.tabKey"/>.
/// </summary>
Tab,
/// <summary>
/// The <see cref="Keyboard.backquoteKey"/>.
/// </summary>
Backquote,
/// <summary>
/// The <see cref="Keyboard.quoteKey"/>.
/// </summary>
Quote,
/// <summary>
/// The <see cref="Keyboard.semicolonKey"/>.
/// </summary>
Semicolon,
/// <summary>
/// The <see cref="Keyboard.commaKey"/>.
/// </summary>
Comma,
/// <summary>
/// The <see cref="Keyboard.periodKey"/>.
/// </summary>
Period,
/// <summary>
/// The <see cref="Keyboard.slashKey"/>.
/// </summary>
Slash,
/// <summary>
/// The <see cref="Keyboard.backslashKey"/>.
/// </summary>
Backslash,
/// <summary>
/// The <see cref="Keyboard.leftBracketKey"/>.
/// </summary>
LeftBracket,
/// <summary>
/// The <see cref="Keyboard.rightBracketKey"/>.
/// </summary>
RightBracket,
/// <summary>
/// The <see cref="Keyboard.minusKey"/>.
/// </summary>
Minus,
/// <summary>
/// The <see cref="Keyboard.equalsKey"/>.
/// </summary>
Equals,
/// <summary>
/// The <see cref="Keyboard.aKey"/>.
/// </summary>
A,
/// <summary>
/// The <see cref="Keyboard.bKey"/>.
/// </summary>
B,
/// <summary>
/// The <see cref="Keyboard.cKey"/>.
/// </summary>
C,
/// <summary>
/// The <see cref="Keyboard.dKey"/>.
/// </summary>
D,
/// <summary>
/// The <see cref="Keyboard.eKey"/>.
/// </summary>
E,
/// <summary>
/// The <see cref="Keyboard.fKey"/>.
/// </summary>
F,
/// <summary>
/// The <see cref="Keyboard.gKey"/>.
/// </summary>
G,
/// <summary>
/// The <see cref="Keyboard.hKey"/>.
/// </summary>
H,
/// <summary>
/// The <see cref="Keyboard.iKey"/>.
/// </summary>
I,
/// <summary>
/// The <see cref="Keyboard.jKey"/>.
/// </summary>
J,
/// <summary>
/// The <see cref="Keyboard.kKey"/>.
/// </summary>
K,
/// <summary>
/// The <see cref="Keyboard.lKey"/>.
/// </summary>
L,
/// <summary>
/// The <see cref="Keyboard.mKey"/>.
/// </summary>
M,
/// <summary>
/// The <see cref="Keyboard.nKey"/>.
/// </summary>
N,
/// <summary>
/// The <see cref="Keyboard.oKey"/>.
/// </summary>
O,
/// <summary>
/// The <see cref="Keyboard.pKey"/>.
/// </summary>
P,
/// <summary>
/// The <see cref="Keyboard.qKey"/>.
/// </summary>
Q,
/// <summary>
/// The <see cref="Keyboard.rKey"/>.
/// </summary>
R,
/// <summary>
/// The <see cref="Keyboard.sKey"/>.
/// </summary>
S,
/// <summary>
/// The <see cref="Keyboard.tKey"/>.
/// </summary>
T,
/// <summary>
/// The <see cref="Keyboard.uKey"/>.
/// </summary>
U,
/// <summary>
/// The <see cref="Keyboard.vKey"/>.
/// </summary>
V,
/// <summary>
/// The <see cref="Keyboard.wKey"/>.
/// </summary>
W,
/// <summary>
/// The <see cref="Keyboard.xKey"/>.
/// </summary>
X,
/// <summary>
/// The <see cref="Keyboard.yKey"/>.
/// </summary>
Y,
/// <summary>
/// The <see cref="Keyboard.zKey"/>.
/// </summary>
Z,
/// <summary>
/// The <see cref="Keyboard.digit1Key"/>.
/// </summary>
Digit1,
/// <summary>
/// The <see cref="Keyboard.digit2Key"/>.
/// </summary>
Digit2,
/// <summary>
/// The <see cref="Keyboard.digit3Key"/>.
/// </summary>
Digit3,
/// <summary>
/// The <see cref="Keyboard.digit4Key"/>.
/// </summary>
Digit4,
/// <summary>
/// The <see cref="Keyboard.digit5Key"/>.
/// </summary>
Digit5,
/// <summary>
/// The <see cref="Keyboard.digit6Key"/>.
/// </summary>
Digit6,
/// <summary>
/// The <see cref="Keyboard.digit7Key"/>.
/// </summary>
Digit7,
/// <summary>
/// The <see cref="Keyboard.digit8Key"/>.
/// </summary>
Digit8,
/// <summary>
/// The <see cref="Keyboard.digit9Key"/>.
/// </summary>
Digit9,
/// <summary>
/// The <see cref="Keyboard.digit0Key"/>.
/// </summary>
Digit0,
// ---- Non-printable keys ----
// NOTE: The left&right variants for shift, ctrl, and alt must be next to each other.
/// <summary>
/// The <see cref="Keyboard.leftShiftKey"/>.
/// </summary>
LeftShift,
/// <summary>
/// The <see cref="Keyboard.rightShiftKey"/>.
/// </summary>
RightShift,
/// <summary>
/// The <see cref="Keyboard.leftAltKey"/>.
/// </summary>
LeftAlt,
/// <summary>
/// The <see cref="Keyboard.rightAltKey"/>.
/// </summary>
RightAlt,
/// <summary>
/// Same as <see cref="RightAlt"/>.
/// </summary>
AltGr = RightAlt,
/// <summary>
/// The <see cref="Keyboard.leftCtrlKey"/>.
/// </summary>
LeftCtrl,
/// <summary>
/// The <see cref="Keyboard.rightCtrlKey"/>.
/// </summary>
RightCtrl,
/// <summary>
/// The <see cref="Keyboard.leftMetaKey"/>.
/// </summary>
LeftMeta,
/// <summary>
/// The <see cref="Keyboard.rightMetaKey"/>.
/// </summary>
RightMeta,
/// <summary>
/// Same as <see cref="LeftMeta"/>.
/// </summary>
LeftWindows = LeftMeta,
/// <summary>
/// Same as <see cref="RightMeta"/>.
/// </summary>
RightWindows = RightMeta,
/// <summary>
/// Same as <see cref="LeftMeta"/>.
/// </summary>
LeftApple = LeftMeta,
/// <summary>
/// Same as <see cref="RightMeta"/>.
/// </summary>
RightApple = RightMeta,
/// <summary>
/// Same as <see cref="LeftMeta"/>.
/// </summary>
LeftCommand = LeftMeta,
/// <summary>
/// Same as <see cref="RightMeta"/>.
/// </summary>
RightCommand = RightMeta,
/// <summary>
/// The <see cref="Keyboard.contextMenuKey"/>.
/// </summary>
ContextMenu,
/// <summary>
/// The <see cref="Keyboard.escapeKey"/>.
/// </summary>
Escape,
/// <summary>
/// The <see cref="Keyboard.leftArrowKey"/>.
/// </summary>
LeftArrow,
/// <summary>
/// The <see cref="Keyboard.rightArrowKey"/>.
/// </summary>
RightArrow,
/// <summary>
/// The <see cref="Keyboard.upArrowKey"/>.
/// </summary>
UpArrow,
/// <summary>
/// The <see cref="Keyboard.downArrowKey"/>.
/// </summary>
DownArrow,
/// <summary>
/// The <see cref="Keyboard.backspaceKey"/>.
/// </summary>
Backspace,
/// <summary>
/// The <see cref="Keyboard.pageDownKey"/>.
/// </summary>
PageDown,
/// <summary>
/// The <see cref="Keyboard.pageUpKey"/>.
/// </summary>
PageUp,
/// <summary>
/// The <see cref="Keyboard.homeKey"/>.
/// </summary>
Home,
/// <summary>
/// The <see cref="Keyboard.endKey"/>.
/// </summary>
End,
/// <summary>
/// The <see cref="Keyboard.insertKey"/>.
/// </summary>
Insert,
/// <summary>
/// The <see cref="Keyboard.deleteKey"/>.
/// </summary>
Delete,
/// <summary>
/// The <see cref="Keyboard.capsLockKey"/>.
/// </summary>
CapsLock,
/// <summary>
/// The <see cref="Keyboard.numLockKey"/>.
/// </summary>
NumLock,
/// <summary>
/// The <see cref="Keyboard.printScreenKey"/>.
/// </summary>
PrintScreen,
/// <summary>
/// The <see cref="Keyboard.scrollLockKey"/>.
/// </summary>
ScrollLock,
/// <summary>
/// The <see cref="Keyboard.pauseKey"/>.
/// </summary>
Pause,
// ---- Numpad ----
// NOTE: Numpad layout follows the 18-key numpad layout. Some PC keyboards
// have a 17-key numpad layout where the plus key is an elongated key
// like the numpad enter key. Be aware that in those layouts the positions
// of some of the operator keys are also different. However, we stay
// layout neutral here, too, and always use the 18-key blueprint.
/// <summary>
/// The <see cref="Keyboard.numpadEnterKey"/>.
/// </summary>
NumpadEnter,
/// <summary>
/// The <see cref="Keyboard.numpadDivideKey"/>.
/// </summary>
NumpadDivide,
/// <summary>
/// The <see cref="Keyboard.numpadMultiplyKey"/>.
/// </summary>
NumpadMultiply,
/// <summary>
/// The <see cref="Keyboard.numpadPlusKey"/>.
/// </summary>
NumpadPlus,
/// <summary>
/// The <see cref="Keyboard.numpadMinusKey"/>.
/// </summary>
NumpadMinus,
/// <summary>
/// The <see cref="Keyboard.numpadPeriodKey"/>.
/// </summary>
NumpadPeriod,
/// <summary>
/// The <see cref="Keyboard.numpadEqualsKey"/>.
/// </summary>
NumpadEquals,
/// <summary>
/// The <see cref="Keyboard.numpad0Key"/>.
/// </summary>
Numpad0,
/// <summary>
/// The <see cref="Keyboard.numpad1Key"/>.
/// </summary>
Numpad1,
/// <summary>
/// The <see cref="Keyboard.numpad2Key"/>.
/// </summary>
Numpad2,
/// <summary>
/// The <see cref="Keyboard.numpad3Key"/>.
/// </summary>
Numpad3,
/// <summary>
/// The <see cref="Keyboard.numpad4Key"/>.
/// </summary>
Numpad4,
/// <summary>
/// The <see cref="Keyboard.numpad5Key"/>.
/// </summary>
Numpad5,
/// <summary>
/// The <see cref="Keyboard.numpad6Key"/>.
/// </summary>
Numpad6,
/// <summary>
/// The <see cref="Keyboard.numpad7Key"/>.
/// </summary>
Numpad7,
/// <summary>
/// The <see cref="Keyboard.numpad8Key"/>.
/// </summary>
Numpad8,
/// <summary>
/// The <see cref="Keyboard.numpad9Key"/>.
/// </summary>
Numpad9,
/// <summary>
/// The <see cref="Keyboard.f1Key"/>.
/// </summary>
F1,
/// <summary>
/// The <see cref="Keyboard.f2Key"/>.
/// </summary>
F2,
/// <summary>
/// The <see cref="Keyboard.f3Key"/>.
/// </summary>
F3,
/// <summary>
/// The <see cref="Keyboard.f4Key"/>.
/// </summary>
F4,
/// <summary>
/// The <see cref="Keyboard.f5Key"/>.
/// </summary>
F5,
/// <summary>
/// The <see cref="Keyboard.f6Key"/>.
/// </summary>
F6,
/// <summary>
/// The <see cref="Keyboard.f7Key"/>.
/// </summary>
F7,
/// <summary>
/// The <see cref="Keyboard.f8Key"/>.
/// </summary>
F8,
/// <summary>
/// The <see cref="Keyboard.f9Key"/>.
/// </summary>
F9,
/// <summary>
/// The <see cref="Keyboard.f10Key"/>.
/// </summary>
F10,
/// <summary>
/// The <see cref="Keyboard.f11Key"/>.
/// </summary>
F11,
/// <summary>
/// The <see cref="Keyboard.f12Key"/>.
/// </summary>
F12,
// Extra keys that a keyboard may have. We make no guarantees about where
// they end up on the keyboard (if they are present).
/// <summary>
/// The <see cref="Keyboard.oem1Key"/>.
/// </summary>
OEM1,
/// <summary>
/// The <see cref="Keyboard.oem2Key"/>.
/// </summary>
OEM2,
/// <summary>
/// The <see cref="Keyboard.oem3Key"/>.
/// </summary>
OEM3,
/// <summary>
/// The <see cref="Keyboard.oem4Key"/>.
/// </summary>
OEM4,
/// <summary>
/// The <see cref="Keyboard.oem5Key"/>.
/// </summary>
OEM5,
////FIXME: This should never have been a Key but rather just an extra button or state on keyboard
// Not exactly a key, but binary data sent by the Keyboard to say if IME is being used.
IMESelected
}
/// <summary>
/// Represents a standard, physical PC-type keyboard.
/// </summary>
/// <remarks>
/// Keyboards allow for both individual button input as well as text input. To receive button
/// input, use the individual <see cref="KeyControl"/>-type controls present on the keyboard.
/// For example, <see cref="aKey"/>. To receive text input, use the <see cref="onTextInput"/>
/// callback.
///
/// The naming/identification of keys is agnostic to keyboard layouts. This means that <see cref="aKey"/>,
/// for example, will always be the key to the right of <see cref="capsLockKey"/> regardless of where
/// the current keyboard language layout puts the "a" character. This also means that having a
/// binding to <c>"<Keyboard>/a"</c> on an <see cref="InputAction"/>, for example, will
/// bind to the same key regardless of locale -- an important feature, for example, for getting
/// stable WASD bindings.
///
/// To find what text character (if any) is produced by a key, you can use the key's <see
/// cref="InputControl.displayName"/> property. This can also be used in bindings.
/// <c>"<Keyboard>/#(a)"</c>, for example, will bind to the key that produces the "a"
/// character according to the currently active keyboard layout.
///
/// To find out which keyboard layout is currently active, you can use the <see cref="keyboardLayout"/>
/// property. Note that keyboard layout names are platform-dependent.
///
/// Note that keyboard devices will always have key controls added for all keys in the
/// <see cref="Key"/> enumeration -- whether they are actually present on the physical
/// keyboard or not. It is thus not possible to find out this way whether the underlying
/// keyboard has certain keys or not.
/// </remarks>
[InputControlLayout(stateType = typeof(KeyboardState), isGenericTypeOfDevice = true)]
public class Keyboard : InputDevice, ITextInputReceiver
{
/// <summary>
/// Total number of key controls on a keyboard, i.e. the number of controls
/// in <see cref="allKeys"/>.
/// </summary>
/// <value>Total number of key controls.</value>
public const int KeyCount = (int)Key.OEM5;
/// <summary>
/// Event that is fired for every single character entered on the keyboard.
/// </summary>
/// <value>Triggered whenever the keyboard receives text input.</value>
/// <remarks>
/// <example>
/// <code>
/// // Let's say we want to do a typing game. We could define a component
/// // something along those lines to match the typed input.
/// public class MatchTextByTyping : MonoBehaviour
/// {
/// public string text
/// {
/// get => m_Text;
/// set
/// {
/// m_Text = value;
/// m_Position = 0;
/// }
/// }
///
/// public Action onTextTypedCorrectly { get; set; }
/// public Action onTextTypedIncorrectly { get; set; }
///
/// private int m_Position;
/// private string m_Text;
///
/// protected void OnEnable()
/// {
/// Keyboard.current.onTextInput += OnTextInput;
/// }
///
/// protected void OnDisable()
/// {
/// Keyboard.current.onTextInput -= OnTextInput;
/// }
///
/// private void OnTextInput(char ch)
/// {
/// if (m_Text == null || m_Position >= m_Text.Length)
/// return;
///
/// if (m_Text[m_Position] == ch)
/// {
/// ++m_Position;
/// if (m_Position == m_Text.Length)
/// onTextTypeCorrectly?.Invoke();
/// }
/// else
/// {
/// m_Text = null;
/// m_Position = 0;
///
/// onTextTypedIncorrectly?.Invoke();
/// }
/// }
/// }
/// </code>
/// </example>
/// </remarks>
public event Action<char> onTextInput
{
add
{
if (value == null)
throw new ArgumentNullException(nameof(value));
if (!m_TextInputListeners.Contains(value))
m_TextInputListeners.Append(value);
}
remove => m_TextInputListeners.Remove(value);
}
/// <summary>
/// An event that is fired to get IME composition strings. Fired once for every change,
/// sends the entire string to date, and sends a blank string whenever a composition is submitted or reset.
/// </summary>
/// <remarks>
/// Some languages use complex input methods which involve opening windows to insert characters.
/// Typically, this is not desirable while playing a game, as games may just interpret key strokes as game input, not as text.
///
/// See <see cref="Keyboard.SetIMEEnabled"/> for turning IME on/off
/// </remarks>
public event Action<IMECompositionString> onIMECompositionChange
{
add
{
if (value == null)
throw new ArgumentNullException(nameof(value));
if (!m_ImeCompositionListeners.Contains(value))
m_ImeCompositionListeners.Append(value);
}
remove => m_ImeCompositionListeners.Remove(value);
}
/// <summary>
/// Activates/deactivates IME composition while typing. This decides whether or not to use the OS supplied IME system.
/// </summary>
/// <remarks>
///
/// Some languages use complex input methods which involve opening windows to insert characters.
/// Typically, this is not desirable while playing a game, as games may just interpret key strokes as game input, not as text.
/// Setting this to On, will enable the OS-level IME system when the user presses keystrokes.
///
/// See <see cref="Keyboard.SetIMECursorPosition"/>, <see cref="Keyboard.onIMECompositionChange"/>,
/// <see cref="Keyboard.imeSelected"/> for more IME settings and data.
/// </remarks>
public void SetIMEEnabled(bool enabled)
{
var command = EnableIMECompositionCommand.Create(enabled);
ExecuteCommand(ref command);
}
/// <summary>
/// Sets the cursor position for IME composition dialogs. Units are from the upper left, in pixels, moving down and to the right.
/// </summary>
/// <remarks>
/// Some languages use complex input methods which involve opening windows to insert characters.
/// Typically, this is not desirable while playing a game, as games may just interpret key strokes as game input, not as text.
///
/// See <see cref="Keyboard.SetIMEEnabled"/> for turning IME on/off
/// </remarks>
public void SetIMECursorPosition(Vector2 position)
{
SetIMECursorPositionCommand command = SetIMECursorPositionCommand.Create(position);
ExecuteCommand(ref command);
}
/// <summary>
/// The name of the layout currently used by the keyboard.
/// </summary>
/// <remarks>
/// Note that keyboard layout names are platform-specific.
///
/// The value of this property reflects the currently used layout and thus changes
/// whenever the layout of the system or the one for the application is changed.
///
/// To determine what a key represents in the current layout, use <see cref="InputControl.displayName"/>.
/// </remarks>
public string keyboardLayout
{
get
{
RefreshConfigurationIfNeeded();
return m_KeyboardLayoutName;
}
protected set => m_KeyboardLayoutName = value;
}
/// <summary>
/// A synthetic button control that is considered pressed if any key on the keyboard is pressed.
/// </summary>
/// <value>Control representing the synthetic "anyKey".</value>
public AnyKeyControl anyKey { get; protected set; }
/// <summary>
/// The space bar key.
/// </summary>
/// <value>Control representing the space bar key.</value>
public KeyControl spaceKey => this[Key.Space];
/// <summary>
/// The enter/return key in the main key block.
/// </summary>
/// <value>Control representing the enter key.</value>
/// <remarks>
/// This key is distinct from the enter key on the numpad which is <see cref="numpadEnterKey"/>.
/// </remarks>
public KeyControl enterKey => this[Key.Enter];
/// <summary>
/// The tab key.
/// </summary>
/// <value>Control representing the tab key.</value>
public KeyControl tabKey => this[Key.Tab];
/// <summary>
/// The ` key. The leftmost key in the row of digits. Directly above <see cref="tabKey"/>.
/// </summary>
/// <value>Control representing the backtick/quote key.</value>
public KeyControl backquoteKey => this[Key.Backquote];
/// <summary>
/// The ' key. The key immediately to the left of <see cref="enterKey"/>.
/// </summary>
/// <value>Control representing the quote key.</value>
public KeyControl quoteKey => this[Key.Quote];
/// <summary>
/// The ';' key. The key immediately to the left of <see cref="quoteKey"/>.
/// </summary>
/// <value>Control representing the semicolon key.</value>
public KeyControl semicolonKey => this[Key.Semicolon];
/// <summary>
/// The ',' key. Third key to the left of <see cref="rightShiftKey"/>.
/// </summary>
/// <value>Control representing the comma key.</value>
public KeyControl commaKey => this[Key.Comma];
/// <summary>
/// The '.' key. Second key to the left of <see cref="rightShiftKey"/>.
/// </summary>
/// <value>Control representing the period key.</value>
public KeyControl periodKey => this[Key.Period];
/// <summary>
/// The '/' key. The key immediately to the left of <see cref="rightShiftKey"/>.
/// </summary>
/// <value>Control representing the forward slash key.</value>
public KeyControl slashKey => this[Key.Slash];
/// <summary>
/// The '\' key. The key immediately to the right of <see cref="rightBracketKey"/> and
/// next to or above <see cref="enterKey"/>.
/// </summary>
/// <value>Control representing the backslash key.</value>
public KeyControl backslashKey => this[Key.Backslash];
/// <summary>
/// The '[' key. The key immediately to the left of <see cref="rightBracketKey"/>.
/// </summary>
/// <value>Control representing the left bracket key.</value>
public KeyControl leftBracketKey => this[Key.LeftBracket];
/// <summary>
/// The ']' key. The key in-between <see cref="leftBracketKey"/> to the left and
/// <see cref="backslashKey"/> to the right.
/// </summary>
/// <value>Control representing the right bracket key.</value>
public KeyControl rightBracketKey => this[Key.RightBracket];
/// <summary>
/// The '-' key. The second key to the left of <see cref="backspaceKey"/>.
/// </summary>
/// <value>Control representing the minus key.</value>
public KeyControl minusKey => this[Key.Minus];
/// <summary>
/// The '=' key in the main key block. The key in-between <see cref="minusKey"/> to the left
/// and <see cref="backspaceKey"/> to the right.
/// </summary>
/// <value>Control representing the equals key.</value>
public KeyControl equalsKey => this[Key.Equals];
/// <summary>
/// The 'a' key. The key immediately to the right of <see cref="capsLockKey"/>.
/// </summary>
/// <value>Control representing the a key.</value>
public KeyControl aKey => this[Key.A];
/// <summary>
/// The 'b' key. The key in-between the <see cref="vKey"/> to the left and the <see cref="nKey"/>
/// to the right in the bottom-most row of alphabetic characters.
/// </summary>
/// <value>Control representing the b key.</value>
public KeyControl bKey => this[Key.B];
/// <summary>
/// The 'c' key. The key in-between the <see cref="xKey"/> to the left and the <see cref="vKey"/>
/// to the right in the bottom-most row of alphabetic characters.
/// </summary>
/// <value>Control representing the c key.</value>
public KeyControl cKey => this[Key.C];
/// <summary>
/// The 'd' key. The key in-between the <see cref="sKey"/> to the left and the <see cref="fKey"/>
/// to the right in the middle row of alphabetic characters.
/// </summary>
/// <value>Control representing the d key.</value>
public KeyControl dKey => this[Key.D];
/// <summary>
/// The 'e' key. The key in-between the <see cref="wKey"/> to the left and the <see cref="rKey"/>
/// to the right in the topmost row of alphabetic characters.
/// </summary>
/// <value>Control representing the e key.</value>
public KeyControl eKey => this[Key.E];
/// <summary>
/// The 'f' key. The key in-between the <see cref="dKey"/> to the left and the <see cref="gKey"/>
/// to the right in the middle row of alphabetic characters.
/// </summary>
/// <value>Control representing the f key.</value>
public KeyControl fKey => this[Key.F];
/// <summary>
/// The 'g' key. The key in-between the <see cref="fKey"/> to the left and the <see cref="hKey"/>
/// to the right in the middle row of alphabetic characters.
/// </summary>
/// <value>Control representing the g key.</value>
public KeyControl gKey => this[Key.G];
/// <summary>
/// The 'h' key. The key in-between the <see cref="gKey"/> to the left and the <see cref="jKey"/>
/// to the right in the middle row of alphabetic characters.
/// </summary>
/// <value>Control representing the h key.</value>
public KeyControl hKey => this[Key.H];
/// <summary>
/// The 'i' key. The key in-between the <see cref="uKey"/> to the left and the <see cref="oKey"/>
/// to the right in the top row of alphabetic characters.
/// </summary>
public KeyControl iKey => this[Key.I];
/// <summary>
/// The 'j' key. The key in-between the <see cref="hKey"/> to the left and the <see cref="kKey"/>
/// to the right in the middle row of alphabetic characters.
/// </summary>
/// <value>Control representing the j key.</value>
public KeyControl jKey => this[Key.J];
/// <summary>
/// The 'k' key. The key in-between the <see cref="jKey"/> to the left and the <see cref="lKey"/>
/// to the right in the middle row of alphabetic characters.
/// </summary>
/// <value>Control representing the k key.</value>
public KeyControl kKey => this[Key.K];
/// <summary>
/// The 'l' key. The key in-between the <see cref="kKey"/> to the left and the <see cref="semicolonKey"/>
/// to the right in the middle row of alphabetic characters.
/// </summary>
/// <value>Control representing the l key.</value>
public KeyControl lKey => this[Key.L];
/// <summary>
/// The 'm' key. The key in-between the <see cref="nKey"/> to the left and the <see cref="commaKey"/>
/// to the right in the bottom row of alphabetic characters.
/// </summary>
/// <value>Control representing the m key.</value>
public KeyControl mKey => this[Key.M];
/// <summary>
/// The 'n' key. The key in-between the <see cref="bKey"/> to the left and the <see cref="mKey"/> to
/// the right in the bottom row of alphabetic characters.
/// </summary>
/// <value>Control representing the n key.</value>
public KeyControl nKey => this[Key.N];
/// <summary>
/// The 'o' key. The key in-between the <see cref="iKey"/> to the left and the <see cref="pKey"/> to
/// the right in the top row of alphabetic characters.
/// </summary>
/// <value>Control representing the o key.</value>
public KeyControl oKey => this[Key.O];
/// <summary>
/// The 'p' key. The key in-between the <see cref="oKey"/> to the left and the <see cref="leftBracketKey"/>
/// to the right in the top row of alphabetic characters.
/// </summary>
/// <value>Control representing the p key.</value>
public KeyControl pKey => this[Key.P];
/// <summary>
/// The 'q' key. The key in-between the <see cref="tabKey"/> to the left and the <see cref="wKey"/>
/// to the right in the top row of alphabetic characters.
/// </summary>
/// <value>Control representing the q key.</value>
public KeyControl qKey => this[Key.Q];
/// <summary>
/// The 'r' key. The key in-between the <see cref="eKey"/> to the left and the <see cref="tKey"/>
/// to the right in the top row of alphabetic characters.
/// </summary>
/// <value>Control representing the r key.</value>
public KeyControl rKey => this[Key.R];
/// <summary>
/// The 's' key. The key in-between the <see cref="aKey"/> to the left and the <see cref="dKey"/>
/// to the right in the middle row of alphabetic characters.
/// </summary>
/// <value>Control representing the s key.</value>
public KeyControl sKey => this[Key.S];
/// <summary>
/// The 't' key. The key in-between the <see cref="rKey"/> to the left and the <see cref="yKey"/>
/// to the right in the top row of alphabetic characters.
/// </summary>
/// <value>Control representing the t key.</value>
public KeyControl tKey => this[Key.T];
/// <summary>
/// The 'u' key. The key in-between the <see cref="yKey"/> to the left and the <see cref="iKey"/>
/// to the right in the top row of alphabetic characters.
/// </summary>
/// <value>Control representing the u key.</value>
public KeyControl uKey => this[Key.U];
/// <summary>
/// The 'v' key. The key in-between the <see cref="cKey"/> to the left and the <see cref="bKey"/>
/// to the right in the bottom row of alphabetic characters.
/// </summary>
/// <value>Control representing the v key.</value>
public KeyControl vKey => this[Key.V];
/// <summary>
/// The 'w' key. The key in-between the <see cref="qKey"/> to the left and the <see cref="eKey"/>
/// to the right in the top row of alphabetic characters.
/// </summary>
/// <value>Control representing the w key.</value>
public KeyControl wKey => this[Key.W];
/// <summary>
/// The 'x' key. The key in-between the <see cref="zKey"/> to the left and the <see cref="cKey"/>
/// to the right in the bottom row of alphabetic characters.
/// </summary>
/// <value>Control representing the x key.</value>
public KeyControl xKey => this[Key.X];
/// <summary>
/// The 'y' key. The key in-between the <see cref="tKey"/> to the left and the <see cref="uKey"/>
/// to the right in the top row of alphabetic characters.
/// </summary>
/// <value>Control representing the y key.</value>
public KeyControl yKey => this[Key.Y];
/// <summary>
/// The 'z' key. The key in-between the <see cref="leftShiftKey"/> to the left and the <see cref="xKey"/>
/// to the right in the bottom row of alphabetic characters.
/// </summary>
/// <value>Control representing the z key.</value>
public KeyControl zKey => this[Key.Z];
/// <summary>
/// The '1' key. The key in-between the <see cref="backquoteKey"/> to the left and the <see cref="digit2Key"/>
/// to the right in the row of digit characters.
/// </summary>
/// <value>Control representing the 1 key.</value>
public KeyControl digit1Key => this[Key.Digit1];
/// <summary>
/// The '2' key. The key in-between the <see cref="digit1Key"/> to the left and the <see cref="digit3Key"/>
/// to the right in the row of digit characters.
/// </summary>
/// <value>Control representing the 2 key.</value>
public KeyControl digit2Key => this[Key.Digit2];
/// <summary>
/// The '3' key. The key in-between the <see cref="digit2Key"/> to the left and the <see cref="digit4Key"/>
/// to the right in the row of digit characters.
/// </summary>
/// <value>Control representing the 3 key.</value>
public KeyControl digit3Key => this[Key.Digit3];
/// <summary>
/// The '4' key. The key in-between the <see cref="digit3Key"/> to the left and the <see cref="digit5Key"/>
/// to the right in the row of digit characters.
/// </summary>
/// <value>Control representing the 4 key.</value>
public KeyControl digit4Key => this[Key.Digit4];
/// <summary>
/// The '5' key. The key in-between the <see cref="digit4Key"/> to the left and the <see cref="digit6Key"/>
/// to the right in the row of digit characters.
/// </summary>
/// <value>Control representing the 5 key.</value>
public KeyControl digit5Key => this[Key.Digit5];
/// <summary>
/// The '6' key. The key in-between the <see cref="digit5Key"/> to the left and the <see cref="digit7Key"/>
/// to the right in the row of digit characters.
/// </summary>
/// <value>Control representing the 6 key.</value>
public KeyControl digit6Key => this[Key.Digit6];
/// <summary>
/// The '7' key. The key in-between the <see cref="digit6Key"/> to the left and the <see cref="digit8Key"/>
/// to the right in the row of digit characters.
/// </summary>
/// <value>Control representing the 7 key.</value>
public KeyControl digit7Key => this[Key.Digit7];
/// <summary>
/// The '8' key. The key in-between the <see cref="digit7Key"/> to the left and the <see cref="digit9Key"/>
/// to the right in the row of digit characters.
/// </summary>
/// <value>Control representing the 8 key.</value>
public KeyControl digit8Key => this[Key.Digit8];
/// <summary>
/// The '9' key. The key in-between the <see cref="digit8Key"/> to the left and the <see cref="digit0Key"/>
/// to the right in the row of digit characters.
/// </summary>
/// <value>Control representing the 9 key.</value>
public KeyControl digit9Key => this[Key.Digit9];
/// <summary>
/// The '0' key. The key in-between the <see cref="digit9Key"/> to the left and the <see cref="minusKey"/>
/// to the right in the row of digit characters.
/// </summary>
/// <value>Control representing the 0 key.</value>
public KeyControl digit0Key => this[Key.Digit0];
/// <summary>
/// The shift key on the left side of the keyboard.
/// </summary>
/// <value>Control representing the left shift key.</value>
public KeyControl leftShiftKey => this[Key.LeftShift];
/// <summary>
/// The shift key on the right side of the keyboard.
/// </summary>
/// <value>Control representing the right shift key.</value>
public KeyControl rightShiftKey => this[Key.RightShift];
/// <summary>
/// The alt/option key on the left side of the keyboard.
/// </summary>
/// <value>Control representing the left alt/option key.</value>
public KeyControl leftAltKey => this[Key.LeftAlt];
/// <summary>
/// The alt/option key on the right side of the keyboard.
/// </summary>
/// <value>Control representing the right alt/option key.</value>
public KeyControl rightAltKey => this[Key.RightAlt];
/// <summary>
/// The control/ctrl key on the left side of the keyboard.
/// </summary>
/// <value>Control representing the left control key.</value>
public KeyControl leftCtrlKey => this[Key.LeftCtrl];
/// <summary>
/// The control/ctrl key on the right side of the keyboard.
/// </summary>
/// <remarks>This key is usually not present on Mac laptops.</remarks>
/// <value>Control representing the right control key.</value>
public KeyControl rightCtrlKey => this[Key.RightCtrl];
/// <summary>
/// The system "meta" key (Windows key on PC, Apple/command key on Mac) on the left
/// side of the keyboard.
/// </summary>
/// <value>Control representing the left system meta key.</value>
public KeyControl leftMetaKey => this[Key.LeftMeta];
/// <summary>
/// The system "meta" key (Windows key on PC, Apple/command key on Mac) on the right
/// side of the keyboard.
/// </summary>
/// <value>Control representing the right system meta key.</value>
public KeyControl rightMetaKey => this[Key.RightMeta];
/// <summary>
/// Same as <see cref="leftMetaKey"/>. Windows system key on left side of keyboard.
/// </summary>
/// <value>Control representing the left Windows system key.</value>
public KeyControl leftWindowsKey => this[Key.LeftWindows];
/// <summary>
/// Same as <see cref="rightMetaKey"/>. Windows system key on right side of keyboard.
/// </summary>
/// <value>Control representing the right Windows system key.</value>
public KeyControl rightWindowsKey => this[Key.RightWindows];
/// <summary>
/// Same as <see cref="leftMetaKey"/>. Apple/command system key on left side of keyboard.
/// </summary>
/// <value>Control representing the left Apple/command system key.</value>
public KeyControl leftAppleKey => this[Key.LeftApple];
/// <summary>
/// Same as <see cref="rightMetaKey"/>. Apple/command system key on right side of keyboard.
/// </summary>
/// <value>Control representing the right Apple/command system key.</value>
public KeyControl rightAppleKey => this[Key.RightApple];
/// <summary>
/// Same as <see cref="leftMetaKey"/>. Apple/command system key on left side of keyboard.
/// </summary>
/// <value>Control representing the left Apple/command system key.</value>
public KeyControl leftCommandKey => this[Key.LeftCommand];
/// <summary>
/// Same as <see cref="rightMetaKey"/>. Apple/command system key on right side of keyboard.
/// </summary>
/// <value>Control representing the right Apple/command system key.</value>
public KeyControl rightCommandKey => this[Key.RightCommand];
/// <summary>
/// The context menu key. This key is generally only found on PC keyboards. If present,
/// the key is found in-between the <see cref="rightWindowsKey"/> to the left and the
/// <see cref="rightCtrlKey"/> to the right. It's intention is to bring up the context
/// menu according to the current selection.
/// </summary>
/// <value>Control representing the context menu key.</value>
public KeyControl contextMenuKey => this[Key.ContextMenu];
/// <summary>
/// The escape key, i.e. the key generally in the top left corner of the keyboard.
/// Usually to the left of <see cref="f1Key"/>.
/// </summary>
/// <value>Control representing the escape key.</value>
public KeyControl escapeKey => this[Key.Escape];
/// <summary>
/// The left arrow key. Usually in a block by itself and generally to the left
/// of <see cref="downArrowKey"/>.
/// </summary>
/// <value>Control representing the left arrow key.</value>
public KeyControl leftArrowKey => this[Key.LeftArrow];
/// <summary>
/// The right arrow key. Usually in a block by itself and generally to the right
/// of <see cref="downArrowKey"/>
/// </summary>
/// <value>Control representing the right arrow key.</value>
public KeyControl rightArrowKey => this[Key.RightArrow];
/// <summary>
/// The up arrow key. Usually in a block by itself and generally on top of the
/// <see cref="downArrowKey"/>.
/// </summary>
/// <value>Control representing the up arrow key.</value>
public KeyControl upArrowKey => this[Key.UpArrow];
/// <summary>
/// The down arrow key. Usually in a block by itself and generally below the
/// <see cref="upArrowKey"/> and in-between <see cref="leftArrowKey"/> to the
/// left and <see cref="rightArrowKey"/> to the right.
/// </summary>
/// <value>Control representing the down arrow key.</value>
public KeyControl downArrowKey => this[Key.DownArrow];
/// <summary>
/// The backspace key (usually labeled "delete" on Mac). The rightmost key
/// in the top digit row with <see cref="equalsKey"/> to the left.
/// </summary>
/// <value>Control representing the backspace key.</value>
/// <remarks>
/// On the Mac, this key may be labeled "delete" which however is a
/// key different from <see cref="deleteKey"/>.
/// </remarks>
public KeyControl backspaceKey => this[Key.Backspace];
/// <summary>
/// The page down key. Usually in a separate block with <see cref="endKey"/>
/// to the left and <see cref="pageUpKey"/> above it.
/// </summary>
/// <value>Control representing the page down key.</value>
public KeyControl pageDownKey => this[Key.PageDown];
/// <summary>
/// The page up key. Usually in a separate block with <see cref="homeKey"/>
/// to the left and <see cref="pageDownKey"/> below it.
/// </summary>
/// <value>Control representing the page up key.</value>
public KeyControl pageUpKey => this[Key.PageUp];
/// <summary>
/// The 'home' key. Usually in a separate block with <see cref="pageUpKey"/>
/// to the right and <see cref="insertKey"/> to the left.
/// </summary>
/// <value>Control representing the insert key.</value>
public KeyControl homeKey => this[Key.Home];
/// <summary>
/// The 'end' key. Usually in a separate block with <see cref="deleteKey"/>
/// to the left and <see cref="pageDownKey"/> to the right.
/// </summary>
/// <value>Control representing the end key.</value>
public KeyControl endKey => this[Key.End];
/// <summary>
/// The 'insert' key. Usually in a separate block with <see cref="homeKey"/>
/// to its right and <see cref="deleteKey"/> sitting below it.
/// </summary>
/// <value>Control representing the insert key.</value>
public KeyControl insertKey => this[Key.Insert];
/// <summary>
/// The 'delete' key. Usually in a separate block with <see cref="endKey"/>
/// to its right and <see cref="insertKey"/> sitting above it.
/// </summary>
/// <value>Control representing the delete key.</value>
/// <remarks>
/// On the Mac, the <see cref="backspaceKey"/> is also labeled "delete".
/// However, this is not this key.
/// </remarks>
public KeyControl deleteKey => this[Key.Delete];
/// <summary>
/// The Caps Lock key. The key below <see cref="tabKey"/> and above
/// <see cref="leftShiftKey"/>.
/// </summary>
/// <value>Control representing the caps lock key.</value>
public KeyControl capsLockKey => this[Key.CapsLock];
/// <summary>
/// The Scroll Lock key. The key in-between the <see cref="printScreenKey"/>
/// to the left and the <see cref="pauseKey"/> to the right. May also
/// be labeled "F14".
/// </summary>
/// <value>Control representing the scroll lock key.</value>
public KeyControl scrollLockKey => this[Key.ScrollLock];
/// <summary>
/// The Num Lock key. The key sitting in the top left corner of the
/// numpad and which usually toggles the numpad between generating
/// digits and triggering functions like "insert" etc. instead.
/// </summary>
/// <value>Control representing the num lock key.</value>
public KeyControl numLockKey => this[Key.NumLock];
/// <summary>
/// The Print Screen key. The key sitting in-between <see cref="f12Key"/>
/// to the left and <see cref="scrollLockKey"/> to the right. May also
/// be labeled "F13".
/// </summary>
/// <value>Control representing the print screen key.</value>
public KeyControl printScreenKey => this[Key.PrintScreen];
/// <summary>
/// The pause/break key. The key sitting to the left of <see cref="scrollLockKey"/>.
/// May also be labeled "F15".
/// </summary>
/// <value>Control representing the pause/break key.</value>
public KeyControl pauseKey => this[Key.Pause];
/// <summary>
/// The enter key on the numpad. The key sitting in the bottom right corner
/// of the numpad.
/// </summary>
/// <value>Control representing the numpad enter key.</value>
public KeyControl numpadEnterKey => this[Key.NumpadEnter];
/// <summary>
/// The divide ('/') key on the numpad. The key in-between <see cref="numpadEqualsKey"/>
/// to the left and <see cref="numpadMultiplyKey"/> to the right.
/// </summary>
/// <value>Control representing the numpad divide key.</value>
/// <remarks>
/// PC keyboards usually have a 17-key numpad layout that differs from the 18-key layout
/// we use for reference. The 18-key layout is usually found on Mac keyboards. The numpad
/// divide key usually is the <see cref="numpadEqualsKey"/> on PC keyboards.
/// </remarks>
public KeyControl numpadDivideKey => this[Key.NumpadDivide];
/// <summary>
/// The multiply ('*') key on the numpad. The key in the upper right corner of the numpad
/// with <see cref="numpadDivideKey"/> to the left and <see cref="numpadMultiplyKey"/>
/// below it.
/// </summary>
/// <value>Control representing the numpad multiply key.</value>
/// <remarks>
/// PC keyboards usually have a 17-key numpad layout that differs from the 18-key layout
/// we use for reference. The 18-key layout is usually found on Mac keyboards. The numpad
/// multiply key usually is the <see cref="numpadMinusKey"/> on PC keyboards.
/// </remarks>
public KeyControl numpadMultiplyKey => this[Key.NumpadMultiply];
/// <summary>
/// The minus ('-') key on the numpad. The key on the right side of the numpad with
/// <see cref="numpadMultiplyKey"/> above it and <see cref="numpadPlusKey"/> below it.
/// </summary>
/// <value>Control representing the numpad minus key.</value>
/// <remarks>
/// PC keyboards usually have a 17-key numpad layout that differs from the 18-key layout
/// we use for reference. The 18-key layout is usually found on Mac keyboards. The numpad
/// minus key is usually <em>not</em> present on PC keyboards. Instead, the 17-key layout
/// has an elongated <see cref="numpadPlusKey"/> that covers the space of two keys.
/// </remarks>
public KeyControl numpadMinusKey => this[Key.NumpadMinus];
/// <summary>
/// The plus ('+') key on the numpad. The key on the right side of the numpad with
/// <see cref="numpadMinusKey"/> above it and <see cref="numpadEnterKey"/> below it.
/// </summary>
/// <value>Control representing the numpad plus key.</value>
/// <remarks>
/// PC keyboards usually have a 17-key numpad layout that differs from the 18-key layout
/// we use for reference. The 18-key layout is usually found on Mac keyboards.
///
/// In particular, the plus key on the numpad is usually an elongated key that covers
/// the space of two keys. These 17-key numpads do not usually have a <see cref="numpadEqualsKey"/>
/// and the key above the plus key will usually be the numpad minus key.
///
/// However, both on a 17-key and 18-key numpad, the plus key references the same physical key.
/// </remarks>
public KeyControl numpadPlusKey => this[Key.NumpadPlus];
/// <summary>
/// The period ('.') key on the numpad. The key in-between the <see cref="numpadEnterKey"/>
/// to the right and the <see cref="numpad0Key"/> to the left.
/// </summary>
/// <value>Control representing the numpad period key.</value>
/// <remarks>
/// This key is the same in 17-key and 18-key numpad layouts.
/// </remarks>
public KeyControl numpadPeriodKey => this[Key.NumpadPeriod];
/// <summary>
/// The equals ('=') key on the numpad. The key in-between <see cref="numLockKey"/> to the left
/// and <see cref="numpadDivideKey"/> to the right in the top row of the numpad.
/// </summary>
/// <value>Control representing the numpad equals key.</value>
/// <remarks>
/// PC keyboards usually have a 17-key numpad layout that differs from the 18-key layout
/// we use for reference. The 18-key layout is usually found on Mac keyboards.
///
/// 17-key numpad layouts do not usually have an equals key. On these PC keyboards, the
/// equals key is usually the divide key.
/// </remarks>
public KeyControl numpadEqualsKey => this[Key.NumpadEquals];
/// <summary>
/// The 0 key on the numpad. The key in the bottom left corner of the numpad. Usually
/// and elongated key.
/// </summary>
/// <value>Control representing the numpad 0 key.</value>
public KeyControl numpad0Key => this[Key.Numpad0];
/// <summary>
/// The 1 key on the numpad. The key on the left side of the numpad with <see cref="numpad0Key"/>
/// below it and <see cref="numpad4Key"/> above it.
/// </summary>
/// <value>Control representing the numpad 1 key.</value>
public KeyControl numpad1Key => this[Key.Numpad1];
/// <summary>
/// The 2 key on the numpad. The key with the <see cref="numpad1Key"/> to its left and
/// the <see cref="numpad3Key"/> to its right.
/// </summary>
/// <value>Control representing the numpad 2 key.</value>
public KeyControl numpad2Key => this[Key.Numpad2];
/// <summary>
/// The 3 key on the numpad. The key with the <see cref="numpad2Key"/> to its left and
/// the <see cref="numpadEnterKey"/> to its right.
/// </summary>
/// <value>Control representing the numpad 3 key.</value>
public KeyControl numpad3Key => this[Key.Numpad3];
/// <summary>
/// The 4 key on the numpad. The key on the left side of the numpad with the <see cref="numpad1Key"/>
/// below it and the <see cref="numpad7Key"/> above it.
/// </summary>
/// <value>Control representing the numpad 4 key.</value>
public KeyControl numpad4Key => this[Key.Numpad4];
/// <summary>
/// The 5 key on the numpad. The key in-between the <see cref="numpad4Key"/> to the left and the
/// <see cref="numpad6Key"/> to the right.
/// </summary>
/// <value>Control representing the numpad 5 key.</value>
public KeyControl numpad5Key => this[Key.Numpad5];
/// <summary>
/// The 6 key on the numpad. The key in-between the <see cref="numpad5Key"/> to the let and
/// the <see cref="numpadPlusKey"/> to the right.
/// </summary>
/// <value>Control representing the numpad 6 key.</value>
public KeyControl numpad6Key => this[Key.Numpad6];
/// <summary>
/// The 7 key on the numpad. The key on the left side of the numpad with <see cref="numpad4Key"/>
/// below it and <see cref="numLockKey"/> above it.
/// </summary>
/// <value>Control representing the numpad 7 key.</value>
public KeyControl numpad7Key => this[Key.Numpad7];
/// <summary>
/// The 8 key on the numpad. The key in-between the <see cref="numpad7Key"/> to the left and the
/// <see cref="numpad9Key"/> to the right.
/// </summary>
/// <value>Control representing the numpad 8 key.</value>
public KeyControl numpad8Key => this[Key.Numpad8];
/// <summary>
/// The 9 key on the numpad. The key in-between the <see cref="numpad8Key"/> to the left and
/// the <see cref="numpadMinusKey"/> to the right (or, on 17-key PC keyboard numpads, the elongated
/// plus key).
/// </summary>
/// <value>Control representing the numpad 9 key.</value>
public KeyControl numpad9Key => this[Key.Numpad9];
/// <summary>
/// The F1 key. The key in-between <see cref="escapeKey"/> to the left and <see cref="f1Key"/>
/// to the right in the topmost row of keys.
/// </summary>
/// <value>Control representing the F1 key.</value>
public KeyControl f1Key => this[Key.F1];
/// <summary>
/// The F2 key. The key in-between <see cref="f1Key"/> to the left and <see cref="f3Key"/>
/// to the right in the topmost row of keys.
/// </summary>
/// <value>Control representing the F2 key.</value>
public KeyControl f2Key => this[Key.F2];
/// <summary>
/// The F3 key. The key in-between <see cref="f2Key"/> to the left and <see cref="f4Key"/>
/// to the right in the topmost row of keys.
/// </summary>
/// <value>Control representing the F3 key.</value>
public KeyControl f3Key => this[Key.F3];
/// <summary>
/// The F4 key. The key in-between <see cref="f3Key"/> to the left and <see cref="f5Key"/>
/// to the right in the topmost row of keys.
/// </summary>
/// <value>Control representing the F4 key.</value>
public KeyControl f4Key => this[Key.F4];
/// <summary>
/// The F5 key. The key in-between <see cref="f4Key"/> to the left and <see cref="f6Key"/>
/// to the right in the topmost row of keys.
/// </summary>
/// <value>Control representing the F5 key.</value>
public KeyControl f5Key => this[Key.F5];
/// <summary>
/// The F6 key. The key in-between <see cref="f5Key"/> to the left and <see cref="f7Key"/>
/// to the right in the topmost row of keys.
/// </summary>
/// <value>Control representing the F6 key.</value>
public KeyControl f6Key => this[Key.F6];
/// <summary>
/// The F7 key. The key in-between <see cref="f6Key"/> to the left and <see cref="f8Key"/>
/// to the right in the topmost row of keys.
/// </summary>
/// <value>Control representing the F7 key.</value>
public KeyControl f7Key => this[Key.F7];
/// <summary>
/// The F8 key. The key in-between <see cref="f7Key"/> to the left and <see cref="f9Key"/>
/// to the right in the topmost row of keys.
/// </summary>
/// <value>Control representing the F8 key.</value>
public KeyControl f8Key => this[Key.F8];
/// <summary>
/// The F9 key. The key in-between <see cref="f8Key"/> to the left and <see cref="f10Key"/>
/// to the right in the topmost row of keys.
/// </summary>
/// <value>Control representing the F9 key.</value>
public KeyControl f9Key => this[Key.F9];
/// <summary>
/// The F10 key. The key in-between <see cref="f9Key"/> to the left and <see cref="f11Key"/>
/// to the right in the topmost row of keys.
/// </summary>
/// <value>Control representing the F10 key.</value>
public KeyControl f10Key => this[Key.F10];
/// <summary>
/// The F11 key. The key in-between <see cref="f10Key"/> to the left and <see cref="f12Key"/>
/// to the right in the topmost row of keys.
/// </summary>
/// <value>Control representing the F11 key.</value>
public KeyControl f11Key => this[Key.F11];
/// <summary>
/// The F12 key. The key in-between <see cref="f11Key"/> to the left and <see cref="printScreenKey"/>
/// to the right in the topmost row of keys.
/// </summary>
/// <value>Control representing the F12 key.</value>
public KeyControl f12Key => this[Key.F12];
/// <summary>
/// First additional key on the keyboard.
/// </summary>
/// <value>Control representing <see cref="Key.OEM1"/>.</value>
/// <remarks>
/// Keyboards may have additional keys that are not part of the standardized 104-key keyboard layout
/// (105 in the case of an 18-key numpad). For example, many non-English keyboard layouts have an additional
/// key in-between <see cref="leftShiftKey"/> and <see cref="zKey"/>.
///
/// Additional keys may be surfaced by the platform as "OEM" keys. There is no guarantee about where the
/// keys are located and what symbols they produce. The OEM key controls are mainly there to surface the
/// inputs but not with the intention of being used in standard bindings.
/// </remarks>
public KeyControl oem1Key => this[Key.OEM1];
/// <summary>
/// Second additional key on the keyboard.
/// </summary>
/// <value>Control representing <see cref="Key.OEM2"/>.</value>
/// <remarks>
/// Keyboards may have additional keys that are not part of the standardized 104-key keyboard layout
/// (105 in the case of an 18-key numpad). For example, many non-English keyboard layouts have an additional
/// key in-between <see cref="leftShiftKey"/> and <see cref="zKey"/>.
///
/// Additional keys may be surfaced by the platform as "OEM" keys. There is no guarantee about where the
/// keys are located and what symbols they produce. The OEM key controls are mainly there to surface the
/// inputs but not with the intention of being used in standard bindings.
/// </remarks>
public KeyControl oem2Key => this[Key.OEM2];
/// <summary>
/// Third additional key on the keyboard.
/// </summary>
/// <value>Control representing <see cref="Key.OEM3"/>.</value>
/// <remarks>
/// Keyboards may have additional keys that are not part of the standardized 104-key keyboard layout
/// (105 in the case of an 18-key numpad). For example, many non-English keyboard layouts have an additional
/// key in-between <see cref="leftShiftKey"/> and <see cref="zKey"/>.
///
/// Additional keys may be surfaced by the platform as "OEM" keys. There is no guarantee about where the
/// keys are located and what symbols they produce. The OEM key controls are mainly there to surface the
/// inputs but not with the intention of being used in standard bindings.
/// </remarks>
public KeyControl oem3Key => this[Key.OEM3];
/// <summary>
/// Fourth additional key on the keyboard.
/// </summary>
/// <value>Control representing <see cref="Key.OEM4"/>.</value>
/// <remarks>
/// Keyboards may have additional keys that are not part of the standardized 104-key keyboard layout
/// (105 in the case of an 18-key numpad). For example, many non-English keyboard layouts have an additional
/// key in-between <see cref="leftShiftKey"/> and <see cref="zKey"/>.
///
/// Additional keys may be surfaced by the platform as "OEM" keys. There is no guarantee about where the
/// keys are located and what symbols they produce. The OEM key controls are mainly there to surface the
/// inputs but not with the intention of being used in standard bindings.
/// </remarks>
public KeyControl oem4Key => this[Key.OEM4];
/// <summary>
/// Fifth additional key on the keyboard.
/// </summary>
/// <value>Control representing <see cref="Key.OEM5"/>.</value>
/// <remarks>
/// Keyboards may have additional keys that are not part of the standardized 104-key keyboard layout
/// (105 in the case of an 18-key numpad). For example, many non-English keyboard layouts have an additional
/// key in-between <see cref="leftShiftKey"/> and <see cref="zKey"/>.
///
/// Additional keys may be surfaced by the platform as "OEM" keys. There is no guarantee about where the
/// keys are located and what symbols they produce. The OEM key controls are mainly there to surface the
/// inputs but not with the intention of being used in standard bindings.
/// </remarks>
public KeyControl oem5Key => this[Key.OEM5];
/// <summary>
/// An artificial combination of <see cref="leftShiftKey"/> and <see cref="rightShiftKey"/> into one control.
/// </summary>
/// <value>Control representing a combined left and right shift key.</value>
/// <remarks>
/// This is a <see cref="InputControl.synthetic"/> button which is considered pressed whenever the left and/or
/// right shift key is pressed.
/// </remarks>
public ButtonControl shiftKey { get; protected set; }
/// <summary>
/// An artificial combination of <see cref="leftCtrlKey"/> and <see cref="rightCtrlKey"/> into one control.
/// </summary>
/// <value>Control representing a combined left and right ctrl key.</value>
/// <remarks>
/// This is a <see cref="InputControl.synthetic"/> button which is considered pressed whenever the left and/or
/// right ctrl key is pressed.
/// </remarks>
public ButtonControl ctrlKey { get; protected set; }
/// <summary>
/// An artificial combination of <see cref="leftAltKey"/> and <see cref="rightAltKey"/> into one control.
/// </summary>
/// <value>Control representing a combined left and right alt key.</value>
/// <remarks>
/// This is a <see cref="InputControl.synthetic"/> button which is considered pressed whenever the left and/or
/// right alt key is pressed.
/// </remarks>
public ButtonControl altKey { get; protected set; }
/// <summary>
/// True when IME composition is enabled. Requires <see cref="Keyboard.SetIMEEnabled"/> to be called to enable IME, and the user to enable it at the OS level.
/// </summary>
/// <remarks>
///
/// Some languages use complex input methods which involve opening windows to insert characters.
/// Typically, this is not desirable while playing a game, as games may just interpret key strokes as game input, not as text.
///
/// See <see cref="Keyboard.SetIMEEnabled"/> for turning IME on/off
/// </remarks>
public ButtonControl imeSelected { get; protected set; }
/// <summary>
/// Look up a key control by its key code.
/// </summary>
/// <param name="key">Key code of key control to return.</param>
/// <exception cref="ArgumentOutOfRangeException">The given <paramref cref="key"/> is not valid.</exception>
/// <remarks>
/// This is equivalent to <c>allKeys[(int)key - 1]</c>.
/// </remarks>
public KeyControl this[Key key]
{
get
{
var index = (int)key - 1;
if (index < 0 || index >= m_Keys.Length)
throw new ArgumentOutOfRangeException(nameof(key));
return m_Keys[index];
}
}
/// <summary>
/// List of all key controls on the keyboard.
/// </summary>
public ReadOnlyArray<KeyControl> allKeys => new ReadOnlyArray<KeyControl>(m_Keys);
/// <summary>
/// The keyboard that was last used or added. Null if there is no keyboard.
/// </summary>
public static Keyboard current { get; private set; }
/// <summary>
/// Make the keyboard the current keyboard (i.e. <see cref="current"/>).
/// </summary>
/// <remarks>
/// A keyboard will automatically be made current when receiving input or when
/// added to the input system.
/// </remarks>
public override void MakeCurrent()
{
base.MakeCurrent();
current = this;
}
/// <summary>
/// Called when the keyboard is removed from the system.
/// </summary>
protected override void OnRemoved()
{
base.OnRemoved();
if (current == this)
current = null;
}
/// <summary>
/// Called after the keyboard has been constructed but before it is added to
/// the system.
/// </summary>
protected override void FinishSetup()
{
var keyStrings = new[]
{
"space",
"enter",
"tab",
"backquote",
"quote",
"semicolon",
"comma",
"period",
"slash",
"backslash",
"leftbracket",
"rightbracket",
"minus",
"equals",
"a",
"b",
"c",
"d",
"e",
"f",
"g",
"h",
"i",
"j",
"k",
"l",
"m",
"n",
"o",
"p",
"q",
"r",
"s",
"t",
"u",
"v",
"w",
"x",
"y",
"z",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"0",
"leftshift",
"rightshift",
"leftalt",
"rightalt",
"leftctrl",
"rightctrl",
"leftmeta",
"rightmeta",
"contextmenu",
"escape",
"leftarrow",
"rightarrow",
"uparrow",
"downarrow",
"backspace",
"pagedown",
"pageup",
"home",
"end",
"insert",
"delete",
"capslock",
"numlock",
"printscreen",
"scrolllock",
"pause",
"numpadenter",
"numpaddivide",
"numpadmultiply",
"numpadplus",
"numpadminus",
"numpadperiod",
"numpadequals",
"numpad0",
"numpad1",
"numpad2",
"numpad3",
"numpad4",
"numpad5",
"numpad6",
"numpad7",
"numpad8",
"numpad9",
"f1",
"f2",
"f3",
"f4",
"f5",
"f6",
"f7",
"f8",
"f9",
"f10",
"f11",
"f12",
"oem1",
"oem2",
"oem3",
"oem4",
"oem5",
};
m_Keys = new KeyControl[keyStrings.Length];
for (var i = 0; i < keyStrings.Length; ++i)
{
m_Keys[i] = GetChildControl<KeyControl>(keyStrings[i]);
////REVIEW: Ideally, we'd have a way to do this through layouts; this way nested key controls could work, too,
//// and it just seems somewhat dirty to jam the data into the control here
m_Keys[i].keyCode = (Key)(i + 1);
}
Debug.Assert(keyStrings[(int)Key.OEM5 - 1] == "oem5",
"keyString array layout doe not match Key enum layout");
anyKey = GetChildControl<AnyKeyControl>("anyKey");
shiftKey = GetChildControl<ButtonControl>("shift");
ctrlKey = GetChildControl<ButtonControl>("ctrl");
altKey = GetChildControl<ButtonControl>("alt");
imeSelected = GetChildControl<ButtonControl>("IMESelected");
base.FinishSetup();
}
/// <inheritdoc/>
protected override void RefreshConfiguration()
{
keyboardLayout = null;
var command = QueryKeyboardLayoutCommand.Create();
if (ExecuteCommand(ref command) >= 0)
keyboardLayout = command.ReadLayoutName();
}
/// <summary>
/// Called when text input on the keyboard is received.
/// </summary>
/// <param name="character">Character that has been entered.</param>
/// <remarks>
/// The system will call this automatically whenever a <see cref="TextEvent"/> is
/// received that targets the keyboard device.
/// </remarks>
public void OnTextInput(char character)
{
for (var i = 0; i < m_TextInputListeners.length; ++i)
m_TextInputListeners[i](character);
}
/// <summary>
/// Return the key control that, according to the currently active keyboard layout (see <see cref="keyboardLayout"/>),
/// is associated with the given text.
/// </summary>
/// <param name="displayName">Display name reported for the key according to the currently active keyboard layout.</param>
/// <returns>The key control corresponding to the given text or <c>null</c> if no such key was found on the current
/// keyboard layout.</returns>
/// <remarks>
/// In most cases, this means that the key inputs the given text when pressed. However, this does not have to be the
/// case. Keys do not necessarily lead to character input.
///
/// <example>
/// // Find key that prints 'q' character (if any).
/// Keyboard.current.FindKeyOnCurrentKeyboardLayout("q");
/// </example>
/// </remarks>
/// <seealso cref="keyboardLayout"/>
public KeyControl FindKeyOnCurrentKeyboardLayout(string displayName)
{
var keys = allKeys;
for (var i = 0; i < keys.Count; ++i)
if (string.Equals(keys[i].displayName, displayName, StringComparison.CurrentCultureIgnoreCase))
return keys[i];
return null;
}
public void OnIMECompositionChanged(IMECompositionString compositionString)
{
if (m_ImeCompositionListeners.length > 0)
{
for (var i = 0; i < m_ImeCompositionListeners.length; ++i)
m_ImeCompositionListeners[i](compositionString);
}
}
private InlinedArray<Action<char>> m_TextInputListeners;
private string m_KeyboardLayoutName;
private KeyControl[] m_Keys;
private InlinedArray<Action<IMECompositionString>> m_ImeCompositionListeners;
/// <summary>
/// Raw array of key controls on the keyboard.
/// </summary>
protected KeyControl[] keys
{
get => m_Keys;
set => m_Keys = value;
}
}
}