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