Struct bevy_sprite::SpritePipelineKey
source · [−]#[repr(transparent)]pub struct SpritePipelineKey { /* private fields */ }
Implementations
sourceimpl SpritePipelineKey
impl SpritePipelineKey
pub const NONE: Self = Self{bits: 0,}
pub const COLORED: Self = Self{bits: 1 << 0,}
pub const MSAA_RESERVED_BITS: Self = Self{bits: SpritePipelineKey::MSAA_MASK_BITS << SpritePipelineKey::MSAA_SHIFT_BITS,}
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
.
sourceimpl SpritePipelineKey
impl SpritePipelineKey
pub fn from_msaa_samples(msaa_samples: u32) -> Self
pub fn msaa_samples(&self) -> u32
Trait Implementations
sourceimpl Binary for SpritePipelineKey
impl Binary for SpritePipelineKey
sourceimpl BitAnd<SpritePipelineKey> for SpritePipelineKey
impl BitAnd<SpritePipelineKey> for SpritePipelineKey
type Output = SpritePipelineKey
type Output = SpritePipelineKey
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<SpritePipelineKey> for SpritePipelineKey
impl BitAndAssign<SpritePipelineKey> for SpritePipelineKey
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<SpritePipelineKey> for SpritePipelineKey
impl BitOr<SpritePipelineKey> for SpritePipelineKey
sourcefn bitor(self, other: SpritePipelineKey) -> Self
fn bitor(self, other: SpritePipelineKey) -> Self
Returns the union of the two sets of flags.
type Output = SpritePipelineKey
type Output = SpritePipelineKey
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<SpritePipelineKey> for SpritePipelineKey
impl BitOrAssign<SpritePipelineKey> for SpritePipelineKey
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<SpritePipelineKey> for SpritePipelineKey
impl BitXor<SpritePipelineKey> for SpritePipelineKey
sourcefn bitxor(self, other: Self) -> Self
fn bitxor(self, other: Self) -> Self
Returns the left flags, but with all the right flags toggled.
type Output = SpritePipelineKey
type Output = SpritePipelineKey
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<SpritePipelineKey> for SpritePipelineKey
impl BitXorAssign<SpritePipelineKey> for SpritePipelineKey
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for SpritePipelineKey
impl Clone for SpritePipelineKey
sourcefn clone(&self) -> SpritePipelineKey
fn clone(&self) -> SpritePipelineKey
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for SpritePipelineKey
impl Debug for SpritePipelineKey
sourceimpl Extend<SpritePipelineKey> for SpritePipelineKey
impl Extend<SpritePipelineKey> for SpritePipelineKey
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
sourceimpl FromIterator<SpritePipelineKey> for SpritePipelineKey
impl FromIterator<SpritePipelineKey> for SpritePipelineKey
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
Creates a value from an iterator. Read more
sourceimpl Hash for SpritePipelineKey
impl Hash for SpritePipelineKey
sourceimpl LowerHex for SpritePipelineKey
impl LowerHex for SpritePipelineKey
sourceimpl Not for SpritePipelineKey
impl Not for SpritePipelineKey
type Output = SpritePipelineKey
type Output = SpritePipelineKey
The resulting type after applying the !
operator.
sourceimpl Octal for SpritePipelineKey
impl Octal for SpritePipelineKey
sourceimpl Ord for SpritePipelineKey
impl Ord for SpritePipelineKey
sourceimpl PartialEq<SpritePipelineKey> for SpritePipelineKey
impl PartialEq<SpritePipelineKey> for SpritePipelineKey
sourcefn eq(&self, other: &SpritePipelineKey) -> bool
fn eq(&self, other: &SpritePipelineKey) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &SpritePipelineKey) -> bool
fn ne(&self, other: &SpritePipelineKey) -> bool
This method tests for !=
.
sourceimpl PartialOrd<SpritePipelineKey> for SpritePipelineKey
impl PartialOrd<SpritePipelineKey> for SpritePipelineKey
sourcefn partial_cmp(&self, other: &SpritePipelineKey) -> Option<Ordering>
fn partial_cmp(&self, other: &SpritePipelineKey) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl Sub<SpritePipelineKey> for SpritePipelineKey
impl Sub<SpritePipelineKey> for SpritePipelineKey
type Output = SpritePipelineKey
type Output = SpritePipelineKey
The resulting type after applying the -
operator.
sourceimpl SubAssign<SpritePipelineKey> for SpritePipelineKey
impl SubAssign<SpritePipelineKey> for SpritePipelineKey
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl 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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
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>
Convert 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
. Read more
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
sourceimpl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcefn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to key
and return true
if they are equal.
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> TypeData for T where
T: 'static + Send + Sync + Clone,
impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,
fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more