Struct wayland_protocols::presentation_time::client::wp_presentation_feedback::Kind

pub struct Kind { /* fields omitted */ }

bitmask of flags in presented event

These flags provide information about how the presentation of the related content update was done. The intent is to help clients assess the reliability of the feedback and the visual quality with respect to possible tearing and timings. The flags are:

VSYNC: The presentation was synchronized to the "vertical retrace" by the display hardware such that tearing does not happen. Relying on user space scheduling is not acceptable for this flag. If presentation is done by a copy to the active frontbuffer, then it must guarantee that tearing cannot happen.

HW_CLOCK: The display hardware provided measurements that the hardware driver converted into a presentation timestamp. Sampling a clock in user space is not acceptable for this flag.

HW_COMPLETION: The display hardware signalled that it started using the new image content. The opposite of this is e.g. a timer being used to guess when the display hardware has switched to the new image content.

ZERO_COPY: The presentation of this update was done zero-copy. This means the buffer from the client was given to display hardware as is, without copying it. Compositing with OpenGL counts as copying, even if textured directly from the client buffer. Possible zero-copy cases include direct scanout of a fullscreen surface and a surface on a hardware overlay.

Implementations

impl Kind

pub const Vsync: Kind

presentation was vsync'd

pub const HwClock: Kind

hardware provided the presentation timestamp

pub const HwCompletion: Kind

hardware signalled the start of the presentation

pub const ZeroCopy: Kind

presentation was done zero-copy

pub const fn empty() -> Kind

Returns an empty set of flags

pub const fn all() -> Kind

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<Kind>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> Kind

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> Kind

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: Kind) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: Kind) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: Kind)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Kind)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Kind)

Toggles the specified flags in-place.

pub fn set(&mut self, other: Kind, value: bool)

Inserts or removes the specified flags depending on the passed value.

impl Kind

pub fn from_raw(n: u32) -> Option<Kind>

pub fn to_raw(&self) -> u32

Trait Implementations

impl Binary for Kind

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

Formats the value using the given formatter.

impl BitAnd<Kind> for Kind

type Output = Kind

The resulting type after applying the & operator.

fn bitand(self, other: Kind) -> Kind

Returns the intersection between the two sets of flags.

impl BitAndAssign<Kind> for Kind

fn bitand_assign(&mut self, other: Kind)

Disables all flags disabled in the set.

impl BitOr<Kind> for Kind

type Output = Kind

The resulting type after applying the | operator.

fn bitor(self, other: Kind) -> Kind

Returns the union of the two sets of flags.

impl BitOrAssign<Kind> for Kind

fn bitor_assign(&mut self, other: Kind)

Adds the set of flags.

impl BitXor<Kind> for Kind

type Output = Kind

The resulting type after applying the ^ operator.

fn bitxor(self, other: Kind) -> Kind

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<Kind> for Kind

fn bitxor_assign(&mut self, other: Kind)

Toggles the set of flags.

impl Clone for Kind

fn clone(&self) -> Kind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Kind

impl Debug for Kind

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

Formats the value using the given formatter.

impl Eq for Kind

impl Extend<Kind> for Kind

fn extend<T: IntoIterator<Item = Kind>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<Kind> for Kind

fn from_iter<T: IntoIterator<Item = Kind>>(iterator: T) -> Kind

Creates a value from an iterator.

impl Hash for Kind

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, 

Feeds a slice of this type into the given [Hasher].

impl LowerHex for Kind

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

Formats the value using the given formatter.

impl Not for Kind

type Output = Kind

The resulting type after applying the ! operator.

fn not(self) -> Kind

Returns the complement of this set of flags.

impl Octal for Kind

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

Formats the value using the given formatter.

impl Ord for Kind

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Kind> for Kind

fn eq(&self, other: &Kind) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Kind) -> bool

This method tests for !=.

impl PartialOrd<Kind> for Kind

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralEq for Kind

impl StructuralPartialEq for Kind

impl Sub<Kind> for Kind

type Output = Kind

The resulting type after applying the - operator.

fn sub(self, other: Kind) -> Kind

Returns the set difference of the two sets of flags.

impl SubAssign<Kind> for Kind

fn sub_assign(&mut self, other: Kind)

Disables all flags enabled in the set.

impl UpperHex for Kind

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

Formats the value using the given formatter.