Struct WpCommitTimingManagerV1

pub struct WpCommitTimingManagerV1 { /* private fields */ }

Available on crate feature commit-timing-v1 only.

commit timing

When a compositor latches on to new content updates it will check for any number of requirements of the available content updates (such as fences of all buffers being signalled) to consider the update ready.

This protocol provides a method for adding a time constraint to surface content. This constraint indicates to the compositor that a content update should be presented as closely as possible to, but not before, a specified time.

This protocol does not change the Wayland property that content updates are applied in the order they are received, even when some content updates contain timestamps and others do not.

To provide timestamps, this global factory interface must be used to acquire a wp_commit_timing_v1 object for a surface, which may then be used to provide timestamp information for commits.

Warning! The protocol described in this file is currently in the testing phase. Backward compatible changes may be added together with the corresponding interface version bump. Backward incompatible changes can only be done by creating a new major version of the extension.

See Event for the list of possible events.

Implementations

impl WpCommitTimingManagerV1

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

unbind from the commit timing interface

Informs the server that the client will no longer be using this protocol object. Existing objects created by this object are not affected.

Since version 1.

pub fn get_timer<D>( self, conn: &mut Connection<D>, surface: WlSurface, ) -> WpCommitTimerV1

request commit timer interface for surface

Establish a timing controller for a surface.

Only one commit timer can be created for a surface, or a commit_timer_exists protocol error will be generated.

Since version 1.

pub fn get_timer_with_cb<D>( self, conn: &mut Connection<D>, surface: WlSurface, cb: impl FnMut(EventCtx<'_, D, WpCommitTimerV1>) + Send + 'static, ) -> WpCommitTimerV1

request commit timer interface for surface

Establish a timing controller for a surface.

Only one commit timer can be created for a surface, or a commit_timer_exists protocol error will be generated.

Since version 1.

Trait Implementations

impl Borrow<ObjectId> for WpCommitTimingManagerV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for WpCommitTimingManagerV1

fn clone(&self) -> WpCommitTimingManagerV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WpCommitTimingManagerV1

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

Formats the value using the given formatter.

impl Hash for WpCommitTimingManagerV1

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 WpCommitTimingManagerV1

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 WpCommitTimingManagerV1

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<WpCommitTimingManagerV1> for ObjectId

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

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 WpCommitTimingManagerV1

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 WpCommitTimingManagerV1

const INTERFACE: &'static Interface

type Event = Event

fn id(&self) -> ObjectId

fn version(&self) -> u32

impl TryFrom<Object> for WpCommitTimingManagerV1

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 WpCommitTimingManagerV1

impl Eq for WpCommitTimingManagerV1