Struct ExtImageCopyCaptureCursorSessionV1

pub struct ExtImageCopyCaptureCursorSessionV1 { /* private fields */ }

Available on crate feature wayland and Linux only.

cursor capture session

This object represents a cursor capture session. It extends the base capture session with cursor-specific metadata.

See also the Request enum for this interface.

Implementations

impl ExtImageCopyCaptureCursorSessionV1

pub fn enter(&self)

cursor entered captured area

Sent when a cursor enters the captured area. It shall be generated before the “position” and “hotspot” events when and only when a cursor enters the area.

The cursor enters the captured area when the cursor image intersects with the captured area. Note, this is different from e.g. wl_pointer.enter.

pub fn leave(&self)

cursor left captured area

Sent when a cursor leaves the captured area. No “position” or “hotspot” event is generated for the cursor until the cursor enters the captured area again.

pub fn position(&self, x: i32, y: i32)

position changed

Cursors outside the image capture source do not get captured and no event will be generated for them.

The given position is the position of the cursor’s hotspot and it is relative to the main buffer’s top left corner in transformed buffer pixel coordinates. The coordinates may be negative or greater than the main buffer size.

pub fn hotspot(&self, x: i32, y: i32)

hotspot changed

The hotspot describes the offset between the cursor image and the position of the input device.

The given coordinates are the hotspot’s offset from the origin in buffer coordinates.

Clients should not apply the hotspot immediately: the hotspot becomes effective when the next ext_image_copy_capture_frame_v1.ready event is received.

Compositors may delay this event until the client captures a new frame.

Trait Implementations

impl Borrow<ObjectId> for ExtImageCopyCaptureCursorSessionV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for ExtImageCopyCaptureCursorSessionV1

fn clone(&self) -> ExtImageCopyCaptureCursorSessionV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExtImageCopyCaptureCursorSessionV1

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

Formats the value using the given formatter.

impl Hash for ExtImageCopyCaptureCursorSessionV1

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Weak<ExtImageCopyCaptureCursorSessionV1>> for ExtImageCopyCaptureCursorSessionV1

fn eq(&self, other: &Weak<ExtImageCopyCaptureCursorSessionV1>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for ExtImageCopyCaptureCursorSessionV1

fn eq(&self, other: &ExtImageCopyCaptureCursorSessionV1) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Resource for ExtImageCopyCaptureCursorSessionV1

type Request = Request

The request enum for this interface

type Event<'event> = Event<'event>

The event enum for this interface

fn interface() -> &'static Interface

The interface description

fn id(&self) -> ObjectId

The ID of this object

fn version(&self) -> u32

The version of this object

fn data<U>(&self) -> Option<&U>

where U: 'static,

Access the user-data associated with this object

fn object_data(&self) -> Option<&Arc<dyn Any + Sync + Send>>

Access the raw data associated with this object.

fn handle(&self) -> &WeakHandle

Access the backend handle associated with this object

fn from_id( conn: &DisplayHandle, id: ObjectId, ) -> Result<ExtImageCopyCaptureCursorSessionV1, InvalidId>

Create an object resource from its ID

fn send_event( &self, evt: <ExtImageCopyCaptureCursorSessionV1 as Resource>::Event<'_>, ) -> Result<(), InvalidId>

Send an event to this object

fn parse_request( conn: &DisplayHandle, msg: Message<ObjectId, OwnedFd>, ) -> Result<(ExtImageCopyCaptureCursorSessionV1, <ExtImageCopyCaptureCursorSessionV1 as Resource>::Request), DispatchError>

Parse a event for this object

fn write_event<'a>( &self, conn: &DisplayHandle, msg: <ExtImageCopyCaptureCursorSessionV1 as Resource>::Event<'a>, ) -> Result<Message<ObjectId, BorrowedFd<'a>>, InvalidId>

Serialize an event for this object

fn client(&self) -> Option<Client>

The client owning this object

fn is_alive(&self) -> bool

Checks if the Wayland object associated with this proxy is still alive

fn post_error(&self, code: impl Into<u32>, error: impl Into<String>)

Trigger a protocol error on this object

fn downgrade(&self) -> Weak<Self>

Creates a weak handle to this object

impl Eq for ExtImageCopyCaptureCursorSessionV1