Click or drag to resize

Input Class

Handles and manages all input devices. Input is a staticton (a singleton with an additional static interface).
Inheritance Hierarchy
SystemObject
  Fusee.Engine.CoreInput

Namespace:  Fusee.Engine.Core
Assembly:  Fusee.Engine.Core (in Fusee.Engine.Core.dll) Version: 0.7.0.0 (0.7.0.0)
Syntax
C#
public class Input

The Input type exposes the following members.

Properties
  NameDescription
Public propertyStatic memberDevices
Public propertyStatic memberDrivers
Retrieves the the input driver implementations currently registered.
Public propertyInputDevices
Public propertyInputDrivers
Retrieves the the input driver implementations currently registered.
Public propertyStatic memberInstance
Provides the singleton Instance of the Input Class.
Public propertyStatic memberKeyboard
Retrieves the first keyboard device (if present).
Public propertyKeyboardInput
Retrieves the first keyboard device (if present).
Public propertyStatic memberMouse
Retrieves the first mouse device (if present).
Public propertyMouseInput
Retrieves the first mouse device (if present).
Public propertyStatic memberTouch
Retrieves the first touch device (if present).
Public propertyTouchInput
Retrieves the first touch device (if present).
Top
Methods
  NameDescription
Public methodStatic memberAddDriverImp
Adds an input driver implementation to the internal list. The input driver is queried about connected devices. All new devices will then show up in the Devices (or InputDevices). list (in addition to the already listed devices.
Public methodAddInputDriverImp
Adds an input driver implementation to the internal list. The input driver is queried about connected devices. All new devices will then show up in the Devices (or InputDevices). list (in addition to the already listed devices.
Public methodDispose
Should be called from the application framework before the application stops. Typically not to be called by user code unless users implement their own application framework.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodStatic memberGetDeviceTDevice
Gets the first input device of a certain type. Shortcut for
InputDevices.OfType<TDevice>().FirstOrDefault()
Public methodStatic memberGetDevicesTDevice
Gets the input devices of a certain type. Shortcut for
InputDevices.OfType<TDevice>()
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetInputDeviceTDevice
Gets the first input device of a certain type. Shortcut for
InputDevices.OfType<TDevice>().FirstOrDefault()
Public methodGetInputDevicesTDevice
Gets the input devices of a certain type. Shortcut for
InputDevices.OfType<TDevice>()
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPostRender
Should be called from the main (rendering-) loop. Typically not to be called by user code unless users implement their own rendering/application loop.
Public methodPreRender
Should be called from the main (rendering-) loop. Typically not to be called by user code unless users implement their own rendering/application loop.
Public methodRegisterInputDeviceType
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventStatic memberDeviceConnected
Occurs when a device such as a gamepad is connected.
Public eventStatic memberDeviceDisconnected
Occurs when a device such as a gamepad is disconnected.
Public eventInputDeviceConnected
Occurs when a device such as a gamepad is connected.
Public eventInputDeviceDisconnected
Occurs when a device such as a gamepad is disconnected.
Top
Remarks
Use the input instanmce in cases where you actually need an object to pass around (although there is no such use case in FUSEE code at all). Use the static access in all other cases to reduce typing Input.Instance over and over again. Use
using static Fusee.Engine.Core.Input
to directly access Keyboard, Mouse and Touch without even typing a namespace or classname.
See Also