Class InputControlLayout

A control layout specifies the composition of an input control.

Inheritance

System.Object

InputControlLayout

Namespace: UnityEngine.InputSystem.Layouts

Syntax

public class InputControlLayout

Remarks

Control layouts can be created in three ways:

1. Loaded from JSON.
2. Constructed through reflection from InputControl classes.
3. Through layout factories using InputControlLayout.Builder.

Once constructed, control layouts are immutable (but you can always replace a registered layout in the system and it will affect everything constructed from the layout).

Control layouts can be for arbitrary control rigs or for entire devices. Device layouts can be matched to InputDeviceDescription using associated InputDeviceMatcher.

InputControlLayout objects are considered temporaries. Except in the editor, they are not kept around beyond device creation.

Fields

VariantSeparator

Declaration

public const string VariantSeparator = ";"

Field Value

Type	Description
System.String

Properties

appliedOverrides

Declaration

public IEnumerable<InternedString> appliedOverrides { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<InternedString>

baseLayouts

Declaration

public IEnumerable<InternedString> baseLayouts { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<InternedString>

commonUsages

Declaration

public ReadOnlyArray<InternedString> commonUsages { get; }

Property Value

Type	Description
ReadOnlyArray<InternedString>

controls

Declaration

public ReadOnlyArray<InputControlLayout.ControlItem> controls { get; }

Property Value

Type	Description
ReadOnlyArray<InputControlLayout.ControlItem>

DefaultVariant

Declaration

public static InternedString DefaultVariant { get; }

Property Value

Type	Description
InternedString

displayName

Declaration

public string displayName { get; }

Property Value

Type	Description
System.String

hideInUI

Declaration

public bool hideInUI { get; }

Property Value

Type	Description
System.Boolean

isControlLayout

Declaration

public bool isControlLayout { get; }

Property Value

Type	Description
System.Boolean

isDeviceLayout

Declaration

public bool isDeviceLayout { get; }

Property Value

Type	Description
System.Boolean

isGenericTypeOfDevice

Declaration

public bool isGenericTypeOfDevice { get; }

Property Value

Type	Description
System.Boolean

Item[String]

Declaration

public InputControlLayout.ControlItem this[string path] { get; }

Parameters

Type	Name	Description
System.String	path

Property Value

Type	Description
InputControlLayout.ControlItem

name

Declaration

public InternedString name { get; }

Property Value

Type	Description
InternedString

stateFormat

Declaration

public FourCC stateFormat { get; }

Property Value

Type	Description
FourCC

type

Declaration

public Type type { get; }

Property Value

Type	Description
System.Type

updateBeforeRender

Declaration

public bool updateBeforeRender { get; }

Property Value

Type	Description
System.Boolean

variants

Declaration

public InternedString variants { get; }

Property Value

Type	Description
InternedString

Methods

FindControl(InternedString)

Declaration

public InputControlLayout.ControlItem? FindControl(InternedString path)

Parameters

Type	Name	Description
InternedString	path

Returns

Type	Description
System.Nullable<InputControlLayout.ControlItem>

FromJson(String)

Declaration

public static InputControlLayout FromJson(string json)

Parameters

Type	Name	Description
System.String	json

Returns

Type	Description
InputControlLayout

FromType(String, Type)

Declaration

public static InputControlLayout FromType(string name, Type type)

Parameters

Type	Name	Description
System.String	name
System.Type	type

Returns

Type	Description
InputControlLayout

MergeLayout(InputControlLayout)

Merge the settings from other into the layout such that they become the base settings.

Declaration

public void MergeLayout(InputControlLayout other)

Parameters

Type	Name	Description
InputControlLayout	other

Remarks

This is the central method for allowing layouts to 'inherit' settings from their base layout. It will merge the information in other into the current layout such that the existing settings in the current layout acts as if applied on top of the settings in the base layout.

ToJson()

Declaration

public string ToJson()

Returns

Type	Description
System.String