read-mouse ( -- mouse-state ) - Factor Documentation

read-mouse ( -- mouse-state )
Game controller input

Prev:	read-keyboard ( -- keyboard-state )
Next:	controller-state

Vocabulary
game.input

Inputs
None

Outputs

mouse-state

a mouse-state

Word description
Reads the current mouse state relative to either when the game input interface was opened with open-game-input or when the mouse state was reset with reset-mouse.

Warning
For efficiency, the implementation may reuse the returned mouse-state object for future read-mouse or reset-mouse calls. You should clone the mouse-state object if you need to preserve it.

Definition

IN: game.input

HOOK: read-mouse game-input-backend ( -- mouse-state )

Methods

USING: game.input game.input.iokit namespaces ;

M: iokit-game-input-backend read-mouse
+mouse-state+ get-global ;