[][src]Module wayland_client::cursor

Cursor utilities

This module contains bindings to the libwayland-cursor.so library.

These utilities allows you to load cursor images in order to match your cursors to the ones of the system.

First of all, the function load_theme will allow you to load a CursorTheme, which represents the full cursor theme.

From this theme, you can load a specific Cursor, which can each contain several images if the cursor is animated. It provides you with the means of knowing which frame of the animation should be displayed at which time, as well as handles to the buffers containing these frames, to attach them to a wayland surface.

Structs

Cursor

A cursor from a theme. Can contain several images if animated.

CursorImageBuffer

A buffer containing a cursor image.

CursorTheme

Represents a cursor theme loaded from the system.

Functions

is_available

Checks if the wayland-cursor lib is available and can be used

load_theme

Attempts to load a cursor theme from given name.