Struct sierra::AccessFlags

pub struct AccessFlags { /* fields omitted */ }

Flags for access types.

Implementations

impl AccessFlags

pub const INDIRECT_COMMAND_READ: AccessFlags

Read access to indirect command data read as part of an indirect build, trace, drawing or dispatch command.

pub const INDEX_READ: AccessFlags

Read access to an index buffer as part of an indexed drawing command

pub const VERTEX_ATTRIBUTE_READ: AccessFlags

Read access to a vertex buffer as part of a drawing command

pub const UNIFORM_READ: AccessFlags

Read access to a uniform buffer..

pub const INPUT_ATTACHMENT_READ: AccessFlags

Read access to an input attachment within a render pass during fragment shading.

pub const SHADER_READ: AccessFlags

Read access to a storage buffer, physical storage buffer, shader binding table, uniform texel buffer, storage texel buffer, sampled image, or storage image.

pub const SHADER_WRITE: AccessFlags

Write access to a storage buffer, physical storage buffer, storage texel buffer, or storage image.

pub const COLOR_ATTACHMENT_READ: AccessFlags

Read access to a color attachment, such as via blending, logic operations, or via certain subpass load operations.
It does not include advanced blend operations.

pub const COLOR_ATTACHMENT_WRITE: AccessFlags

Write access to a color, resolve, or depth/stencil resolve attachment during a render pass or via certain subpass load and store operations.

pub const DEPTH_STENCIL_ATTACHMENT_READ: AccessFlags

Read access to a depth/stencil attachment, via depth or stencil operations or via certain subpass load operations.

pub const DEPTH_STENCIL_ATTACHMENT_WRITE: AccessFlags

Write access to a depth/stencil attachment, via depth or stencil operations or via certain subpass load and store operations.

pub const TRANSFER_READ: AccessFlags

Read access to an image or buffer in a copy operation.

pub const TRANSFER_WRITE: AccessFlags

Write access to an image or buffer in a clear or copy operation.

pub const HOST_READ: AccessFlags

Read access by a host operation.

pub const HOST_WRITE: AccessFlags

Write access by a host operation.

pub const MEMORY_READ: AccessFlags

All read accesses.

pub const MEMORY_WRITE: AccessFlags

All write accesses.

pub const CONDITIONAL_RENDERING_READ: AccessFlags

Read access to a predicate as part of conditional rendering.

pub const COLOR_ATTACHMENT_READ_NONCOHERENT: AccessFlags

Similar to [COLOR_ATTACHMENT_READ], but also includes advanced blend operations.

pub const ACCELERATION_STRUCTURE_READ: AccessFlags

Read access to an acceleration structure as part of a trace, build, or copy command, or to an acceleration structure scratch buffer

pub const ACCELERATION_STRUCTURE_WRITE: AccessFlags

Write access to an acceleration structure or acceleration structure scratch buffer as part of a build or copy command.

pub const FRAGMENT_DENSITY_MAP_READ: AccessFlags

Read access to a fragment density map attachment during dynamic fragment density map operations.

pub const FRAGMENT_SHADING_RATE_ATTACHMENT_READ: AccessFlags

Read access to a fragment shading rate attachment or shading rate image during rasterization.

pub const fn empty() -> AccessFlags

Returns an empty set of flags

pub const fn all() -> AccessFlags

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

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

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

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

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

impl AccessFlags

pub fn is_readonly(self) -> bool

Trait Implementations

impl Binary for AccessFlags

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

Formats the value using the given formatter.

impl BitAnd<AccessFlags> for AccessFlags

type Output = AccessFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<AccessFlags> for AccessFlags

fn bitand_assign(&mut self, other: AccessFlags)

Disables all flags disabled in the set.

impl BitOr<AccessFlags> for AccessFlags

type Output = AccessFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<AccessFlags> for AccessFlags

fn bitor_assign(&mut self, other: AccessFlags)

Adds the set of flags.

impl BitXor<AccessFlags> for AccessFlags

type Output = AccessFlags

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<AccessFlags> for AccessFlags

fn bitxor_assign(&mut self, other: AccessFlags)

Toggles the set of flags.

impl Clone for AccessFlags

fn clone(&self) -> AccessFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for AccessFlags

impl Debug for AccessFlags

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

Formats the value using the given formatter.

impl Eq for AccessFlags

impl Extend<AccessFlags> for AccessFlags

fn extend<T: IntoIterator<Item = AccessFlags>>(&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<AccessFlags> for AccessFlags

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

Creates a value from an iterator.

impl Hash for AccessFlags

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 AccessFlags

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

Formats the value using the given formatter.

impl Not for AccessFlags

type Output = AccessFlags

The resulting type after applying the ! operator.

fn not(self) -> AccessFlags

Returns the complement of this set of flags.

impl Octal for AccessFlags

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

Formats the value using the given formatter.

impl Ord for AccessFlags

fn cmp(&self, other: &AccessFlags) -> 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<AccessFlags> for AccessFlags

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

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

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

This method tests for !=.

impl PartialOrd<AccessFlags> for AccessFlags

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

impl StructuralPartialEq for AccessFlags

impl Sub<AccessFlags> for AccessFlags

type Output = AccessFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<AccessFlags> for AccessFlags

fn sub_assign(&mut self, other: AccessFlags)

Disables all flags enabled in the set.

impl UpperHex for AccessFlags

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

Formats the value using the given formatter.