Click above to get retro games delivered to your door ever month!

HideMouse()

Hide the mouse cursor in graphic mode


Syntax

HideMouse()


Returns

0
Success.

-99
Parameter is invalid.


Remarks

HideMouse() removes the graphic mouse cursor from the screen and restores 
the image data beneath. It must be used when drawing to the screen, to 
prevent the mouse cursor from being overwritten by the drawing function 
being called. It is a good policy to hide the mouse whenever writing to the 
screen remembering to restore it with ShowMouse() upon conclusion of 
whatever draw function used. If the above procedure is not followed, 
unwanted graphic garbage may be accidentally left on the screen underneath 
the mouse cursor.


Example

nStatus = FindVideoMode(640, 480, 16)
nStatus = OpenLiveMouse(0,0)
nStatus = Sleep(7)
nStatus = HideMouse()
nStatus = SunSay(0,0,8,15,1,"","Sample text string")
nStatus = ShowMouse()
nStatus = Sleep(7)
nStatus = CloseLiveMouse()
nStatus = TextMode()

For other examples of how to use the mouse support functions, see 
SUNMOUSE.PRG, an example program distributed with Sunshow Pro.