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

 mouseoff()          Hide the mouse cursor
------------------------------------------------------------------------------
 Declaration
   mouse.hdr

 Syntax
   proc mouseoff extern

 Arguments
   None.

 Return
   None.

 Description
   The mouseoff() procedure hides the mouse cursor.

   Most mouse drivers internally use a counter for the mouse state which
   is decremented whenever the mouse off function is called. If you call
   the mouseoff() function repeatedly, the same number of calls to the
   mouseon() function is required to make the mouse cursor visible again
   (which increments the counter). Because mouseoff() uses an
   internal toggle flag, the first call to mouseon() will make the
   mouse cursor visible, no matter how often mouseoff() was called
   before.

 Example
   #define EXAMPLE_MOUSE
   #include example.hdr

   proc Test_mouseoff
   if mouseavail()
      mouseon()
      ? "Mouse is", iifc( ismouseon(), "on", "off" )
      wait
      mouseoff()
      ? "Mouse is", iifc( ismouseon(), "on", "off" )
      wait
   else
      ? "Mouse is not available"
   endif
   endproc

   proc main
   Test_mouseoff()
   endproc