Struct three_d::Mesh

pub struct Mesh {
    pub name: String,
    pub cull: CullType,
    pub transformation: Mat4,
    // some fields omitted
}

A triangle mesh which can be rendered with one of the default render functions or with a custom MeshProgram. See also PhongMesh for rendering a mesh with lighting.

Fields

name: String

cull: CullType

transformation: Mat4

Implementations

impl Mesh

pub fn new(context: &Context, cpu_mesh: &CPUMesh) -> Result<Self, Error>

Copies the per vertex data defined in the given CPUMesh to the GPU, thereby making it possible to render the mesh.

pub fn render_color(
    &self,
    render_states: RenderStates,
    viewport: Viewport,
    camera: &Camera
) -> Result<(), Error>

Render the mesh with a color per triangle vertex. The colors are defined when constructing the mesh. Must be called in a render target render function, for example in the callback function of Screen::write.

Errors

Will return an error if the mesh has no colors.

pub fn render_with_color(
    &self,
    color: &Vec4,
    render_states: RenderStates,
    viewport: Viewport,
    camera: &Camera
) -> Result<(), Error>

Render the mesh with the given color. Must be called in a render target render function, for example in the callback function of Screen::write.

pub fn render_uvs(
    &self,
    render_states: RenderStates,
    viewport: Viewport,
    camera: &Camera
) -> Result<(), Error>

Render the uv coordinates of the mesh in red (u) and green (v). Must be called in a render target render function, for example in the callback function of Screen::write.

Errors

Will return an error if the mesh has no uv coordinates.

pub fn render_with_texture(
    &self,
    texture: &impl Texture,
    render_states: RenderStates,
    viewport: Viewport,
    camera: &Camera
) -> Result<(), Error>

Render the mesh with the given texture. Must be called in a render target render function, for example in the callback function of Screen::write.

Errors

Will return an error if the mesh has no uv coordinates.

pub fn render(
    &self,
    program: &MeshProgram,
    render_states: RenderStates,
    viewport: Viewport,
    camera: &Camera
) -> Result<(), Error>

Render the mesh with the given MeshProgram. Must be called in a render target render function, for example in the callback function of Screen::write.

Errors

Will return an error if the mesh shader program requires a certain attribute and the mesh does not have that attribute. For example if the program needs the normal to calculate lighting, but the mesh does not have per vertex normals, this function will return an error.

Trait Implementations

impl Clone for Mesh

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Drop for Mesh

fn drop(&mut self)

Executes the destructor for this type.

impl Geometry for Mesh

fn render_depth_to_red(
    &self,
    render_states: RenderStates,
    viewport: Viewport,
    camera: &Camera,
    max_depth: f32
) -> Result<(), Error>

Render the depth (scaled such that a value of 1 corresponds to max_depth) into the red channel of the current color render target which for example is used for picking. Must be called in a render target render function, for example in the callback function of Screen::write.

fn render_depth(
    &self,
    render_states: RenderStates,
    viewport: Viewport,
    camera: &Camera
) -> Result<(), Error>

Render only the depth into the current depth render target which is useful for shadow maps or depth pre-pass. Must be called in a render target render function, for example in the callback function of Screen::write.

fn aabb(&self) -> Option<AxisAlignedBoundingBox>