Class InputControl

A typed and named source of input values in a hierarchy of controls.

Inheritance

InputControl

Namespace: UnityEngine.InputSystem

Syntax

[Preserve]
public abstract class InputControl

Remarks

Controls can have children which in turn may have children. At the root of the child hierarchy is always an InputDevice (which themselves are InputControls).

Controls can be looked up by their path (see TryFindControl(InputControl, String, Int32)).

Each control must have a unique name within the children of its parent. Multiple names can be assigned to controls using aliases (see aliases). Name lookup is case-insensitive.

For display purposes, a control may have a separate displayName. This name will usually correspond to what the control is caused on the actual underlying hardware. For example, on an Xbox gamepad, the control with the name "buttonSouth" will have a display name of "A". Controls that have very long display names may also have a shortDisplayName. This is the case for the "Left Button" on the Mouse, for example, which is commonly abbreviated "LMB".

In addition to names, a control may have usages associated with it (see usages). A usage indicates how a control is meant to be used. For example, a button can be assigned the "PrimaryAction" usage to indicate it is the primary action button the device. Within a device, usages have to be unique. See CommonUsages for a list of standardized usages.

Controls do not actually store values. Instead, every control receives an InputStateBlock which, after the control's device has been added to the system, is used to read out values from the device's backing store. This backing store is referred to as "state" in the API as opposed to "values" which represent the data resulting from reading state. The format that each control stores state in is specific to the control. It can vary not only between controls of different types but also between controls of the same type. An AxisControl, for example, can be stored as a float or as a byte or in a number of other formats. stateBlock identifies both where the control stores its state as well as the format it stores it in.

Controls are generally not created directly but are created internally by the input system from data known as "layouts" (see InputControlLayout). Each such layout describes the setup of a specific hierarchy of controls. The system internally maintains a registry of layouts and produces devices and controls from them as needed. The layout that a control has been created from can be queried using layout. For most purposes, the intricacies of the control layout mechanisms can be ignored and it is sufficient to know the names of a small set of common device layouts such as "Keyboard", "Mouse", "Gamepad", and "Touchscreen".

