Struct MeshAttributeCompressionFlags 

pub struct MeshAttributeCompressionFlags(/* private fields */);

Available on crate feature bevy_mesh only.

If the corresponding attribute compression is enabled:

• Position will be Snorm16x4 relative to the mesh’s AABB. The w component is unused.
• Normal and tangent will be Snorm16x2 with octahedral encoding, using octahedral_encode_signed and octahedral_encode_tangent.
• UV0 and UV1 will be Unorm16x2. UVs are remapped based on their min/max values so they can go beyond [0, 1], though a larger range will reduce precision.

Implementations

impl MeshAttributeCompressionFlags

pub const COMPRESS_POSITION: MeshAttributeCompressionFlags

pub const COMPRESS_NORMAL: MeshAttributeCompressionFlags

pub const COMPRESS_TANGENT: MeshAttributeCompressionFlags

pub const COMPRESS_UV0: MeshAttributeCompressionFlags

pub const COMPRESS_UV1: MeshAttributeCompressionFlags

impl MeshAttributeCompressionFlags

pub const fn empty() -> MeshAttributeCompressionFlags

Get a flags value with all bits unset.

pub const fn all() -> MeshAttributeCompressionFlags

Get a flags value with all known bits set.

pub const fn bits(&self) -> u8

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u8) -> Option<MeshAttributeCompressionFlags>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u8) -> MeshAttributeCompressionFlags

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u8) -> MeshAttributeCompressionFlags

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<MeshAttributeCompressionFlags>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in self are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: MeshAttributeCompressionFlags) -> bool

Whether any set bits in other are also set in self.

pub const fn contains(&self, other: MeshAttributeCompressionFlags) -> bool

Whether all set bits in other are also set in self.

Examples found in repository

examples/shader_advanced/custom_render_phase.rs (line 215)

    fn specialize(
        &self,
        key: Self::Key,
        layout: &MeshVertexBufferLayoutRef,
    ) -> Result<RenderPipelineDescriptor, SpecializedMeshPipelineError> {
        let mut shader_defs = Vec::new();
        // We will only use the position of the mesh in our shader so we only need to specify that
        let mut vertex_attributes = Vec::new();
        if layout.0.contains(Mesh::ATTRIBUTE_POSITION) {
            // Handle compressed vertex positions.
            if layout
                .0
                .get_attribute_compression()
                .contains(MeshAttributeCompressionFlags::COMPRESS_POSITION)
            {
                shader_defs.push("VERTEX_POSITIONS_COMPRESSED".into());
            }
            // Make sure this matches the shader location
            vertex_attributes.push(Mesh::ATTRIBUTE_POSITION.at_shader_location(0));
        }
        // This will automatically generate the correct `VertexBufferLayout` based on the vertex attributes
        let vertex_buffer_layout = layout.0.get_layout(&vertex_attributes)?;
        let view_layout = self
            .mesh_pipeline
            .get_view_layout(MeshPipelineViewLayoutKey::from(key));
        Ok(RenderPipelineDescriptor {
            label: Some("Specialized Mesh Pipeline".into()),
            // We want to reuse the data from bevy so we use the same bind groups as the default
            // mesh pipeline
            layout: vec![
                // Bind group 0 is the view uniform
                view_layout.main_layout,
                // Bind group 1 is empty
                view_layout.empty_layout,
                // Bind group 2 is the mesh uniform
                self.mesh_pipeline.mesh_layouts.model_only.clone(),
            ],
            vertex: VertexState {
                shader: self.shader_handle.clone(),
                shader_defs: shader_defs.clone(),
                buffers: vec![vertex_buffer_layout],
                ..default()
            },
            fragment: Some(FragmentState {
                shader: self.shader_handle.clone(),
                shader_defs,
                targets: vec![Some(ColorTargetState {
                    format: key.target_format(),
                    blend: None,
                    write_mask: ColorWrites::ALL,
                })],
                ..default()
            }),
            primitive: PrimitiveState {
                topology: key.primitive_topology(),
                strip_index_format: key.strip_index_format(),
                cull_mode: Some(Face::Back),
                ..default()
            },
            // It's generally recommended to specialize your pipeline for MSAA,
            // but it's not always possible
            ..default()
        })
    }

