Struct bevy_render::mesh::Mesh

pub struct Mesh { /* private fields */ }

Implementations

impl Mesh

Contains geometry in the form of a mesh.

Often meshes are automatically generated by bevy’s asset loaders or primitives, such as shape::Cube or shape::Box, but you can also construct one yourself.

Example of constructing a mesh:

fn create_triangle() -> Mesh {
    let mut mesh = Mesh::new(PrimitiveTopology::TriangleList);
    mesh.insert_attribute(Mesh::ATTRIBUTE_POSITION, vec![[1.0, 0.0, 0.0], [0.0, 1.0, 0.0], [1.0, 1.0, 0.0]]);
    mesh.set_indices(Some(Indices::U32(vec![0,1,2])));
    mesh
}

pub const ATTRIBUTE_POSITION: MeshVertexAttribute = _

Where the vertex is located in space. Use in conjunction with Mesh::insert_attribute

pub const ATTRIBUTE_NORMAL: MeshVertexAttribute = _

The direction the vertex normal is facing in. Use in conjunction with Mesh::insert_attribute

pub const ATTRIBUTE_UV_0: MeshVertexAttribute = _

Texture coordinates for the vertex. Use in conjunction with Mesh::insert_attribute

pub const ATTRIBUTE_TANGENT: MeshVertexAttribute = _

The direction of the vertex tangent. Used for normal mapping

pub const ATTRIBUTE_COLOR: MeshVertexAttribute = _

Per vertex coloring. Use in conjunction with Mesh::insert_attribute

pub const ATTRIBUTE_JOINT_WEIGHT: MeshVertexAttribute = _

Per vertex joint transform matrix weight. Use in conjunction with Mesh::insert_attribute

pub const ATTRIBUTE_JOINT_INDEX: MeshVertexAttribute = _

Per vertex joint transform matrix index. Use in conjunction with Mesh::insert_attribute

pub fn new(primitive_topology: PrimitiveTopology) -> Self

Construct a new mesh. You need to provide a PrimitiveTopology so that the renderer knows how to treat the vertex data. Most of the time this will be PrimitiveTopology::TriangleList.

pub fn primitive_topology(&self) -> PrimitiveTopology

Returns the topology of the mesh.

pub fn insert_attribute( &mut self, attribute: MeshVertexAttribute, values: impl Into<VertexAttributeValues> )

Sets the data for a vertex attribute (position, normal etc.). The name will often be one of the associated constants such as Mesh::ATTRIBUTE_POSITION.

Panics

Panics when the format of the values does not match the attribute’s format.

pub fn remove_attribute( &mut self, attribute: impl Into<MeshVertexAttributeId> ) -> Option<VertexAttributeValues>

Removes the data for a vertex attribute

pub fn contains_attribute(&self, id: impl Into<MeshVertexAttributeId>) -> bool

pub fn attribute( &self, id: impl Into<MeshVertexAttributeId> ) -> Option<&VertexAttributeValues>

Retrieves the data currently set to the vertex attribute with the specified name.

pub fn attribute_mut( &mut self, id: impl Into<MeshVertexAttributeId> ) -> Option<&mut VertexAttributeValues>

Retrieves the data currently set to the vertex attribute with the specified name mutably.

pub fn attributes( &self ) -> impl Iterator<Item = (MeshVertexAttributeId, &VertexAttributeValues)>

Returns an iterator that yields references to the data of each vertex attribute.

pub fn attributes_mut( &mut self ) -> impl Iterator<Item = (MeshVertexAttributeId, &mut VertexAttributeValues)>

Returns an iterator that yields mutable references to the data of each vertex attribute.

pub fn set_indices(&mut self, indices: Option<Indices>)

Sets the vertex indices of the mesh. They describe how triangles are constructed out of the vertex attributes and are therefore only useful for the PrimitiveTopology variants that use triangles.

pub fn indices(&self) -> Option<&Indices>

Retrieves the vertex indices of the mesh.

pub fn indices_mut(&mut self) -> Option<&mut Indices>

Retrieves the vertex indices of the mesh mutably.

pub fn get_index_buffer_bytes(&self) -> Option<&[u8]>

