Struct WpCommitTimerV1

pub struct WpCommitTimerV1 { /* private fields */ }

Available on crate feature commit-timing-v1 only.

Surface commit timer

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

See Event for the list of possible events.

Implementations

impl WpCommitTimerV1

pub fn set_timestamp<D>( self, conn: &mut Connection<D>, 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.

Since version 1.

pub fn destroy<D>(self, conn: &mut Connection<D>)

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.

Since version 1.

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

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

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<ObjectId> for WpCommitTimerV1

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

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

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

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Proxy for WpCommitTimerV1

const INTERFACE: &'static Interface

type Event = Event

fn id(&self) -> ObjectId

fn version(&self) -> u32

impl TryFrom<Object> for WpCommitTimerV1

type Error = WrongObject

The type returned in the event of a conversion error.

fn try_from(object: Object) -> Result<Self, WrongObject>

Performs the conversion.

impl Copy for WpCommitTimerV1

impl Eq for WpCommitTimerV1