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

Functions

Enums

Typedefs

Variables

void Enlighten::ProfileHistory< tNumProfileItems >::AddItem

---

public: void AddItem
(
    Geo::s32 item,
    double value
)

---

Add a profile item to the history.

D3DFORMAT Enlighten::ConvertToDx9Format

---

public: D3DFORMAT ConvertToDx9Format
(
    TextureFormat format
)

---

Helper function to convert from platform independent Enlighten::TextureFormat to Dx9 texture format.

DXGI_FORMAT Enlighten::ConvertToDxgiFormat

---

public: DXGI_FORMAT ConvertToDxgiFormat
(
    TextureFormat format
)

---

Helper function to convert from platform independent Enlighten::TextureFormat to DXGI texture format.

void Enlighten::LightMethodSelector::Copy

---

public: void Copy
(
    InputLightBase * lightDst,
    const UpdateManagerLight * lightSrc
) const

---

Copies a light.

void Enlighten::LightMethodSelector::Copy

---

public: void Copy
(
    UpdateManagerLight * lightDst,
    const InputLightBase * lightSrc
) const

---

Copies a light.

static IUpdateManager* Enlighten::MultithreadCpuUpdateManager::Create

---

public: IUpdateManager * Create
(
    const UpdateManagerProperties & properties
)

---

Create a multithread CPU update manager.

Note: Call GeoAttachLogger to listen for important error and warning messages. Returns null if no logger was attached!

double Enlighten::CyclesToMillisecond

---

public: double CyclesToMillisecond
(
    Geo::s64 cycles
)

---

Helper function to convert CPU cycles to milliseconds.

double Enlighten::CyclesToSeconds

---

public: double CyclesToSeconds
(
    Geo::s64 cycles
)

---

Helper function to convert CPU cycles to seconds.

void Enlighten::EnqueueCommand

---

public: void EnqueueCommand
(
    IUpdateManager * updateManager,
    CommandType && command
)

---

Enqueues a command.

The command will be executed on the worker thread if one exists, otherwise it will be executed immediately on the calling thread. CommandType is expected to be derived from the Command class - see Command.h

void Enlighten::BaseUpdateManager::EnqueueCommand

---

public: void EnqueueCommand
(
    CommandType && command
)

---

Enqueues a command. The command will be executed on the worker thread if one exists, otherwise it will be executed immediately on the calling thread.

void Enlighten::BaseWorker::EnqueueCommand

---

public: void EnqueueCommand
(
    CommandType && newCommand
)

---

Enqueues a command for later execution by the worker thread, if it is running.

If the worker thread isn't running, the command is executed immediately on the calling thread.

void Enlighten::EnqueueSetObjectParameter

---

public: void EnqueueSetObjectParameter
(
    IUpdateManager * updateManager,
    Geo::GeoGuid objectId,
    void(ObjectType::*)(ParamType) function,
    ArgType && value
)

---

Enqueues a command to set a parameter on an object on the worker thread.

ObjectType may be BaseSystem, BaseDynamicObject, BaseCubeMap or Probes.

void Enlighten::BaseUpdateManager::EnqueueSetObjectParameter

---

public: void EnqueueSetObjectParameter
(
    PointerType object,
    void(ObjectType::*)(ParamType) function,
    ArgType && value
)

---

Enqueues a command to set an object parameter.

ObjectType may be BaseSystem, BaseDynamicObject, BaseCubeMap or BaseProbeSet. IdType may be Geo::GeoGuid or a pointer to the object.

void Enlighten::EnqueueSetObjectParameter

---

public: void EnqueueSetObjectParameter
(
    IUpdateManager * updateManager,
    ObjectType * object,
    void(ObjectType::*)(const ParamType &) function,
    ArgType && value
)

---

Enqueues a command to set a parameter on an object on the worker thread.

ObjectType may be BaseSystem, BaseDynamicObject, BaseCubeMap or Probes.

void Enlighten::EnqueueSetObjectParameter

---

public: void EnqueueSetObjectParameter
(
    IUpdateManager * updateManager,
    Geo::GeoGuid objectId,
    void(ObjectType::*)(const ParamType &) function,
    ArgType && value
)

---

Enqueues a command to set a parameter on an object on the worker thread.

ObjectType may be BaseSystem, BaseDynamicObject, BaseCubeMap or Probes.

void Enlighten::EnqueueSetObjectParameter

---

