Class Fz2D.Input.Mouse

Defined in:

src/input/mouse.coffee

Overview

Public: Mouse

Instance Method Summary

::constructor(element, x = 0, y = 0) Constructor
::hide() Hides the mouse cursor.
::show(style = 'initial') Shows the mouse cursor.
::update() Updates mouse state on every frame.

Constructor Details

::constructor(element, x = 0, y = 0) Source

Public: Constructor element - HTML DOM element x - initial mouse position on the X axis (default: 0) y - initial mouse position on the Y axis (default: 0)

Parameters:

element — HTML DOM element
x — initial mouse position on the X axis (default: 0)
y — initial mouse position on the Y axis (default: 0)

Instance Method Details

::hide() Source

Public: Hides the mouse cursor.

::show(style = 'initial') Source

Public: Shows the mouse cursor. style - cursor style (default: initial)

Parameters:

style — cursor style (default: initial)

::update() Source

Public: Updates mouse state on every frame.