Cursor
Mouse cursor operations
Operations
CaptureMouse # function
Capture the mouse and to track input outside an SDL window
function : CaptureMouse(enabled:Bool) ~ IntParameters
| Name | Type | Description |
|---|---|---|
| enabled | Bool | true to enable capturing, false to disable. |
Return
| Type | Description |
|---|---|
| Int | 0 on success or -1 if not supported |
GetGlobalMouseState # function
Retrieve the current global state of the mouse
function : GetGlobalMouseState(x:IntRef, y:IntRef) ~ IntParameters
| Name | Type | Description |
|---|---|---|
| x | IntRef | coordinate of the mouse cursor position relative to the focus window |
| y | IntRef | coordinate of the mouse cursor position relative to the focus window |
Return
| Type | Description |
|---|---|
| Int | current button state as a bitmask |
GetGlobalMouseState # function
Retrieve the current global state of the mouse
function : GetGlobalMouseState(p:Point) ~ IntParameters
| Name | Type | Description |
|---|---|---|
| p | Point | x and y coordinates of the mouse cursor position relative to the focus window |
Return
| Type | Description |
|---|---|
| Int | current button state as a bitmask |
GetMouseState # function
Retrieve the current state of the mouse
function : GetMouseState(x:IntRef, y:IntRef) ~ IntParameters
| Name | Type | Description |
|---|---|---|
| x | IntRef | coordinate of the mouse cursor position relative to the focus window |
| y | IntRef | coordinate of the mouse cursor position relative to the focus window |
Return
| Type | Description |
|---|---|
| Int | current button state as a bitmask |
GetMouseState # function
Retrieve the current state of the mouse
function : GetMouseState(p:Point) ~ IntParameters
| Name | Type | Description |
|---|---|---|
| p | Point | x and y coordinates of the mouse cursor position relative to the focus window |
Return
| Type | Description |
|---|---|
| Int | current button state as a bitmask |
GetRelativeMouseMode # function
Whether relative mouse mode is currently on.
function : GetRelativeMouseMode() ~ BoolReturn
| Type | Description |
|---|---|
| Bool | true when the mouse is captured for relative motion |
SetRelativeMouseMode # function
Turn relative mouse mode on or off. This is what mouse-look needs. It hides the cursor, locks it to the window, and makes motion events report unbounded deltas -- read them with MouseMotionEvent->GetRelX/GetRelY. Without it the pointer stops at the screen edge and the view stops turning with it. Turn it off before showing a menu, or the user cannot click anything.
function : SetRelativeMouseMode(enabled:Bool) ~ IntParameters
| Name | Type | Description |
|---|---|---|
| enabled | Bool | true to capture the mouse for look control |
Return
| Type | Description |
|---|---|
| Int | 0 on success, or -1 if the platform does not support it |