Struct bgfx_rs::static_lib::TextureFlags
source · [−]pub struct TextureFlags { /* private fields */ }
Implementations
sourceimpl TextureFlags
impl TextureFlags
pub const NONE: Self = Self{bits: bgfx_sys::BGFX_TEXTURE_NONE as _,}
sourcepub const MSAA_SAMPLE: Self = Self{bits: bgfx_sys::BGFX_TEXTURE_MSAA_SAMPLE as _,}
pub const MSAA_SAMPLE: Self = Self{bits: bgfx_sys::BGFX_TEXTURE_MSAA_SAMPLE as _,}
Texture will be used for MSAA sampling.
sourcepub const COMPUTE_WRITE: Self = Self{bits: bgfx_sys::BGFX_TEXTURE_COMPUTE_WRITE as _,}
pub const COMPUTE_WRITE: Self = Self{bits: bgfx_sys::BGFX_TEXTURE_COMPUTE_WRITE as _,}
Texture will be used for compute write.
sourcepub const BLIT_DST: Self = Self{bits: bgfx_sys::BGFX_TEXTURE_BLIT_DST as _,}
pub const BLIT_DST: Self = Self{bits: bgfx_sys::BGFX_TEXTURE_BLIT_DST as _,}
Texture will be used as blit destination.
sourcepub const READ_BACK: Self = Self{bits: bgfx_sys::BGFX_TEXTURE_READ_BACK as _,}
pub const READ_BACK: Self = Self{bits: bgfx_sys::BGFX_TEXTURE_READ_BACK as _,}
Texture will be used for read back from GPU.
sourcepub const fn from_bits(bits: u64) -> Option<Self>
pub const fn from_bits(bits: u64) -> 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: u64) -> Self
pub const fn from_bits_truncate(bits: u64) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u64) -> Self
pub const unsafe fn from_bits_unchecked(bits: u64) -> 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 TextureFlags
impl Binary for TextureFlags
sourceimpl BitAnd<TextureFlags> for TextureFlags
impl BitAnd<TextureFlags> for TextureFlags
type Output = TextureFlags
type Output = TextureFlags
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<TextureFlags> for TextureFlags
impl BitAndAssign<TextureFlags> for TextureFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<TextureFlags> for TextureFlags
impl BitOr<TextureFlags> for TextureFlags
sourcefn bitor(self, other: TextureFlags) -> Self
fn bitor(self, other: TextureFlags) -> Self
Returns the union of the two sets of flags.
type Output = TextureFlags
type Output = TextureFlags
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<TextureFlags> for TextureFlags
impl BitOrAssign<TextureFlags> for TextureFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<TextureFlags> for TextureFlags
impl BitXor<TextureFlags> for TextureFlags
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 = TextureFlags
type Output = TextureFlags
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<TextureFlags> for TextureFlags
impl BitXorAssign<TextureFlags> for TextureFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for TextureFlags
impl Clone for TextureFlags
sourcefn clone(&self) -> TextureFlags
fn clone(&self) -> TextureFlags
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 TextureFlags
impl Debug for TextureFlags
sourceimpl Extend<TextureFlags> for TextureFlags
impl Extend<TextureFlags> for TextureFlags
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<TextureFlags> for TextureFlags
impl FromIterator<TextureFlags> for TextureFlags
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 TextureFlags
impl Hash for TextureFlags
sourceimpl LowerHex for TextureFlags
impl LowerHex for TextureFlags
sourceimpl Not for TextureFlags
impl Not for TextureFlags
type Output = TextureFlags
type Output = TextureFlags
The resulting type after applying the !
operator.
sourceimpl Octal for TextureFlags
impl Octal for TextureFlags
sourceimpl Ord for TextureFlags
impl Ord for TextureFlags
sourceimpl PartialEq<TextureFlags> for TextureFlags
impl PartialEq<TextureFlags> for TextureFlags
sourcefn eq(&self, other: &TextureFlags) -> bool
fn eq(&self, other: &TextureFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &TextureFlags) -> bool
fn ne(&self, other: &TextureFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<TextureFlags> for TextureFlags
impl PartialOrd<TextureFlags> for TextureFlags
sourcefn partial_cmp(&self, other: &TextureFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &TextureFlags) -> 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<TextureFlags> for TextureFlags
impl Sub<TextureFlags> for TextureFlags
type Output = TextureFlags
type Output = TextureFlags
The resulting type after applying the -
operator.
sourceimpl SubAssign<TextureFlags> for TextureFlags
impl SubAssign<TextureFlags> for TextureFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for TextureFlags
impl UpperHex for TextureFlags
impl Copy for TextureFlags
impl Eq for TextureFlags
impl StructuralEq for TextureFlags
impl StructuralPartialEq for TextureFlags
Auto Trait Implementations
impl RefUnwindSafe for TextureFlags
impl Send for TextureFlags
impl Sync for TextureFlags
impl Unpin for TextureFlags
impl UnwindSafe for TextureFlags
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