namespace Enlighten

This is the documentation for Enlighten.

namespace Enlighten

Enlighten

Classes

Name

Description

Name

Description

Enlighten::A8CpuTextureSampler

A8 texture sampler.

Enlighten::AllFilter

Return all light types.

Enlighten::Alpha8Normalised

Class to store a normalised single channel value in 1 byte.

Enlighten::AsyncTaskThreadGroup

A thread group which executes Enlighten tasks by calling the AsyncTaskCallback a given number of times, and uses GeoEvent signalling to wait until all threads have completed execution.

Enlighten::BakedProbeOutputInfo

Parameters to be enqueued for a SetBakedProbeOutput() command The pointer contents will be copied; when the command has executed the original data may be released.

Enlighten::BakeInputLight

The input light type for baking.

Enlighten::BakeInputMeshInfo

Data about a mesh, used as a parameter to IBakeInputSystem::AddMesh.

Enlighten::BakeInputTexture

Texture object for the Baking.

Enlighten::BakeMaterialInfo

The material description for baking.

Enlighten::BaseAlbedoHandler

Base Albedo Handler.

Enlighten::BaseCubeMap

Base class used by the update manager to hold all of the resources for a cube map (regardless of where the solving happens).

Enlighten::BaseDynamicObject

Base class which holds everything a dynamic object must have (regardless of where the solving happens).

Enlighten::BaseEnvironment

Trivial base class used to lend a base type to environment maps.

Enlighten::BaseProbeSet

Class used by the update manager to hold all of the resources for a probe set together.

Enlighten::BaseSystem

Base class which holds everything a system must have (regardless of where the solving happens).

Enlighten::BaseSystemSolutionSpace

Base implementation of ISystemSolutionSpace.

Enlighten::BaseUpdateManager

Base implementation of the IUpdateManager interface. All update managers derive from this class.

Enlighten::BaseWorker

Base implementation of the worker class, containing functionality common to all platforms.

Enlighten::BoundingBox2D

Bounding box in 2D.

Enlighten::BoxSpotlight

BoxSpotlight class used by extended input lighting.

Enlighten::BoxVolume

Box volume primitive.

Enlighten::CachedLightSelector

Selects the Cached type for the input light.

Enlighten::CachedLightWriter

Cached Lights writer.

Enlighten::CallableEnqueueFunctorCommand

An object that can be called to enqueue a command.

Enlighten::CanQuickShade

By default, light types do not support quickshade.

Enlighten::CanQuickShade< LIGHT_TYPE_DIRECTIONAL_LIGHT >

Specialization to enable QuickShade on this light type.

Enlighten::ClusterAlbedoWorkspaceMaterialData

Constitutes the precomputed material data for a system.

Enlighten::ClusterMaterialComponent

Enlighten internal class for per material dynamic updates.

Enlighten::ClusterMaterials

Enlighten internal implementation for cluster albedo materials.

Enlighten::ClusterProbeBounceSampleData

Precompute data block detailing a buffer of ClusterProbeBounceSamples (internal).

Enlighten::ClusterProbeSample

Cluster probe bounce sample (internal).

Enlighten::ClusterProbeTransparencySampleData

Precompute data block detailing probe transparency sample data (internal).

Enlighten::ClusterRange

The ClusterRange describes a range of leaf clusters that belong to a certain cluster in the tree.

Enlighten::Command

Basic interface for commands to be executed on the worker thread.

Enlighten::ConstLightValueIterator

Const LightValue iterator. This contains the logic for iterating over LightValue64 or LightValue128 arrays.

Enlighten::CopyAlbedoBufferInfo

Parameters to be enqueued for a CopyInputLightingBuffer() command.

Enlighten::CopyBounceBufferInfo

Parameters to be enqueued for a CopyInputLightingBuffer() command.

Enlighten::CopyEmissiveBufferInfo

Parameters to be enqueued for a CopyInputLightingBuffer() command.

Enlighten::CopyEmissiveEnvironmentInfo

Parameters to be enqueued for the CopyEmissiveEnvironment() command.

Enlighten::CopyInputLightingBufferInfo

Parameters to be enqueued for a CopyInputLightingBuffer() command.

Enlighten::CopyProbeOutputInfo

Parameters to be enqueued for a CopyProbeOutputInfo() command.

Enlighten::CopyRawOutputInfo

Parameters to be enqueued for a CopyRawOutput() command.

Enlighten::CopyTransparencyBufferInfo

Parameters to be enqueued for a CopyMaterialTransparencyBuffer() or CopyGeometryTransparencyBuffer() command.

