Struct wayland_protocols::wp::tearing_control::v1::client::wp_tearing_control_v1::WpTearingControlV1

pub struct WpTearingControlV1 { /* private fields */ }

per-surface tearing control interface

An additional interface to a wl_surface object, which allows the client to hint to the compositor if the content on the surface is suitable for presentation with tearing. The default presentation hint is vsync. See presentation_hint for more details.

If the associated wl_surface is destroyed, this object becomes inert and should be destroyed.

This interface has no events.

Implementations

impl WpTearingControlV1

pub fn set_presentation_hint(&self, hint: PresentationHint)

set presentation hint

Set the presentation hint for the associated wl_surface. This state is double-buffered, see wl_surface.commit.

The compositor is free to dynamically respect or ignore this hint based on various conditions like hardware capabilities, surface state and user preferences.

pub fn destroy(&self)

destroy tearing control object

Destroy this surface tearing object and revert the presentation hint to vsync. The change will be applied on the next wl_surface.commit.

Trait Implementations

impl Borrow<ObjectId> for WpTearingControlV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for WpTearingControlV1

fn clone(&self) -> WpTearingControlV1

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WpTearingControlV1

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

Formats the value using the given formatter.

impl Hash for WpTearingControlV1

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

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

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

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 WpTearingControlV1