Back to class index

Class Input

Summary

Exposes mouse, keyboard, touch and keypad input events.

Member Reference

InputExposes mouse, keyboard, touch and keypad input events.
EventTriggeredThis event is raised whenever there are new input events to process.
numMouseButtons[static][const]The total number of different mouse buttons supported.
ctor
~dtor
OnNewFrameStarted()Call whenever a new application frame is processed.
OnNewInputEvent(e)Call this function to inject a new input event to this Input object.
IsKeyPressed(keyCode)Returns true if the given key was pressed down during this frame.
IsKeyDown(keyCode)Returns true if the given key is being held down during this frame, or was just pressed down this frame.
IsKeyReleased(keyCode)Returns true if the given key was released during this frame.
ClearKeyHeldDown(keyCode)Removes the given key from being tracked in the 'held down' state.
KeyNumFramesHeldDown(keyCode)Returns the number of frames the given key code has been held down.
KeyTimePressed(keyCode)Returns the wallclock tick time the given key code was pressed down.
HeldDownKeys()Returns a list of all keys currently held down.
IsMouseButtonPressed(button)Returns true if the given mouse button was pressed down during this frame.
IsMouseButtonDown(button)Returns true if the given mouse button is being held down during this frame.
IsMouseButtonReleased(button)Returns true if the given mouse button was just released during this frame.
NumMouseButtonsHeldDown()[const]Returns the total number of mouse buttons that are currently being held down.
MouseButtonNumFramesHeldDown(button)Returns the total number of application frames the given mouse button has now been held down.
MouseButtonTimePressed(button)Returns the wall-clock time of when the given mouse button was pressed down.
MousePos()Returns the current mouse position.
MouseButtonPressPos(button)Returns the position where the given mouse button was held down.
MouseDelta()Returns the relative difference of the mouse cursor between last and this frame.
MouseDragDelta(button)Returns the relative difference of the mouse cursor, when dragged with the given button down.
MouseWheelDelta()[const]
HeldDownMouseButtons()[const]Returns a list of the currently held down mouse buttons.
MouseButtonState()Returns the internal mouse button state array.
NumTouchPoints()[const]Returns the total number of currently tracked touch points. (may be pressed, held, or released)
NumTouchPointsHeldDown()Returns the number of touch points currently held down.
NumTouchPointsPressed()Returns the number of touch points pressed down this frame.
NumTouchPointsReleased()Returns the number of touch points released this frame.
TouchPointIDs()[const]Returns the Touch IDs of all currently tracked touch points.
PressedTouchPointIDs()[const]Returns a list of the Touch IDs of the touch points pressed down this frame.
HeldTouchPointIDs()[const]Returns a list of the Touch IDs of the touch points currently held down.
ReleasedTouchPointIDs()[const]Returns a list of the Touch IDs of the touch points released this frame.
HeldTouchPointID(touchPointIndex)Returns the Touch ID of the n'th touch point.
HeldTouchPointIndex(touchPointID)Returns the array index of the touch point with the given Touch ID.
TouchPointByIndex(touchPointIndex)Returns the n'th touch point in the currently active touch point array.
TouchPointByID(touchPointID)Returns the touch point object corresponding to the given touch event ID, or null if no touch event is active with the given ID.
TouchPointState()Returns the full internal state array of the currently recorded touch points.
Back to class index