love.mouse.setGrabbed

Available since LÖVE 0.9.0
It has been renamed from love.mouse.setGrab.

Grabs the mouse and confines it to the window.

Function

Synopsis

love.mouse.setGrabbed( grab )

Arguments

boolean grab

True to confine the mouse, false to let it leave the window.

Returns

Nothing.

Examples

Toggles whether the mouse is grabbed by pressing tab, with the help of love.mouse.isGrabbed.

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)
   end
end

See Also

• love.mouse
• love.mouse.isGrabbed