pub struct FeatureFlags { /* private fields */ }
Implementations
sourceimpl FeatureFlags
impl FeatureFlags
pub const TEXTURE_RECTANGLE: Self = Self{bits: 2,}
pub const TEXTURE_NPOT: Self = Self{bits: 4,}
pub const TEXTURE_YUV: Self = Self{bits: 8,}
pub const TEXTURE_READ_PIXELS: Self = Self{bits: 16,}
pub const SHADERS_GLSL: Self = Self{bits: 32,}
pub const OFFSCREEN: Self = Self{bits: 64,}
pub const OFFSCREEN_MULTISAMPLE: Self = Self{bits: 128,}
pub const OFFSCREEN_BLIT: Self = Self{bits: 256,}
pub const FOUR_CLIP_PLANES: Self = Self{bits: 512,}
pub const STENCIL_BUFFER: Self = Self{bits: 1024,}
pub const VBOS: Self = Self{bits: 2048,}
pub const PBOS: Self = Self{bits: 4096,}
pub const UNSIGNED_INT_INDICES: Self = Self{bits: 8192,}
pub const DEPTH_RANGE: Self = Self{bits: 16384,}
pub const TEXTURE_NPOT_BASIC: Self = Self{bits: 32768,}
pub const TEXTURE_NPOT_MIPMAP: Self = Self{bits: 65536,}
pub const TEXTURE_NPOT_REPEAT: Self = Self{bits: 131072,}
pub const POINT_SPRITE: Self = Self{bits: 262144,}
pub const TEXTURE_3D: Self = Self{bits: 524288,}
pub const SHADERS_ARBFP: Self = Self{bits: 1048576,}
pub const MAP_BUFFER_FOR_READ: Self = Self{bits: 2097152,}
pub const MAP_BUFFER_FOR_WRITE: Self = Self{bits: 4194304,}
pub const ONSCREEN_MULTIPLE: Self = Self{bits: 8388608,}
pub const DEPTH_TEXTURE: Self = Self{bits: 16777216,}
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
.
Trait Implementations
sourceimpl Binary for FeatureFlags
impl Binary for FeatureFlags
sourceimpl BitAnd<FeatureFlags> for FeatureFlags
impl BitAnd<FeatureFlags> for FeatureFlags
type Output = FeatureFlags
type Output = FeatureFlags
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<FeatureFlags> for FeatureFlags
impl BitAndAssign<FeatureFlags> for FeatureFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<FeatureFlags> for FeatureFlags
impl BitOr<FeatureFlags> for FeatureFlags
sourcefn bitor(self, other: FeatureFlags) -> Self
fn bitor(self, other: FeatureFlags) -> Self
Returns the union of the two sets of flags.
type Output = FeatureFlags
type Output = FeatureFlags
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<FeatureFlags> for FeatureFlags
impl BitOrAssign<FeatureFlags> for FeatureFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<FeatureFlags> for FeatureFlags
impl BitXor<FeatureFlags> for FeatureFlags
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 = FeatureFlags
type Output = FeatureFlags
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<FeatureFlags> for FeatureFlags
impl BitXorAssign<FeatureFlags> for FeatureFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for FeatureFlags
impl Clone for FeatureFlags
sourcefn clone(&self) -> FeatureFlags
fn clone(&self) -> FeatureFlags
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 FeatureFlags
impl Debug for FeatureFlags
sourceimpl Extend<FeatureFlags> for FeatureFlags
impl Extend<FeatureFlags> for FeatureFlags
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<FeatureFlags> for FeatureFlags
impl FromIterator<FeatureFlags> for FeatureFlags
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 FeatureFlags
impl Hash for FeatureFlags
sourceimpl LowerHex for FeatureFlags
impl LowerHex for FeatureFlags
sourceimpl Not for FeatureFlags
impl Not for FeatureFlags
type Output = FeatureFlags
type Output = FeatureFlags
The resulting type after applying the !
operator.
sourceimpl Octal for FeatureFlags
impl Octal for FeatureFlags
sourceimpl Ord for FeatureFlags
impl Ord for FeatureFlags
sourceimpl PartialEq<FeatureFlags> for FeatureFlags
impl PartialEq<FeatureFlags> for FeatureFlags
sourcefn eq(&self, other: &FeatureFlags) -> bool
fn eq(&self, other: &FeatureFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &FeatureFlags) -> bool
fn ne(&self, other: &FeatureFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<FeatureFlags> for FeatureFlags
impl PartialOrd<FeatureFlags> for FeatureFlags
sourcefn partial_cmp(&self, other: &FeatureFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &FeatureFlags) -> 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<FeatureFlags> for FeatureFlags
impl Sub<FeatureFlags> for FeatureFlags
type Output = FeatureFlags
type Output = FeatureFlags
The resulting type after applying the -
operator.
sourceimpl SubAssign<FeatureFlags> for FeatureFlags
impl SubAssign<FeatureFlags> for FeatureFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for FeatureFlags
impl UpperHex for FeatureFlags
impl Copy for FeatureFlags
impl Eq for FeatureFlags
impl StructuralEq for FeatureFlags
impl StructuralPartialEq for FeatureFlags
Auto Trait Implementations
impl RefUnwindSafe for FeatureFlags
impl Send for FeatureFlags
impl Sync for FeatureFlags
impl Unpin for FeatureFlags
impl UnwindSafe for FeatureFlags
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
.