This is the documentation for Enlighten.
class Enlighten IUpdateManager
class Enlighten::IUpdateManager
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.
Functions
Name | Description |
|---|---|
Allocate a cube map object. | |
Allocate a dynamic object. | |
AllocateProbeSet(const RadProbeSetCore *, bool, Enlighten::eSHOrder, RawBuffer) | Allocate a probe set object. |
AllocateStaticProbeSet(const RadProbeSetCore *, bool, Enlighten::eSHOrder, RawBuffer) | Allocate a probe set object that is not solved at runtime. |
AllocateStaticSystem(Geo::GeoGuid, InputLightingBuffer *, Geo::s32) | Allocate a radiosity system where the lighting does not change at runtime. |
Allocate a radiosity system where the lighting does not change at runtime. | |
AllocateSystem(const InputWorkspace *, const PrecomputedVisibilityData *, Geo::s32) | Allocate a radiosity system. |
AllocateSystem(const InputWorkspace *, const PrecomputedVisibilityData *) | Allocate a radiosity system. |
Allocate a radiosity system. | |
Allocate a radiosity system. | |
Allocate the solution space, which contains the textures and memory for the output, for a system. | |
AllocateSystemSolutionSpace(const RadSystemCore *, IGpuTexture *, eOutputFormat) | Allocate the solution space, which contains the textures and memory for the output, for a system. |
AllocateSystemSolutionSpace(const RadSystemCore *, IGpuTexture *) | Allocate the solution space, which contains the textures and memory for the output, for a system. |
Wait until asynchronous processing has finished, then remove all objects from the update manager. | |
Advanced: remove a cube map from the render thread-side list, prior to its removal. | |
Advanced: remove a dynamic object from the render thread-side list, prior to its removal. | |
Advanced: remove a probe set from the render thread-side list, prior to its removal. | |
Advanced: remove a system from the render thread-side system list, prior to its removal. | |
Add a previously allocated cube map to the worker's list. | |
Add a previously allocated dynamic object to the worker's list. | |
Add a previously allocated probe set to the worker's list. | |
Add a previously allocated system to the worker's list. | |
EnqueueReleaseSystemSolutionSpaces(ISystemSolutionSpace *const *, Geo::s32) | Enqueue system solution spaces release. |
Removes all lights. | |
Remove or disable updates for a cube map. | |
Removes a dynamic object. | |
Removes an environment. | |
Removes a light. | |
Remove or disable updates for a probe set. | |
Remove or disable updates for a system. | |
Enqueue system solution spaces remove. | |
Set the update counters for all systems, probe sets and cube maps in the update manager. | |
Set the flag which turns off temporal coherence for the next frame and performs a full solve from scratch. | |
Set the light bank update counter for the given light bank. | |
Set the Probe Set Manager object. | |
EnqueueSetProbeSetTransform(Geo::GeoGuid, const Geo::Matrix &) | Set the world-to-local-space transform for the given probe set. This will trigger a global recomputation of all probe interpolants. |
EnqueueSetVisibilityBits(Geo::GeoGuid, Geo::GeoGuid, void *) | Set the visibility data associated to a given (system/cube map, spotlight) pair. |
EnqueueSetWorkerProperties(const UpdateManagerWorkerProperties &) | Enqueue a change to the worker's global state. |
EnqueueUpdateEmissiveEnvironment(Geo::GeoGuid, Geo::s32, const Geo::v128 *) | Update the environment with the given GUID. If this environment hasn't been updated before it will be added to the update manager. |
EnqueueUpdateLight(const Geo::GeoGuid &, const LightType &, UpdateLightOptions) | Add the light. |
Wait for all commands to be executed before proceeding. This blocks the current thread, potentially for a long time. | |
Get the output texture for the cube map texture. | |
GetDynamicObjectEnvironmentVisibilityShCoeff(Geo::GeoGuid, Geo::SHCoeff &) | Gets the environment visibility probe output for a given dynamic object. |
GetDynamicObjectShCoeff(Geo::GeoGuid, Geo::SHCoeff &, Geo::SHCoeff &, Geo::SHCoeff &) | Gets the probe output for a given dynamic object. |
Returns number of cube maps registered with the update manager. | |
Returns number of dynamic objects registered with the update manager. | |
Returns number of probe sets registered with the update manager. | |
Returns number of systems registered with the update manager. | |
Gets the output texture of the given type for the given system. | |
Returns information about the required PPPI output textures. | |
Returns the probe output for the given probe set and probe index, or NULL if the probe set produces compressed output. | |
Returns the probe output if the probeset has been updated since this function was last called on it, otherwise NULL. | |
Get the total number of ticks spent updating GPU textures. | |
Returns the compressed probe output for the given probe set and probe index, or NULL if the probe set produces uncompressed output. | |
Gets the matrix to transform world space to UVW texture space for a dynamic object. | |
Returns true if the update manager has a cube map with this GUID; false if it doesn't. | |
Returns true if the update manager has a dynamic object with this GUID. | |
Returns true if the update manager has a probe set with this GUID; false if it doesn't. | |
Returns true if the update manager has a system with this GUID; false if it doesn't. | |
Are we at the limit of the number of allowed enqueued updates, and therefore the update rate is throttled? | |
Destroys the update manager and all the resources it owns. | |
Free this object that was created within the Enlighten libraries. | |
Returns true for Update Managers that require spotlight visibility to be copied to the CPU before it can be used. | |
SetPppiOutputWorkspace(const PppiOutputWorkspace &, IPppiTextureUpdateHandler *) | Use the provided PPPI output textures. |
Wait for all asynchronous processing to finish, then quit the worker thread(s), if any. | |
The main update function. This should be called once per frame from the rendering thread. | |
UpdatePppi(const Geo::v128 &, const IViewVolumeIntersector *, float) | Update PPPI indirection texture based on the view origin. |
Update the lighting for parts of the PPPI volume not covered by any probe set. |
virtual BaseCubeMap* Enlighten::IUpdateManager::AllocateCubeMap
public: BaseCubeMap * AllocateCubeMap
(
const RadCubeMapCore * coreData,
IGpuTexture * outputTexture
)
Allocate a cube map object.
Pointer parameters that are are owned by the caller may be read any time after EnqueueAddCubeMap and before the completion of the async RemoveCubeMap command.
Parameters
[in] | coreData | The runtime data that represents the cube map. |
[in] | coreData | The radiosity core data for the cubemap. Does not take ownership. |
[in] | outputTexture | The cubemap output texture. Takes ownership. |
virtual BaseDynamicObject* Enlighten::IUpdateManager::AllocateDynamicObject
public: BaseDynamicObject * AllocateDynamicObject
(
const Enlighten::DynamicObject & dynamicObjectDesc
)
Allocate a dynamic object.
This will add the object to the update manager's list but it must be separately added to the worker's copy via EnqueueAddDynamicObject.
Parameters
[in] | dynamicObjectDesc | The dynamic object to add |
virtual BaseProbeSet* Enlighten::IUpdateManager::AllocateProbeSet
public: BaseProbeSet * AllocateProbeSet
(
const RadProbeSetCore * coreData,
bool useU8Output,
Enlighten::eSHOrder shOrder,
RawBuffer output
)
Allocate a probe set object.
Pointer parameters that are are owned by the caller may be read (and output may be written) any time after EnqueueAddProbeSet and before the completion of the async RemoveProbeSet command.
Parameters
[in] | coreData | The runtime data that represents the probe set. Owned by the caller. |
[in] | useU8Output | When true, this probe set is solved to compressed probe output format. This may reduce lighting quality and introduce artifacts. |
[in] | shOrder | The number of spherical harmonic coefficients in the solved output for this probe set. |
[in] | output | The (optional) output buffer. Owned by the caller. This buffer may be written to any time after AddProbeSet and before the completion of the async RemoveProbeSet command. |
virtual BaseProbeSet* Enlighten::IUpdateManager::AllocateStaticProbeSet
public: BaseProbeSet * AllocateStaticProbeSet
(
const RadProbeSetCore * coreData,
bool useU8Output,
Enlighten::eSHOrder shOrder,
RawBuffer output
)
Allocate a probe set object that is not solved at runtime.
Pointer parameters that are are owned by the caller may be read (and output may be written) any time after EnqueueAddProbeSet and before the completion of the async RemoveProbeSet command.
Parameters
[in] | coreData | The runtime data that represents the probe set. Owned by the caller. |
[in] | useU8Output | When true, this probe set is solved to compressed probe output format. This may reduce lighting quality and introduce artifacts. |
[in] | shOrder | The number of spherical harmonic coefficients in the solved output for this probe set. |
[in] | output | The (optional) output buffer. Owned by the caller. This buffer may be written to any time after AddProbeSet and before the completion of the async RemoveProbeSet command. |
virtual BaseSystem* Enlighten::IUpdateManager::AllocateStaticSystem
public: BaseSystem * AllocateStaticSystem
(
Geo::GeoGuid systemId,
InputLightingBuffer * inputLightingBuffer,
Geo::s32 lightChannels
)
Allocate a radiosity system where the lighting does not change at runtime.
A saved InputLightingBuffer ensures that the lighting bounces into systems which depend on this system. Pointer parameters that are are owned by the caller may be read any time after EnqueueAddSystem and before the completion of the async RemoveSystem command.
Parameters
[in] | systemId | The unique ID of the system. Provide the same value to RemoveSystem. |
[in] | inputLightingBuffer | The (static) input lighting for the system. Owned by the caller. |
[in] | lightChannels | Only lights which have the same light channel bit set are used as input for this system. |
BaseSystem* Enlighten::IUpdateManager::AllocateStaticSystem
public: BaseSystem * AllocateStaticSystem
(
Geo::GeoGuid systemId,
InputLightingBuffer * inputLightingBuffer
)
Allocate a radiosity system where the lighting does not change at runtime.
A saved InputLightingBuffer ensures that the lighting bounces into systems which depend on this system. Pointer parameters that are are owned by the caller may be read any time after EnqueueAddSystem and before the completion of the async RemoveSystem command.
Parameters
[in] | systemId | The unique ID of the system. Provide the same value to RemoveSystem. |
[in] | inputLightingBuffer | The (static) input lighting for the system. Owned by the caller. |
virtual BaseSystem* Enlighten::IUpdateManager::AllocateSystem
public: BaseSystem * AllocateSystem
(
const InputWorkspace * inputWorkspace,
const PrecomputedVisibilityData * visibilityData,
Geo::s32 lightChannels
)
Allocate a radiosity system.
Pointer parameters that are are owned by the caller may be read any time after EnqueueAddSystem and before the completion of the async RemoveSystem command.
Parameters
[in] | inputWorkspace | The input workspace data for this system. Owned by the caller. |
[in] | visibilityData | The directional visibility data for this system. Owned by the caller. |
[in] | lightChannels | Only lights which have the same light channel bit set are used as input for this system. |
BaseSystem* Enlighten::IUpdateManager::AllocateSystem
public: BaseSystem * AllocateSystem
(
const InputWorkspace * inputWorkspace,
const PrecomputedVisibilityData * visibilityData
)
Allocate a radiosity system.
Pointer parameters that are are owned by the caller may be read any time after EnqueueAddSystem and before the completion of the async RemoveSystem command.
Parameters
[in] | inputWorkspace | The input workspace data for this system. Owned by the caller. |
[in] | visibilityData | The directional visibility data for this system. Owned by the caller. |