public: void EnqueueSetObjectParameter
(
    IUpdateManager * updateManager,
    ObjectType * object,
    void(ObjectType::*)(ParamType) function,
    ArgType && value
)

---

Enqueues a command to set a parameter on an object on the worker thread.

ObjectType may be BaseSystem, BaseDynamicObject, BaseCubeMap or Probes.

void Enlighten::IUpdateManager::EnqueueUpdateLight

---

public: void EnqueueUpdateLight
(
    const Geo::GeoGuid & guid,
    const LightType & light,
    UpdateLightOptions options
)

---

Add the light.

Parameters

bool Enlighten::BaseWorker::FindObject

---

public: bool FindObject
(
    const Geo::GeoGuid & id,
    CpuSystem *& systemObjectPtr
)

---

Specialise the BaseWorker::FindObject to deal with a concrete type here.

bool Enlighten::BaseWorker::FindObject

---

public: bool FindObject
(
    const Geo::GeoGuid & id,
    BaseDynamicObject *& dynamicObjectPtr
)

---

Finds the object with the given GUID.

bool Enlighten::BaseWorker::FindObject

---

public: bool FindObject
(
    const Geo::GeoGuid & id,
    BaseProbeSet *& probeSetPtr
)

---

Finds the object with the given GUID.

bool Enlighten::BaseWorker::FindObject

---

public: bool FindObject
(
    const Geo::GeoGuid & id,
    BaseCubeMap *& cubeMapPtr
)

---

Finds the object with the given GUID.

bool Enlighten::BaseWorker::FindObject

---

public: bool FindObject
(
    const Geo::GeoGuid & id,
    BaseSystem *& systemPtr
)

---

Finds the object with the given GUID.

Geo::s32 Enlighten::GetDxgiFormatBytesPerPixel

---

public: Geo::s32 GetDxgiFormatBytesPerPixel
(
    DXGI_FORMAT format
)

---

Helper function to calculate the number of texture bytes per pixel for DXGI texture formats supported by Enlighten.

double Enlighten::ProfileHistory< tNumProfileItems >::GetItem

---

public: double GetItem
(
    Geo::s32 item
) const

---

Get the last added profile item.

double Enlighten::ProfileHistory< tNumProfileItems >::GetItemAverage

---

public: double GetItemAverage
(
    Geo::s32 item
) const

---

Get the average of the profile items in the history.

Geo::u64 Enlighten::ProfileHistory< tNumProfileItems >::GetItemCount

---

public: Geo::u64 GetItemCount
(
    Geo::s32 item
) const

---

Get the number of profile items in the history.

double Enlighten::ProfileHistory< tNumProfileItems >::GetItemMaximum

---

public: double GetItemMaximum
(
    Geo::s32 item
) const

---

Get the max value of the profile items in the history.

double Enlighten::ProfileHistory< tNumProfileItems >::GetItemMinimum

---

public: double GetItemMinimum
(
    Geo::s32 item
) const

---

Get the min value of the profile items in the history.

OutputTextureType Enlighten::GetOutputTextureRangeEnd

---

public: OutputTextureType GetOutputTextureRangeEnd
(
    const RadSystemCore & core,
    SolveType solveType
)

---

Return the end of the range of output texture types that can be updated for this combination of solve type and radiosity core.

Geo::s32 Enlighten::GetTextureBytesPerPixel

---

public: Geo::s32 GetTextureBytesPerPixel
(
    TextureFormat format
)

---

Gets the number of bytes required for each pixel of the given texture format.

Enlighten::MultithreadCpuUpdateManager::MultithreadCpuUpdateManager

---

protected: MultithreadCpuUpdateManager
(
    const UpdateManagerProperties & properties,
    const ILogHandler * logger
)

---

Protected constructor. Do not call directly, use Create instead.

Enlighten::ProfileHistory< tNumProfileItems >::ProfileHistory

---

public: ProfileHistory
(
    const Geo::GeoGuid & systemGuid
)

---

Construct a history from a guid.

void Enlighten::ProfileHistory< tNumProfileItems >::Reset

---

public: void Reset()

---

Reset to empty (clear all history)

void Enlighten::BaseWorker::SetWorkerProperties

---

public: virtual void SetWorkerProperties
(
    const UpdateManagerWorkerProperties & properties
)

---

Set the worker global state.

GEO_POP_IGNORE_DEPRECATION_WARNING void Enlighten::BaseWorker::UpdateRadiosity