examples/shader_advanced/specialized_mesh_pipeline.rs (line 228)

    fn specialize(
        &self,
        mesh_key: Self::Key,
        layout: &MeshVertexBufferLayoutRef,
    ) -> Result<RenderPipelineDescriptor, SpecializedMeshPipelineError> {
        let mut shader_defs = Vec::new();
        // Define the vertex attributes based on a standard bevy [`Mesh`]
        let mut vertex_attributes = Vec::new();
        if layout.0.contains(Mesh::ATTRIBUTE_POSITION) {
            // Handle compressed vertex positions.
            if layout
                .0
                .get_attribute_compression()
                .contains(MeshAttributeCompressionFlags::COMPRESS_POSITION)
            {
                shader_defs.push("VERTEX_POSITIONS_COMPRESSED".into());
            }
            // Make sure this matches the shader location
            vertex_attributes.push(Mesh::ATTRIBUTE_POSITION.at_shader_location(0));
        }
        if layout.0.contains(Mesh::ATTRIBUTE_COLOR) {
            shader_defs.push("VERTEX_COLORS".into());
            // Make sure this matches the shader location
            vertex_attributes.push(Mesh::ATTRIBUTE_COLOR.at_shader_location(1));
        }
        // This will automatically generate the correct `VertexBufferLayout` based on the vertex attributes
        let vertex_buffer_layout = layout.0.get_layout(&vertex_attributes)?;

        let view_layout = self
            .mesh_pipeline
            .get_view_layout(MeshPipelineViewLayoutKey::from(mesh_key));

        Ok(RenderPipelineDescriptor {
            label: Some("Specialized Mesh Pipeline".into()),
            layout: vec![
                view_layout.main_layout,
                view_layout.empty_layout,
                self.mesh_pipeline.mesh_layouts.model_only.clone(),
            ],
            vertex: VertexState {
                shader: self.shader_handle.clone(),
                shader_defs: shader_defs.clone(),
                // Customize how to store the meshes' vertex attributes in the vertex buffer
                buffers: vec![vertex_buffer_layout],
                ..default()
            },
            fragment: Some(FragmentState {
                shader: self.shader_handle.clone(),
                shader_defs,
                targets: vec![Some(ColorTargetState {
                    // This isn't required, but bevy supports rendering different formats
                    // so it's generally recommended to specialize the pipeline for that
                    format: mesh_key.target_format(),
                    // For this example we only use opaque meshes,
                    // but if you wanted to use alpha blending you would need to set it here
                    blend: None,
                    write_mask: ColorWrites::ALL,
                })],
                ..default()
            }),
            primitive: PrimitiveState {
                topology: mesh_key.primitive_topology(),
                strip_index_format: mesh_key.strip_index_format(),
                front_face: FrontFace::Ccw,
                cull_mode: Some(Face::Back),
                polygon_mode: PolygonMode::Fill,
                ..default()
            },
            // Note that if your view has no depth buffer this will need to be
            // changed.
            depth_stencil: Some(DepthStencilState {
                format: CORE_3D_DEPTH_FORMAT,
                depth_write_enabled: Some(true),
                depth_compare: Some(CompareFunction::GreaterEqual),
                stencil: default(),
                bias: default(),
            }),
            // It's generally recommended to specialize your pipeline for MSAA,
            // but it's not always possible
            multisample: MultisampleState {
                count: mesh_key.msaa_samples(),
                ..default()
            },
            ..default()
        })
    }

pub fn insert(&mut self, other: MeshAttributeCompressionFlags)

The bitwise or (|) of the bits in self and other.

pub fn remove(&mut self, other: MeshAttributeCompressionFlags)

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: MeshAttributeCompressionFlags)

The bitwise exclusive-or (^) of the bits in self and other.