Each control has a single, fixed value type. The type can be queried at runtime using valueType. Most types of controls are derived from InputControl<TValue> which has APIs specific to the type of value of the control (e.g. ReadValue().

The following example demonstrates various common operations performed on input controls:

// Look up dpad/up control on current gamepad.
var dpadUpControl = Gamepad.current["dpad/up"];

// Look up the back button on the current gamepad.
var backButton = Gamepad.current["{Back}"];

// Look up all dpad/up controls on all gamepads in the system.
using (var controls = InputSystem.FindControls("<Gamepad>/dpad/up"))
    Debug.Log($"Found {controls.Count} controls");

// Display the value of all controls on the current gamepad.
foreach (var control in Gamepad.current.allControls)
    Debug.Log(controls.ReadValueAsObject());

// Track the value of the left stick on the current gamepad over time.
var leftStickHistory = new InputStateHistory(Gamepad.current.leftStick);
leftStickHistory.Enable();

Constructors

InputControl()

Declaration

protected InputControl()

Fields

m_StateBlock

Declaration

protected InputStateBlock m_StateBlock

Field Value

Type	Description
InputStateBlock

Properties

aliases

Declaration

public ReadOnlyArray<InternedString> aliases { get; }

Property Value

Type	Description
ReadOnlyArray<InternedString>

children

List of immediate children.

Declaration

public ReadOnlyArray<InputControl> children { get; }

Property Value

Type	Description
ReadOnlyArray<InputControl>

Remarks

Does not allocate.

currentStatePtr

Declaration

protected void *currentStatePtr { get; }

Property Value

Type	Description
Void*

defaultStatePtr

Declaration

protected void *defaultStatePtr { get; }

Property Value

Type	Description
Void*

device

The device that this control is a part of.

Declaration

public InputDevice device { get; }

Property Value

Type	Description
InputDevice

Remarks

This is the root of the control hierarchy. For the device at the root, this will point to itself.

displayName

The text to display as the name of the control.

Declaration

public string displayName { get; protected set; }

Property Value

Type	Description
String

Remarks

Note that the display name of a control may change over time. For example, when changing from a QWERTY keyboard layout to an AZERTY keyboard layout, the "q" key (which will keep that name) will change its display name from "q" to "a".

By default, a control's display name will come from its layout. If it is not assigned a display name there, the display name will default to name. However, specific controls may override this behavior. KeyControl, for example, will set the display name to the actual key name corresponding to the current keyboard layout.

For nested controls, the display name will include the display names of all parent controls, i.e. the display name will fully identify the control on the device. For example, the display name for the left D-Pad button on a gamepad is "D-Pad Left" and not just "Left".

Item[String]

Fetch a control from the control's hierarchy by name.

Declaration

public InputControl this[string path] { get; }

Parameters

Type	Name	Description
String	path

Property Value

Type	Description
InputControl

Remarks

Note that path matching is case-insensitive.

Examples

gamepad["leftStick"] // Returns Gamepad.leftStick
gamepad["leftStick/x"] // Returns Gamepad.leftStick.x
gamepad["{PrimaryAction}"] // Returns the control with PrimaryAction usage, i.e. Gamepad.aButton

Exceptions

Type	Condition
KeyNotFoundException	`path` cannot be found.

layout

Layout the control is based on.

Declaration

public string layout { get; }

Property Value

Type	Description
String

Remarks

This is the layout name rather than a reference to an InputControlLayout as we only create layout instances during device creation and treat them as temporaries in general so as to not waste heap space during normal operation.

name

The name of the control, i.e. the final name part in its path.

Declaration

public string name { get; }

Property Value

Type	Description
String

Remarks

Names of controls must be unique within the context of their parent.

Note that this is the name of the control as assigned internally (like "buttonSouth") and not necessarily a good display name. Use displayName for getting more readable names for display purposes (where available).

Lookup of names is case-insensitive.

This is set from the name of the control in the layout.

noiseMaskPtr

Return the memory that holds the noise mask for the control.

Declaration

protected void *noiseMaskPtr { get; }

Property Value

Type	Description
Void*	Noise bit mask for the control.

Remarks

Like with all state blocks, the specific memory block for the control is found at the memory region specified by stateBlock.

The noise mask can be overlaid as a bit mask over the state for the control. When doing so, all state that is noise will be masked out whereas all state that isn't will come through unmodified. In other words, any bit that is set in the noise mask indicates that the corresponding bit in the control's state memory is noise.

Declaration

public bool noisy { get; }

Property Value

Type	Description
Boolean	True if the control produces noisy input.

Remarks

A control is considered "noisy" if it produces different values without necessarily requiring user interaction. A good example are sensors (see Sensor). For example, the PS4 controller which has a gyroscope sensor built into the device. Whereas sticks and buttons on the device require user interaction to produce non-default values, the gyro will produce varying values even if the device just sits there without user interaction.

The value of this property is determined by the layout (InputControlLayout) that the control has been built from.

Note that for devices (InputDevice) this property is true if any control on the device is marked as noisy.

The primary effect of being noise is on MakeCurrent() and on interactive rebinding (see InputActionRebindingExtensions.RebindingOperation). However, being noisy also affects automatic resetting of controls that happens when the application loses focus. While other controls are reset to their default value (except if Application.runInBackground is true and the device the control belongs to is marked as canRunInBackground), noisy controls will not be reset but rather remain at their current value. This is based on the assumption that noisy controls most often represent sensor values and snapping the last sampling value back to default will usually have undesirable effects on an application's simulation logic.

parent

The immediate parent of the control or null if the control has no parent (which, once fully constructed) will only be the case for InputDevices).

Declaration

public InputControl parent { get; }

Property Value

Type	Description
InputControl

path

Full path all the way from the root.

Declaration

public string path { get; }

Property Value

Type	Description
String

Remarks

This will always be the "effective" path of the control, i.e. it will not contain elements such as usages ("{Back}") and other elements that can be part of control paths used for matching. Instead, this property will always be a simple linear ordering of names leading from the device at the top to the control with each element being separated by a forward slash (/).

Allocates on first hit. Paths are not created until someone asks for them.

Example: "/gamepad/leftStick/x"

previousFrameStatePtr

Declaration

protected void *previousFrameStatePtr { get; }

Property Value

Type	Description
Void*

shortDisplayName

