Struct WpFifoV1

pub struct WpFifoV1 { /* private fields */ }

Available on crate features staging and client only.

fifo interface

A fifo object for a surface that may be used to add display refresh constraints to content updates.

This interface has no events.

Implementations

impl WpFifoV1

pub fn set_barrier(&self)

sets the start point for a fifo constraint

When the content update containing the “set_barrier” is applied, it sets a “fifo_barrier” condition on the surface associated with the fifo object. The condition is cleared immediately after the following latching deadline for non-tearing presentation.

The compositor may clear the condition early if it must do so to ensure client forward progress assumptions.

To wait for this condition to clear, use the “wait_barrier” request.

“set_barrier” is double-buffered state, see wl_surface.commit.

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

pub fn wait_barrier(&self)

adds a fifo constraint to a content update

Indicate that this content update is not ready while a “fifo_barrier” condition is present on the surface.

This means that when the content update containing “set_barrier” was made active at a latching deadline, it will be active for at least one refresh cycle. A content update which is allowed to tear might become active after a latching deadline if no content update became active at the deadline.

The constraint must be ignored if the surface is a subsurface in synchronized mode. If the surface is not being updated by the compositor (off-screen, occluded) the compositor may ignore the constraint. Clients must use an additional mechanism such as frame callbacks or timestamps to ensure throttling occurs under all conditions.

“wait_barrier” is double-buffered state, see wl_surface.commit.

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

pub fn destroy(&self)

destroy the fifo interface

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

Surface state changes previously made by this protocol are unaffected by this object’s destruction.

Trait Implementations

impl Borrow<ObjectId> for WpFifoV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for WpFifoV1

fn clone(&self) -> WpFifoV1

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WpFifoV1

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

Formats the value using the given formatter.

impl Hash for WpFifoV1

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

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

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

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 WpFifoV1