Struct bevy::render::mesh::Mesh

pub struct Mesh { /* fields omitted */ }

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.set_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_COLOR: &'static str

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

pub const ATTRIBUTE_NORMAL: &'static str

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

pub const ATTRIBUTE_TANGENT: &'static str

The direction of the vertex tangent. Used for normal mapping

pub const ATTRIBUTE_POSITION: &'static str

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

pub const ATTRIBUTE_UV_0: &'static str

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

pub const ATTRIBUTE_JOINT_WEIGHT: &'static str

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

pub const ATTRIBUTE_JOINT_INDEX: &'static str

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

pub fn new(primitive_topology: PrimitiveTopology) -> Mesh

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 set_attribute(
    &mut self,
    name: impl Into<Cow<'static, str>>,
    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.

pub fn attribute(
    &self,
    name: impl Into<Cow<'static, str>>
) -> Option<&VertexAttributeValues>

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

pub fn attribute_mut(
    &mut self,
    name: impl Into<Cow<'static, str>>
) -> Option<&mut VertexAttributeValues>

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

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 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, Global>

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.

Panics

If the mesh has any other topology than PrimitiveTopology::TriangleList.

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. Consider calling Mesh::duplicate_vertices or export your mesh with normal attributes.

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

pub 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

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

Formats the value using the given formatter.

impl From<Box> for Mesh

pub fn from(sp: Box) -> Mesh

Performs the conversion.

impl From<Capsule> for Mesh

pub fn from(capsule: Capsule) -> Mesh

Performs the conversion.

impl From<Cube> for Mesh

pub fn from(cube: Cube) -> Mesh

Performs the conversion.

impl From<Icosphere> for Mesh

pub fn from(sphere: Icosphere) -> Mesh

Performs the conversion.

impl From<Plane> for Mesh

pub fn from(plane: Plane) -> Mesh

Performs the conversion.

impl From<Quad> for Mesh

pub fn from(quad: Quad) -> Mesh

Performs the conversion.

impl From<Torus> for Mesh

pub fn from(torus: Torus) -> Mesh

Performs the conversion.

impl From<UVSphere> for Mesh

pub fn from(sphere: UVSphere) -> Mesh

Performs the conversion.

impl RenderAsset for Mesh

pub fn extract_asset(&self) -> <Mesh as RenderAsset>::ExtractedAsset

Clones the mesh.

pub fn prepare_asset(
    mesh: <Mesh as RenderAsset>::ExtractedAsset,
    render_device: &mut <<<Mesh as RenderAsset>::Param as SystemParam>::Fetch as SystemParamFetch<'_, '_>>::Item
) -> Result<<Mesh as RenderAsset>::PreparedAsset, PrepareAssetError<<Mesh as RenderAsset>::ExtractedAsset>>

Converts the extracted mesh a into GpuMesh.

type ExtractedAsset = Mesh

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

type PreparedAsset = GpuMesh

The GPU-representation of the the asset.

type Param = Res<'static, RenderDevice>

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

impl TypeUuid for Mesh

pub const TYPE_UUID: Uuid