Struct gfx_hal::image::Access

pub struct Access { /* fields omitted */ }

Bitflags to describe how memory in an image or buffer can be accessed.

Methods

impl Access

pub const INPUT_ATTACHMENT_READ: Access

Read access to an input attachment from within a fragment shader.

pub const SHADER_READ: Access

Read-only state for SRV access, or combine with SHADER_WRITE to have r/w access to UAV.

pub const SHADER_WRITE: Access

Writeable state for UAV access. Combine with SHADER_READ to have r/w access to UAV.

pub const COLOR_ATTACHMENT_READ: Access

Read state but can only be combined with COLOR_ATTACHMENT_WRITE.

pub const COLOR_ATTACHMENT_WRITE: Access

Write-only state but can be combined with COLOR_ATTACHMENT_READ.

pub const DEPTH_STENCIL_ATTACHMENT_READ: Access

Read access to a depth/stencil attachment in a depth or stencil operation.

pub const DEPTH_STENCIL_ATTACHMENT_WRITE: Access

Write access to a depth/stencil attachment in a depth or stencil operation.

pub const TRANSFER_READ: Access

Read access to the buffer in a copy operation.

pub const TRANSFER_WRITE: Access

Write access to the buffer in a copy operation.

pub const HOST_READ: Access

Read access for raw memory to be accessed by the host system (ie, CPU).

pub const HOST_WRITE: Access

Write access for raw memory to be accessed by the host system.

pub const MEMORY_READ: Access

Read access for memory to be accessed by a non-specific entity. This may be the host system, or it may be something undefined or specified by an extension.

pub const MEMORY_WRITE: Access

Write access for memory to be accessed by a non-specific entity.

pub const fn empty() -> Access

Returns an empty set of flags

pub const fn all() -> Access

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

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

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

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

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Extend<Access> for Access

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

Extends a collection with the contents of an iterator.

impl Clone for Access

fn clone(&self) -> Access

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Access

impl Eq for Access

impl Ord for Access

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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<Access> for Access

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

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

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

This method tests for !=.

impl PartialOrd<Access> for Access

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

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

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

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

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

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

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

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

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

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

impl Debug for Access

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

Formats the value using the given formatter.

impl Sub<Access> for Access

type Output = Access

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<Access> for Access

fn sub_assign(&mut self, other: Access)

Disables all flags enabled in the set.

impl Not for Access

type Output = Access

The resulting type after applying the ! operator.

fn not(self) -> Access

Returns the complement of this set of flags.

impl BitAnd<Access> for Access

type Output = Access

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitOr<Access> for Access

type Output = Access

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitXor<Access> for Access

type Output = Access

The resulting type after applying the ^ operator.

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

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

impl BitAndAssign<Access> for Access

fn bitand_assign(&mut self, other: Access)

Disables all flags disabled in the set.

impl BitOrAssign<Access> for Access

fn bitor_assign(&mut self, other: Access)

Adds the set of flags.

impl BitXorAssign<Access> for Access

fn bitxor_assign(&mut self, other: Access)

Toggles the set of flags.

impl Hash for Access

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 StructuralPartialEq for Access

impl StructuralEq for Access

impl FromIterator<Access> for Access

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

Creates a value from an iterator.

impl Octal for Access

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

Formats the value using the given formatter.

impl Binary for Access

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

Formats the value using the given formatter.

impl LowerHex for Access

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

Formats the value using the given formatter.

impl UpperHex for Access

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

Formats the value using the given formatter.