This is the documentation for Enlighten.
module Pipeline
Classes
Name | Description |
---|---|
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::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::PipelineProbeRegion | 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::PipelineRadiosityInstance | An instance object, corresponding to an <instance> element in the .scene file. |
Enlighten::PipelineRadiosityInstance::MaterialOverride | Overrides the nth material of each mesh with the geometry object. |
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::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< 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. |
Enums
Name | Description |
---|---|
PipelineEnvironmentResolution | The allowed values for Environment resolution. |
PipelineFormFactorBudget | The recommended values for Irradiance Budget. |
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 world space axis in which a given axis points. |
PrecomputeDistribute | The way the precompute process should be distributed. |
PrecomputeResult | The result of the precompute process. |
Functions
Name | Description |
---|---|
ReportPipelineError(Geo::GeoUIString) | Report a fatal PipelineError. |
PipelineEnvironmentResolution
public: enum PipelineEnvironmentResolution{}
The allowed values for Environment resolution.
PipelineFormFactorBudget
public: enum PipelineFormFactorBudget{}
The recommended values for Irradiance Budget.
PipelineRadiosityGroupType
public: enum PipelineRadiosityGroupType{}
Whether the instance group can be automatically split by the precompute.
PipelineRadiosityLightingType
public: enum PipelineRadiosityLightingType{}
The way a radiosity instance is lit by Enlighten indirect lighting.
PipelineRadiosityShadowType
public: enum PipelineRadiosityShadowType{}
Whether an instance casts an indirect shadow.
PipelineWorldAxis
public: enum PipelineWorldAxis{}
The world space axis in which a given axis points.
PrecomputeDistribute
public: enum PrecomputeDistribute{}
The way the precompute process should be distributed.
PrecomputeResult
public: enum PrecomputeResult{}
The result of the precompute process.
void Enlighten::ReportPipelineError
public: void ReportPipelineError
(
Geo::GeoUIString message
)
Report a fatal PipelineError.