Struct bevy::sprite::SpritePipelineKey
pub struct SpritePipelineKey { /* private fields */ }
Implementations§
§impl SpritePipelineKey
impl SpritePipelineKey
pub const NONE: SpritePipelineKey = Self{ bits: 0,}
pub const COLORED: SpritePipelineKey = Self{ bits: 1 << 0,}
pub const HDR: SpritePipelineKey = Self{ bits: 1 << 1,}
pub const TONEMAP_IN_SHADER: SpritePipelineKey = Self{ bits: 1 << 2,}
pub const DEBAND_DITHER: SpritePipelineKey = Self{ bits: 1 << 3,}
pub const MSAA_RESERVED_BITS: SpritePipelineKey = Self{ bits: Self::MSAA_MASK_BITS << Self::MSAA_SHIFT_BITS,}
pub const TONEMAP_METHOD_RESERVED_BITS: SpritePipelineKey = Self{ bits: Self::TONEMAP_METHOD_MASK_BITS << Self::TONEMAP_METHOD_SHIFT_BITS,}
pub const TONEMAP_METHOD_NONE: SpritePipelineKey = Self{ bits: 0 << Self::TONEMAP_METHOD_SHIFT_BITS,}
pub const TONEMAP_METHOD_REINHARD: SpritePipelineKey = Self{ bits: 1 << Self::TONEMAP_METHOD_SHIFT_BITS,}
pub const TONEMAP_METHOD_REINHARD_LUMINANCE: SpritePipelineKey = Self{ bits: 2 << Self::TONEMAP_METHOD_SHIFT_BITS,}
pub const TONEMAP_METHOD_ACES_FITTED: SpritePipelineKey = Self{ bits: 3 << Self::TONEMAP_METHOD_SHIFT_BITS,}
pub const TONEMAP_METHOD_AGX: SpritePipelineKey = Self{ bits: 4 << Self::TONEMAP_METHOD_SHIFT_BITS,}
pub const TONEMAP_METHOD_SOMEWHAT_BORING_DISPLAY_TRANSFORM: SpritePipelineKey = Self{ bits: 5 << Self::TONEMAP_METHOD_SHIFT_BITS,}
pub const TONEMAP_METHOD_TONY_MC_MAPFACE: SpritePipelineKey = Self{ bits: 6 << Self::TONEMAP_METHOD_SHIFT_BITS,}
pub const TONEMAP_METHOD_BLENDER_FILMIC: SpritePipelineKey = Self{ bits: 7 << Self::TONEMAP_METHOD_SHIFT_BITS,}
pub const fn empty() -> SpritePipelineKey
pub const fn empty() -> SpritePipelineKey
Returns an empty set of flags.
pub const fn all() -> SpritePipelineKey
pub const fn all() -> SpritePipelineKey
Returns the set containing all flags.
pub const fn from_bits(bits: u32) -> Option<SpritePipelineKey>
pub const fn from_bits(bits: u32) -> Option<SpritePipelineKey>
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) -> SpritePipelineKey
pub const fn from_bits_truncate(bits: u32) -> SpritePipelineKey
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
pub const unsafe fn from_bits_unchecked(bits: u32) -> SpritePipelineKey
pub const unsafe fn from_bits_unchecked(bits: u32) -> SpritePipelineKey
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.
pub const fn intersects(&self, other: SpritePipelineKey) -> bool
pub const fn intersects(&self, other: SpritePipelineKey) -> bool
Returns true
if there are flags common to both self
and other
.
pub const fn contains(&self, other: SpritePipelineKey) -> bool
pub const fn contains(&self, other: SpritePipelineKey) -> bool
Returns true
if all of the flags in other
are contained within self
.
pub fn insert(&mut self, other: SpritePipelineKey)
pub fn insert(&mut self, other: SpritePipelineKey)
Inserts the specified flags in-place.
pub fn remove(&mut self, other: SpritePipelineKey)
pub fn remove(&mut self, other: SpritePipelineKey)
Removes the specified flags in-place.
pub fn toggle(&mut self, other: SpritePipelineKey)
pub fn toggle(&mut self, other: SpritePipelineKey)
Toggles the specified flags in-place.
pub fn set(&mut self, other: SpritePipelineKey, value: bool)
pub fn set(&mut self, other: SpritePipelineKey, value: bool)
Inserts or removes the specified flags depending on the passed value.
pub const fn intersection(self, other: SpritePipelineKey) -> SpritePipelineKey
pub const fn intersection(self, other: SpritePipelineKey) -> SpritePipelineKey
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
.
pub const fn union(self, other: SpritePipelineKey) -> SpritePipelineKey
pub const fn union(self, other: SpritePipelineKey) -> SpritePipelineKey
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
.
pub const fn difference(self, other: SpritePipelineKey) -> SpritePipelineKey
pub const fn difference(self, other: SpritePipelineKey) -> SpritePipelineKey
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
.
pub const fn symmetric_difference(
self,
other: SpritePipelineKey
) -> SpritePipelineKey
pub const fn symmetric_difference( self, other: SpritePipelineKey ) -> SpritePipelineKey
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
.
pub const fn complement(self) -> SpritePipelineKey
pub const fn complement(self) -> SpritePipelineKey
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
.
§impl SpritePipelineKey
impl SpritePipelineKey
pub const fn from_msaa_samples(msaa_samples: u32) -> SpritePipelineKey
pub const fn msaa_samples(&self) -> u32
pub const fn from_colored(colored: bool) -> SpritePipelineKey
pub const fn from_hdr(hdr: bool) -> SpritePipelineKey
Trait Implementations§
§impl Binary for SpritePipelineKey
impl Binary for SpritePipelineKey
§impl BitAnd<SpritePipelineKey> for SpritePipelineKey
impl BitAnd<SpritePipelineKey> for SpritePipelineKey
§fn bitand(self, other: SpritePipelineKey) -> SpritePipelineKey
fn bitand(self, other: SpritePipelineKey) -> SpritePipelineKey
Returns the intersection between the two sets of flags.
§type Output = SpritePipelineKey
type Output = SpritePipelineKey
&
operator.§impl BitAndAssign<SpritePipelineKey> for SpritePipelineKey
impl BitAndAssign<SpritePipelineKey> for SpritePipelineKey
§fn bitand_assign(&mut self, other: SpritePipelineKey)
fn bitand_assign(&mut self, other: SpritePipelineKey)
Disables all flags disabled in the set.
§impl BitOr<SpritePipelineKey> for SpritePipelineKey
impl BitOr<SpritePipelineKey> for SpritePipelineKey
§fn bitor(self, other: SpritePipelineKey) -> SpritePipelineKey
fn bitor(self, other: SpritePipelineKey) -> SpritePipelineKey
Returns the union of the two sets of flags.
§type Output = SpritePipelineKey
type Output = SpritePipelineKey
|
operator.§impl BitOrAssign<SpritePipelineKey> for SpritePipelineKey
impl BitOrAssign<SpritePipelineKey> for SpritePipelineKey
§fn bitor_assign(&mut self, other: SpritePipelineKey)
fn bitor_assign(&mut self, other: SpritePipelineKey)
Adds the set of flags.
§impl BitXor<SpritePipelineKey> for SpritePipelineKey
impl BitXor<SpritePipelineKey> for SpritePipelineKey
§fn bitxor(self, other: SpritePipelineKey) -> SpritePipelineKey
fn bitxor(self, other: SpritePipelineKey) -> SpritePipelineKey
Returns the left flags, but with all the right flags toggled.
§type Output = SpritePipelineKey
type Output = SpritePipelineKey
^
operator.§impl BitXorAssign<SpritePipelineKey> for SpritePipelineKey
impl BitXorAssign<SpritePipelineKey> for SpritePipelineKey
§fn bitxor_assign(&mut self, other: SpritePipelineKey)
fn bitxor_assign(&mut self, other: SpritePipelineKey)
Toggles the set of flags.
§impl Clone for SpritePipelineKey
impl Clone for SpritePipelineKey
§fn clone(&self) -> SpritePipelineKey
fn clone(&self) -> SpritePipelineKey
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more§impl Debug for SpritePipelineKey
impl Debug for SpritePipelineKey
§impl Extend<SpritePipelineKey> for SpritePipelineKey
impl Extend<SpritePipelineKey> for SpritePipelineKey
§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = SpritePipelineKey>,
fn extend<T>(&mut self, iterator: T)where T: IntoIterator<Item = SpritePipelineKey>,
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
)§impl FromIterator<SpritePipelineKey> for SpritePipelineKey
impl FromIterator<SpritePipelineKey> for SpritePipelineKey
§fn from_iter<T>(iterator: T) -> SpritePipelineKeywhere
T: IntoIterator<Item = SpritePipelineKey>,
fn from_iter<T>(iterator: T) -> SpritePipelineKeywhere T: IntoIterator<Item = SpritePipelineKey>,
§impl Hash for SpritePipelineKey
impl Hash for SpritePipelineKey
§impl LowerHex for SpritePipelineKey
impl LowerHex for SpritePipelineKey
§impl Not for SpritePipelineKey
impl Not for SpritePipelineKey
§fn not(self) -> SpritePipelineKey
fn not(self) -> SpritePipelineKey
Returns the complement of this set of flags.
§type Output = SpritePipelineKey
type Output = SpritePipelineKey
!
operator.§impl Octal for SpritePipelineKey
impl Octal for SpritePipelineKey
§impl Ord for SpritePipelineKey
impl Ord for SpritePipelineKey
§fn cmp(&self, other: &SpritePipelineKey) -> Ordering
fn cmp(&self, other: &SpritePipelineKey) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
§impl PartialEq<SpritePipelineKey> for SpritePipelineKey
impl PartialEq<SpritePipelineKey> for SpritePipelineKey
§fn eq(&self, other: &SpritePipelineKey) -> bool
fn eq(&self, other: &SpritePipelineKey) -> bool
self
and other
values to be equal, and is used
by ==
.§impl PartialOrd<SpritePipelineKey> for SpritePipelineKey
impl PartialOrd<SpritePipelineKey> for SpritePipelineKey
§fn partial_cmp(&self, other: &SpritePipelineKey) -> Option<Ordering>
fn partial_cmp(&self, other: &SpritePipelineKey) -> 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 more§impl Sub<SpritePipelineKey> for SpritePipelineKey
impl Sub<SpritePipelineKey> for SpritePipelineKey
§fn sub(self, other: SpritePipelineKey) -> SpritePipelineKey
fn sub(self, other: SpritePipelineKey) -> SpritePipelineKey
Returns the set difference of the two sets of flags.
§type Output = SpritePipelineKey
type Output = SpritePipelineKey
-
operator.§impl SubAssign<SpritePipelineKey> for SpritePipelineKey
impl SubAssign<SpritePipelineKey> for SpritePipelineKey
§fn sub_assign(&mut self, other: SpritePipelineKey)
fn sub_assign(&mut self, other: SpritePipelineKey)
Disables all flags enabled in the set.
§impl UpperHex for SpritePipelineKey
impl UpperHex for SpritePipelineKey
impl Copy for SpritePipelineKey
impl Eq for SpritePipelineKey
impl StructuralEq for SpritePipelineKey
impl StructuralPartialEq for SpritePipelineKey
Auto Trait Implementations§
impl RefUnwindSafe for SpritePipelineKey
impl Send for SpritePipelineKey
impl Sync for SpritePipelineKey
impl Unpin for SpritePipelineKey
impl UnwindSafe for SpritePipelineKey
Blanket Implementations§
§impl<T, U> AsBindGroupShaderType<U> for Twhere
U: ShaderType,
&'a T: for<'a> Into<U>,
impl<T, U> AsBindGroupShaderType<U> for Twhere U: ShaderType, &'a T: for<'a> Into<U>,
§fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist.§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere T: Any,
§fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
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 + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
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.source§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.