A named set of zero or more device requirements along an associated binding group.
[Serializable]
public struct InputControlScheme : IEquatable<InputControlScheme>
Constructors
Declaration
public InputControlScheme(string name, IEnumerable<InputControlScheme.DeviceRequirement> devices = null)
Parameters
Properties
Binding group that is associated with the control scheme.
Declaration
public string bindingGroup { get; set; }
Property Value
Type |
Description |
System.String |
|
Devices used by the control scheme.
Declaration
public ReadOnlyArray<InputControlScheme.DeviceRequirement> deviceRequirements { get; }
Property Value
Name of the control scheme.
Declaration
public string name { get; }
Property Value
Type |
Description |
System.String |
|
Methods
Declaration
public override bool Equals(object obj)
Parameters
Type |
Name |
Description |
System.Object |
obj |
|
Returns
Type |
Description |
System.Boolean |
|
Overrides
System.ValueType.Equals(System.Object)
Declaration
public bool Equals(InputControlScheme other)
Parameters
Returns
Type |
Description |
System.Boolean |
|
Declaration
public static InputControlScheme? FindControlSchemeForDevice<TList>(InputDevice device, TList schemes)
where TList : IEnumerable<InputControlScheme>
Parameters
Returns
Type Parameters
Declaration
public static InputControlScheme? FindControlSchemeForDevices<TDevices, TList>(TDevices devices, TList schemes)
where TDevices : IReadOnlyList<InputDevice> where TList : IEnumerable<InputControlScheme>
Parameters
Type |
Name |
Description |
TDevices |
devices |
|
TList |
schemes |
|
Returns
Type Parameters
Name |
Description |
TDevices |
|
TList |
|
Declaration
public override int GetHashCode()
Returns
Type |
Description |
System.Int32 |
|
Overrides
System.ValueType.GetHashCode()
Based on a list of devices, make a selection that matches the deviceRequirements
imposed by the control scheme.
Declaration
public InputControlScheme.MatchResult PickDevicesFrom<TDevices>(TDevices devices)
where TDevices : IReadOnlyList<InputDevice>
Parameters
Type |
Name |
Description |
TDevices |
devices |
A list of devices to choose from.
|
Returns
Type Parameters
Name |
Description |
TDevices |
|
Declaration
public bool SupportsDevice(InputDevice device)
Parameters
Returns
Type |
Description |
System.Boolean |
|
Declaration
public override string ToString()
Returns
Type |
Description |
System.String |
|
Overrides
System.ValueType.ToString()
Operators
Declaration
public static bool operator ==(InputControlScheme left, InputControlScheme right)
Parameters
Returns
Type |
Description |
System.Boolean |
|
Declaration
public static bool operator !=(InputControlScheme left, InputControlScheme right)
Parameters
Returns
Type |
Description |
System.Boolean |
|
Extension Methods
See Also