Class wl_cursor_image

A wl_cursor_image represents a single cursor image (for example a single frame in a loading cursor animation).

You can access a cursor image through a wl_cursors image property.

Usage:

    -- if mycursor is a wl_cursor
    local cursor_image = mycursor.image[idx]
    local buffer = cursor_image:get_buffer()
    

Fields

wl_cursor_image.width Actual width
wl_cursor_image.height Actual height
wl_cursor_image.hotspot_x Hot spot x (must be inside image)
wl_cursor_image.hotspot_y Hot spot y (must be inside image)
wl_cursor_image.delay Animation delay to next frame (ms)

Methods

wl_cursor_image:get_buffer () Get an shm buffer for a cursor image


Fields

wl_cursor_image.width
Actual width
  • int Actual width
wl_cursor_image.height
Actual height
  • int Actual height
wl_cursor_image.hotspot_x
Hot spot x (must be inside image)
  • int Hot spot x (must be inside image)
wl_cursor_image.hotspot_y
Hot spot y (must be inside image)
  • int Hot spot y (must be inside image)
wl_cursor_image.delay
Animation delay to next frame (ms)
  • int Animation delay to next frame (ms)

Methods

wl_cursor_image:get_buffer ()
Get an shm buffer for a cursor image

Returns:

    wl_shm An shm buffer for the cursor image. The user should not destroy the returned buffer.
generated by LDoc 1.5.0 Last updated 2023-07-28 15:31:50