Struct bgfx_rs::static_lib::SamplerMipFlags
source · [−]pub struct SamplerMipFlags { /* private fields */ }
Implementations
sourceimpl SamplerMipFlags
impl SamplerMipFlags
sourcepub const POINT: Self = Self{bits: bgfx_sys::BGFX_SAMPLER_MIP_POINT as _,}
pub const POINT: Self = Self{bits: bgfx_sys::BGFX_SAMPLER_MIP_POINT as _,}
Mip sampling mode: Point
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 SamplerMipFlags
impl Binary for SamplerMipFlags
sourceimpl BitAnd<SamplerMipFlags> for SamplerMipFlags
impl BitAnd<SamplerMipFlags> for SamplerMipFlags
type Output = SamplerMipFlags
type Output = SamplerMipFlags
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<SamplerMipFlags> for SamplerMipFlags
impl BitAndAssign<SamplerMipFlags> for SamplerMipFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<SamplerMipFlags> for SamplerMipFlags
impl BitOr<SamplerMipFlags> for SamplerMipFlags
sourcefn bitor(self, other: SamplerMipFlags) -> Self
fn bitor(self, other: SamplerMipFlags) -> Self
Returns the union of the two sets of flags.
type Output = SamplerMipFlags
type Output = SamplerMipFlags
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<SamplerMipFlags> for SamplerMipFlags
impl BitOrAssign<SamplerMipFlags> for SamplerMipFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<SamplerMipFlags> for SamplerMipFlags
impl BitXor<SamplerMipFlags> for SamplerMipFlags
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 = SamplerMipFlags
type Output = SamplerMipFlags
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<SamplerMipFlags> for SamplerMipFlags
impl BitXorAssign<SamplerMipFlags> for SamplerMipFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for SamplerMipFlags
impl Clone for SamplerMipFlags
sourcefn clone(&self) -> SamplerMipFlags
fn clone(&self) -> SamplerMipFlags
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 SamplerMipFlags
impl Debug for SamplerMipFlags
sourceimpl Extend<SamplerMipFlags> for SamplerMipFlags
impl Extend<SamplerMipFlags> for SamplerMipFlags
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<SamplerMipFlags> for SamplerMipFlags
impl FromIterator<SamplerMipFlags> for SamplerMipFlags
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 SamplerMipFlags
impl Hash for SamplerMipFlags
sourceimpl LowerHex for SamplerMipFlags
impl LowerHex for SamplerMipFlags
sourceimpl Not for SamplerMipFlags
impl Not for SamplerMipFlags
type Output = SamplerMipFlags
type Output = SamplerMipFlags
The resulting type after applying the !
operator.
sourceimpl Octal for SamplerMipFlags
impl Octal for SamplerMipFlags
sourceimpl Ord for SamplerMipFlags
impl Ord for SamplerMipFlags
sourceimpl PartialEq<SamplerMipFlags> for SamplerMipFlags
impl PartialEq<SamplerMipFlags> for SamplerMipFlags
sourcefn eq(&self, other: &SamplerMipFlags) -> bool
fn eq(&self, other: &SamplerMipFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &SamplerMipFlags) -> bool
fn ne(&self, other: &SamplerMipFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<SamplerMipFlags> for SamplerMipFlags
impl PartialOrd<SamplerMipFlags> for SamplerMipFlags
sourcefn partial_cmp(&self, other: &SamplerMipFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &SamplerMipFlags) -> 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<SamplerMipFlags> for SamplerMipFlags
impl Sub<SamplerMipFlags> for SamplerMipFlags
type Output = SamplerMipFlags
type Output = SamplerMipFlags
The resulting type after applying the -
operator.
sourceimpl SubAssign<SamplerMipFlags> for SamplerMipFlags
impl SubAssign<SamplerMipFlags> for SamplerMipFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for SamplerMipFlags
impl UpperHex for SamplerMipFlags
impl Copy for SamplerMipFlags
impl Eq for SamplerMipFlags
impl StructuralEq for SamplerMipFlags
impl StructuralPartialEq for SamplerMipFlags
Auto Trait Implementations
impl RefUnwindSafe for SamplerMipFlags
impl Send for SamplerMipFlags
impl Sync for SamplerMipFlags
impl Unpin for SamplerMipFlags
impl UnwindSafe for SamplerMipFlags
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