This is the documentation for Enlighten.
class Enlighten MultithreadCpuWorker
class Enlighten::MultithreadCpuWorker
└>Enlighten::MultithreadCpuWorkerCommon
└>Enlighten::CpuWorker
└>Enlighten::BaseWorker
└>Enlighten::IUpdateManagerWorker
Worker for the mulithreaded CPU update manager.
Functions
Name | Description |
|---|---|
Add a cube map to the worker. | |
Add a cube map to the worker. | |
Add a cube map to the worker. | |
Add a dynamic object to the worker. | |
Add a dynamic object to the worker. | |
Add a probe set to the worker. | |
Add a probe set to the worker. | |
Add a probe set to the worker. | |
Add a system to the worker, and allocate any required auxiliary resources. | |
Add a system to the worker, and allocate any required auxiliary resources. | |
Add a system to the worker, and allocate any required auxiliary resources. | |
Add a system to the worker, and allocate any required auxiliary resources. | |
Allocates/Frees memory for visibility data. | |
Allocates/Frees memory for visibility data. | |
Base class constructor. | |
Remove all objects from the worker, and free memory allocated by the worker. | |
Remove all objects from the worker, and free memory allocated by the worker. | |
Remove all objects from the worker, and free memory allocated by the worker. | |
Clears the cube map volume transparency. | |
Clears the cube map volume transparency. | |
Clears the system volume transparency. | |
Clears the system volume transparency. | |
Clears the system volume transparency. | |
Compute directional light visibility for the given system. | |
Allocate and make a copy of an albedo buffer. | |
Allocate and make a copy of an albedo buffer. | |
Allocate and make a copy of an emissive buffer. | |
Allocate and make a copy of an emissive buffer. | |
Allocate and make a copy of an emissive buffer. | |
Allocate and make a copy of an emissive buffer. | |
CopyEmissiveEnvironment(CopyEmissiveEnvironmentInfo const &) | Allocate and make a copy of an emissive environment. |
CopyEmissiveEnvironment(CopyEmissiveEnvironmentInfo const &) | Allocate and make a copy of an emissive environment. |
CopyGeometryTransparencyBuffer(CopyTransparencyBufferInfo const &) | Copies the geometry transparency buffer. |
CopyGeometryTransparencyBuffer(CopyTransparencyBufferInfo const &) | Allocate and make a copy of a geoemtry transparency buffer. |
CopyGeometryTransparencyBuffer(CopyTransparencyBufferInfo const &) | Copies the geometry transparency buffer. |
CopyInputLightingBuffer(CopyInputLightingBufferInfo const &) | Allocate and make a copy of an input lighting buffer. |
CopyInputLightingBuffer(CopyInputLightingBufferInfo const &) | Allocate and make a copy of an input lighting buffer. |
Convert UpdateManagerLights to Enlighten::InputLights in preparation for Enlighten work. | |
Convert UpdateManagerLights to Enlighten::InputLights in preparation for Enlighten work. | |
CopyMaterialTransparencyBuffer(CopyTransparencyBufferInfo const &) | Allocate and make a copy of a material transparency buffer. |
CopyMaterialTransparencyBuffer(CopyTransparencyBufferInfo const &) | Allocate and make a copy of a material transparency buffer. |
Allocate and make a copy of Enlighten probe set output. | |
Allocate and make a copy of Enlighten probe set output. | |
Allocate and make a copy of raw Enlighten texture output. | |
Allocate and make a copy of raw Enlighten texture output. | |
Allocate and make a copy of a visibility data block. | |
Allocate and make a copy of a visibility data block. | |
Constructor, taking properties which are fixed at creation time. | |
Decrements the update counters for all systems, probe sets, cube maps and light banks. | |
Release all the objects this worker constructed. | |
DoBounceSolverTask(Enlighten::SolveBounceTask, void *, Geo::u32 &, Geo::u32 &, CpuSystem *) | Call the bounce solver and trigger feedback updates if required. |
Do the solve task for a cube map using the working memory of the given thread index. | |
Do the solve task for a cube map using the working memory of the given thread index. | |
Do the interpolation for a single dynamic object, to allow multithreading. | |
Runs the probe interpolation tasks for all dynamic objects, non-multithreaded. | |
Copies the environment values from the application-settable copy to the internal copy. | |
Do the next task on the queue using the working memory of the given thread index. | |
Do the input lighting task for a system using the working memory of the given thread index. | |
Do the input lighting task for a system using the working memory of the given thread index. | |
Do a freeze of the solution space data. | |
Do a solve of a particular system solution space for a given system and update bounce buffers. | |
Enqueues a command for later execution by the worker thread, if it is running. | |
Tell the update thread to quit. | |
Enqueue a radiosity update on the worker thread. | |
Ensure the solver light buffer is large enough to store all the lights. | |
Ensure the solver light buffer is large enough to store all the lights. | |
Have we requested to solve the environment in secondary bounce only. (ie skip primary bounce) | |
Returns the value of the worker property m_ExcludeEnvrionmentInPrimaryBounce. | |
Executes and destroys commands in the command ring buffer until the buffer is empty. | |
Finds the object with the given GUID. | |
Finds the object with the given address. | |
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. | |
Finds the object with the given GUID. | |
Finds the object with the given GUID. | |
Allocates/Frees memory for visibility data. | |
Gets the precision hint for the input lighting buffer,. | |
Gets the light method selector. | |
Gets the light method selector. | |
Get the total size of probe set output workspaces. | |
Get the total size of probe set output workspaces. | |
Get the total size of probe set input workspaces. | |
Get the total size of probe set input workspaces. | |
Get the size of the working memory required for solving. | |
Get the size of the working memory required for solving. | |
Get the size of the working memory required for solving. | |
Returns the array of systems. Used by the GeoMaya plug in to work out when to trigger refreshes. | |
One-time thread group initialisation. | |
Returns true if called on the worker thread, or if no worker thread is running. | |
Returns true if called on the worker thread, or if no worker thread is running. | |
IsEnvOnlyUpdateRequired(CpuSystemSolutionSpace *, bool, const Enlighten::InputLightingBuffer *) | Returns true if the EnvOnly feature is enabled and an update is required. |
Are we at the limit of the number of allowed enqueued updates, and therefore the update rate is throttled? | |
Are we at the limit of the number of allowed enqueued updates, and therefore the update rate is throttled? | |
Whether the worker thread is currently running. | |
Returns true if a separate worker thread is currently running, false if not. | |
Log stats with the profiler using an enclosure. | |
Constructor. | |
Constructor. | |
ProbeSetManagerSetMaxWeightForProbeSet(Geo::GeoGuid const &, float) | Set max interpolation weight for a given probe set. |
ProbeSetManagerSetMaxWeightForProbeSet(Geo::GeoGuid const &, float) | Set max interpolation weight for a given probe set. |
PushMultipleObjectsToDestroy(Geo::IGeoReleasable *const *, Geo::s32) | Push a list of objects which has been removed from the worker on to a list to be destroyed by the rendering thread. |
Push an object which has been removed from the worker on to a list to be destroyed by the rendering thread. | |
ReadInputLightingBuffer(ReadInputLightingBufferInfo const &) | These functions are provided for debugging/visualisation purposes. |
ReadInputLightingBuffer(ReadInputLightingBufferInfo const &) | These functions are provided for debugging/visualisation purposes. |
Updates the probe interpolation inputs, if required. | |
ReleaseSystemSolutionSpaces(ReleaseSystemSolutionSpacesInfo const &) | Release system solution spaces. |
ReleaseSystemSolutionSpaces(ReleaseSystemSolutionSpacesInfo const &) | Release the solution spaces. |
Remove all lights. | |
Remove all lights. | |
Remove a cube map from the worker (either completely or partially) | |
Remove a cube map from the worker (either completely or partially) | |
Remove a cube map from the worker (either completely or partially) | |
Removes a light with the given GUID from the list of directional lights (if one is found), and frees the associated memory. | |
Remove a dynamic object from the worker. | |
Remove a dynamic object from the worker. | |
Remove a dynamic object from the worker. | |
Remove the environment with the given id. | |
Remove the environment with the given id. | |
Remove the light with the given id. | |
Remove the light with the given id. | |
Remove a light bank. | |
Remove a light bank. | |
Removes a light with the given GUID from the list of lights without visibility (if one is found), and frees the associated memory. | |
Removes a light with the given GUID from the list of lights with visibility (if one is found), and frees the associated memory. | |
Remove a probe set from the worker (either completely or partially) | |
Remove a probe set from the worker (either completely or partially) | |
Remove a probe set from the worker (either completely or partially) | |
Remove a system from the worker (either completely or partially) | |
Remove a system from the worker (either completely or partially) | |
Remove a system from the worker (either completely or partially) | |
Remove a system from the worker (either completely or partially) | |
Remove a system from the worker (either completely or partially) | |
Removes the given system from all cached dependency lists. | |
Removes the solution spaces from the system. This function will not release the solution spaces. | |
Removes the solution spaces from the system. This function will not release the solution spaces. | |
Re-register all objects with the profiler. | |
Start the worker thread if it is not already running. | |