# love.mouse.isGrabbed

Checks if the mouse is grabbed.

## Function

### Synopsis

    grabbed = love.mouse.isGrabbed( )

### Arguments

None.

### Returns

`boolean grabbed`
  True if the cursor is grabbed, false if it is not.

## Examples

Toggles whether the mouse is grabbed by pressing tab, using love.mouse.setGrabbed.

    function love.keypressed(key)
       if key == "tab" then
          local state = not love.mouse.isGrabbed()   -- the opposite of whatever it currently is
          love.mouse.setGrabbed(state) --Use love.mouse.setGrab(state) for 0.8.0 or lower
       end
    end

## See Also

- love.mouse
- love.mouse.setGrabbed

##

Category:

- Functions