Struct Scene

pub struct Scene<'a> { /* private fields */ }

A scene containing various geometry for rendering. Geometry can be added and removed by attaching and detaching it, after which the scene BVH can be built via commit which will return a CommittedScene which can be used for ray queries.

Implementations

impl<'a> Scene<'a>

pub fn new(device: &'a Device) -> Scene<'_>

pub fn attach_geometry(&mut self, mesh: Geometry<'a>) -> u32

Attach a new geometry to the scene. Returns the scene local ID which can than be used to find the hit geometry from the ray ID member. A geometry can only be attached to one Scene at a time, per the Embree documentation. The geometry can be detached from the scene to move it to another one.

pub fn deattach_geometry(&mut self, id: u32) -> Option<Geometry<'a>>

Detach the geometry from the scene

pub fn get_geometry(&self, id: u32) -> Option<&Geometry<'a>>

Look up a geometry in the scene by the ID returned from attach_geometry

pub fn get_geometry_mut(&mut self, id: u32) -> Option<&mut Geometry<'a>>

Look up a geometry in the scene by the ID returned from attach_geometry

pub fn iter(&self) -> Iter<'_, u32, Geometry<'a>>

Get an iterator over the geometry map

pub fn iter_mut(&mut self) -> IterMut<'_, u32, Geometry<'a>>

Get an iterator over the geometry map

pub fn commit(&'a self) -> CommittedScene<'a>

Commit the scene to build the BVH on top of the geometry to allow for ray tracing the scene. The returned CommittedScene can be used for intersection and occlusion tests. The Scene can’t be modified while the CommittedScene is active.

pub unsafe fn handle(&self) -> RTCScene

Get the underlying handle to the scene, e.g. for passing it to native code or ISPC kernels.

Trait Implementations

impl<'a> Drop for Scene<'a>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> Sync for Scene<'a>