Struct bgfx_rs::static_lib::SamplerUFlags
source · pub struct SamplerUFlags { /* private fields */ }
Expand description
Sampler flags.
Implementations§
source§impl SamplerUFlags
impl SamplerUFlags
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§
source§impl Binary for SamplerUFlags
impl Binary for SamplerUFlags
source§impl BitAnd for SamplerUFlags
impl BitAnd for SamplerUFlags
source§impl BitAndAssign for SamplerUFlags
impl BitAndAssign for SamplerUFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr for SamplerUFlags
impl BitOr for SamplerUFlags
source§fn bitor(self, other: SamplerUFlags) -> Self
fn bitor(self, other: SamplerUFlags) -> Self
Returns the union of the two sets of flags.
§type Output = SamplerUFlags
type Output = SamplerUFlags
|
operator.source§impl BitOrAssign for SamplerUFlags
impl BitOrAssign for SamplerUFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor for SamplerUFlags
impl BitXor for SamplerUFlags
source§impl BitXorAssign for SamplerUFlags
impl BitXorAssign for SamplerUFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for SamplerUFlags
impl Clone for SamplerUFlags
source§fn clone(&self) -> SamplerUFlags
fn clone(&self) -> SamplerUFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for SamplerUFlags
impl Debug for SamplerUFlags
source§impl Extend<SamplerUFlags> for SamplerUFlags
impl Extend<SamplerUFlags> for SamplerUFlags
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<SamplerUFlags> for SamplerUFlags
impl FromIterator<SamplerUFlags> for SamplerUFlags
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 SamplerUFlags
impl Hash for SamplerUFlags
source§impl LowerHex for SamplerUFlags
impl LowerHex for SamplerUFlags
source§impl Not for SamplerUFlags
impl Not for SamplerUFlags
source§impl Octal for SamplerUFlags
impl Octal for SamplerUFlags
source§impl Ord for SamplerUFlags
impl Ord for SamplerUFlags
source§fn cmp(&self, other: &SamplerUFlags) -> Ordering
fn cmp(&self, other: &SamplerUFlags) -> 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 SamplerUFlags
impl PartialEq for SamplerUFlags
source§fn eq(&self, other: &SamplerUFlags) -> bool
fn eq(&self, other: &SamplerUFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for SamplerUFlags
impl PartialOrd for SamplerUFlags
source§fn partial_cmp(&self, other: &SamplerUFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &SamplerUFlags) -> 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 Sub for SamplerUFlags
impl Sub for SamplerUFlags
source§impl SubAssign for SamplerUFlags
impl SubAssign for SamplerUFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.