Struct WpCommitTimerV1

pub struct WpCommitTimerV1 { /* private fields */ }

Available on crate feature wayland and Linux only.

Surface commit timer

An object to set a time constraint for a content update on a surface.

This interface has no events.

Implementations

impl WpCommitTimerV1

pub fn set_timestamp(&self, tv_sec_hi: u32, tv_sec_lo: u32, tv_nsec: u32)

Specify time the following commit takes effect

Provide a timing constraint for a surface content update.

A set_timestamp request may be made before a wl_surface.commit to tell the compositor that the content is intended to be presented as closely as possible to, but not before, the specified time. The time is in the domain of the compositor’s presentation clock.

An invalid_timestamp error will be generated for invalid tv_nsec.

If a timestamp already exists on the surface, a timestamp_exists error is generated.

Requesting set_timestamp after the commit_timer object’s surface is destroyed will generate a “surface_destroyed” error.

pub fn destroy(&self)

Destroy the timer

Informs the server that the client will no longer be using this protocol object.

Existing timing constraints are not affected by the destruction.

Trait Implementations

impl Borrow<ObjectId> for WpCommitTimerV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for WpCommitTimerV1

fn clone(&self) -> WpCommitTimerV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WpCommitTimerV1

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

Formats the value using the given formatter.

impl Hash for WpCommitTimerV1

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

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

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

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>(&self) -> Option<&U>

where U: Send + Sync + 'static,

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: <WpCommitTimerV1 as Proxy>::Request<'_>, ) -> Result<(), InvalidId>

Send a request for this object.

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

where I: Proxy,

Send a request for this object that creates another object.

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

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> WpCommitTimerV1

Create an inert object proxy

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

Parse a event for this object

fn write_request<'a>( &self, conn: &Connection, msg: <WpCommitTimerV1 as Proxy>::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 WpCommitTimerV1