love.mouse.isVisible

love.mouse.isVisible

Checks if the cursor is visible.

Function

Synopsis

visible = love.mouse.isVisible( )

Arguments

None.

Returns

boolean visible

True if the cursor to visible, false if the cursor is hidden.

Examples

Toggle mouse visibility by pressing tab (using setVisible).

function love.keypressed(key)
   if key == "tab" then
      local state = not love.mouse.isVisible()   -- the opposite of whatever it currently is
      love.mouse.setVisible(state)
   end
end

See Also

• love.mouse
• love.mouse.setVisible