Classes
| Name | Description |
|---|---|
| Enlighten::PipelineBoxSetProbeRegion | A probe region object, corresponding to a <probeRegion> element in the .scene file. |
| Enlighten::PipelineCubemap | A cubemap object, corresponding to a <cubeMap> element in the .scene file. |
| Enlighten::PipelineError | An exception thrown to indicate a violation of the API contract, such as: |
| Enlighten::PipelineExcludedInstance | An instance object, corresponding to an <instance> element in the .scene file. |
| Enlighten::PipelineGeom | A geometry object, corresponding to a single .geom file. |
| Enlighten::PipelineGeometryProperties | The properties of a .geom that are relevant to the precompute. |
| Enlighten::PipelineGlobalParameters | The parameters that affect the precompute for all instances in the scene. |
| Enlighten::PipelineInstanceMaterial | Overrides the nth material of each mesh with the geometry object. |
| Enlighten::PipelineInstanceParameters | Recommended default values for parameters that affect the precompute for a subset of instances in the scene. |
| Enlighten::PipelineMaterial | The properties of an Enlighten material that are relevant to radiosity. |
| Enlighten::PipelineMesh | A mesh object, corresponding to a single <mesh> element within the .geom file. |
| Enlighten::PipelinePaths | The paths to the Enlighten scene and runtime data generated by the pipeline. |
| Enlighten::PipelinePointSetProbeRegion | A probe region object, corresponding to a <probeRegion> element in the .scene file. |
| Enlighten::PipelineProbeVolume | A probe volume object, corresponding to a <probeVolume> element in the .scene file. |
| Enlighten::PipelineProgressBase | Implements Geo::IGeoProgressProxy::ReportError. |
| Enlighten::PipelineProgressBase::HasHandleError::SFINAE | |
| Enlighten::PipelineRadiosityInstance | An instance object, corresponding to an <instance> element in the .scene file. |
| Enlighten::PipelineRadiosityProperties | The properties of a radiosity instance that are relevant to the precompute. |
| Enlighten::PipelineScene | The scene to be precomputed. |
| Enlighten::PipelineTransform | The transform used by each instance object. |
| Enlighten::PipelineUnlitInstance | An unlit instance to prevent light leaks, corresponding to an <instance> element in the .scene file. |
| Enlighten::PipelineVolumeProbeRegion | A probe region object, corresponding to a <probeRegion> element in the .scene file. |
| Enlighten::PipelineWorldAxes | 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. |
| Enlighten::PrecomputeParameters | The arguments to the HLBS precompute process. |
| Enlighten::PrecomputePipeline | Exports the scene and runs the precompute process. |
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< IPrecompInputProbeSet > InputProbeSetPtr | A unique pointer which controls the lifetime of the 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::GeoUniqueReleasePtr< IPrecompProbeAtlasMaxima > ProbeAtlasMaximaPtr | 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. |
Enums
| Name | Description |
|---|---|
| PipelineEnvironmentResolution | The allowed values for Environment resolution. |
| PipelineFormFactorBudget | The recommended values for Irradiance Budget. |
| PipelineProbeLodBias | The allowed values for Probe LOD bias. |
| PipelineRadiosityGroupType | Whether the instance group can be automatically split by the precompute. |
| PipelineRadiosityLightingType | The way a radiosity instance is lit by Enlighten indirect lighting. |
| PipelineRadiosityShadowType | Whether an instance casts an indirect shadow. |
| PipelineWorldAxis | The direction in which a world axis points. |
| PrecomputeDistribute | The way the precompute process should be distributed. |
| PrecomputeResult | The result of the precompute process. |
Functions
| Name | Description |
|---|---|
| MakeWorldAxis(PipelineWorldAxis) | The world space axis in which a given axis points. |
| ReportPipelineError(Geo::GeoUIString) | Report a fatal PipelineError. |
| Anchor | ||||
|---|---|---|---|---|
|
PipelineEnvironmentResolution
...
public: enum PipelineEnvironmentResolution{}
...
The allowed values for Environment resolution.
| Anchor | ||||
|---|---|---|---|---|
|
PipelineFormFactorBudget
...
public: enum PipelineFormFactorBudget{}
...
The recommended values for Irradiance Budget.
| Anchor | ||||
|---|---|---|---|---|
|
PipelineProbeLodBias
...
public: enum PipelineProbeLodBias{}
...
The allowed values for Probe LOD bias.
| Anchor | ||||
|---|---|---|---|---|
|
PipelineRadiosityGroupType
...
public: enum PipelineRadiosityGroupType{}
...
Whether the instance group can be automatically split by the precompute.
| Anchor | ||||
|---|---|---|---|---|
|
PipelineRadiosityLightingType
...
public: enum PipelineRadiosityLightingType{}
...
The way a radiosity instance is lit by Enlighten indirect lighting.
| Anchor | ||||
|---|---|---|---|---|
|
PipelineRadiosityShadowType
...
public: enum PipelineRadiosityShadowType{}
...
Whether an instance casts an indirect shadow.
| Anchor | ||||
|---|---|---|---|---|
|
PipelineWorldAxis
...
public: enum PipelineWorldAxis{}
...
The direction in which a world axis points.
| Anchor | ||||
|---|---|---|---|---|
|
PrecomputeDistribute
...
public: enum PrecomputeDistribute{}
...
The way the precompute process should be distributed.
| Anchor | ||||
|---|---|---|---|---|
|
PrecomputeResult
...
public: enum PrecomputeResult{}
...
The result of the precompute process.
| Anchor | ||||
|---|---|---|---|---|
|
WorldAxis Enlighten::MakeWorldAxis
...
public: WorldAxis MakeWorldAxis
(
PipelineWorldAxis worldAxis
)
...
The world space axis in which a given axis points.
| Anchor | ||||
|---|---|---|---|---|
|
bool Enlighten::ReportPipelineError
...
public: bool ReportPipelineError
(
Geo::GeoUIString message
)
...
Report a fatal PipelineError.