Struct rafx_api::RafxResourceState

pub struct RafxResourceState { /* fields omitted */ }

The current state of a resource. When an operation is performed that references a resource, it must be in the correct state. Resources are moved between state using barriers.

Implementations

impl RafxResourceState

pub const UNDEFINED: RafxResourceState

pub const VERTEX_AND_CONSTANT_BUFFER: RafxResourceState

pub const INDEX_BUFFER: RafxResourceState

pub const RENDER_TARGET: RafxResourceState

Similar to vulkan’s COLOR_ATTACHMENT_OPTIMAL image layout

pub const UNORDERED_ACCESS: RafxResourceState

pub const DEPTH_WRITE: RafxResourceState

Similar to vulkan’s DEPTH_STENCIL_ATTACHMENT_OPTIMAL image layout

pub const DEPTH_READ: RafxResourceState

pub const NON_PIXEL_SHADER_RESOURCE: RafxResourceState

pub const PIXEL_SHADER_RESOURCE: RafxResourceState

pub const SHADER_RESOURCE: RafxResourceState

Similar to vulkan’s SHADER_READ_ONLY_OPTIMAL image layout

pub const STREAM_OUT: RafxResourceState

pub const INDIRECT_ARGUMENT: RafxResourceState

pub const COPY_DST: RafxResourceState

Similar to vulkan’s TRANSFER_DST_OPTIMAL image layout

pub const COPY_SRC: RafxResourceState

Similar to vulkan’s TRANSFER_SRC_OPTIMAL image layout

pub const GENERIC_READ: RafxResourceState

pub const PRESENT: RafxResourceState

Similar to vulkan’s PRESENT_SRC_KHR image layout

pub const COMMON: RafxResourceState

Similar to vulkan’s COMMON image layout

pub const fn empty() -> RafxResourceState

Returns an empty set of flags

pub const fn all() -> RafxResourceState

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

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

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

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

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for RafxResourceState

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

Formats the value using the given formatter.

impl BitAnd<RafxResourceState> for RafxResourceState

type Output = RafxResourceState

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<RafxResourceState> for RafxResourceState

fn bitand_assign(&mut self, other: RafxResourceState)

Disables all flags disabled in the set.

impl BitOr<RafxResourceState> for RafxResourceState

type Output = RafxResourceState

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<RafxResourceState> for RafxResourceState

fn bitor_assign(&mut self, other: RafxResourceState)

Adds the set of flags.

impl BitXor<RafxResourceState> for RafxResourceState

type Output = RafxResourceState

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<RafxResourceState> for RafxResourceState

fn bitxor_assign(&mut self, other: RafxResourceState)

Toggles the set of flags.

impl Clone for RafxResourceState

fn clone(&self) -> RafxResourceState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for RafxResourceState

impl Debug for RafxResourceState

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

Formats the value using the given formatter.

impl Eq for RafxResourceState

impl Extend<RafxResourceState> for RafxResourceState

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

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

Creates a value from an iterator.

impl Hash for RafxResourceState

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 RafxResourceState

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

Formats the value using the given formatter.

impl Not for RafxResourceState

type Output = RafxResourceState

The resulting type after applying the ! operator.

fn not(self) -> RafxResourceState

Returns the complement of this set of flags.

impl Octal for RafxResourceState

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

Formats the value using the given formatter.

impl Ord for RafxResourceState

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

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

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

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

This method tests for !=.

impl PartialOrd<RafxResourceState> for RafxResourceState

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

impl StructuralPartialEq for RafxResourceState

impl Sub<RafxResourceState> for RafxResourceState

type Output = RafxResourceState

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<RafxResourceState> for RafxResourceState

fn sub_assign(&mut self, other: RafxResourceState)

Disables all flags enabled in the set.

impl UpperHex for RafxResourceState

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

Formats the value using the given formatter.