pub struct ImageFlags { /* private fields */ }
Implementations
sourceimpl ImageFlags
impl ImageFlags
pub const GENERATE_MIPMAPS: ImageFlags = Self{bits: 1,}
pub const REPEATX: ImageFlags = Self{bits: 2,}
pub const REPEATY: ImageFlags = Self{bits: 4,}
pub const FLIPY: ImageFlags = Self{bits: 8,}
pub const PREMULTIPLIED: ImageFlags = Self{bits: 16,}
pub const NEAREST: ImageFlags = Self{bits: 32,}
sourcepub const fn empty() -> ImageFlags
pub const fn empty() -> ImageFlags
Returns an empty set of flags.
sourcepub const fn all() -> ImageFlags
pub const fn all() -> ImageFlags
Returns the set containing all flags.
sourcepub const fn from_bits(bits: u32) -> Option<ImageFlags>
pub const fn from_bits(bits: u32) -> Option<ImageFlags>
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) -> ImageFlags
pub const fn from_bits_truncate(bits: u32) -> ImageFlags
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> ImageFlags
pub const unsafe fn from_bits_unchecked(bits: u32) -> ImageFlags
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: ImageFlags) -> bool
pub const fn intersects(&self, other: ImageFlags) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: ImageFlags) -> bool
pub const fn contains(&self, other: ImageFlags) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn insert(&mut self, other: ImageFlags)
pub fn insert(&mut self, other: ImageFlags)
Inserts the specified flags in-place.
sourcepub fn remove(&mut self, other: ImageFlags)
pub fn remove(&mut self, other: ImageFlags)
Removes the specified flags in-place.
sourcepub fn toggle(&mut self, other: ImageFlags)
pub fn toggle(&mut self, other: ImageFlags)
Toggles the specified flags in-place.
sourcepub fn set(&mut self, other: ImageFlags, value: bool)
pub fn set(&mut self, other: ImageFlags, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: ImageFlags) -> ImageFlags
pub const fn intersection(self, other: ImageFlags) -> ImageFlags
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: ImageFlags) -> ImageFlags
pub const fn union(self, other: ImageFlags) -> ImageFlags
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: ImageFlags) -> ImageFlags
pub const fn difference(self, other: ImageFlags) -> ImageFlags
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: ImageFlags) -> ImageFlags
pub const fn symmetric_difference(self, other: ImageFlags) -> ImageFlags
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) -> ImageFlags
pub const fn complement(self) -> ImageFlags
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
sourceimpl Binary for ImageFlags
impl Binary for ImageFlags
sourceimpl BitAnd<ImageFlags> for ImageFlags
impl BitAnd<ImageFlags> for ImageFlags
sourcefn bitand(self, other: ImageFlags) -> ImageFlags
fn bitand(self, other: ImageFlags) -> ImageFlags
Returns the intersection between the two sets of flags.
type Output = ImageFlags
type Output = ImageFlags
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<ImageFlags> for ImageFlags
impl BitAndAssign<ImageFlags> for ImageFlags
sourcefn bitand_assign(&mut self, other: ImageFlags)
fn bitand_assign(&mut self, other: ImageFlags)
Disables all flags disabled in the set.
sourceimpl BitOr<ImageFlags> for ImageFlags
impl BitOr<ImageFlags> for ImageFlags
sourcefn bitor(self, other: ImageFlags) -> ImageFlags
fn bitor(self, other: ImageFlags) -> ImageFlags
Returns the union of the two sets of flags.
type Output = ImageFlags
type Output = ImageFlags
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<ImageFlags> for ImageFlags
impl BitOrAssign<ImageFlags> for ImageFlags
sourcefn bitor_assign(&mut self, other: ImageFlags)
fn bitor_assign(&mut self, other: ImageFlags)
Adds the set of flags.
sourceimpl BitXor<ImageFlags> for ImageFlags
impl BitXor<ImageFlags> for ImageFlags
sourcefn bitxor(self, other: ImageFlags) -> ImageFlags
fn bitxor(self, other: ImageFlags) -> ImageFlags
Returns the left flags, but with all the right flags toggled.
type Output = ImageFlags
type Output = ImageFlags
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<ImageFlags> for ImageFlags
impl BitXorAssign<ImageFlags> for ImageFlags
sourcefn bitxor_assign(&mut self, other: ImageFlags)
fn bitxor_assign(&mut self, other: ImageFlags)
Toggles the set of flags.
sourceimpl Clone for ImageFlags
impl Clone for ImageFlags
sourcefn clone(&self) -> ImageFlags
fn clone(&self) -> ImageFlags
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 ImageFlags
impl Debug for ImageFlags
sourceimpl Extend<ImageFlags> for ImageFlags
impl Extend<ImageFlags> for ImageFlags
sourcefn extend<T>(&mut self, iterator: T) where
T: IntoIterator<Item = ImageFlags>,
fn extend<T>(&mut self, iterator: T) where
T: IntoIterator<Item = ImageFlags>,
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<ImageFlags> for ImageFlags
impl FromIterator<ImageFlags> for ImageFlags
sourcefn from_iter<T>(iterator: T) -> ImageFlags where
T: IntoIterator<Item = ImageFlags>,
fn from_iter<T>(iterator: T) -> ImageFlags where
T: IntoIterator<Item = ImageFlags>,
Creates a value from an iterator. Read more
sourceimpl Hash for ImageFlags
impl Hash for ImageFlags
sourceimpl LowerHex for ImageFlags
impl LowerHex for ImageFlags
sourceimpl Not for ImageFlags
impl Not for ImageFlags
sourcefn not(self) -> ImageFlags
fn not(self) -> ImageFlags
Returns the complement of this set of flags.
type Output = ImageFlags
type Output = ImageFlags
The resulting type after applying the !
operator.
sourceimpl Octal for ImageFlags
impl Octal for ImageFlags
sourceimpl Ord for ImageFlags
impl Ord for ImageFlags
sourceimpl PartialEq<ImageFlags> for ImageFlags
impl PartialEq<ImageFlags> for ImageFlags
sourcefn eq(&self, other: &ImageFlags) -> bool
fn eq(&self, other: &ImageFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &ImageFlags) -> bool
fn ne(&self, other: &ImageFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<ImageFlags> for ImageFlags
impl PartialOrd<ImageFlags> for ImageFlags
sourcefn partial_cmp(&self, other: &ImageFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &ImageFlags) -> 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<ImageFlags> for ImageFlags
impl Sub<ImageFlags> for ImageFlags
sourcefn sub(self, other: ImageFlags) -> ImageFlags
fn sub(self, other: ImageFlags) -> ImageFlags
Returns the set difference of the two sets of flags.
type Output = ImageFlags
type Output = ImageFlags
The resulting type after applying the -
operator.
sourceimpl SubAssign<ImageFlags> for ImageFlags
impl SubAssign<ImageFlags> for ImageFlags
sourcefn sub_assign(&mut self, other: ImageFlags)
fn sub_assign(&mut self, other: ImageFlags)
Disables all flags enabled in the set.
sourceimpl UpperHex for ImageFlags
impl UpperHex for ImageFlags
impl Copy for ImageFlags
impl Eq for ImageFlags
impl StructuralEq for ImageFlags
impl StructuralPartialEq for ImageFlags
Auto Trait Implementations
impl RefUnwindSafe for ImageFlags
impl Send for ImageFlags
impl Sync for ImageFlags
impl Unpin for ImageFlags
impl UnwindSafe for ImageFlags
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> Clamp<T> for T where
T: PartialOrd<T>,
impl<T> Clamp<T> for T where
T: PartialOrd<T>,
fn clamped(self, min: T, max: T) -> T
sourceimpl<Fr, To> IntoColor<To> for Fr where
To: FromColor<Fr>,
impl<Fr, To> IntoColor<To> for Fr where
To: FromColor<Fr>,
sourcefn into_color(self) -> To
fn into_color(self) -> To
Convert into color
impl<T> Pointable for T
impl<T> Pointable for T
impl<T> SetParameter for T
impl<T> SetParameter for T
fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where
T: Parameter<Self>,
fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where
T: Parameter<Self>,
Sets value
as a parameter of self
.