Struct rafx_api::RafxResourceState
source · pub struct RafxResourceState { /* private fields */ }
Expand description
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.
The implementation of resource_state_to_access_flags() in the vulkan backend gives a more thorough explanation for what these states imply about syncrhonization. See also determine_pipeline_stage_flags() and resource_state_to_image_layout() in the vulkan backend.
Implementations§
source§impl RafxResourceState
impl RafxResourceState
pub const UNDEFINED: Self = _
pub const VERTEX_AND_CONSTANT_BUFFER: Self = _
pub const INDEX_BUFFER: Self = _
sourcepub const RENDER_TARGET: Self = _
pub const RENDER_TARGET: Self = _
Similar to vulkan’s COLOR_ATTACHMENT_OPTIMAL image layout
sourcepub const UNORDERED_ACCESS: Self = _
pub const UNORDERED_ACCESS: Self = _
Shader read/write
sourcepub const DEPTH_WRITE: Self = _
pub const DEPTH_WRITE: Self = _
Similar to vulkan’s DEPTH_STENCIL_ATTACHMENT_OPTIMAL image layout
pub const DEPTH_READ: Self = _
pub const NON_PIXEL_SHADER_RESOURCE: Self = _
pub const PIXEL_SHADER_RESOURCE: Self = _
sourcepub const SHADER_RESOURCE: Self = _
pub const SHADER_RESOURCE: Self = _
Similar to vulkan’s SHADER_READ_ONLY_OPTIMAL image layout
pub const STREAM_OUT: Self = _
pub const INDIRECT_ARGUMENT: Self = _
pub const GENERIC_READ: Self = _
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> Self
pub const unsafe fn from_bits_unchecked(bits: u32) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
§Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
Trait Implementations§
source§impl Binary for RafxResourceState
impl Binary for RafxResourceState
source§impl BitAnd for RafxResourceState
impl BitAnd for RafxResourceState
source§impl BitAndAssign for RafxResourceState
impl BitAndAssign for RafxResourceState
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr for RafxResourceState
impl BitOr for RafxResourceState
source§fn bitor(self, other: RafxResourceState) -> Self
fn bitor(self, other: RafxResourceState) -> Self
Returns the union of the two sets of flags.
§type Output = RafxResourceState
type Output = RafxResourceState
|
operator.source§impl BitOrAssign for RafxResourceState
impl BitOrAssign for RafxResourceState
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor for RafxResourceState
impl BitXor for RafxResourceState
source§impl BitXorAssign for RafxResourceState
impl BitXorAssign for RafxResourceState
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for RafxResourceState
impl Clone for RafxResourceState
source§fn clone(&self) -> RafxResourceState
fn clone(&self) -> RafxResourceState
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for RafxResourceState
impl Debug for RafxResourceState
source§impl Extend<RafxResourceState> for RafxResourceState
impl Extend<RafxResourceState> for RafxResourceState
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
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 FromIterator<RafxResourceState> for RafxResourceState
impl FromIterator<RafxResourceState> for RafxResourceState
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for RafxResourceState
impl Hash for RafxResourceState
source§impl LowerHex for RafxResourceState
impl LowerHex for RafxResourceState
source§impl Not for RafxResourceState
impl Not for RafxResourceState
source§impl Octal for RafxResourceState
impl Octal for RafxResourceState
source§impl Ord for RafxResourceState
impl Ord for RafxResourceState
source§fn cmp(&self, other: &RafxResourceState) -> Ordering
fn cmp(&self, other: &RafxResourceState) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq for RafxResourceState
impl PartialEq for RafxResourceState
source§fn eq(&self, other: &RafxResourceState) -> bool
fn eq(&self, other: &RafxResourceState) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for RafxResourceState
impl PartialOrd for RafxResourceState
source§fn partial_cmp(&self, other: &RafxResourceState) -> Option<Ordering>
fn partial_cmp(&self, other: &RafxResourceState) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Sub for RafxResourceState
impl Sub for RafxResourceState
source§impl SubAssign for RafxResourceState
impl SubAssign for RafxResourceState
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
source§impl UpperHex for RafxResourceState
impl UpperHex for RafxResourceState
impl Copy for RafxResourceState
impl Eq for RafxResourceState
impl StructuralPartialEq for RafxResourceState
Auto Trait Implementations§
impl RefUnwindSafe for RafxResourceState
impl Send for RafxResourceState
impl Sync for RafxResourceState
impl Unpin for RafxResourceState
impl UnwindSafe for RafxResourceState
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.