Struct sierra::PipelineStageFlags

pub struct PipelineStageFlags { /* fields omitted */ }

Flags to specify set of pipeline stages.

Implementations

impl PipelineStageFlags

pub const TOP_OF_PIPE: PipelineStageFlags

Pseudo-stage that precedes all other stages and doesn’t execute any commands. Using it in first scope of dependency will not cause any waiting, because no operations should be waited upon. Using it in second scope will make all operations in second scope to wait for operations first scope.

pub const DRAW_INDIRECT: PipelineStageFlags

Stage at which indirect draw buffer is read.

pub const VERTEX_INPUT: PipelineStageFlags

Stage at which vertex buffers are read.

pub const VERTEX_SHADER: PipelineStageFlags

Stage at which vertex shader is executed.

pub const EARLY_FRAGMENT_TESTS: PipelineStageFlags

Stage at which early fragment depth and stencil test is performed before fragment shader execution.

pub const FRAGMENT_SHADER: PipelineStageFlags

Stage at which fragment shader is executed.

pub const LATE_FRAGMENT_TESTS: PipelineStageFlags

Stage at which late fragment depth and stencil test is performed after fragment shader execution.

pub const COLOR_ATTACHMENT_OUTPUT: PipelineStageFlags

Stage at which color output of fragment shader is written and multi-sample resolve operation happens.

pub const COMPUTE_SHADER: PipelineStageFlags

Stage at which compute shader is executed.

pub const TRANSFER: PipelineStageFlags

Stage at which transfer commands (Copy, Blit etc) are executed.

pub const BOTTOM_OF_PIPE: PipelineStageFlags

Pseudo-stage that follows all other stages and doesn’t execute any commands. Using it in first scope will make operations in second scope to wait for all operations first scope. Using it in second scope of dependency will not cause any waiting, because no operations should be waited upon.

pub const HOST: PipelineStageFlags

Pseudo-stage at which HOST access to resources is performed. It has very limited use because command submission creates memory dependency between host access and device operations.

pub const ALL_GRAPHICS: PipelineStageFlags

Flag that can be used instead of specifying all graphics stages including those from enabled extensions.

pub const ALL_COMMANDS: PipelineStageFlags

Flag that can be used instead of specifying all compute stages including those from enabled extensions.

pub const RAY_TRACING_SHADER: PipelineStageFlags

Stage at which ray-tracing pipeline is executed.

pub const ACCELERATION_STRUCTURE_BUILD: PipelineStageFlags

Stage at which acceleration structures are built.

pub const fn empty() -> PipelineStageFlags

Returns an empty set of flags

pub const fn all() -> PipelineStageFlags

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<PipelineStageFlags>

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) -> PipelineStageFlags

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

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

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: PipelineStageFlags) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for PipelineStageFlags

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

Formats the value using the given formatter.

impl BitAnd<PipelineStageFlags> for PipelineStageFlags

type Output = PipelineStageFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<PipelineStageFlags> for PipelineStageFlags

fn bitand_assign(&mut self, other: PipelineStageFlags)

Disables all flags disabled in the set.

impl BitOr<PipelineStageFlags> for PipelineStageFlags

type Output = PipelineStageFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<PipelineStageFlags> for PipelineStageFlags

fn bitor_assign(&mut self, other: PipelineStageFlags)

Adds the set of flags.

impl BitXor<PipelineStageFlags> for PipelineStageFlags

type Output = PipelineStageFlags

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<PipelineStageFlags> for PipelineStageFlags

fn bitxor_assign(&mut self, other: PipelineStageFlags)

Toggles the set of flags.

impl Clone for PipelineStageFlags

fn clone(&self) -> PipelineStageFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for PipelineStageFlags

impl Debug for PipelineStageFlags

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

Formats the value using the given formatter.

impl Eq for PipelineStageFlags

impl Extend<PipelineStageFlags> for PipelineStageFlags

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

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

pub 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<PipelineStageFlags> for PipelineStageFlags

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

Creates a value from an iterator.

impl Hash for PipelineStageFlags

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub 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 PipelineStageFlags

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

Formats the value using the given formatter.

impl Not for PipelineStageFlags

type Output = PipelineStageFlags

The resulting type after applying the ! operator.

fn not(self) -> PipelineStageFlags

Returns the complement of this set of flags.

impl Octal for PipelineStageFlags

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

Formats the value using the given formatter.

impl Ord for PipelineStageFlags

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<PipelineStageFlags> for PipelineStageFlags

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

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

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

This method tests for !=.

impl PartialOrd<PipelineStageFlags> for PipelineStageFlags

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl StructuralEq for PipelineStageFlags

impl StructuralPartialEq for PipelineStageFlags

impl Sub<PipelineStageFlags> for PipelineStageFlags

type Output = PipelineStageFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<PipelineStageFlags> for PipelineStageFlags

fn sub_assign(&mut self, other: PipelineStageFlags)

Disables all flags enabled in the set.

impl UpperHex for PipelineStageFlags

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

Formats the value using the given formatter.