ExamineMouse()

Syntax

Result = ExamineMouse()
Description
Updates the mouse state. This function should be used before MouseDeltaX(), MouseDeltaY(), MouseX(), MouseY() or MouseButton().

Parameters

None.

Return value

Nonzero if the mouse state has been updated, zero otherwise.

Remarks

The first call to ExamineMouse() captures the mouse to the active Screen or 'WindowedScreen'. The mouse is available again on your whole system after calling ReleaseMouse(#True) or after the end of that program.

In fullscreen mode the command FlipBuffers() need to be called inside your event loop to handle all events properly.

See Also

ExamineMouse(), MouseDeltaX(), MouseDeltaY(), MouseX(), MouseY(), MouseButton()

Supported OS

All

Mouse Index - InitMouse() ->