love.mouse.setCursor

Available since LÖVE 0.9.0
This function is not supported in earlier versions.

Sets the current mouse cursor.

Function

Synopsis

love.mouse.setCursor( cursor )

Arguments

Cursor cursor

The Cursor object to use as the current mouse cursor.

Returns

Nothing.

Function

Synopsis

love.mouse.setCursor( )

Arguments

None.

Returns

Nothing.

Notes

Resets the current mouse cursor to the default.

Examples

function love.load()
    cursor = love.mouse.getSystemCursor("hand")
    -- Alternative: cursor = love.mouse.newCursor("pig.png", 0, 0)
end
 
function love.mousepressed(x, y, button)
    -- Use a custom cursor when the left mouse button is pressed.
    if button == 1 then
        love.mouse.setCursor(cursor)
    end
end
 
function love.mousereleased(x, y, button)
    -- Go back to the default cursor when the left mouse button is released.
    if button == 1 then
        love.mouse.setCursor()
    end
end

See Also

• love.mouse
• love.mouse.newCursor
• love.mouse.getCursor