---

public: virtual void UpdateRadiosity()

---

The main radiosity update function.

AggregateProfileItem

---

public: enum AggregateProfileItem
{
    API_ENLIGHTEN_TOTAL_CPU = 0,
    API_ENLIGHTEN_TOTAL_GPU,
    API_ENLIGHTEN_TOTAL_PROBES,
    API_ENLIGHTEN_TOTAL_PROBE_INTERPOLATION,
    API_ENLIGHTEN_TOTAL_CUBEMAPS,
    API_ENLIGHTEN_SETUP_WALLCLOCK,
    API_ENLIGHTEN_ENVIRONMENT_WALLCLOCK,
    API_ENLIGHTEN_INPUTLIGHTING_WALLCLOCK,
    API_ENLIGHTEN_SYSTEMS_WALLCLOCK,
    API_ENLIGHTEN_PROBES_WALLCLOCK,
    API_ENLIGHTEN_CUBEMAPS_WALLCLOCK,
    API_ENLIGHTEN_SOLVE_TASKS_WALLCLOCK,
    API_ENLIGHTEN_DYNAMICOBJECTS_WALLCLOCK,
    API_ENLIGHTEN_TIME_BETWEEN_UPDATES,
    API_ENLIGHTEN_OTHER_COMMANDS,
    API_ENLIGHTEN_INPUTLIGHTING_GPU_TICKS,
    API_ENLIGHTEN_NUM_BLOCKED_BUFFER_WRITES,
    API_ENLIGHTEN_BLOCKED_COMMAND_WRITES_DURATION,
    API_ENLIGHTEN_PPPI_PROBESET_UPDATE_COUNT,
    API_ENLIGHTEN_PPPI_COPIED_PROBE_COUNT,
    API_ENLIGHTEN_PPPI_CONVERT_TIME_US,
    API_ENLIGHTEN_PPPI_COPY_TIME_US,
    API_ENLIGHTEN_PPPI_BUILD_TIME_US,
    API_ENLIGHTEN_PPPI_INDIRECTION_UPDATE_TIME_US,
    API_ENLIGHTEN_PPPI_ATLAS_BLOCK_COUNT,
    NUM_AGGREGATE_PROFILE_ITEMS
}

---

Items we record for totals.

enumerators

CubeMapProfileItem

---

public: enum CubeMapProfileItem
{
    CMPI_SOLVE_TIME = 0,
    CMPI_SETUP_TIME,
    NUM_CUBE_MAP_PROFILE_ITEMS
}

---

Items we record against cube maps.

enumerators

EnlightenTaskType

---

public: enum EnlightenTaskType
{
    ETT_SYSTEM_INPUT_LIGHTING,
    ETT_SYSTEM_SOLVE,
    ETT_PROBE_SOLVE,
    ETT_CUBE_MAP_SOLVE,
    ETT_DYNAMIC_OBJECT_INTERPOLATION
}

---

The MultithreadCpuWorker works by putting tasks in a list, and then executing TaskProcessors on several threads in parallel.

A TaskProcessor pulls tasks off the list one by one, until either the whole list is done, or an ILimiter tells it to stop.

The executing threads are accessed through the IThreadGroup interface. If none is supplied then the MultithreadCpuWorker will create a DefaultThreadGroup which executes tasks in serial on the calling thread (ie the update manager worker thread). When it is destroyed, the MultithreadCpuWorker will call Release() on the IThreadGroup interface it was passed. There is an implementation of IThreadGroup which uses Intel Threaded Building Blocks in the TbbThreadGroup.h header (which does not get compiled in to EnlightenHRLT).

ILimiter is an optional interface which can be implemented by the application. A simple FixedTimeLimiter is included here which times out after a given fixed time. Note that the limiter only controls the point at which new tasks can be started, not the total time taken.

The Enlighten update loop consists of three multithreaded phases: input lighting, solve tasks, and probe interpolation. Within each phase tasks can run in parallel (for instance, a probe set can be solved at the same time as a system), but tasks from different phases cannot run together.

If no limiter is supplied, the MultithreadCpuWorker will complete one full pass through the update loop for each call to UpdateRadiosity(). However, it can remembers where in the udpate loop it previously stopped, so if a limiter tells it to stop part-way through an update it will resume from where it left off. This ensures that the Enlighten data remains in a consistent state at all times. Enumeration of Enlighten task types. These are executed by the TaskProcessors.

enumerators

