class Enlighten PipelineScene

This is the documentation for Enlighten.

class Enlighten PipelineScene

class Enlighten::PipelineScene

 

The scene to be precomputed.

Member functions may assert or throw a PipelineError exception to indicate a violation of the API contract.

Functions

Name

Description

Name

Description

AddCubemap(const PipelineCubemap &)

Add a cubemap to the scene.

AddGeom(const PipelineGeom &)

Add the geom to the scene.

AddInstance(const PipelineExcludedInstance &)

Add an excluded instance to the scene.

AddInstance(const PipelineRadiosityInstance &)

Add a radiosity instance to the scene.

AddInstanceParameters(const PipelineInstanceParameters &)

Add a named set of instance parameters to the scene.

AddProbeOctreeBoxes(Geo::GeoFileString, ProbeOctreeResolution, const Geo::GeoBoundingBox *, Geo::s32)

Add a region defined by an array of boxes to the specified probe octree.

AddProbeOctreePoints(Geo::GeoFileString, ProbeOctreeResolution, const Geo::v128 *, Geo::s32)

Add a region defined by an array of points to the specified probe octree.

AddProbeOctreeVolume(Geo::GeoFileString, ProbeOctreeResolution, const IPrecompVolumeQuery &)

Add a region defined by a volume to the specified probe octree.

AddProbeVolume(const PipelineProbeVolume &)

Adds a probe volume to the scene.

AddRadiosityDependencies(PipelineRadiosityGroupType, Geo::GeoFileString, const Dependencies &, const Dependencies &)

Adds a dependency set.

CreateAlbedoBuffer(InputWorkspace *)

Create a runtime object.

CreateDynamicMaterialWorkspace(ClusterAlbedoWorkspaceMaterialData *)

Create a runtime object.

CreateEmissiveBuffer(InputWorkspace *)

Create a runtime object.

DumpDebugScene(const Geo::GeoFileString &)

Dump the entire scene to a single text file for debug and test purposes.

GetInstanceNames(const Geo::GeoFileString &)

Return the names of the instances within the specified group.

LoadClusterAlbedoWorkspaceMaterialData(const Geo::GeoFileString &)

Load a precompute object from file.

LoadGeneratedSystems(const Geo::GeoFileString &)

Load a precompute object from file.

LoadInputWorkspace(const Geo::GeoFileString &)

Load a precompute object from file.

LoadOctreeProbeSetCore(const Geo::GeoFileString &, Geo::s32)

Load a precompute object from file.

LoadOutputProbeOctree(const Geo::GeoFileString &)

Load a precompute object from file.

LoadPackedGeometry(const Geo::GeoFileString &, const Geo::GeoFileString &)

Load a precompute object from file.

LoadPackedSystem(const Geo::GeoFileString &)

Load a precompute object from file.

LoadPrecomputedVisibilityData(const Geo::GeoFileString &)

Load a precompute object from file.

LoadRadCubeMapCore(const Geo::GeoFileString &)

Load a precompute object from file.

LoadRadiosityNormalTexture(const Geo::GeoFileString &, Geo::s32)

Load a precompute object from file.

LoadRadProbeSetCore(const Geo::GeoFileString &)

Load a precompute object from file.

LoadRadSystemCore(const Geo::GeoFileString &, Geo::s32)

Load a precompute object from file.

LoadSystemDuster(const Geo::GeoFileString &)

Load a precompute object from file.

PipelineScene(PipelinePaths, const PipelineGlobalParameters &)

Constructor.

WriteScene(Geo::IGeoProgressProxy &)

Write the Enlighten scene to disk.

Typedefs

Name

Description

Name

Description

Geo::GeoArray< Geo::GeoFileString > Dependencies

Array of dependencies.

Geo::GeoArray< Geo::GeoFileString > InstanceNames

An array of instance names.