pub fn set(&mut self, other: MeshAttributeCompressionFlags, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection( self, other: MeshAttributeCompressionFlags, ) -> MeshAttributeCompressionFlags

The bitwise and (&) of the bits in self and other.

pub const fn union( self, other: MeshAttributeCompressionFlags, ) -> MeshAttributeCompressionFlags

The bitwise or (|) of the bits in self and other.

pub const fn difference( self, other: MeshAttributeCompressionFlags, ) -> MeshAttributeCompressionFlags

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference( self, other: MeshAttributeCompressionFlags, ) -> MeshAttributeCompressionFlags

The bitwise exclusive-or (^) of the bits in self and other.

pub const fn complement(self) -> MeshAttributeCompressionFlags

The bitwise negation (!) of the bits in self, truncating the result.

impl MeshAttributeCompressionFlags

pub const fn iter(&self) -> Iter<MeshAttributeCompressionFlags>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<MeshAttributeCompressionFlags>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for MeshAttributeCompressionFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl BitAnd for MeshAttributeCompressionFlags

fn bitand( self, other: MeshAttributeCompressionFlags, ) -> MeshAttributeCompressionFlags

The bitwise and (&) of the bits in self and other.

type Output = MeshAttributeCompressionFlags

The resulting type after applying the & operator.

impl BitAndAssign for MeshAttributeCompressionFlags

fn bitand_assign(&mut self, other: MeshAttributeCompressionFlags)

The bitwise and (&) of the bits in self and other.

impl BitOr for MeshAttributeCompressionFlags

fn bitor( self, other: MeshAttributeCompressionFlags, ) -> MeshAttributeCompressionFlags

The bitwise or (|) of the bits in self and other.

type Output = MeshAttributeCompressionFlags

The resulting type after applying the | operator.

impl BitOrAssign for MeshAttributeCompressionFlags

fn bitor_assign(&mut self, other: MeshAttributeCompressionFlags)

The bitwise or (|) of the bits in self and other.

impl BitXor for MeshAttributeCompressionFlags

fn bitxor( self, other: MeshAttributeCompressionFlags, ) -> MeshAttributeCompressionFlags

The bitwise exclusive-or (^) of the bits in self and other.

type Output = MeshAttributeCompressionFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for MeshAttributeCompressionFlags

fn bitxor_assign(&mut self, other: MeshAttributeCompressionFlags)

The bitwise exclusive-or (^) of the bits in self and other.

impl Clone for MeshAttributeCompressionFlags

fn clone(&self) -> MeshAttributeCompressionFlags

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for MeshAttributeCompressionFlags

impl Debug for MeshAttributeCompressionFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MeshAttributeCompressionFlags

fn deserialize<__D>( __deserializer: __D, ) -> Result<MeshAttributeCompressionFlags, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for MeshAttributeCompressionFlags

impl Extend<MeshAttributeCompressionFlags> for MeshAttributeCompressionFlags

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = MeshAttributeCompressionFlags>,

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: T)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for MeshAttributeCompressionFlags

const FLAGS: &'static [Flag<MeshAttributeCompressionFlags>]

The set of defined flags.

type Bits = u8

The underlying bits type.

fn bits(&self) -> u8

Get the underlying bits value.

fn from_bits_retain(bits: u8) -> MeshAttributeCompressionFlags

Convert from a bits value exactly.

fn all_named() -> MeshAttributeCompressionFlags

Get a flags value with all bits from named flags set.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn known_bits(&self) -> Self::Bits

Get the known bits from a flags value.

fn unknown_bits(&self) -> Self::Bits

Get the unknown bits from a flags value.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by Self::FLAGS.

fn iter_equal_names(&self) -> IterEqualNames<Self>

