Struct bgfx_rs::static_lib::BufferFlags
source · [−]pub struct BufferFlags { /* private fields */ }
Implementations
sourceimpl BufferFlags
impl BufferFlags
pub const NONE: Self = Self{bits: bgfx_sys::BGFX_BUFFER_NONE as _,}
sourcepub const COMPUTE_READ: Self = Self{bits: bgfx_sys::BGFX_BUFFER_COMPUTE_READ as _,}
pub const COMPUTE_READ: Self = Self{bits: bgfx_sys::BGFX_BUFFER_COMPUTE_READ as _,}
Buffer will be read by shader.
sourcepub const COMPUTE_WRITE: Self = Self{bits: bgfx_sys::BGFX_BUFFER_COMPUTE_WRITE as _,}
pub const COMPUTE_WRITE: Self = Self{bits: bgfx_sys::BGFX_BUFFER_COMPUTE_WRITE as _,}
Buffer will be used for writing.
sourcepub const DRAW_INDIRECT: Self = Self{bits: bgfx_sys::BGFX_BUFFER_DRAW_INDIRECT as _,}
pub const DRAW_INDIRECT: Self = Self{bits: bgfx_sys::BGFX_BUFFER_DRAW_INDIRECT as _,}
Buffer will be used for storing draw indirect commands.
sourcepub const ALLOW_RESIZE: Self = Self{bits: bgfx_sys::BGFX_BUFFER_ALLOW_RESIZE as _,}
pub const ALLOW_RESIZE: Self = Self{bits: bgfx_sys::BGFX_BUFFER_ALLOW_RESIZE as _,}
Allow dynamic index/vertex buffer resize during update.
sourcepub const INDEX_32: Self = Self{bits: bgfx_sys::BGFX_BUFFER_INDEX32 as _,}
pub const INDEX_32: Self = Self{bits: bgfx_sys::BGFX_BUFFER_INDEX32 as _,}
Index buffer contains 32-bit indices.
pub const COMPUTE_READ_WRITE: Self = Self{bits: bgfx_sys::BGFX_BUFFER_COMPUTE_READ_WRITE as _,}
sourcepub const fn from_bits(bits: u16) -> Option<Self>
pub const fn from_bits(bits: u16) -> 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: u16) -> Self
pub const fn from_bits_truncate(bits: u16) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u16) -> Self
pub const unsafe fn from_bits_unchecked(bits: u16) -> 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 BufferFlags
impl Binary for BufferFlags
sourceimpl BitAnd<BufferFlags> for BufferFlags
impl BitAnd<BufferFlags> for BufferFlags
type Output = BufferFlags
type Output = BufferFlags
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<BufferFlags> for BufferFlags
impl BitAndAssign<BufferFlags> for BufferFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<BufferFlags> for BufferFlags
impl BitOr<BufferFlags> for BufferFlags
sourcefn bitor(self, other: BufferFlags) -> Self
fn bitor(self, other: BufferFlags) -> Self
Returns the union of the two sets of flags.
type Output = BufferFlags
type Output = BufferFlags
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<BufferFlags> for BufferFlags
impl BitOrAssign<BufferFlags> for BufferFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<BufferFlags> for BufferFlags
impl BitXor<BufferFlags> for BufferFlags
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 = BufferFlags
type Output = BufferFlags
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<BufferFlags> for BufferFlags
impl BitXorAssign<BufferFlags> for BufferFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for BufferFlags
impl Clone for BufferFlags
sourcefn clone(&self) -> BufferFlags
fn clone(&self) -> BufferFlags
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 BufferFlags
impl Debug for BufferFlags
sourceimpl Extend<BufferFlags> for BufferFlags
impl Extend<BufferFlags> for BufferFlags
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<BufferFlags> for BufferFlags
impl FromIterator<BufferFlags> for BufferFlags
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 BufferFlags
impl Hash for BufferFlags
sourceimpl LowerHex for BufferFlags
impl LowerHex for BufferFlags
sourceimpl Not for BufferFlags
impl Not for BufferFlags
type Output = BufferFlags
type Output = BufferFlags
The resulting type after applying the !
operator.
sourceimpl Octal for BufferFlags
impl Octal for BufferFlags
sourceimpl Ord for BufferFlags
impl Ord for BufferFlags
sourceimpl PartialEq<BufferFlags> for BufferFlags
impl PartialEq<BufferFlags> for BufferFlags
sourcefn eq(&self, other: &BufferFlags) -> bool
fn eq(&self, other: &BufferFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &BufferFlags) -> bool
fn ne(&self, other: &BufferFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<BufferFlags> for BufferFlags
impl PartialOrd<BufferFlags> for BufferFlags
sourcefn partial_cmp(&self, other: &BufferFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &BufferFlags) -> 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<BufferFlags> for BufferFlags
impl Sub<BufferFlags> for BufferFlags
type Output = BufferFlags
type Output = BufferFlags
The resulting type after applying the -
operator.
sourceimpl SubAssign<BufferFlags> for BufferFlags
impl SubAssign<BufferFlags> for BufferFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for BufferFlags
impl UpperHex for BufferFlags
impl Copy for BufferFlags
impl Eq for BufferFlags
impl StructuralEq for BufferFlags
impl StructuralPartialEq for BufferFlags
Auto Trait Implementations
impl RefUnwindSafe for BufferFlags
impl Send for BufferFlags
impl Sync for BufferFlags
impl Unpin for BufferFlags
impl UnwindSafe for BufferFlags
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