Struct PipelineStatisticsTypes

pub struct PipelineStatisticsTypes(/* private fields */);

Available on crate feature unstable-wgpu-24 only.

Flags for which pipeline data should be recorded.

The amount of values written when resolved depends on the amount of flags. If 3 flags are enabled, 3 64-bit values will be written per-query.

The order they are written is the order they are declared in this bitflags. If you enabled CLIPPER_PRIMITIVES_OUT and COMPUTE_SHADER_INVOCATIONS, it would write 16 bytes, the first 8 bytes being the primitive out value, the last 8 bytes being the compute shader invocation count.

Implementations

impl PipelineStatisticsTypes

pub const VERTEX_SHADER_INVOCATIONS: PipelineStatisticsTypes

Amount of times the vertex shader is ran. Accounts for the vertex cache when doing indexed rendering.

pub const CLIPPER_INVOCATIONS: PipelineStatisticsTypes

Amount of times the clipper is invoked. This is also the amount of triangles output by the vertex shader.

pub const CLIPPER_PRIMITIVES_OUT: PipelineStatisticsTypes

Amount of primitives that are not culled by the clipper. This is the amount of triangles that are actually on screen and will be rasterized and rendered.

pub const FRAGMENT_SHADER_INVOCATIONS: PipelineStatisticsTypes

Amount of times the fragment shader is ran. Accounts for fragment shaders running in 2x2 blocks in order to get derivatives.

pub const COMPUTE_SHADER_INVOCATIONS: PipelineStatisticsTypes

Amount of times a compute shader is invoked. This will be equivalent to the dispatch count times the workgroup size.

impl PipelineStatisticsTypes

pub const fn empty() -> PipelineStatisticsTypes

Get a flags value with all bits unset.

pub const fn all() -> PipelineStatisticsTypes

Get a flags value with all known bits set.

pub const fn bits(&self) -> u8

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u8) -> Option<PipelineStatisticsTypes>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u8) -> PipelineStatisticsTypes

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u8) -> PipelineStatisticsTypes

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<PipelineStatisticsTypes>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

Whether any set bits in a source flags value are also set in a target flags value.

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

Whether all set bits in a source flags value are also set in a target flags value.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

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

The bitwise exclusive-or (^) of the bits in two flags values.

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

Call insert when value is true or remove when value is false.

pub const fn intersection( self, other: PipelineStatisticsTypes, ) -> PipelineStatisticsTypes

The bitwise and (&) of the bits in two flags values.

pub const fn union( self, other: PipelineStatisticsTypes, ) -> PipelineStatisticsTypes

The bitwise or (|) of the bits in two flags values.

pub const fn difference( self, other: PipelineStatisticsTypes, ) -> PipelineStatisticsTypes

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference( self, other: PipelineStatisticsTypes, ) -> PipelineStatisticsTypes

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> PipelineStatisticsTypes

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl PipelineStatisticsTypes

pub const fn iter(&self) -> Iter<PipelineStatisticsTypes>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<PipelineStatisticsTypes>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for PipelineStatisticsTypes

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

Formats the value using the given formatter.

impl BitAnd for PipelineStatisticsTypes

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

The bitwise and (&) of the bits in two flags values.

type Output = PipelineStatisticsTypes

The resulting type after applying the & operator.

impl BitAndAssign for PipelineStatisticsTypes

fn bitand_assign(&mut self, other: PipelineStatisticsTypes)

The bitwise and (&) of the bits in two flags values.

impl BitOr for PipelineStatisticsTypes

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

The bitwise or (|) of the bits in two flags values.

type Output = PipelineStatisticsTypes

The resulting type after applying the | operator.

impl BitOrAssign for PipelineStatisticsTypes

fn bitor_assign(&mut self, other: PipelineStatisticsTypes)

The bitwise or (|) of the bits in two flags values.

impl BitXor for PipelineStatisticsTypes

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

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = PipelineStatisticsTypes

The resulting type after applying the ^ operator.

impl BitXorAssign for PipelineStatisticsTypes

fn bitxor_assign(&mut self, other: PipelineStatisticsTypes)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for PipelineStatisticsTypes

fn clone(&self) -> PipelineStatisticsTypes

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PipelineStatisticsTypes

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

Formats the value using the given formatter.

impl Extend<PipelineStatisticsTypes> for PipelineStatisticsTypes

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = PipelineStatisticsTypes>,

The bitwise or (|) of the bits in each flags value.

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 Flags for PipelineStatisticsTypes

const FLAGS: &'static [Flag<PipelineStatisticsTypes>]

The set of defined flags.

type Bits = u8

The underlying bits type.

fn bits(&self) -> u8

Get the underlying bits value.

fn from_bits_retain(bits: u8) -> PipelineStatisticsTypes

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

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

where Self: Sized,

Call [Flags::insert] when value is true or [Flags::remove] when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<PipelineStatisticsTypes> for PipelineStatisticsTypes

fn from_iter<T>(iterator: T) -> PipelineStatisticsTypes

where T: IntoIterator<Item = PipelineStatisticsTypes>,

The bitwise or (|) of the bits in each flags value.

impl Hash for PipelineStatisticsTypes

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 IntoIterator for PipelineStatisticsTypes

type Item = PipelineStatisticsTypes

The type of the elements being iterated over.

type IntoIter = Iter<PipelineStatisticsTypes>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <PipelineStatisticsTypes as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for PipelineStatisticsTypes

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

Formats the value using the given formatter.

impl Not for PipelineStatisticsTypes

fn not(self) -> PipelineStatisticsTypes

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = PipelineStatisticsTypes

The resulting type after applying the ! operator.

impl Octal for PipelineStatisticsTypes

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

Formats the value using the given formatter.

impl PartialEq for PipelineStatisticsTypes

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

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = PipelineStatisticsTypes

The resulting type after applying the - operator.

impl SubAssign for PipelineStatisticsTypes

fn sub_assign(&mut self, other: PipelineStatisticsTypes)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for PipelineStatisticsTypes

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

Formats the value using the given formatter.

impl Copy for PipelineStatisticsTypes

impl Eq for PipelineStatisticsTypes

impl StructuralPartialEq for PipelineStatisticsTypes