Struct wayland_cursor::CursorImageBuffer

pub struct CursorImageBuffer {
    pub(crate) buffer: WlBuffer,
    pub(crate) delay: u32,
    pub(crate) xhot: u32,
    pub(crate) yhot: u32,
    pub(crate) width: u32,
    pub(crate) height: u32,
}

A buffer containing a cursor image.

You can access the WlBuffer via Deref.

Note that this buffer is internally managed by wayland-cursor, as such you should not try to act on it beyond assigning it to wl_surfaces.

Fields

buffer: WlBuffer

delay: u32

xhot: u32

yhot: u32

width: u32

height: u32

Implementations

impl CursorImageBuffer

pub(crate) fn new( conn: &Connection, theme: &mut CursorTheme, image: &XCursorImage, ) -> Self

Construct a new CursorImageBuffer

This function appends the pixels of the image to the provided file, and constructs a wl_buffer on that data.

pub fn dimensions(&self) -> (u32, u32)

Dimensions of this image

pub fn hotspot(&self) -> (u32, u32)

Location of the pointer hotspot in this image

pub fn delay(&self) -> u32

Time (in milliseconds) for which this image should be displayed

Methods from Deref<Target = WlBuffer>

pub fn destroy(&self)

destroy a buffer

Destroy a buffer. If and how you need to release the backing storage is defined by the buffer factory interface.

For possible side-effects to a surface, see wl_surface.attach.

Trait Implementations

impl Clone for CursorImageBuffer

fn clone(&self) -> CursorImageBuffer

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CursorImageBuffer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for CursorImageBuffer

type Target = WlBuffer

The resulting type after dereferencing.

fn deref(&self) -> &WlBuffer

Dereferences the value.