Struct ZcosmicScreencopyCursorSessionV2

pub struct ZcosmicScreencopyCursorSessionV2 { /* private fields */ }

cursor capture session

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

See also the Event enum for this interface.

Implementations

impl ZcosmicScreencopyCursorSessionV2

pub fn destroy(&self)

delete this object

Destroys the session. This request can be sent at any time by the client.

This request doesn’t affect zcosmic_screencopy_frame_v2 objects created by this object.

pub fn get_screencopy_session<U: Send + Sync + 'static, D: Dispatch<ZcosmicScreencopySessionV2, U> + 'static>( &self, qh: &QueueHandle<D>, udata: U, ) -> ZcosmicScreencopySessionV2

get screencopy session

Gets the screencopy session for this cursor session.

The session will produce frames of the cursor image. The compositor may pause the session when the cursor leaves the captured area.

This request must not be sent more than once, or else the duplicate_session protocol error is raised.

Trait Implementations

impl Borrow<ObjectId> for ZcosmicScreencopyCursorSessionV2

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for ZcosmicScreencopyCursorSessionV2

fn clone(&self) -> ZcosmicScreencopyCursorSessionV2

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ZcosmicScreencopyCursorSessionV2

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

Formats the value using the given formatter.

impl Hash for ZcosmicScreencopyCursorSessionV2

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

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<ZcosmicScreencopyCursorSessionV2>> for ZcosmicScreencopyCursorSessionV2

fn eq(&self, other: &Weak<ZcosmicScreencopyCursorSessionV2>) -> 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 ZcosmicScreencopyCursorSessionV2

fn eq(&self, other: &ZcosmicScreencopyCursorSessionV2) -> 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 Proxy for ZcosmicScreencopyCursorSessionV2

type Request<'request> = Request<'request>

The request enum for this interface

type 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: Send + Sync + 'static>(&self) -> Option<&U>

Access the user-data associated with this object

fn object_data(&self) -> Option<&Arc<dyn ObjectData>>

Access the raw data associated with this object.

fn backend(&self) -> &WeakBackend

Access the backend associated with this object

fn send_request(&self, req: Self::Request<'_>) -> Result<(), InvalidId>

Send a request for this object.

fn send_constructor<I: Proxy>( &self, req: Self::Request<'_>, data: Arc<dyn ObjectData>, ) -> Result<I, InvalidId>

Send a request for this object that creates another object.

fn from_id(conn: &Connection, id: ObjectId) -> Result<Self, InvalidId>

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> Self

Create an inert object proxy

fn parse_event( conn: &Connection, msg: Message<ObjectId, OwnedFd>, ) -> Result<(Self, Self::Event), DispatchError>

Parse a event for this object

fn write_request<'a>( &self, conn: &Connection, msg: Self::Request<'a>, ) -> Result<(Message<ObjectId, BorrowedFd<'a>>, Option<(&'static Interface, u32)>), InvalidId>

Serialize a request for this object

fn is_alive(&self) -> bool

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

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

Creates a weak handle to this object

impl Eq for ZcosmicScreencopyCursorSessionV2