Enlighten::CopyVisibilityBufferInfo

Parameters to be enqueued for a CopyVisibilityBuffer() command.

Enlighten::CountLightSizeVisitor

Count light size.

Enlighten::CpuAlbedoHandler

Implementation of BaseAlbedoHandler for the CPU solver.

Enlighten::CpuCubeMap

Derived class of BaseCubeMap used by the CPU and console update managers.

Enlighten::CpuDynamicObject

Implementation of BaseDynamicObject for Cpu Solving.

Enlighten::CpuEnvironment

Class used by the CPU and console update managers to represent an environment map.

Enlighten::CpuSystem

System for the CPU solver.

Enlighten::CpuSystemSolutionSpace

System solution space for the CPU solver.

Enlighten::CpuTextureSamplerBase

CPU texture sampler base class.

Enlighten::CpuUpdateManager

Base class update managers for Enlighten that perform updates on the CPU, and aren't blocking the rendering thread.

Enlighten::CpuWorker

Implementation of the worker class, containing functionality common to all platforms which solve radiosity on a CPU or SPU.

Enlighten::CubeMapDataBlock

A CubeMap data block which contains the precompute data required by Enlighten at runtime.

Enlighten::CullCluster

A class used to apply cluster-light level culling.

Enlighten::CullClusterGroup

A class used to apply clustergroup-light level culling.

Enlighten::CullingIterator

Struct to iterate over the lights of a particular type, applying the culling operation.

Enlighten::CullingIterator< LIGHT_TYPE_INVALID, Culler >

Terminator for CullingIterator.

Enlighten::CullSystem

A class used to apply system-light level culling.

Enlighten::DefaultGeometryTransparencySampler

The default transparency sampler.

Enlighten::DefaultThreadGroup

Default implementation of IThreadGroup which executes tasks serially on the calling thread (the worker thread).

Enlighten::DirectInputLightingParameters

A class containing the parameters to be used as input to the direct input lighting stage.

Enlighten::DirectionalLight

DirectionalLight class used by extended input lighting.

Enlighten::Dx11TextureUpdater

Implementation for managing solver output and Dx11 GPU textures.

Enlighten::Dx9TextureUpdater

Implementation for managing solver output and Dx9 GPU textures.

Enlighten::DynamicMaterialWorkspace

Enlighten object used for dynamic material updates at runtime.

Enlighten::DynamicObject

Class representing the local bounding box and corresponding output probe resolution of a dynamic object, so that it can be lit with volume textures of SH probe data.

Enlighten::EnlightenDataBlock

A generic Enlighten data block.

Enlighten::EnlightenProfile

A container for Enlighten runtime profile statistics.

Enlighten::EnlightenTask

A task to be executed by a TaskProcessor. It consists of a task type and an object pointer.

Enlighten::EntireProbeSetTask

An EntireProbeSetTask solves an entire set of probes as an atomic block.

Enlighten::ExcludeQuickShadeFilter

Return all types except quick shade lights.

Enlighten::FitModel

This is a model class, which can currently only be a plane or a cylinder.

Enlighten::FixedTimeLimiter

Simple implementation of ILimiter which prevents new tasks from starting after a fixed time has elapsed from the start of UpdateRadiosity().

Enlighten::Fp16CpuTextureSampler

FP16 texture sampler.

Enlighten::FrustumLight

FrustumLight class used by extended input lighting.

Enlighten::FunctorCommand

Callable object (incl. lambda expressions) commands.

Enlighten::GenericColourBuffer

Generic class to store an array of values for a given system.

Enlighten::GeoClusterNode

Debugging output representation of a value in the clustering metric.

Enlighten::GeoClusterNodeForest

Debugging output representation of a set of clustering metric hierarchies.

Enlighten::GeoClusterNodeTree

Debugging output representation of a hierarchy of clustering metrics.

Enlighten::GeoDirectionalPoint

Debugging output representation of a point with a normal.

Enlighten::GeometryDataBlock

A Geometry data block which contains the precompute data required by Enlighten at runtime.

Enlighten::GeoRayOrigin

Debugging output representation of a ray origin.

Enlighten::GlTextureUpdater

Implementation for managing solver output and OpenGL GPU textures.

Enlighten::GpuTextureWrapper

Concrete implementation of IGpuTexture.

Enlighten::HashLightVisitor

Hash lights functor.

Enlighten::IAsyncTask

Async task interface.

Enlighten::IBake

The Low Level Enlighten Baking API.

Enlighten::IBakeInputGeometryLightingNormals

