This is the documentation for Enlighten.
module High Level Runtime
In addition to the low level API in the Enlighten library itself, the Enlighten SDK now includes a high level run time layer built on top of the low level API.
This part of Enlighten is shipped as source code. As well as being available for integration into a game engine, it serves as example usage of the Enlighten low level API. More details are available in the High Level Runtime section of the SDK documentation.
Classes
Name | Description |
|---|---|
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. | |
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. | |
Base Albedo Handler. | |
Base class used by the update manager to hold all of the resources for a cube map (regardless of where the solving happens). | |
Base class which holds everything a dynamic object must have (regardless of where the solving happens). | |
Trivial base class used to lend a base type to environment maps. | |
Class used by the update manager to hold all of the resources for a probe set together. | |
Base class which holds everything a system must have (regardless of where the solving happens). | |
Base implementation of ISystemSolutionSpace. | |
Base implementation of the worker class, containing functionality common to all platforms. | |
Basic interface for commands to be executed on the worker thread. | |
Parameters to be enqueued for a CopyInputLightingBuffer() command. | |
Parameters to be enqueued for a CopyInputLightingBuffer() command. | |
Parameters to be enqueued for a CopyInputLightingBuffer() command. | |
Parameters to be enqueued for the CopyEmissiveEnvironment() command. | |
Parameters to be enqueued for a CopyInputLightingBuffer() command. | |
Parameters to be enqueued for a CopyProbeOutputInfo() command. | |
Parameters to be enqueued for a CopyRawOutput() command. | |
Parameters to be enqueued for a CopyMaterialTransparencyBuffer() or CopyGeometryTransparencyBuffer() command. | |
Parameters to be enqueued for a CopyVisibilityBuffer() command. | |
Implementation of BaseAlbedoHandler for the CPU solver. | |
Derived class of BaseCubeMap used by the CPU and console update managers. | |
Implementation of BaseDynamicObject for Cpu Solving. | |
Class used by the CPU and console update managers to represent an environment map. | |
System for the CPU solver. | |
System solution space for the CPU solver. | |
Implementation of the worker class, containing functionality common to all platforms which solve radiosity on a CPU or SPU. | |
Default implementation of IThreadGroup which executes tasks serially on the calling thread (the worker thread). | |
Implementation for managing solver output and Dx11 GPU textures. | |
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. | |
A container for Enlighten runtime profile statistics. | |
A task to be executed by a TaskProcessor. It consists of a task type and an object pointer. | |
Simple implementation of ILimiter which prevents new tasks from starting after a fixed time has elapsed from the start of UpdateRadiosity(). | |
Implementation for managing solver output and OpenGL GPU textures. | |
Concrete implementation of IGpuTexture. | |
Async task interface. | |
IGpuTexture is the main interface used by the HLRT to keep track of output textures. | |
Interface which enables Enlighten to allocate GPU textures to hold the solved output. | |
IGpuTextureUpdater is the interface used by the HLRT to manage Enlighten solver output and associated GPU texture resources. | |
Interface which can prevent Enlighten tasks from starting in the current call to UpdateRadiosity. | |
A solution space for a system. | |
Interface through which MultithreadCpuWorker runs tasks on multiple threads in parallel. | |
This class is the base interface for the singleton object which manages all of the Enlighten updates for the systems and lights in the world, according to the current update strategy, solve type and albedo type. | |
Interface of the update manager worker. | |
Light Method Selector. | |
An update manager for Enlighten that does CPU updates. | |
Worker for the mulithreaded CPU update manager. | |
Implementation of the worker class, containing functionality for platforms which run tasks on a multithreaded CPU. | |
A simple class for recording a history of double valued stats. | |
A range of bytes. | |
Parameters to be enqueued for a ReadInputLightingBufferInfo() command. | |
Texture allocator for creating CPU solution spaces for Enlighten without any associated GPU resources. | |
Reference texture updater. | |
Parameters to be enqueued for a ReleaseSystemSolutionSpaces() command. | |
Parameters to be enqueued for a RemoveSystem(), RemoveProbeSet(), RemoveCubeMap() or RemoveDynamicObject() command. | |
Parameters to be enqueued for a SetLightBankUpdateCounter() command. | |
Command to set a parameter on an object. | |
Parameters to be enqueued for a SetProbeSetTransform() command. | |
Command to set solutions spaces for given system. | |
Parameters to be enqueued for a SetTransparencySamplePositionOffset() command. | |
Parameters to be enqueued for a SetVisibilityBits() command. | |
Class representing the albedo data for a system (or dynamic object which contributes to radiosity). | |
TaskProcessor runs a loop for pulling tasks off the current queue until either the whole list is done, or an ILimiter tells it to stop. | |
Defines a sub-section of a texture, specified in texels. | |
Command to trigger a transprency volume. | |
Parameters to be enqueued for the UpdateEmissiveEnvironment() command. | |
Command to update a light. | |
Parameters to be enqueued for the UpdateLight() command. | |
Optional parameters to the UpdateLight() command. | |
Class which extends the Enlighten input light class with extra data used only by the high level runtime, and not by Enlighten itself. | |
This class contains the properties of an Update Manager which must be supplied on creation and can't be changed. | |
Class representing the global state of the update manager worker. | |
Command to execute a function in the IUpdaetManagerWorker interface with no input arguments. | |
Command to execute a function in the IUpdateManagerWorker interface with one input argument. | |
Command to execute a function in the IUpdateManagerWorker interface with two parameters. | |
Command to execute paramless method on an an object specified by the guid. | |
Helper class for holding per-thread working data. | |
A specialised circular/stack allocator hybrid for allocating solve workspace memory. |
Functions
Name | Description |
|---|---|
Add a profile item to the history. | |
Remove all objects from the update manager and free all associated memory. | |
Helper function to convert from platform independent Enlighten::TextureFormat to DXGI texture format. | |
Copies a light. | |
Copies a light. | |
Create a multithread CPU update manager. | |
Helper function to convert CPU cycles to milliseconds. | |
Helper function to convert CPU cycles to seconds. | |
Enqueues a command. | |
Enqueues a command for later execution by the worker thread, if it is running. | |
Enqueues a command to set a parameter on an object on the worker thread. | |
Enqueues a command to set a parameter on an object on the worker thread. | |
Enqueues a command to set a parameter on an object on the worker thread. | |
Enqueues a command to set a parameter on an object on the worker thread. | |
Finds the object with the given GUID. | |
Finds the object with the given GUID. | |
Finds the object with the given GUID. | |
Finds the object with the given GUID. | |
Specialise the BaseWorker::FindObject to deal with a concrete type here. | |
Helper function to calculate the number of texture bytes per pixel for DXGI texture formats supported by Enlighten. | |
Get the last added profile item. | |
Get the average of the profile items in the history. | |
Get the number of profile items in the history. | |
Get the max value of the profile items in the history. | |
Get the min value of the profile items in the history. | |
Return the end of the range of output texture types that can be updated for this combination of solve type and radiosity core. | |
Gets the number of bytes required for each pixel of the given texture format. | |
MultithreadCpuUpdateManager(const UpdateManagerProperties &) | Protected constructor. Do not call directly, use Create instead. |
Construct a history from a guid. | |
Reset to empty (clear all history) | |
Set the worker global state. | |
The main radiosity update function. |
Enums
Name | Description |
|---|---|
Items we record for totals. | |
Items we record against cube maps. | |
The MultithreadCpuWorker works by putting tasks in a list, and then executing TaskProcessors on several threads in parallel. | |
Enumeration of the different output textures produced by the Enlighten solvers. | |
Items we record against probe sets. | |
Enumeration of the different probe volume output textures. | |
Enumeration of the different types of solve. | |
Items we record against systems. | |
Enumeration of output texture formats used by the high level run-time. |
Typedefs
Name | Description |
|---|---|
void(GEO_CALL * AsyncTaskCallback)(IAsyncTask *Task, const char *Name) | Function pointer type for the callback for executing tasks asynchronously. |
void(* CommandCompletedCallback)(void *) | Callback signature for when a command is completed. |
ProfileHistory< NUM_AGGREGATE_PROFILE_ITEMS > EnlightenAggregateProfile | History profile for aggregate stats. |
ProfileHistory< NUM_CUBE_MAP_PROFILE_ITEMS > EnlightenCubeMapProfile | History profile for cube maps. |
ProfileHistory< NUM_PROBE_SET_PROFILE_ITEMS > EnlightenProbeSetProfile | History profile for probesets. |
ProfileHistory< NUM_SYSTEM_PROFILE_ITEMS > EnlightenSystemProfile | History profile for systems. |
Geo::GeoString< char > ProfileDescription | String for describing a profile, used by EnlightenProfile. |
Geo::GeoMap< Geo::GeoGuid, Geo::s32 > TGuidIndexMap | GeoGuid-to-s32 map used by EnlightenProfile. |
Variables
Name |
|---|