Struct CursorSource 

pub struct CursorSource { /* private fields */ }

A cursor presented as a scene layer.

Static cursors are painted once. An animated one repaints when the frame under the clock changes, and says so as full-frame damage.

Implementations

impl CursorSource

pub fn new(device: &Device, cursor: Cursor) -> Result<Self, DumbError>

Wrap a cursor that is already loaded.

The buffer is sized to the largest frame, so an animation whose frames differ in size still has room for all of them, and the first frame is painted immediately.

Errors

DumbError if the buffer cannot be allocated or mapped.

pub fn from_argb( device: &Device, pixels: &[u32], width: u32, height: u32, xhot: u32, yhot: u32, ) -> Result<Self, SourceError>

Build a static cursor from raw premultiplied 0xAARRGGBB pixels.

The themeless fallback: what a caller uses when there is no cursor theme on the system, which is most embedded images.

Errors

SourceError::Failed with EINVAL if a dimension is zero or oversize or the pixel count does not match the dimensions, or whatever the allocation failed with.

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

Where the pointer actually points, in buffer pixels.

The caller puts the layer’s destination at pointer - hotspot so the active point tracks the pointer rather than the sprite’s corner.

pub const fn size(&self) -> (u32, u32)

The buffer’s size, which is the largest frame’s.

pub const fn cursor(&self) -> &Cursor

The cursor being shown.

Trait Implementations

impl Debug for CursorSource

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

Formats the value using the given formatter.

impl LayerBufferSource for CursorSource

fn acquire(&mut self) -> Result<AcquiredBuffer, SourceError>

Produce this frame’s buffer.

fn release(&mut self, _acquired: AcquiredBuffer)

Return a buffer to the free pool.

fn binding_model(&self) -> BindingModel

Which binding contract this source participates in.

fn format(&self) -> SourceFormat

The buffer’s shape, read during layer lowering to populate the properties the allocator consults.

fn map(&mut self, access: MapAccess) -> Result<Mapping<'_>, SourceError>

Acquire a CPU view of the pixel storage.

fn on_session_paused(&mut self)

The session is losing DRM master; issue no ioctls until resumed.

fn on_session_resumed(&mut self, device: &Device) -> Result<(), SourceError>

The session is back with a fresh device.

fn release_with_fence( &mut self, acquired: AcquiredBuffer, release_fence: Option<SyncFence>, )

Release carrying the OUT_FENCE of the commit that displaced this buffer.

fn wants_release_fence(&self) -> bool

Whether this source wants the per-buffer release fence.

fn has_fresh_content(&self) -> bool

Whether a producer submitted something new since the last commit.

fn on_retired(&mut self)

The scene acquires from this source no more: its layer was removed.

fn with_mapping( &mut self, access: MapAccess, f: &mut dyn FnMut(&mut Mapping<'_>), ) -> Result<(), SourceError>

Run f over a CPU view of the pixel storage, writable when access allows it.

fn export_dma_buf(&mut self) -> Result<DmaBufDesc<'_>, SourceError>

Export the currently-acquired buffer’s DMA-BUF planes.

fn bind_to_plane(&mut self, plane_id: u32) -> Result<(), SourceError>

Bind a driver-owned producer to a plane.

fn unbind_from_plane(&mut self, plane_id: u32)

Unbind from a plane, when the layer is reassigned or retired. Dormant, as bind_to_plane is.