All Bundles

Cursor

Mouse cursor operations

Operations

CaptureMouse

Capture the mouse and to track input outside an SDL window

function : CaptureMouse(enabled:Bool) ~ Int
Parameters
NameTypeDescription
enabledBooltrue to enable capturing, false to disable.

Return
TypeDescription
Int0 on success or -1 if not supported

GetGlobalMouseState

Get the current state of the mouse in relation to the desktop

function : GetGlobalMouseState(x:IntRef, y:IntRef) ~ Int
Parameters
NameTypeDescription
xIntReffilled in with the current X coord relative to the desktop
yIntReffilled in with the current Y coord relative to the desktop

Return
TypeDescription
Intcurrent button state as a bitmask

GetMouseState

Retrieve the current state of the mouse

function : GetMouseState(x:IntRef, y:IntRef) ~ Int
Parameters
NameTypeDescription
xIntRefcoordinate of the mouse cursor position relative to the focus window
yIntRefcoordinate of the mouse cursor position relative to the focus window

Return
TypeDescription
Intcurrent button state as a bitmask

WarpMouseGlobal

Move the mouse to the given position in global screen space

function : WarpMouseGlobal(x:Int, y:Int) ~ Int
Parameters
NameTypeDescription
xIntx coordinate
yInty coordinate

Return
TypeDescription
Int0 on success or a negative error code on failure