SetMouse
Sets the position and visibility of the mouse cursor
Declare Function SetMouse ( ByVal x As Integer = -1, ByVal y As Integer = -1, ByVal visibility As Integer = -1, ByVal clip As Integer = -1 ) As Integer
result = SetMouse([ x ] [, [ y ] [, [ visibility ] [, [ clip ]]]])
(For each parameter, -1 is a special value indicating "no changes.")
x
Zero (0) on success, non-zero to indicate failure.
SetMouse will set the (x, y) coordinates of the mouse pointer, as well as setting its visibility. THe mouse position is set using the x and y parameters. The mouse will be visible if visibility is set to 1, and invisible if visibility is set to 0. SetMouse is intended for graphics modes initiated using the Screen (Graphics) statement only.
Syntax
Declare Function SetMouse ( ByVal x As Integer = -1, ByVal y As Integer = -1, ByVal visibility As Integer = -1, ByVal clip As Integer = -1 ) As Integer
Usage
result = SetMouse([ x ] [, [ y ] [, [ visibility ] [, [ clip ]]]])
Parameters
(For each parameter, -1 is a special value indicating "no changes.")
x
optional - set x coordinate
yoptional - set y coordinate
visibilityoptional - set visibility: 1 indicates visible, 0 indicates hidden
clipoptional - set clipping: 1 indicates mouse is clipped to graphics window, 0 indicates no clipping
Return Value
Zero (0) on success, non-zero to indicate failure.
Description
SetMouse will set the (x, y) coordinates of the mouse pointer, as well as setting its visibility. THe mouse position is set using the x and y parameters. The mouse will be visible if visibility is set to 1, and invisible if visibility is set to 0. SetMouse is intended for graphics modes initiated using the Screen (Graphics) statement only.
Example
Dim As Integer x, y, buttons
' create a screen 640*480
ScreenRes 640, 480
Print "Click the mouse button to center the mouse"
Do
' get mouse x, y and button state (wait until mouse is onscreen)
Do: Sleep 1: Loop While GetMouse( x, y , , buttons) <> 0
If buttons And 1 Then
' on left mouse click, center mouse
SetMouse 320, 240
End If
' run loop until Escape is pressed
Loop Until Inkey = Chr(27)
' create a screen 640*480
ScreenRes 640, 480
Print "Click the mouse button to center the mouse"
Do
' get mouse x, y and button state (wait until mouse is onscreen)
Do: Sleep 1: Loop While GetMouse( x, y , , buttons) <> 0
If buttons And 1 Then
' on left mouse click, center mouse
SetMouse 320, 240
End If
' run loop until Escape is pressed
Loop Until Inkey = Chr(27)
Dialect Differences
- Not available in the -lang qb dialect unless referenced with the alias __Setmouse.
Differences from QB
- New to FreeBASIC
See also
