Struct ark_api::render::RenderMeshStyleFlags
source · [−]#[repr(C)]pub struct RenderMeshStyleFlags { /* private fields */ }
Implementations
sourceimpl RenderMeshStyleFlags
impl RenderMeshStyleFlags
sourcepub const LIGHTING: RenderMeshStyleFlags = Self{ bits: 1,}
pub const LIGHTING: RenderMeshStyleFlags = Self{ bits: 1,}
Enables lighting.
sourcepub const FLAT_SHADING: RenderMeshStyleFlags = Self{ bits: 4,}
pub const FLAT_SHADING: RenderMeshStyleFlags = Self{ bits: 4,}
Enables lighting based on triangle face normals rather than vertex normals.
sourcepub const BILLBOARD: RenderMeshStyleFlags = Self{ bits: 32,}
pub const BILLBOARD: RenderMeshStyleFlags = Self{ bits: 32,}
Will make the mesh face the camera at all times, can be handy for things like particles or ui.
sourcepub const TWO_SIDED: RenderMeshStyleFlags = Self{ bits: 64,}
pub const TWO_SIDED: RenderMeshStyleFlags = Self{ bits: 64,}
Two sided - effectively turns off backface culling.
sourcepub const DEPTH_TEST: RenderMeshStyleFlags = Self{ bits: 128,}
pub const DEPTH_TEST: RenderMeshStyleFlags = Self{ bits: 128,}
NOTE! Basic renderer only! Will eventually go away!
If true
, depth testing is enabled, which means things closer to the camera
will rendered on top of things further away. This is normally what you want.
If false
, this instance will be rendered on top of previous instances, even if this instance is further away.
In other words, settings depth_test=false
will
make your instance visible through all other instances, even if they are not transparent.
Instances with depth_test=false
are always rendered last.
sourcepub const DEPTH_WRITE: RenderMeshStyleFlags = Self{ bits: 256,}
pub const DEPTH_WRITE: RenderMeshStyleFlags = Self{ bits: 256,}
NOTE! Basic renderer only! Will eventually go away! NOTE! Ignored by mesh rendering, only used by SDF for backwards compatibility reasons.
Enables writing to the depth buffer. Control whether or not to write to the depth buffer.
NOTE: render order is respected, EXCEPT for instances which are transparent or has depth_test=false
.
sourcepub const fn empty() -> RenderMeshStyleFlags
pub const fn empty() -> RenderMeshStyleFlags
Returns an empty set of flags.
sourcepub const fn all() -> RenderMeshStyleFlags
pub const fn all() -> RenderMeshStyleFlags
Returns the set containing all flags.
sourcepub const fn from_bits(bits: u32) -> Option<RenderMeshStyleFlags>
pub const fn from_bits(bits: u32) -> Option<RenderMeshStyleFlags>
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) -> RenderMeshStyleFlags
pub const fn from_bits_truncate(bits: u32) -> RenderMeshStyleFlags
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> RenderMeshStyleFlags
pub const unsafe fn from_bits_unchecked(bits: u32) -> RenderMeshStyleFlags
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: RenderMeshStyleFlags) -> bool
pub const fn intersects(&self, other: RenderMeshStyleFlags) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: RenderMeshStyleFlags) -> bool
pub const fn contains(&self, other: RenderMeshStyleFlags) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn insert(&mut self, other: RenderMeshStyleFlags)
pub fn insert(&mut self, other: RenderMeshStyleFlags)
Inserts the specified flags in-place.
sourcepub fn remove(&mut self, other: RenderMeshStyleFlags)
pub fn remove(&mut self, other: RenderMeshStyleFlags)
Removes the specified flags in-place.
sourcepub fn toggle(&mut self, other: RenderMeshStyleFlags)
pub fn toggle(&mut self, other: RenderMeshStyleFlags)
Toggles the specified flags in-place.
sourcepub fn set(&mut self, other: RenderMeshStyleFlags, value: bool)
pub fn set(&mut self, other: RenderMeshStyleFlags, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(
self,
other: RenderMeshStyleFlags
) -> RenderMeshStyleFlags
pub const fn intersection(
self,
other: RenderMeshStyleFlags
) -> RenderMeshStyleFlags
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: RenderMeshStyleFlags) -> RenderMeshStyleFlags
pub const fn union(self, other: RenderMeshStyleFlags) -> RenderMeshStyleFlags
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: RenderMeshStyleFlags
) -> RenderMeshStyleFlags
pub const fn difference(
self,
other: RenderMeshStyleFlags
) -> RenderMeshStyleFlags
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: RenderMeshStyleFlags
) -> RenderMeshStyleFlags
pub const fn symmetric_difference(
self,
other: RenderMeshStyleFlags
) -> RenderMeshStyleFlags
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) -> RenderMeshStyleFlags
pub const fn complement(self) -> RenderMeshStyleFlags
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 RenderMeshStyleFlags
impl Binary for RenderMeshStyleFlags
sourceimpl BitAnd<RenderMeshStyleFlags> for RenderMeshStyleFlags
impl BitAnd<RenderMeshStyleFlags> for RenderMeshStyleFlags
sourcefn bitand(self, other: RenderMeshStyleFlags) -> RenderMeshStyleFlags
fn bitand(self, other: RenderMeshStyleFlags) -> RenderMeshStyleFlags
Returns the intersection between the two sets of flags.
type Output = RenderMeshStyleFlags
type Output = RenderMeshStyleFlags
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<RenderMeshStyleFlags> for RenderMeshStyleFlags
impl BitAndAssign<RenderMeshStyleFlags> for RenderMeshStyleFlags
sourcefn bitand_assign(&mut self, other: RenderMeshStyleFlags)
fn bitand_assign(&mut self, other: RenderMeshStyleFlags)
Disables all flags disabled in the set.
sourceimpl BitOr<RenderMeshStyleFlags> for RenderMeshStyleFlags
impl BitOr<RenderMeshStyleFlags> for RenderMeshStyleFlags
sourcefn bitor(self, other: RenderMeshStyleFlags) -> RenderMeshStyleFlags
fn bitor(self, other: RenderMeshStyleFlags) -> RenderMeshStyleFlags
Returns the union of the two sets of flags.
type Output = RenderMeshStyleFlags
type Output = RenderMeshStyleFlags
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<RenderMeshStyleFlags> for RenderMeshStyleFlags
impl BitOrAssign<RenderMeshStyleFlags> for RenderMeshStyleFlags
sourcefn bitor_assign(&mut self, other: RenderMeshStyleFlags)
fn bitor_assign(&mut self, other: RenderMeshStyleFlags)
Adds the set of flags.
sourceimpl BitXor<RenderMeshStyleFlags> for RenderMeshStyleFlags
impl BitXor<RenderMeshStyleFlags> for RenderMeshStyleFlags
sourcefn bitxor(self, other: RenderMeshStyleFlags) -> RenderMeshStyleFlags
fn bitxor(self, other: RenderMeshStyleFlags) -> RenderMeshStyleFlags
Returns the left flags, but with all the right flags toggled.
type Output = RenderMeshStyleFlags
type Output = RenderMeshStyleFlags
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<RenderMeshStyleFlags> for RenderMeshStyleFlags
impl BitXorAssign<RenderMeshStyleFlags> for RenderMeshStyleFlags
sourcefn bitxor_assign(&mut self, other: RenderMeshStyleFlags)
fn bitxor_assign(&mut self, other: RenderMeshStyleFlags)
Toggles the set of flags.
sourceimpl Clone for RenderMeshStyleFlags
impl Clone for RenderMeshStyleFlags
sourcefn clone(&self) -> RenderMeshStyleFlags
fn clone(&self) -> RenderMeshStyleFlags
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 RenderMeshStyleFlags
impl Debug for RenderMeshStyleFlags
sourceimpl Default for RenderMeshStyleFlags
impl Default for RenderMeshStyleFlags
sourcefn default() -> RenderMeshStyleFlags
fn default() -> RenderMeshStyleFlags
Returns the “default value” for a type. Read more
sourceimpl<'de> Deserialize<'de> for RenderMeshStyleFlags
impl<'de> Deserialize<'de> for RenderMeshStyleFlags
sourcefn deserialize<__D>(
__deserializer: __D
) -> Result<RenderMeshStyleFlags, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D
) -> Result<RenderMeshStyleFlags, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl Extend<RenderMeshStyleFlags> for RenderMeshStyleFlags
impl Extend<RenderMeshStyleFlags> for RenderMeshStyleFlags
sourcefn extend<T>(&mut self, iterator: T) where
T: IntoIterator<Item = RenderMeshStyleFlags>,
fn extend<T>(&mut self, iterator: T) where
T: IntoIterator<Item = RenderMeshStyleFlags>,
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<RenderMeshStyleFlags> for RenderMeshStyleFlags
impl FromIterator<RenderMeshStyleFlags> for RenderMeshStyleFlags
sourcefn from_iter<T>(iterator: T) -> RenderMeshStyleFlags where
T: IntoIterator<Item = RenderMeshStyleFlags>,
fn from_iter<T>(iterator: T) -> RenderMeshStyleFlags where
T: IntoIterator<Item = RenderMeshStyleFlags>,
Creates a value from an iterator. Read more
sourceimpl Hash for RenderMeshStyleFlags
impl Hash for RenderMeshStyleFlags
sourceimpl LowerHex for RenderMeshStyleFlags
impl LowerHex for RenderMeshStyleFlags
sourceimpl Not for RenderMeshStyleFlags
impl Not for RenderMeshStyleFlags
sourcefn not(self) -> RenderMeshStyleFlags
fn not(self) -> RenderMeshStyleFlags
Returns the complement of this set of flags.
type Output = RenderMeshStyleFlags
type Output = RenderMeshStyleFlags
The resulting type after applying the !
operator.
sourceimpl Octal for RenderMeshStyleFlags
impl Octal for RenderMeshStyleFlags
sourceimpl Ord for RenderMeshStyleFlags
impl Ord for RenderMeshStyleFlags
sourcefn cmp(&self, other: &RenderMeshStyleFlags) -> Ordering
fn cmp(&self, other: &RenderMeshStyleFlags) -> Ordering
1.21.0 · sourcefn max(self, other: Self) -> Self
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
1.21.0 · sourcefn min(self, other: Self) -> Self
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
1.50.0 · sourcefn clamp(self, min: Self, max: Self) -> Self where
Self: PartialOrd<Self>,
fn clamp(self, min: Self, max: Self) -> Self where
Self: PartialOrd<Self>,
Restrict a value to a certain interval. Read more
sourceimpl PartialEq<RenderMeshStyleFlags> for RenderMeshStyleFlags
impl PartialEq<RenderMeshStyleFlags> for RenderMeshStyleFlags
sourcefn eq(&self, other: &RenderMeshStyleFlags) -> bool
fn eq(&self, other: &RenderMeshStyleFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourceimpl PartialOrd<RenderMeshStyleFlags> for RenderMeshStyleFlags
impl PartialOrd<RenderMeshStyleFlags> for RenderMeshStyleFlags
sourcefn partial_cmp(&self, other: &RenderMeshStyleFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &RenderMeshStyleFlags) -> 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<'a_, C_> Readable<'a_, C_> for RenderMeshStyleFlags where
C_: Context,
impl<'a_, C_> Readable<'a_, C_> for RenderMeshStyleFlags where
C_: Context,
fn read_from<R_>(
_reader_: &mut R_
) -> Result<RenderMeshStyleFlags, <C_ as Context>::Error> where
R_: Reader<'a_, C_>,
fn minimum_bytes_needed() -> usize
fn read_from_buffer_with_ctx(
context: C,
buffer: &'a [u8]
) -> Result<Self, <C as Context>::Error>
fn read_with_length_from_buffer_with_ctx(
context: C,
buffer: &'a [u8]
) -> (Result<Self, <C as Context>::Error>, usize)
fn read_from_buffer_copying_data_with_ctx(
context: C,
buffer: &[u8]
) -> Result<Self, <C as Context>::Error>
fn read_with_length_from_buffer_copying_data_with_ctx(
context: C,
buffer: &[u8]
) -> (Result<Self, <C as Context>::Error>, usize)
fn read_with_length_from_buffer_copying_data_with_ctx_mut(
context: &mut C,
buffer: &[u8]
) -> (Result<Self, <C as Context>::Error>, usize)
fn read_from_stream_unbuffered_with_ctx<S>(
context: C,
stream: S
) -> Result<Self, <C as Context>::Error> where
S: Read,
fn read_from_stream_buffered_with_ctx<S>(
context: C,
stream: S
) -> Result<Self, <C as Context>::Error> where
S: Read,
fn read_from_file_with_ctx(
context: C,
path: impl AsRef<Path>
) -> Result<Self, <C as Context>::Error>
sourceimpl Serialize for RenderMeshStyleFlags
impl Serialize for RenderMeshStyleFlags
sourcefn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
__S: Serializer,
Serialize this value into the given Serde serializer. Read more
sourceimpl Sub<RenderMeshStyleFlags> for RenderMeshStyleFlags
impl Sub<RenderMeshStyleFlags> for RenderMeshStyleFlags
sourcefn sub(self, other: RenderMeshStyleFlags) -> RenderMeshStyleFlags
fn sub(self, other: RenderMeshStyleFlags) -> RenderMeshStyleFlags
Returns the set difference of the two sets of flags.
type Output = RenderMeshStyleFlags
type Output = RenderMeshStyleFlags
The resulting type after applying the -
operator.
sourceimpl SubAssign<RenderMeshStyleFlags> for RenderMeshStyleFlags
impl SubAssign<RenderMeshStyleFlags> for RenderMeshStyleFlags
sourcefn sub_assign(&mut self, other: RenderMeshStyleFlags)
fn sub_assign(&mut self, other: RenderMeshStyleFlags)
Disables all flags enabled in the set.
sourceimpl UpperHex for RenderMeshStyleFlags
impl UpperHex for RenderMeshStyleFlags
sourceimpl<C_> Writable<C_> for RenderMeshStyleFlags where
C_: Context,
impl<C_> Writable<C_> for RenderMeshStyleFlags where
C_: Context,
fn write_to<T_>(&self, _writer_: &mut T_) -> Result<(), <C_ as Context>::Error> where
T_: Writer<C_> + ?Sized,
fn write_to_buffer_with_ctx(
&self,
context: C,
buffer: &mut [u8]
) -> Result<(), <C as Context>::Error>
fn write_to_buffer_with_ctx_mut(
&self,
context: &mut C,
buffer: &mut [u8]
) -> Result<(), <C as Context>::Error>
fn write_to_vec_with_ctx(
&self,
context: C
) -> Result<Vec<u8, Global>, <C as Context>::Error>
fn write_to_vec_with_ctx_mut(
&self,
context: &mut C
) -> Result<Vec<u8, Global>, <C as Context>::Error>
fn write_to_stream_with_ctx<S>(
&self,
context: C,
stream: S
) -> Result<(), <C as Context>::Error> where
S: Write,
fn write_to_file_with_ctx(
&self,
context: C,
path: impl AsRef<Path>
) -> Result<(), <C as Context>::Error>
fn bytes_needed(&self) -> Result<usize, <C as Context>::Error>
impl Copy for RenderMeshStyleFlags
impl Eq for RenderMeshStyleFlags
impl Pod for RenderMeshStyleFlags
impl StructuralEq for RenderMeshStyleFlags
impl StructuralPartialEq for RenderMeshStyleFlags
Auto Trait Implementations
impl RefUnwindSafe for RenderMeshStyleFlags
impl Send for RenderMeshStyleFlags
impl Sync for RenderMeshStyleFlags
impl Unpin for RenderMeshStyleFlags
impl UnwindSafe for RenderMeshStyleFlags
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
sourceimpl<T> CheckedBitPattern for T where
T: AnyBitPattern,
impl<T> CheckedBitPattern for T where
T: AnyBitPattern,
type Bits = T
type Bits = T
Self
must have the same layout as the specified Bits
except for
the possible invalid bit patterns being checked during
is_valid_bit_pattern
. Read more
sourcefn is_valid_bit_pattern(_bits: &T) -> bool
fn is_valid_bit_pattern(_bits: &T) -> bool
If this function returns true, then it must be valid to reinterpret bits
as &Self
. Read more