Struct three_d::renderer::geometry::InstancedMesh

pub struct InstancedMesh { /* private fields */ }

Similar to Mesh, except it is possible to render many instances of the same mesh efficiently.

Implementations

impl InstancedMesh

pub fn new(
    context: &Context,
    instances: &Instances,
    cpu_mesh: &CpuMesh
) -> ThreeDResult<Self>

Creates a new instanced 3D mesh from the given CpuMesh. All data in the CpuMesh is transfered to the GPU, so make sure to remove all unnecessary data from the CpuMesh before calling this method. The model is rendered in as many instances as there are attributes in Instances given as input.

pub fn transformation(&self) -> Mat4

Returns the local to world transformation applied to all instances.

pub fn set_transformation(&mut self, transformation: Mat4)

Set the local to world transformation applied to all instances. This is applied before the transform for each instance.

pub fn texture_transform(&self) -> &Mat3

Get the texture transform applied to the uv coordinates of all of the instances.

pub fn set_texture_transform(&mut self, texture_transform: Mat3)

Set the texture transform applied to the uv coordinates of all of the model instances. This is applied before the texture transform for each instance.

pub fn instance_count(&self) -> u32

Returns the number of instances that is rendered.

pub fn set_instance_count(&mut self, instance_count: u32)

Use this if you only want to render instance 0 through to instance instance_count. This is the same as changing the instances using set_instances, except that it is faster since it doesn’t update any buffers. instance_count will be set to the number of instances when they are defined by set_instances, so all instanced are rendered by default.

pub fn set_instances(&mut self, instances: &Instances) -> ThreeDResult<()>

Update the instances.

Trait Implementations

impl Geometry for InstancedMesh

fn aabb(&self) -> AxisAlignedBoundingBox

Returns the AxisAlignedBoundingBox for this geometry in the global coordinate system.

fn render_with_material(
    &self,
    material: &dyn Material,
    camera: &Camera,
    lights: &[&dyn Light]
) -> ThreeDResult<()>

Render the geometry with the given material. Must be called in the callback given as input to a RenderTarget, ColorTarget or DepthTarget write method. Use an empty array for the lights argument, if the objects does not require lights to be rendered.