GF4J 0.9.4 Beta

gameframe.input
Interface InputEngine

All Known Implementing Classes:
CInputEngine, CInputEngine

public interface InputEngine

Represents the interface to an input engine that is used to get to the input devices in the system. The engine allows usage of both polled implementations of one device. Implementations should only create one instance of a polled device (as it can be shared).

Since:
GameFrame for Java 0.9
Version:
GameFrame for Java 0.9.4

Method Summary
 KeyboardDevice[] getAllKeyboardDevices()
          Returns all keyboard type of devices found on the system as polled devices (whenever the program that wants to know about the state of the device it must ask it from the device).
 PointerDevice[] getAllPointerDevices()
          Returns all pointer type of devices found on the system as polled devices (whenever the program that wants to know about the state of the device it must ask it from the device).
 KeyboardDevice getDefaultKeyboardDevice()
          Returns the default keyboard type of device in the system as polled device (whenever the program that wants to know about the state of the device it must ask it from the device).
 PointerDevice getDefaultPointerDevice()
          Returns the default pointer type of device in the system as an polled device (whenever the program that wants to know about the state of the device it must ask it from the device).
 java.lang.String getDescription()
          Returns the (possibly multiline) description of the implementation.
 java.lang.String getName()
          Returns the short name (max 8 characters) of the implementation e.g.
 

Method Detail

getAllKeyboardDevices

public KeyboardDevice[] getAllKeyboardDevices()
                                       throws GameFrameException
Returns all keyboard type of devices found on the system as polled devices (whenever the program that wants to know about the state of the device it must ask it from the device).
Returns:
All keyboard type of devices.
Throws:
GameFrameException - Thrown if errors occur while enumerating the keyboard devices.
Since:
GameFrame for Java 0.9
See Also:
KeyboardDevice

getDefaultKeyboardDevice

public KeyboardDevice getDefaultKeyboardDevice()
                                        throws GameFrameException
Returns the default keyboard type of device in the system as polled device (whenever the program that wants to know about the state of the device it must ask it from the device).
Returns:
The default keyboard device.
Throws:
GameFrameException - Thrown if errors occur while getting the default keyboard device.
Since:
GameFrame for Java 0.9
See Also:
KeyboardDevice

getAllPointerDevices

public PointerDevice[] getAllPointerDevices()
                                     throws GameFrameException
Returns all pointer type of devices found on the system as polled devices (whenever the program that wants to know about the state of the device it must ask it from the device).
Returns:
All pointer type of devices.
Throws:
GameFrameException - Thrown if errors occur while enumerating the pointer devices.
Since:
GameFrame for Java 0.9
See Also:
PointerDevice

getDefaultPointerDevice

public PointerDevice getDefaultPointerDevice()
                                      throws GameFrameException
Returns the default pointer type of device in the system as an polled device (whenever the program that wants to know about the state of the device it must ask it from the device).
Returns:
The default pointer device.
Throws:
GameFrameException - Thrown if errors occur while getting the default pointer device.
Since:
GameFrame for Java 0.9
See Also:
PointerDevice

getName

public java.lang.String getName()
Returns the short name (max 8 characters) of the implementation e.g. "Java11" or "DDraw".
Returns:
The short name of the graphics engine.
Since:
GameFrame for Java 0.9.3

getDescription

public java.lang.String getDescription()
Returns the (possibly multiline) description of the implementation.
Returns:
A description of the graphics engine.
Since:
GameFrame for Java 0.9.3

GF4J 0.9.4 Beta