Interface for providing lighting normals for the geometry.

Enlighten::IBakeInputGeometryTangents

Interface for providing tangents for the geometry.

Enlighten::IBakeInputGeometryUvs

Interface for providing tangents for the geometry.

Enlighten::IBakeInputLighting

Input lighting for the offline baking; mainly a collection of EnlightenLight structures.

Enlighten::IBakeInputMaterial

The material descriptions for a bake system. This will have a BakeMaterialInfo for each facegroup in each mesh in each geometry, with optional overrides per-instance.

Enlighten::IBakeInputMeshLightingNormals

Interface for providing lighting normals for the mesh.

Enlighten::IBakeInputMeshTangents

Interface for providing tangents for the mesh.

Enlighten::IBakeInputMeshUvs

Interface for providing tangents for the mesh.

Enlighten::IBakeInputProperties

Bake properties class, used by calculation tasks to hold global and task specific data.

Enlighten::IBakeInputRayOriginPositions

The ray origin positions for all systems.

Enlighten::IBakeInputRuntime

The Enlighten runtime objects; RadDataCore, InputWorkspace, et al.

Enlighten::IBakeInputSystem

A triangle list and GBuffer of the incoming system.

Enlighten::IBakeOutputProbeSet

Baking output for a probe set.

Enlighten::IBakeOutputProbeSetVisibility

Baking output for per light visibility.

Enlighten::IBakeOutputSystemAO

Baking output for ambient occlusion.

Enlighten::IBakeOutputSystemDirect

Baking output for direct lighting.

Enlighten::IBakeOutputSystemFinalGather

Baking output for indirect lighting from Final Gather.

Enlighten::IBakeOutputSystemIndirect

Baking output for indirect lighting.

Enlighten::IBakeOutputSystemRadiosityNormal

Baking output for radiosity normal texture.

Enlighten::IBakeOutputSystemVisibility

Baking output for per light visibility.

Enlighten::IBakeRuntimeLighting

Material textures for the albedo and emissive channels, in Enlighten UV space.

Enlighten::IBakeSolvedRuntime

Interface for providing radiosity output for systems and probesets for baking.

Enlighten::IBakeSystemResource

System data for baking.

Enlighten::IBakeTextureManager

Interface for providing and caching textures.

Enlighten::IBakeVisibilityBuffer

Visibility information for a light map.

Enlighten::IClusteringOutput

An interface for diagnosing the quality and any issues with the clustering process in EnlightenPrecomp2.

Enlighten::IGpuTexture

IGpuTexture is the main interface used by the HLRT to keep track of output textures.

Enlighten::IGpuTextureAllocator

Interface which enables Enlighten to allocate GPU textures to hold the solved output.

Enlighten::IGpuTextureUpdater

IGpuTextureUpdater is the interface used by the HLRT to manage Enlighten solver output and associated GPU texture resources.

Enlighten::ILightTransportOutput

An interface for diagnosing the quality and any issues with the light transport process in EnlightenPrecomp2.

Enlighten::ILimiter

Interface which can prevent Enlighten tasks from starting in the current call to UpdateRadiosity.

Enlighten::ILogHandler

Implement this interface to receive messages from Enlighten.

Enlighten::IMeshSimpOutput

An interface for diagnosing the quality and any issues with the mesh simplification process in EnlightenPrecomp2.

Enlighten::IncidentLightingBuffer

A buffer containing the incident lighting for a system's input sample points (internal).

Enlighten::IndirectInputLightingInternalParameters

A class containing the parameters to be used as input to the internal indirect input lighting stage.

Enlighten::IndirectInputLightingParameters

A class containing the parameters to be used as input to the indirect input lighting stage.

Enlighten::IndirectionTextureRegions

A set of regions of the indirection texture, one per clipmap level.

Enlighten::InputLightBase

A base class all light types must derive from to work with any input lighting API.

Enlighten::InputLightFalloffTable

Class encapsulating the description of a light falloff curve.

Enlighten::InputLightingBuffer

A single frame of the InputWorkspace lighting (internal).

Enlighten::InputTextureSamplerParameters

A class containing the parameters to be used as input to the albedo/emissive/transparency sampling stage.

Enlighten::InputWorkspace

Constitutes the core precomputed data for the input lighting generation for a system.

Enlighten::InputWorkspaceDebugIterator

This class is used to iterate through the duster samples in order to get a InputWorkspaceDebugPoint.

Enlighten::InputWorkspaceDebugPoint

A structure for receiving the data held internally about a duster point for debugging visualisation purposes.