Struct asefile::LayerFlags
source · pub struct LayerFlags(/* private fields */);
Expand description
Various layer attributes.
For checking whether a layer is visible prefer to use Layer::is_visible as that also takes into account any parent layer’s visibility.
Implementations§
source§impl LayerFlags
impl LayerFlags
sourcepub const MOVEMENT_LOCKED: Self = _
pub const MOVEMENT_LOCKED: Self = _
Layer cannot be moved.
sourcepub const BACKGROUND: Self = _
pub const BACKGROUND: Self = _
Layer is background (stack order cannot be changed).
sourcepub const CONTINUOUS: Self = _
pub const CONTINUOUS: Self = _
Prefer to link cels when the user copies them.
sourcepub const BACKGROUND_LAYER: Self = _
pub const BACKGROUND_LAYER: Self = _
The is a background layer.
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 fn from_bits_retain(bits: u32) -> Self
pub const fn from_bits_retain(bits: u32) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
Get the value for a flag from its stringified name.
Names are case-sensitive, so must correspond exactly to the identifier given to the flag.
sourcepub const fn iter_names(&self) -> IterRaw
pub const fn iter_names(&self) -> IterRaw
Iterate over enabled flag values with their stringified names.
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 LayerFlags
impl Binary for LayerFlags
source§impl BitAnd for LayerFlags
impl BitAnd for LayerFlags
source§impl BitAndAssign for LayerFlags
impl BitAndAssign for LayerFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitFlags for LayerFlags
impl BitFlags for LayerFlags
§type IterNames = IterRaw
type IterNames = IterRaw
source§fn from_bits(bits: u32) -> Option<LayerFlags>
fn from_bits(bits: u32) -> Option<LayerFlags>
source§fn from_bits_truncate(bits: u32) -> LayerFlags
fn from_bits_truncate(bits: u32) -> LayerFlags
source§fn from_bits_retain(bits: u32) -> LayerFlags
fn from_bits_retain(bits: u32) -> LayerFlags
source§fn iter_names(&self) -> Self::IterNames
fn iter_names(&self) -> Self::IterNames
source§fn intersects(&self, other: LayerFlags) -> bool
fn intersects(&self, other: LayerFlags) -> bool
true
if there are flags common to both self
and other
.source§fn contains(&self, other: LayerFlags) -> bool
fn contains(&self, other: LayerFlags) -> bool
true
if all of the flags in other
are contained within self
.source§fn insert(&mut self, other: LayerFlags)
fn insert(&mut self, other: LayerFlags)
source§fn remove(&mut self, other: LayerFlags)
fn remove(&mut self, other: LayerFlags)
source§fn toggle(&mut self, other: LayerFlags)
fn toggle(&mut self, other: LayerFlags)
source§fn set(&mut self, other: LayerFlags, value: bool)
fn set(&mut self, other: LayerFlags, value: bool)
source§impl BitOr for LayerFlags
impl BitOr for LayerFlags
source§fn bitor(self, other: LayerFlags) -> Self
fn bitor(self, other: LayerFlags) -> Self
Returns the union of the two sets of flags.
§type Output = LayerFlags
type Output = LayerFlags
|
operator.source§impl BitOrAssign for LayerFlags
impl BitOrAssign for LayerFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor for LayerFlags
impl BitXor for LayerFlags
source§impl BitXorAssign for LayerFlags
impl BitXorAssign for LayerFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for LayerFlags
impl Clone for LayerFlags
source§fn clone(&self) -> LayerFlags
fn clone(&self) -> LayerFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for LayerFlags
impl Debug for LayerFlags
source§impl Extend<LayerFlags> for LayerFlags
impl Extend<LayerFlags> for LayerFlags
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<LayerFlags> for LayerFlags
impl FromIterator<LayerFlags> for LayerFlags
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 LayerFlags
impl Hash for LayerFlags
source§impl IntoIterator for LayerFlags
impl IntoIterator for LayerFlags
source§impl LowerHex for LayerFlags
impl LowerHex for LayerFlags
source§impl Not for LayerFlags
impl Not for LayerFlags
source§impl Octal for LayerFlags
impl Octal for LayerFlags
source§impl Ord for LayerFlags
impl Ord for LayerFlags
source§fn cmp(&self, other: &LayerFlags) -> Ordering
fn cmp(&self, other: &LayerFlags) -> 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 LayerFlags
impl PartialEq for LayerFlags
source§fn eq(&self, other: &LayerFlags) -> bool
fn eq(&self, other: &LayerFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for LayerFlags
impl PartialOrd for LayerFlags
source§fn partial_cmp(&self, other: &LayerFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &LayerFlags) -> 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 PublicFlags for LayerFlags
impl PublicFlags for LayerFlags
source§impl Sub for LayerFlags
impl Sub for LayerFlags
source§impl SubAssign for LayerFlags
impl SubAssign for LayerFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.