An alternate, abbreviated displayName (for example "LMB" instead of "Left Button").

Declaration

public string shortDisplayName { get; protected set; }

Property Value

Type	Description
String

Remarks

If the control has no abbreviated version, this will be null. Note that this behavior is different from displayName which will fall back to name if no display name has been assigned to the control.

For nested controls, the short display name will include the short display names of all parent controls, i.e. the display name will fully identify the control on the device. For example, the display name for the left D-Pad button on a gamepad is "D-Pad \u2190" and not just "\u2190". Note that if a parent control has no short name, its long name will be used instead.

stateBlock

Declaration

public InputStateBlock stateBlock { get; }

Property Value

Type	Description
InputStateBlock

stateOffsetRelativeToDeviceRoot

The offset of this control's state relative to its device root.

Declaration

protected uint stateOffsetRelativeToDeviceRoot { get; }

Property Value

Type	Description
UInt32

Remarks

Once a device has been added to the system, its state block will get allocated in the global state buffers and the offset of the device's state block will get baked into all of the controls on the device. This property always returns the "unbaked" offset.

synthetic

Whether the control is considered synthetic.

Declaration

public bool synthetic { get; }

Property Value

Type	Description
Boolean	True if the control does not represent an actual physical control on the device.

Remarks

A control is considered "synthetic" if it does not correspond to an actual, physical control on the device. An example for this is anyKey or the up/down/left/right buttons added by StickControl.

The value of this property is determined by the layout (InputControlLayout) that the control has been built from.

The primary effect of being synthetic is in interactive rebinding (see InputActionRebindingExtensions.RebindingOperation) where non-synthetic controls will be favored over synthetic ones. This means, for example, that if both "<Gamepad>/leftStick/x" and "<Gamepad>/leftStick/left" are suitable picks, "<Gamepad>/leftStick/x" will be favored as it represents input from an actual physical control whereas "<Gamepad>/leftStick/left" represents input from a made-up control. If, however, the "left" button is the only viable pick, it will be accepted.

usages

List of usage tags associated with the control.

Declaration

public ReadOnlyArray<InternedString> usages { get; }

Property Value

Type	Description
ReadOnlyArray<InternedString>

Remarks

Usages apply "semantics" to a control. Whereas the name of a control identifies a particular "endpoint" within the control hierarchy, the usages of a control identify particular roles of specific control. A simple example is Back which identifies a control generally used to move backwards in the navigation history of a UI. On a keyboard, it is the escape key that generally fulfills this role whereas on a gamepad, it is generally the "B" / "Circle" button. Some devices may not have a control that generally fulfills this function and thus may not have any control with the "Back" usage.

By looking up controls by usage rather than by name, it is possible to locate the correct control to use for certain standardized situation without having to know the particulars of the device or platform.

// Bind to any control which is tagged with the "Back" usage on any device.
var backAction = new InputAction(binding: "*/{Back}");

Note that usages on devices work slightly differently than usages of controls on devices. They are also queried through this property but unlike the usages of controls, the set of usages of a device can be changed dynamically as the role of the device changes. For details, see SetDeviceUsage(InputDevice, String). Controls, on the other hand, can currently only be assigned usages through layouts (usage or usages).

valueSizeInBytes

Size in bytes of values that the control returns.

Declaration

public abstract int valueSizeInBytes { get; }

Property Value

Type	Description
Int32

Declaration

public abstract Type valueType { get; }

Property Value

Type	Description
Type	Type of values produced by the control.

Remarks

This is the type of values that are returned when reading the current value of a control or when reading a value of a control from an event.

variants

Semicolon-separated list of variants of the control layout or "default".

Declaration

public string variants { get; }

Property Value

Type	Description
String

Examples

"Lefty" when using the "Lefty" gamepad layout.

Methods

CompareValue(Void, Void)

Compare the value of the control as read from firstStatePtr to that read from secondStatePtr and return true if they are equal.

Declaration

public abstract bool CompareValue(void *firstStatePtr, void *secondStatePtr)

Parameters

Type	Name	Description
Void*	firstStatePtr	Memory containing the control's stateBlock.
Void*	secondStatePtr	Memory containing the control's stateBlock

Returns

