Struct wgpu_types::PipelineStatisticsTypes
source · pub struct PipelineStatisticsTypes(/* private fields */);
Expand description
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§
source§impl PipelineStatisticsTypes
impl PipelineStatisticsTypes
sourcepub const VERTEX_SHADER_INVOCATIONS: Self = _
pub const VERTEX_SHADER_INVOCATIONS: Self = _
Amount of times the vertex shader is ran. Accounts for the vertex cache when doing indexed rendering.
sourcepub const CLIPPER_INVOCATIONS: Self = _
pub const CLIPPER_INVOCATIONS: Self = _
Amount of times the clipper is invoked. This is also the amount of triangles output by the vertex shader.
sourcepub const CLIPPER_PRIMITIVES_OUT: Self = _
pub const CLIPPER_PRIMITIVES_OUT: Self = _
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.
sourcepub const FRAGMENT_SHADER_INVOCATIONS: Self = _
pub const FRAGMENT_SHADER_INVOCATIONS: Self = _
Amount of times the fragment shader is ran. Accounts for fragment shaders running in 2x2 blocks in order to get derivatives.
sourcepub const COMPUTE_SHADER_INVOCATIONS: Self = _
pub const COMPUTE_SHADER_INVOCATIONS: Self = _
Amount of times a compute shader is invoked. This will be equivalent to the dispatch count times the workgroup size.
source§impl PipelineStatisticsTypes
impl PipelineStatisticsTypes
sourcepub const fn bits(&self) -> u8
pub const fn bits(&self) -> u8
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: u8) -> Option<Self>
pub const fn from_bits(bits: u8) -> Option<Self>
Convert from a bits value.
This method will return None
if any unknown bits are set.
sourcepub const fn from_bits_truncate(bits: u8) -> Self
pub const fn from_bits_truncate(bits: u8) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u8) -> Self
pub const fn from_bits_retain(bits: u8) -> Self
Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
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.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
sourcepub fn remove(&mut self, other: Self)
pub fn remove(&mut self, other: Self)
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.
sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
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.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl PipelineStatisticsTypes
impl PipelineStatisticsTypes
sourcepub const fn iter(&self) -> Iter<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.
sourcepub const fn iter_names(&self) -> IterNames<PipelineStatisticsTypes>
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.
source§impl PipelineStatisticsTypes
impl PipelineStatisticsTypes
sourcepub fn contains_invalid_bits(&self) -> bool
pub fn contains_invalid_bits(&self) -> bool
Returns true if the bitflags contains bits that are not part of the bitflags definition.
Trait Implementations§
source§impl Binary for PipelineStatisticsTypes
impl Binary for PipelineStatisticsTypes
source§impl BitAnd for PipelineStatisticsTypes
impl BitAnd for PipelineStatisticsTypes
source§impl BitAndAssign for PipelineStatisticsTypes
impl BitAndAssign for PipelineStatisticsTypes
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOr for PipelineStatisticsTypes
impl BitOr for PipelineStatisticsTypes
source§fn bitor(self, other: PipelineStatisticsTypes) -> Self
fn bitor(self, other: PipelineStatisticsTypes) -> Self
The bitwise or (|
) of the bits in two flags values.
§type Output = PipelineStatisticsTypes
type Output = PipelineStatisticsTypes
|
operator.source§impl BitOrAssign for PipelineStatisticsTypes
impl BitOrAssign for PipelineStatisticsTypes
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXor for PipelineStatisticsTypes
impl BitXor for PipelineStatisticsTypes
source§impl BitXorAssign for PipelineStatisticsTypes
impl BitXorAssign for PipelineStatisticsTypes
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
source§impl Clone for PipelineStatisticsTypes
impl Clone for PipelineStatisticsTypes
source§fn clone(&self) -> PipelineStatisticsTypes
fn clone(&self) -> PipelineStatisticsTypes
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for PipelineStatisticsTypes
impl Debug for PipelineStatisticsTypes
source§impl Extend<PipelineStatisticsTypes> for PipelineStatisticsTypes
impl Extend<PipelineStatisticsTypes> for PipelineStatisticsTypes
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|
) of the bits in each flags value.
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl Flags for PipelineStatisticsTypes
impl Flags for PipelineStatisticsTypes
source§const FLAGS: &'static [Flag<PipelineStatisticsTypes>] = _
const FLAGS: &'static [Flag<PipelineStatisticsTypes>] = _
source§fn from_bits_retain(bits: u8) -> PipelineStatisticsTypes
fn from_bits_retain(bits: u8) -> PipelineStatisticsTypes
source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|
) of the bits in two flags values.source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read moresource§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^
) of the bits in two flags values.source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read moresource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.source§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.source§impl FromIterator<PipelineStatisticsTypes> for PipelineStatisticsTypes
impl FromIterator<PipelineStatisticsTypes> for PipelineStatisticsTypes
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|
) of the bits in each flags value.
source§impl Hash for PipelineStatisticsTypes
impl Hash for PipelineStatisticsTypes
source§impl LowerHex for PipelineStatisticsTypes
impl LowerHex for PipelineStatisticsTypes
source§impl Not for PipelineStatisticsTypes
impl Not for PipelineStatisticsTypes
source§impl Octal for PipelineStatisticsTypes
impl Octal for PipelineStatisticsTypes
source§impl PartialEq for PipelineStatisticsTypes
impl PartialEq for PipelineStatisticsTypes
source§fn eq(&self, other: &PipelineStatisticsTypes) -> bool
fn eq(&self, other: &PipelineStatisticsTypes) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PublicFlags for PipelineStatisticsTypes
impl PublicFlags for PipelineStatisticsTypes
source§impl Sub for PipelineStatisticsTypes
impl Sub for PipelineStatisticsTypes
source§fn sub(self, other: Self) -> Self
fn sub(self, other: Self) -> Self
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
type Output = PipelineStatisticsTypes
-
operator.source§impl SubAssign for PipelineStatisticsTypes
impl SubAssign for PipelineStatisticsTypes
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
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.