Struct rafx_api::RafxResourceType
source · pub struct RafxResourceType { /* private fields */ }
Expand description
Indicates how a resource will be used. In some cases, multiple flags are allowed.
Implementations§
source§impl RafxResourceType
impl RafxResourceType
pub const UNDEFINED: Self = _
pub const SAMPLER: Self = _
sourcepub const TEXTURE: Self = _
pub const TEXTURE: Self = _
Similar to DX12 SRV and vulkan SAMPLED image usage flag and SAMPLED_IMAGE descriptor type
sourcepub const TEXTURE_READ_WRITE: Self = _
pub const TEXTURE_READ_WRITE: Self = _
Similar to DX12 UAV and vulkan STORAGE image usage flag and STORAGE_IMAGE descriptor type
sourcepub const BUFFER_READ_WRITE: Self = _
pub const BUFFER_READ_WRITE: Self = _
Similar to DX12 UAV and vulkan STORAGE_BUFFER descriptor type
sourcepub const UNIFORM_BUFFER: Self = _
pub const UNIFORM_BUFFER: Self = _
Similar to vulkan UNIFORM_BUFFER descriptor type
sourcepub const ROOT_CONSTANT: Self = _
pub const ROOT_CONSTANT: Self = _
Similar to DX12 root constants and vulkan push constants
sourcepub const VERTEX_BUFFER: Self = _
pub const VERTEX_BUFFER: Self = _
Similar to vulkan VERTEX_BUFFER buffer usage flag
sourcepub const INDEX_BUFFER: Self = _
pub const INDEX_BUFFER: Self = _
Similar to vulkan INDEX_BUFFER buffer usage flag
sourcepub const INDIRECT_BUFFER: Self = _
pub const INDIRECT_BUFFER: Self = _
Similar to vulkan INDIRECT_BUFFER buffer usage flag
sourcepub const TEXTURE_CUBE: Self = _
pub const TEXTURE_CUBE: Self = _
Similar to vulkan’s CUBE_COMPATIBLE image create flag and metal’s Cube texture type
pub const RENDER_TARGET_MIP_SLICES: Self = _
pub const RENDER_TARGET_ARRAY_SLICES: Self = _
pub const RENDER_TARGET_DEPTH_SLICES: Self = _
pub const INPUT_ATTACHMENT: Self = _
pub const TEXEL_BUFFER: Self = _
pub const TEXEL_BUFFER_READ_WRITE: Self = _
pub const COMBINED_IMAGE_SAMPLER: Self = _
pub const ARGUMENT_BUFFER: Self = _
pub const INDIRECT_COMMAND_BUFFER: Self = _
pub const RENDER_PIPELINE_STATE: Self = _
sourcepub const RENDER_TARGET_COLOR: Self = _
pub const RENDER_TARGET_COLOR: Self = _
A color attachment in a renderpass
sourcepub const RENDER_TARGET_DEPTH_STENCIL: Self = _
pub const RENDER_TARGET_DEPTH_STENCIL: Self = _
A depth/stencil attachment in a renderpass
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
.
source§impl RafxResourceType
impl RafxResourceType
pub fn is_uniform_buffer(self) -> bool
pub fn is_storage_buffer(self) -> bool
pub fn is_render_target(self) -> bool
pub fn is_texture(self) -> bool
Trait Implementations§
source§impl Binary for RafxResourceType
impl Binary for RafxResourceType
source§impl BitAnd for RafxResourceType
impl BitAnd for RafxResourceType
source§impl BitAndAssign for RafxResourceType
impl BitAndAssign for RafxResourceType
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 RafxResourceType
impl BitOr for RafxResourceType
source§fn bitor(self, other: RafxResourceType) -> Self
fn bitor(self, other: RafxResourceType) -> Self
Returns the union of the two sets of flags.
§type Output = RafxResourceType
type Output = RafxResourceType
|
operator.source§impl BitOrAssign for RafxResourceType
impl BitOrAssign for RafxResourceType
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor for RafxResourceType
impl BitXor for RafxResourceType
source§impl BitXorAssign for RafxResourceType
impl BitXorAssign for RafxResourceType
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for RafxResourceType
impl Clone for RafxResourceType
source§fn clone(&self) -> RafxResourceType
fn clone(&self) -> RafxResourceType
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for RafxResourceType
impl Debug for RafxResourceType
source§impl Default for RafxResourceType
impl Default for RafxResourceType
source§fn default() -> RafxResourceType
fn default() -> RafxResourceType
source§impl Extend<RafxResourceType> for RafxResourceType
impl Extend<RafxResourceType> for RafxResourceType
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<RafxResourceType> for RafxResourceType
impl FromIterator<RafxResourceType> for RafxResourceType
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 RafxResourceType
impl Hash for RafxResourceType
source§impl LowerHex for RafxResourceType
impl LowerHex for RafxResourceType
source§impl Not for RafxResourceType
impl Not for RafxResourceType
source§impl Octal for RafxResourceType
impl Octal for RafxResourceType
source§impl Ord for RafxResourceType
impl Ord for RafxResourceType
source§fn cmp(&self, other: &RafxResourceType) -> Ordering
fn cmp(&self, other: &RafxResourceType) -> 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 RafxResourceType
impl PartialEq for RafxResourceType
source§fn eq(&self, other: &RafxResourceType) -> bool
fn eq(&self, other: &RafxResourceType) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for RafxResourceType
impl PartialOrd for RafxResourceType
source§fn partial_cmp(&self, other: &RafxResourceType) -> Option<Ordering>
fn partial_cmp(&self, other: &RafxResourceType) -> 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 RafxResourceType
impl Sub for RafxResourceType
source§impl SubAssign for RafxResourceType
impl SubAssign for RafxResourceType
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 RafxResourceType
impl UpperHex for RafxResourceType
impl Copy for RafxResourceType
impl Eq for RafxResourceType
impl StructuralPartialEq for RafxResourceType
Auto Trait Implementations§
impl RefUnwindSafe for RafxResourceType
impl Send for RafxResourceType
impl Sync for RafxResourceType
impl Unpin for RafxResourceType
impl UnwindSafe for RafxResourceType
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.