OutputTextureType

---

public: enum OutputTextureType
{
    ENLIGHTEN_OUTPUT_IRRADIANCE = 0,
    ENLIGHTEN_OUTPUT_DIRECTIONAL = 1,
    ENLIGHTEN_OUTPUT_DIRECTIONAL_G = 2,
    ENLIGHTEN_OUTPUT_DIRECTIONAL_B = 3,
    ENLIGHTEN_NUM_OUTPUT_TEXTURE_TYPES = 4
}

---

Enumeration of the different output textures produced by the Enlighten solvers.

enumerators

ProbeSetProfileItem

---

public: enum ProbeSetProfileItem
{
    PSPI_SOLVE_TIME = 0,
    PSPI_SETUP_TIME,
    PSPI_FREEZE_TIME,
    PSPI_NUM_TOTAL_PROBES,
    PSPI_NUM_REAL_PROBES,
    PSPI_NUM_VIRTUAL_PROBES,
    PSPI_NUM_SOLVED_PROBES,
    NUM_PROBE_SET_PROFILE_ITEMS
}

---

Items we record against probe sets.

enumerators

ProbeVolumeOutputTextureType

---

public: enum ProbeVolumeOutputTextureType
{
    ENLIGHTEN_PROBE_VOLUME_R = 0,
    ENLIGHTEN_PROBE_VOLUME_G = 1,
    ENLIGHTEN_PROBE_VOLUME_B = 2,
    ENLIGHTEN_PROBE_VOLUME_ENV_VIS_SH = 3,
    ENLIGHTEN_PROBE_VOLUME_NUM_TYPES = 4
}

---

Enumeration of the different probe volume output textures.

enumerators

RemovalMode

---

public: enum RemovalMode
{
    REMOVE_COMPLETELY = 0,
    REMOVE_UPDATES = 1
}

---

Enumeration of the different levels of data removal for probe sets, systems and cube maps.

enumerators

SolveType

---

public: enum SolveType
{
    ENLIGHTEN_IRRADIANCE_ONLY = 0,
    ENLIGHTEN_DIRECTIONAL_IRRADIANCE = 1,
    ENLIGHTEN_DIRECTIONAL_IRRADIANCE_RGB = 2
}

---

Enumeration of the different types of solve.

enumerators

SystemProfileItem

---

public: enum SystemProfileItem
{
    SPI_SOLVE_TIME = 0,
    SPI_SOLVE_SETUP_TIME,
    SPI_TRANSPARENCY_TIME,
    SPI_INPUT_LIGHTING_SETUP_TIME,
    SPI_WRITE_INPUT_TIME,
    SPI_DIRECT_INPUT_LIGHTING_TIME = SPI_WRITE_INPUT_TIME,
    SPI_RESAMPLE_LIGHTMAP_BOUNCE,
    SPI_RESAMPLE_PROBE_BOUNCE,
    SPI_END_INPUT_TIME,
    SPI_INDIRECT_INPUT_LIGHTING_TIME = SPI_END_INPUT_TIME,
    SPI_FREEZE_TIME,
    SPI_SOLVE_PERC,
    SPI_DIRECTIONAL_VISIBILITY_TIME,
    SPI_UPDATE_RATE,
    SPI_NUM_TOTAL_PIXELS,
    SPI_NUM_SOLVED_PIXELS,
    NUM_SYSTEM_PROFILE_ITEMS
}

---

Items we record against systems.

enumerators

TextureFormat

---

public: enum TextureFormat
{
    TextureFormat_A16B16G16R16F,
    TextureFormat_A32B32G32R32F,
    GEO_DEPRECATED_ENUMERATOR =(TextureFormat_A16B16G16R16_Deprecated),
    TextureFormat_A8R8G8B8,
    GEO_DEPRECATED_ENUMERATOR =(TextureFormat_A16B16G16R16_Deprecated),
    GEO_DEPRECATED_ENUMERATOR =(TextureFormat_A16B16G16R16_Deprecated),
    TextureFormat_R8G8B8A8_UINT,
    TextureFormat_R8,
    TextureFormat_R32F,
    GEO_DEPRECATED_ENUMERATOR =(TextureFormat_A16B16G16R16_Deprecated),
    TextureFormat_R11G11B10,
    TextureFormat_R9G9B9E5,
    TextureFormat_UNKNOWN
}

---

Enumeration of output texture formats used by the high level run-time.

enumerators