ERY.AgateLib.Input Class Reference

Static class which contains basic functions for handling non-keyboard and mouse input. More...

List of all members.

Public Member Functions
delegate void	InputSystemDelegate ()
	Delegate for DisposeInput event.
Static Public Member Functions
static void	Initialize (InputTypeID inputType)
	Initializes the input system by instantiating the driver with the given InputTypeID. The input driver must be registered with the Registrar class.
static void	Dispose ()
	Disposes of the input driver.
static void	InitializeJoysticks ()
	Initializes all joysticks.
static void	PollJoysticks ()
	Polls all joysticks for input now.
Static Public Attributes
static event InputSystemDelegate	DisposeInput
	Event raised when Input.Dispose() is called.
Properties
static InputImpl	Impl [get]
	Gets the object which handles all of the actual calls to Input functions.
static int	JoystickCount [get]
	Counts the number of joysticks attached to the system.
static IList< Joystick >	Joysticks [get]
	Returns a list of joysticks which can be iterated through, or accessed like an array.
static int	MinJoysticks [get, set]
	Minimum number of joysticks for the system to have. If there aren't enough physical joysticks attached to the system, NullJoysticks will be created to emulate a joystick which does nothing. (this is to avoid NullReferenceExceptions).
static double	PollInterval [get, set]
	Gets or sets the interval in milliseconds for the time between automatic joystick polls.
static double	PollFrequency [get, set]
	Gets or sets the number of times per second that joysticks should be polled.

---

Detailed Description

Static class which contains basic functions for handling non-keyboard and mouse input.

---

Member Function Documentation

static void ERY.AgateLib.Input.Initialize

(

InputTypeID

inputType

)

[static]

Initializes the input system by instantiating the driver with the given InputTypeID. The input driver must be registered with the Registrar class.

Parameters:

inputType

static void ERY.AgateLib.Input.Dispose

(

)

[static]

Disposes of the input driver.

delegate void ERY.AgateLib.Input.InputSystemDelegate

(

)

Delegate for DisposeInput event.

static void ERY.AgateLib.Input.InitializeJoysticks

(

)

[static]

Initializes all joysticks.

static void ERY.AgateLib.Input.PollJoysticks

(

)

[static]

Polls all joysticks for input now.

---

Member Data Documentation

event InputSystemDelegate ERY.AgateLib.Input.DisposeInput [static]

Event raised when Input.Dispose() is called.

---

Property Documentation

InputImpl ERY.AgateLib.Input.Impl [static, get]

Gets the object which handles all of the actual calls to Input functions.

int ERY.AgateLib.Input.JoystickCount [static, get]

Counts the number of joysticks attached to the system.

IList<Joystick> ERY.AgateLib.Input.Joysticks [static, get]

Returns a list of joysticks which can be iterated through, or accessed like an array.

int ERY.AgateLib.Input.MinJoysticks [static, get, set]

Minimum number of joysticks for the system to have. If there aren't enough physical joysticks attached to the system, NullJoysticks will be created to emulate a joystick which does nothing. (this is to avoid NullReferenceExceptions).

[Experimental - The API may be changed in the future, or this feature may be removed.]

double ERY.AgateLib.Input.PollInterval [static, get, set]

Gets or sets the interval in milliseconds for the time between automatic joystick polls.

double ERY.AgateLib.Input.PollFrequency [static, get, set]

Gets or sets the number of times per second that joysticks should be polled.

---

The documentation for this class was generated from the following file:

• E:/Devel/AgateLib/trunk/src/Input.cs

---

AgateLib Awesome Game and Tool Engine Library