Type	Description
Boolean	True if the value of the control is equal in both `firstStatePtr` and `secondStatePtr`.

Remarks

Unlike , this method will have to do more than just compare the memory for the control in the two state buffers. It will have to read out state for the control and run the full processing machinery for the control to turn the state into a final, processed value. CompareValue is thus more costly than .

This method will apply epsilons (Epsilon) when comparing floats.

EvaluateMagnitude()

Compute an absolute, normalized magnitude value that indicates the extent to which the control is actuated.

Declaration

public float EvaluateMagnitude()

Returns

Type	Description
Single	Amount of actuation of the control or -1 if it cannot be determined.

Remarks

Magnitudes do not make sense for all types of controls. For example, for a control that represents an enumeration of values (such as TouchPhaseControl), there is no meaningful linear ordering of values (one could derive a linear ordering through the actual enum values but their assignment may be entirely arbitrary; it is unclear whether a state of Canceled has a higher or lower "magnitude" as a state of Began).

Controls that have no meaningful magnitude will return -1 when calling this method. Any negative return value should be considered an invalid value.

Declaration

public virtual float EvaluateMagnitude(void *statePtr)

Parameters

Type	Name	Description
Void*	statePtr	State containing the control's stateBlock.

Returns

Type	Description
Single	Amount of actuation of the control or -1 if it cannot be determined.

FinishSetup()

Perform final initialization tasks after the control hierarchy has been put into place.

Declaration

protected virtual void FinishSetup()

Remarks

This method can be overridden to perform control- or device-specific setup work. The most common use case is for looking up child controls and storing them in local getters.

public class MyDevice : InputDevice
{
    public ButtonControl button { get; private set; }
    public AxisControl axis { get; private set; }

    protected override void OnFinishSetup()
    {
        // Cache controls in getters.
        button = GetChildControl("button");
        axis = GetChildControl("axis");
    }
}

GetChildControl(String)

Declaration

public InputControl GetChildControl(string path)

Parameters

Type	Name	Description
String	path

Returns

Type	Description
InputControl

GetChildControl<TControl>(String)

Declaration

public TControl GetChildControl<TControl>(string path)
    where TControl : InputControl

Parameters

Type	Name	Description
String	path

Returns

Type	Description
TControl

Type Parameters

Name	Description
TControl

ReadValueFromBufferAsObject(Void*, Int32)

Declaration

public abstract object ReadValueFromBufferAsObject(void *buffer, int bufferSize)

Parameters

Type	Name	Description
Void*	buffer
Int32	bufferSize

Returns

Type	Description
Object

ReadValueFromStateAsObject(Void*)

Read the control's final, processed value from the given state and return the value as an object.

Declaration

public abstract object ReadValueFromStateAsObject(void *statePtr)

Parameters

Type	Name	Description
Void*	statePtr

Returns

Type	Description
Object	The control's value as stored in `statePtr`.

Remarks

This method allocates GC memory and should not be used during normal gameplay operation.

Exceptions

Type	Condition
ArgumentNullException	`statePtr` is null.

ReadValueFromStateIntoBuffer(Void, Void, Int32)

Read the control's final, processed value from the given state and store it in the given buffer.

Declaration

public abstract void ReadValueFromStateIntoBuffer(void *statePtr, void *bufferPtr, int bufferSize)

Parameters

Type	Name	Description
Void*	statePtr	State to read the value for the control from.
Void*	bufferPtr	Buffer to store the value in.
Int32	bufferSize	Size of `bufferPtr` in bytes. Must be at least valueSizeInBytes. If it is smaller, ArgumentException will be thrown.

Exceptions

Type	Condition
ArgumentNullException	`statePtr` is null, or `bufferPtr` is null.
ArgumentException	`bufferSize` is smaller than valueSizeInBytes.

RefreshConfiguration()

Declaration

protected virtual void RefreshConfiguration()

RefreshConfigurationIfNeeded()

Call RefreshConfiguration() if the configuration has in the interim been invalidated by a DeviceConfigurationEvent.

Declaration

protected void RefreshConfigurationIfNeeded()

Remarks

This method is only relevant if you are implementing your own devices or new types of controls which are fetching configuration data from the devices (such as KeyControl which is fetching display names for individual keys from the underlying platform).

