love.mouse.getSystemCursor

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

Gets a Cursor object representing a system-native hardware cursor.

Hardware cursors are framerate-independent and work the same way as normal operating system cursors. Unlike drawing an image at the mouse's current coordinates, hardware cursors never have visible lag between when the mouse is moved and when the cursor position updates, even at low framerates.

Function

Synopsis

cursor = love.mouse.getSystemCursor( ctype )

Arguments

CursorType ctype: The type of system cursor to get.

Returns

Cursor cursor: The Cursor object representing the system cursor type.

Notes

The "image" CursorType is not a valid argument. Use love.mouse.newCursor to create a hardware cursor using a custom image.

Examples

function love.load()
    i_beam_cursor = love.mouse.getSystemCursor("ibeam")
    love.mouse.setCursor(i_beam_cursor)
end