Interface IInputDeviceInstance

Represents an instance of a device with regards to a specific input driver.

Namespace: Snowflake.Input.Device

Assembly: Snowflake.Framework.Primitives.dll

Syntax

public interface IInputDeviceInstance

Properties

Capabilities

The capabilities this device instance supports.

Declaration

IEnumerable<DeviceCapability> Capabilities { get; }

Property Value

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

CapabilityLabels

Gets the friendly label names for capabilities this device instance supports. This collection must at least have labels for all supported capabilities in Capabilities.

Declaration

IDeviceCapabilityLabels CapabilityLabels { get; }

Property Value

Type	Description
IDeviceCapabilityLabels

ClassEnumerationIndex

When enumerating devices with a given driver, the index of enumeration for this driver, with regards to the specific type of device, as determined by unique PID/VID combination, if and only if the driver disambiguates between different devices.

For example, if 2 DualShock 4 (054c:09cc) controllers were installed, with enumeration index of 2 and 4 respectively, they would have a class enumeration index of 0 and 1.

However, if this was an XInput device instance, then this is the same as EnumerationIndex since XInput devices do not disambiguate between devices.

Declaration

int ClassEnumerationIndex { get; }

Property Value

Type	Description
System.Int32

DefaultLayout

Without regards to a Stone controller layout, provides the natural mapping from controller element to a device capability.

Declaration

IDeviceLayoutMapping DefaultLayout { get; }

Property Value

Type	Description
IDeviceLayoutMapping

Driver

The input driver this instance implements

Declaration

InputDriver Driver { get; }

Property Value

Type	Description
InputDriver

EnumerationIndex

When enumerating devices with a given driver, the index of enumeration for this driver.

If Driver is Passthrough, or Keyboard, the index is always 0.

Declaration

int EnumerationIndex { get; }

Property Value

Type	Description
System.Int32

NameEnumerationIndex

When enumerating devices with a given driver, the index of enumeration for this driver, with regards to the specific type of device, as determined by unique ProductName combination, if and only if the driver disambiguates between different devices.

For example, if 2 DualShock 4 ("Wireless Controller") controllers were installed, with enumeration index of 2 and 4 respectively, they would have a class enumeration index of 0 and 1. If for example however, another controller from another vendor, such as 8bitdo, was also named "Wireless Controller", that controller would have index 2. To distinguish between product names across different vendors, use the more specific ProductEnumerationIndex.

However, if this was an XInput device instance, then this is the same as EnumerationIndex, since XInput devices do not disambiguate between devices.

Declaration

int NameEnumerationIndex { get; }

Property Value

Type	Description
System.Int32

ProductEnumerationIndex

When enumerating devices with a given driver, the index of enumeration for this driver, with regards to the specific type of device, as determined by unique VendorID and ProductName combination to uniquely identify a product, if and only if the driver disambiguates between different devices.

For example, if 2 DualShock 4 ("Wireless Controller") controllers were installed, with enumeration index of 2 and 4 respectively, they would have a class enumeration index of 0 and 1.

However, if this was an XInput device instance, then this is the same as EnumerationIndex, since XInput devices do not disambiguate between devices.

Declaration

int ProductEnumerationIndex { get; }

Property Value

Type	Description
System.Int32