This method should be called if you are accessing cached data set up by RefreshConfiguration().

// Let's say your device has an associated orientation which it can be held with
// and you want to surface both as a property and as a usage on the device.
// Whenever your backend code detects a change in orientation, it should send
// a DeviceConfigurationEvent to your device to signal that the configuration
// of the device has changed. You can then implement RefreshConfiguration() to
// read out and update the device orientation on the managed InputDevice instance.
public class MyDevice : InputDevice
{
    public enum Orientation
    {
        Horizontal,
        Vertical,
    }

    private Orientation m_Orientation;
    public Orientation orientation
    {
        get
        {
            // Call RefreshOrientation if the configuration of the device has been
            // invalidated since last time we initialized m_Orientation.
            RefreshConfigurationIfNeeded();
            return m_Orientation;
        }
    }
    protected override void RefreshConfiguration()
    {
        // Fetch the current orientation from the backend. How you do this
        // depends on your device. Using DeviceCommands is one way.
        var fetchOrientationCommand = new FetchOrientationCommand();
        ExecuteCommand(ref fetchOrientationCommand);
        m_Orientation = fetchOrientation;

        // Reflect the orientation on the device.
        switch (m_Orientation)
        {
            case Orientation.Vertical:
                InputSystem.RemoveDeviceUsage(this, s_Horizontal);
                InputSystem.AddDeviceUsage(this, s_Vertical);
                break;

            case Orientation.Horizontal:
                InputSystem.RemoveDeviceUsage(this, s_Vertical);
                InputSystem.AddDeviceUsage(this, s_Horizontal);
                break;
        }
    }

    private static InternedString s_Vertical = new InternedString("Vertical");
    private static InternedString s_Horizontal = new InternedString("Horizontal");
}

ToString()

Return a string representation of the control useful for debugging.

Declaration

public override string ToString()

Returns

Type	Description
String	A string representation of the control.

Overrides

Object.ToString()

TryGetChildControl(String)

Try to find a child control matching the given path.

Declaration

public InputControl TryGetChildControl(string path)

Parameters

Type	Name	Description
String	path	A control path. See InputControlPath.

Returns

Type	Description
InputControl	The first direct or indirect child control that matches the given `path` or null if no control was found to match.

Remarks

Note that if the given path matches multiple child controls, only the first control encountered in the search will be returned.

// Returns the leftStick control of the current gamepad.
Gamepad.current.TryGetChildControl("leftStick");

// Returns the X axis control of the leftStick on the current gamepad.
Gamepad.current.TryGetChildControl("leftStick/x");

// Returns the first control ending with "stick" in its name. Note that it
// undetermined whether this is leftStick or rightStick (or even another stick
// added by the given gamepad).
Gamepad.current.TryGetChildControl("*stick");

This method is equivalent to calling TryFindChild(InputControl, String, Int32).

Exceptions

Type	Condition
ArgumentNullException	`path` is `null` or empty.

TryGetChildControl<TControl>(String)

Declaration

public TControl TryGetChildControl<TControl>(string path)
    where TControl : InputControl

Parameters

Type	Name	Description
String	path

Returns

Type	Description
TControl

Type Parameters

Name	Description
TControl

WriteValueFromBufferIntoState(Void, Int32, Void)

Read a value from the given memory and store it as state.

Declaration

public virtual void WriteValueFromBufferIntoState(void *bufferPtr, int bufferSize, void *statePtr)

Parameters

Type	Name	Description
Void*	bufferPtr	Memory containing value.
Int32	bufferSize	Size of `bufferPtr` in bytes. Must be at least valueSizeInBytes.
Void*	statePtr	State containing the control's stateBlock. Will receive the state as converted from the given value.

Remarks

Writing values will NOT apply processors to the given value. This can mean that when reading a value from a control after it has been written to its state, the resulting value differs from what was written.

Exceptions

Type	Condition
NotSupportedException	The control does not support writing. This is the case, for example, that compute values (such as the magnitude of a vector).

Declaration

public virtual void WriteValueFromObjectIntoState(object value, void *statePtr)

Parameters

Type	Name	Description
Object	value	Value for the control.
Void*	statePtr	State containing the control's stateBlock. Will receive the state state as converted from the given value.