Interface IInputDriverImp

Implementations of this interface represent a piece of software capable of connecting to one or more input devices (IInputDeviceImp. Members of this interface allow access to the devices.

Namespace: Fusee.Engine.Common

Assembly: Fusee.Engine.Common.dll

Syntax

public interface IInputDriverImp

Remarks

An input "device" is considered a physical device such as keyboard, mouse, gamepad, kinect, etc.

Properties

Devices

Retrieves a list of devices supported by this input driver.

Declaration

IEnumerable<IInputDeviceImp> Devices { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<IInputDeviceImp>	The list of devices.

Remarks

The devices yielded represent the current status. At any time other devices can connect or disconnect. Listen to the NewDeviceConnected and DeviceDisconnected events to get informed about new or vanishing devices. Drivers may implement "static" access to devices such that devices are connected at driver instantiation and never disconnected (in this case NewDeviceConnected and DeviceDisconnected are never fired).

DriverDesc

Gets the driver description string.

Declaration

string DriverDesc { get; }

Property Value

Type	Description
System.String	A human-readable string describing the driver.

DriverId

Gets the unique driver identifier.

Declaration

string DriverId { get; }

Property Value

Type	Description
System.String	The driver identifier.

Events

DeviceDisconnected

Occurs when a device is disconnected such as a gamepad is plugged off from the system.

Declaration

event EventHandler<DeviceImpDisconnectedArgs> DeviceDisconnected

Event Type

Type	Description
System.EventHandler<DeviceImpDisconnectedArgs>

NewDeviceConnected

Occurs when a new device is connected such as a gamepad is plugged into the system.

Declaration

event EventHandler<NewDeviceImpConnectedArgs> NewDeviceConnected

Event Type

Type	Description
System.EventHandler<NewDeviceImpConnectedArgs>