View source

enum MouseMode

package hxd.impl

@:directlyUsed

The mouse movement input handling mode.

JS/HTML5 note:

Due to browser limitations, restorePos is ignored and always treated as true.

Additionally, mouse mode will be forcefully changed to Absolute when user performs a browser action that exits the mouse capture mode,

e.g. pressing Escape or switching tabs/windows.

Override Window.onMouseModeChange event in order to catch such cases.

If mouse is not currently captured, but mouseMode is set to either Relative or AbsoluteUnbound,

mouse movement events are ignored and first click on the canvas is used to capture the mouse and hence discarded.

See also:

Values

Absolute

Default mouse movement mode. Causes EMove events in window coordinates.

Relative(callback:Event ‑> Void, restorePos:Bool)

Relative mouse movement mode. In this mode the mouse cursor is hidden and instead of EMove event the callback is invoked with relative mouse movement.

During Relative mouse mode the window mouse position is not updated.

Parameters:

callback

The callback to which the relative mouse movements are reported. Unless event is cancelled, set propagate flag in order to emit an EMove event with current window cursor position. Use Window.setMousePos to manually update the window cursor position.

restorePos

If set, when changing mouse mode to Absolute, cursor position would be restored to the position it was on when this mode was enabled. Otherwise mouse position is clipped to window boundaries. Ignored and treated as true on JS.

AbsoluteUnbound(restorePos:Bool)

Alternate relative mouse movement mode. In this mode the mouse cursor is hidden, and EMove can report mouse positions outside of window boundaries.

Parameters:

restorePos

If set, when changing mouse mode to Absolute, cursor position would be restored to the position it was on when this mode was enabled. Otherwise mouse position is clipped to window boundaries. Ignored and treated as true on JS.