Struct bgfx_rs::static_lib::CapsFormatFlags
source · [−]pub struct CapsFormatFlags { /* private fields */ }
Implementations
sourceimpl CapsFormatFlags
impl CapsFormatFlags
sourcepub const TEXTURE_NONE: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_NONE as _,}
pub const TEXTURE_NONE: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_NONE as _,}
Texture format is not supported.
sourcepub const TEXTURE_2_D: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_2D as _,}
pub const TEXTURE_2_D: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_2D as _,}
Texture format is supported.
sourcepub const TEXTURE_2_D_SRGB: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_2D_SRGB as _,}
pub const TEXTURE_2_D_SRGB: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_2D_SRGB as _,}
Texture as sRGB format is supported.
sourcepub const TEXTURE_2_D_EMULATED: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_2D_EMULATED as _,}
pub const TEXTURE_2_D_EMULATED: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_2D_EMULATED as _,}
Texture format is emulated.
sourcepub const TEXTURE_3_D: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_3D as _,}
pub const TEXTURE_3_D: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_3D as _,}
Texture format is supported.
sourcepub const TEXTURE_3_D_SRGB: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_3D_SRGB as _,}
pub const TEXTURE_3_D_SRGB: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_3D_SRGB as _,}
Texture as sRGB format is supported.
sourcepub const TEXTURE_3_D_EMULATED: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_3D_EMULATED as _,}
pub const TEXTURE_3_D_EMULATED: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_3D_EMULATED as _,}
Texture format is emulated.
sourcepub const TEXTURE_CUBE: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_CUBE as _,}
pub const TEXTURE_CUBE: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_CUBE as _,}
Texture format is supported.
sourcepub const TEXTURE_CUBE_SRGB: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_CUBE_SRGB as _,}
pub const TEXTURE_CUBE_SRGB: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_CUBE_SRGB as _,}
Texture as sRGB format is supported.
sourcepub const TEXTURE_CUBE_EMULATED: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_CUBE_EMULATED as _,}
pub const TEXTURE_CUBE_EMULATED: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_CUBE_EMULATED as _,}
Texture format is emulated.
sourcepub const TEXTURE_VERTEX: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_VERTEX as _,}
pub const TEXTURE_VERTEX: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_VERTEX as _,}
Texture format can be used from vertex shader.
sourcepub const TEXTURE_IMAGE_READ: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_IMAGE_READ as _,}
pub const TEXTURE_IMAGE_READ: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_IMAGE_READ as _,}
Texture format can be used as image and read from.
sourcepub const TEXTURE_IMAGE_WRITE: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_IMAGE_WRITE as _,}
pub const TEXTURE_IMAGE_WRITE: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_IMAGE_WRITE as _,}
Texture format can be used as image and written to.
sourcepub const TEXTURE_FRAMEBUFFER: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_FRAMEBUFFER as _,}
pub const TEXTURE_FRAMEBUFFER: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_FRAMEBUFFER as _,}
Texture format can be used as frame buffer.
sourcepub const TEXTURE_FRAMEBUFFER_MSAA: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_FRAMEBUFFER_MSAA as _,}
pub const TEXTURE_FRAMEBUFFER_MSAA: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_FRAMEBUFFER_MSAA as _,}
Texture format can be used as MSAA frame buffer.
sourcepub const TEXTURE_MSAA: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_MSAA as _,}
pub const TEXTURE_MSAA: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_MSAA as _,}
Texture can be sampled as MSAA.
sourcepub const TEXTURE_MIP_AUTOGEN: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_MIP_AUTOGEN as _,}
pub const TEXTURE_MIP_AUTOGEN: Self = Self{bits: bgfx_sys::BGFX_CAPS_FORMAT_TEXTURE_MIP_AUTOGEN as _,}
Texture format supports auto-generated mips.
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 CapsFormatFlags
impl Binary for CapsFormatFlags
sourceimpl BitAnd<CapsFormatFlags> for CapsFormatFlags
impl BitAnd<CapsFormatFlags> for CapsFormatFlags
type Output = CapsFormatFlags
type Output = CapsFormatFlags
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<CapsFormatFlags> for CapsFormatFlags
impl BitAndAssign<CapsFormatFlags> for CapsFormatFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<CapsFormatFlags> for CapsFormatFlags
impl BitOr<CapsFormatFlags> for CapsFormatFlags
sourcefn bitor(self, other: CapsFormatFlags) -> Self
fn bitor(self, other: CapsFormatFlags) -> Self
Returns the union of the two sets of flags.
type Output = CapsFormatFlags
type Output = CapsFormatFlags
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<CapsFormatFlags> for CapsFormatFlags
impl BitOrAssign<CapsFormatFlags> for CapsFormatFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<CapsFormatFlags> for CapsFormatFlags
impl BitXor<CapsFormatFlags> for CapsFormatFlags
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 = CapsFormatFlags
type Output = CapsFormatFlags
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<CapsFormatFlags> for CapsFormatFlags
impl BitXorAssign<CapsFormatFlags> for CapsFormatFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for CapsFormatFlags
impl Clone for CapsFormatFlags
sourcefn clone(&self) -> CapsFormatFlags
fn clone(&self) -> CapsFormatFlags
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 CapsFormatFlags
impl Debug for CapsFormatFlags
sourceimpl Extend<CapsFormatFlags> for CapsFormatFlags
impl Extend<CapsFormatFlags> for CapsFormatFlags
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<CapsFormatFlags> for CapsFormatFlags
impl FromIterator<CapsFormatFlags> for CapsFormatFlags
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 CapsFormatFlags
impl Hash for CapsFormatFlags
sourceimpl LowerHex for CapsFormatFlags
impl LowerHex for CapsFormatFlags
sourceimpl Not for CapsFormatFlags
impl Not for CapsFormatFlags
type Output = CapsFormatFlags
type Output = CapsFormatFlags
The resulting type after applying the !
operator.
sourceimpl Octal for CapsFormatFlags
impl Octal for CapsFormatFlags
sourceimpl Ord for CapsFormatFlags
impl Ord for CapsFormatFlags
sourceimpl PartialEq<CapsFormatFlags> for CapsFormatFlags
impl PartialEq<CapsFormatFlags> for CapsFormatFlags
sourcefn eq(&self, other: &CapsFormatFlags) -> bool
fn eq(&self, other: &CapsFormatFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &CapsFormatFlags) -> bool
fn ne(&self, other: &CapsFormatFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<CapsFormatFlags> for CapsFormatFlags
impl PartialOrd<CapsFormatFlags> for CapsFormatFlags
sourcefn partial_cmp(&self, other: &CapsFormatFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &CapsFormatFlags) -> 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<CapsFormatFlags> for CapsFormatFlags
impl Sub<CapsFormatFlags> for CapsFormatFlags
type Output = CapsFormatFlags
type Output = CapsFormatFlags
The resulting type after applying the -
operator.
sourceimpl SubAssign<CapsFormatFlags> for CapsFormatFlags
impl SubAssign<CapsFormatFlags> for CapsFormatFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for CapsFormatFlags
impl UpperHex for CapsFormatFlags
impl Copy for CapsFormatFlags
impl Eq for CapsFormatFlags
impl StructuralEq for CapsFormatFlags
impl StructuralPartialEq for CapsFormatFlags
Auto Trait Implementations
impl RefUnwindSafe for CapsFormatFlags
impl Send for CapsFormatFlags
impl Sync for CapsFormatFlags
impl Unpin for CapsFormatFlags
impl UnwindSafe for CapsFormatFlags
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