Computes and returns the index data of the mesh as bytes. This is used to transform the index data into a GPU friendly format.

pub fn get_mesh_vertex_buffer_layout(&self) -> MeshVertexBufferLayout

For a given descriptor returns a VertexBufferLayout compatible with this mesh. If this mesh is not compatible with the given descriptor (ex: it is missing vertex attributes), None will be returned.

pub fn count_vertices(&self) -> usize

Counts all vertices of the mesh.

Panics

Panics if the attributes have different vertex counts.

pub fn get_vertex_buffer_data(&self) -> Vec<u8>

Computes and returns the vertex data of the mesh as bytes. Therefore the attributes are located in alphabetical order. This is used to transform the vertex data into a GPU friendly format.

Panics

Panics if the attributes have different vertex counts.

pub fn duplicate_vertices(&mut self)

Duplicates the vertex attributes so that no vertices are shared.

This can dramatically increase the vertex count, so make sure this is what you want. Does nothing if no Indices are set.

pub fn compute_flat_normals(&mut self)

Calculates the Mesh::ATTRIBUTE_NORMAL of a mesh.

Panics

Panics if Indices are set or Mesh::ATTRIBUTE_POSITION is not of type float3 or if the mesh has any other topology than PrimitiveTopology::TriangleList. Consider calling Mesh::duplicate_vertices or export your mesh with normal attributes.

pub fn generate_tangents(&mut self) -> Result<(), GenerateTangentsError>

Generate tangents for the mesh using the mikktspace algorithm.

Sets the Mesh::ATTRIBUTE_TANGENT attribute if successful. Requires a PrimitiveTopology::TriangleList topology and the Mesh::ATTRIBUTE_POSITION, Mesh::ATTRIBUTE_NORMAL and Mesh::ATTRIBUTE_UV_0 attributes set.

pub fn compute_aabb(&self) -> Option<Aabb>

Compute the Axis-Aligned Bounding Box of the mesh vertices in model space

Trait Implementations

impl Clone for Mesh

fn clone(&self) -> Mesh

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Mesh

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

Formats the value using the given formatter.

impl From<Box> for Mesh

fn from(sp: Box) -> Self

Converts to this type from the input type.

impl From<Capsule> for Mesh

fn from(capsule: Capsule) -> Self

Converts to this type from the input type.

impl From<Circle> for Mesh

fn from(circle: Circle) -> Self

Converts to this type from the input type.

impl From<Cube> for Mesh

fn from(cube: Cube) -> Self

Converts to this type from the input type.

impl From<Cylinder> for Mesh

fn from(c: Cylinder) -> Self

Converts to this type from the input type.

impl From<Plane> for Mesh

fn from(plane: Plane) -> Self

Converts to this type from the input type.

impl From<Quad> for Mesh

fn from(quad: Quad) -> Self

Converts to this type from the input type.

impl From<RegularPolygon> for Mesh

fn from(polygon: RegularPolygon) -> Self

Converts to this type from the input type.

impl From<Torus> for Mesh

fn from(torus: Torus) -> Self

Converts to this type from the input type.

impl From<UVSphere> for Mesh

fn from(sphere: UVSphere) -> Self

Converts to this type from the input type.

impl RenderAsset for Mesh

fn extract_asset(&self) -> Self::ExtractedAsset

Clones the mesh.

fn prepare_asset( mesh: Self::ExtractedAsset, render_device: &mut SystemParamItem<'_, '_, Self::Param> ) -> Result<Self::PreparedAsset, PrepareAssetError<Self::ExtractedAsset>>

Converts the extracted mesh a into GpuMesh.

type ExtractedAsset = Mesh

The representation of the asset in the “render world”.

type PreparedAsset = GpuMesh

The GPU-representation of the asset.

type Param = Res<'static, RenderDevice>

Specifies all ECS data required by RenderAsset::prepare_asset. For convenience use the lifetimeless SystemParam.

impl TryFrom<Icosphere> for Mesh

type Error = FromIcosphereError

The type returned in the event of a conversion error.

fn try_from(sphere: Icosphere) -> Result<Self, Self::Error>

Performs the conversion.

impl TypeUuid for Mesh

const TYPE_UUID: Uuid = _