This is the documentation for Enlighten.
module EnlightenPipeline
Classes
Name | Description |
|---|---|
A cubemap object, corresponding to a <cubeMap> element in the .scene file. | |
An exception thrown to indicate a violation of the API contract, such as: | |
An instance object, corresponding to an <instance> element in the .scene file. | |
A geometry object, corresponding to a single .geom file. | |
The properties of a .geom that are relevant to the precompute. | |
The parameters that affect the precompute for all instances in the scene. | |
Recommended default values for parameters that affect the precompute for a subset of instances in the scene. | |
The properties of an Enlighten material that are relevant to radiosity. | |
A mesh object, corresponding to a single <mesh> element within the .geom file. | |
The paths to the Enlighten scene and runtime data generated by the pipeline. | |
A probe region object, corresponding to a <probeRegion> element in the .scene file. | |
A probe volume object, corresponding to a <probeVolume> element in the .scene file. | |
An instance object, corresponding to an <instance> element in the .scene file. | |
Not documented. | |
The properties of a radiosity instance that are relevant to the precompute. | |
The scene to be precomputed. | |
The transform used by each instance object. | |
The permutation of the "axes" attribute of the <scene> element of the .scene file Use this to enable the Enlighten debugging tools to display your scene correctly. | |
The arguments to the HLBS precompute process. | |
Exports the scene and runs the precompute process Member functions may assert or throw a PipelineError exception to indicate a violation of the API contract. |
Typedefs
Name | Description |
|---|---|
Geo::GeoUniquePtr< Enlighten::AlbedoBuffer, Geo::GeoAlignedFreeDestructor > AlbedoBufferPtr | A unique pointer which controls the lifetime of the object. |
Geo::GeoUniqueDelegatePtr< ClusterAlbedoWorkspaceMaterialData, DeleteClusterAlbedoWorkspaceMaterialData > CAWMaterialDataPtr | A unique pointer which controls the lifetime of the object. |
Geo::GeoUniquePtr< Enlighten::DynamicMaterialWorkspace, Geo::GeoAlignedFreeDestructor > DynamicMaterialWorkspacePtr | A unique pointer which controls the lifetime of the object. |
Geo::GeoUniquePtr< Enlighten::EmissiveBuffer, Geo::GeoAlignedFreeDestructor > EmissiveBufferPtr | A unique pointer which controls the lifetime of the object. |
Geo::GeoUniqueReleasePtr< IPrecompGeneratedSystems > GeneratedSystemsPtr | A unique pointer which controls the lifetime of the object. |
Geo::GeoUniqueReleasePtr< IPrecompInputProbeRegion > InputProbeRegionPtr | A unique pointer to an IPrecompInputProbeRegion object. |
Geo::GeoUniqueDelegatePtr< InputWorkspace, DeleteInputWorkspace > InputWorkspacePtr | A unique pointer which controls the lifetime of the object. |
Geo::GeoUniqueReleasePtr< IPrecompOutputProbeOctree > OutputProbeOctreePtr | A unique pointer which controls the lifetime of the object. |
Geo::GeoUniqueReleasePtr< IPrecompPackedGeometry > PackedGeometryPtr | A unique pointer which controls the lifetime of the object. |
Geo::GeoUniqueReleasePtr< IPrecompPackedSystem > PackedSystemPtr | A unique pointer which controls the lifetime of the object. |
Geo::GeoUniqueDelegatePtr< PrecomputedVisibilityData, DeletePrecomputedVisibilityData > PrecompVisDataPtr | A unique pointer which controls the lifetime of the object. |
Geo::GeoUniqueDelegatePtr< RadCubeMapCore, DeleteRadCubeMapCore > RadCubeMapCorePtr | A unique pointer which controls the lifetime of the object. |
Geo::GeoUniqueDelegatePtr< RadProbeSetCore, DeleteRadProbeSetCore > RadProbeSetCorePtr | A unique pointer which controls the lifetime of the object. |
Geo::GeoUniqueDelegatePtr< RadSystemCore, DeleteRadSystemCore > RadSystemCorePtr | A unique pointer which controls the lifetime of the object. |
Geo::GeoUniqueReleasePtr< Geo::GeoRGBXTexture > RGBXTexturePtr | A unique pointer which controls the lifetime of the object. |
Geo::GeoUniqueReleasePtr< IPrecompSystemDuster > SystemDusterPtr | A unique pointer which controls the lifetime of the object. |