Get an iterator over all defined names for this flags value.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in other are also set in self.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in other are also set in self.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in self and other.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of self with the complement of other (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in self and other.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in self and other.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in self and other.

fn difference(self, other: Self) -> Self

The intersection of self with the complement of other (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in self and other.

fn complement(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

impl FromArg for MeshAttributeCompressionFlags

type This<'from_arg> = MeshAttributeCompressionFlags

The type to convert into.

fn from_arg( arg: Arg<'_>, ) -> Result<<MeshAttributeCompressionFlags as FromArg>::This<'_>, ArgError>

Creates an item from an argument.

impl FromIterator<MeshAttributeCompressionFlags> for MeshAttributeCompressionFlags

fn from_iter<T>(iterator: T) -> MeshAttributeCompressionFlags

where T: IntoIterator<Item = MeshAttributeCompressionFlags>,

The bitwise or (|) of the bits in each flags value.

impl FromReflect for MeshAttributeCompressionFlags

fn from_reflect( reflect: &(dyn PartialReflect + 'static), ) -> Option<MeshAttributeCompressionFlags>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetOwnership for MeshAttributeCompressionFlags

fn ownership() -> Ownership

Returns the ownership of Self.

impl GetTypeRegistration for MeshAttributeCompressionFlags

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(_registry: &mut TypeRegistry)

Registers other types needed by this type.

impl Hash for MeshAttributeCompressionFlags

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoIterator for MeshAttributeCompressionFlags

type Item = MeshAttributeCompressionFlags

The type of the elements being iterated over.

type IntoIter = Iter<MeshAttributeCompressionFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <MeshAttributeCompressionFlags as IntoIterator>::IntoIter

Creates an iterator from a value.

impl IntoReturn for MeshAttributeCompressionFlags

fn into_return<'into_return>(self) -> Return<'into_return>

where MeshAttributeCompressionFlags: 'into_return,

Converts Self into a Return value.

impl LowerHex for MeshAttributeCompressionFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Not for MeshAttributeCompressionFlags

fn not(self) -> MeshAttributeCompressionFlags

The bitwise negation (!) of the bits in self, truncating the result.

type Output = MeshAttributeCompressionFlags

The resulting type after applying the ! operator.

impl Octal for MeshAttributeCompressionFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl PartialEq for MeshAttributeCompressionFlags

fn eq(&self, other: &MeshAttributeCompressionFlags) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialReflect for MeshAttributeCompressionFlags

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn to_dynamic(&self) -> Result<Box<dyn PartialReflect>, ReflectCloneError>

Converts this reflected value into its dynamic representation based on its kind.

fn try_apply( &mut self, value: &(dyn PartialReflect + 'static), ) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<MeshAttributeCompressionFlags>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<MeshAttributeCompressionFlags>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&(dyn Reflect + 'static)>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut (dyn Reflect + 'static)>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect( self: Box<MeshAttributeCompressionFlags>, ) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &(dyn PartialReflect + 'static)

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut (dyn PartialReflect + 'static)

Casts this type to a mutable, reflected value.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn reflect_partial_eq( &self, value: &(dyn PartialReflect + 'static), ) -> Option<bool>

Returns a “partial equality” comparison result.

fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Debug formatter for the value.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>

where T: 'static, Self: Sized + TypePath,

For a type implementing PartialReflect, combines reflect_clone and take in a useful fashion, automatically constructing an appropriate ReflectCloneError if the downcast fails.

fn reflect_partial_cmp( &self, _value: &(dyn PartialReflect + 'static), ) -> Option<Ordering>

Returns a “partial comparison” result.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for MeshAttributeCompressionFlags

fn into_any(self: Box<MeshAttributeCompressionFlags>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<MeshAttributeCompressionFlags>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

impl Serialize for MeshAttributeCompressionFlags

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.

impl StructuralPartialEq for MeshAttributeCompressionFlags

impl Sub for MeshAttributeCompressionFlags

fn sub( self, other: MeshAttributeCompressionFlags, ) -> MeshAttributeCompressionFlags

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = MeshAttributeCompressionFlags

The resulting type after applying the - operator.

impl SubAssign for MeshAttributeCompressionFlags

fn sub_assign(&mut self, other: MeshAttributeCompressionFlags)

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl TypePath for MeshAttributeCompressionFlags

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for MeshAttributeCompressionFlags

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl UpperHex for MeshAttributeCompressionFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.