Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device. Atlassian cookies and tracking notice, (opens new window)
Enlighten API 4.03 Documentation
Results will update as you type.
  • class Enlighten BakeInputLight
  • class Enlighten BakeInputMeshInfo
  • class Enlighten BakeMaterialInfo
  • class Enlighten BaseAlbedoHandler
  • class Enlighten BaseCubeMap
  • class Enlighten BaseDynamicObject
  • class Enlighten BaseEnvironment
  • class Enlighten BaseProbeSet
  • class Enlighten BaseSystem
  • class Enlighten BaseSystemSolutionSpace
  • class Enlighten BaseWorker
  • class Enlighten BoundingBox2D
  • class Enlighten BoxSpotlight
  • class Enlighten BoxVolume
  • class Enlighten CallableEnqueueFunctorCommand
  • class Enlighten ClusterAlbedoWorkspaceMaterialData
  • class Enlighten ClusterMaterialComponent
  • class Enlighten ClusterMaterials
  • class Enlighten ClusterProbeTransparencySampleData
  • class Enlighten ClusterRange
  • class Enlighten Command
  • class Enlighten ConstLightValueIterator
  • class Enlighten CopyAlbedoBufferInfo
  • class Enlighten CopyBounceBufferInfo
  • class Enlighten CopyEmissiveBufferInfo
  • class Enlighten CopyEmissiveEnvironmentInfo
  • class Enlighten CopyInputLightingBufferInfo
  • class Enlighten CopyProbeOutputInfo
  • class Enlighten CopyRawOutputInfo
  • class Enlighten CopyTransparencyBufferInfo
  • class Enlighten CopyVisibilityBufferInfo
  • class Enlighten CpuAlbedoHandler
  • class Enlighten CpuCubeMap
  • class Enlighten CpuDynamicObject
  • class Enlighten CpuEnvironment
  • class Enlighten CpuSystem
  • class Enlighten CpuSystemSolutionSpace
  • class Enlighten CpuTextureSamplerBase
  • class Enlighten CpuWorker
  • class Enlighten DefaultGeometryTransparencySampler
  • class Enlighten DefaultThreadGroup
  • class Enlighten DirectInputLightingParameters
  • class Enlighten DirectionalLight
  • class Enlighten Dx11TextureUpdater
  • class Enlighten DynamicMaterialWorkspace
  • class Enlighten DynamicObject
  • class Enlighten EnlightenProfile
  • class Enlighten EnlightenTask
  • class Enlighten EntireProbeSetTask
  • class Enlighten FitModel
  • class Enlighten FixedTimeLimiter
  • class Enlighten Fp16CpuTextureSampler
  • class Enlighten FrustumLight
  • class Enlighten FunctorCommand
  • class Enlighten GenericColourBuffer
  • class Enlighten GeoClusterNode
  • class Enlighten GeoClusterNodeForest
  • class Enlighten GeoClusterNodeTree
  • class Enlighten GeoDirectionalPoint
  • class Enlighten GeoRayOrigin
  • class Enlighten GlTextureUpdater
  • class Enlighten GpuTextureWrapper
  • class Enlighten IAsyncTask
  • class Enlighten IBake
  • class Enlighten IBakeInputGeometryLightingNormals
  • class Enlighten IBakeInputGeometryTangents
  • class Enlighten IBakeInputGeometryUvs
  • class Enlighten IBakeInputLighting
  • class Enlighten IBakeInputMaterial
  • class Enlighten IBakeInputMeshLightingNormals
  • class Enlighten IBakeInputMeshTangents
  • class Enlighten IBakeInputMeshUvs
  • class Enlighten IBakeInputProperties
  • class Enlighten IBakeInputRayOriginPositions
  • class Enlighten IBakeInputRuntime
  • class Enlighten IBakeInputSystem
  • class Enlighten IBakeOutputProbeSet
  • class Enlighten IBakeOutputProbeSetVisibility
  • class Enlighten IBakeOutputSystemAO
  • class Enlighten IBakeOutputSystemDirect
  • class Enlighten IBakeOutputSystemFinalGather
    Calendars
You‘re viewing this with anonymous access, so some content might be blocked.
/
class Enlighten DefaultThreadGroup

    This is the documentation for Enlighten.

    class Enlighten DefaultThreadGroup

    Sept 09, 2025

    class Enlighten::DefaultThreadGroup

        └>Enlighten::IThreadGroup
            └>Geo::IGeoReleasable

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

    Functions

    Name Description
    GetNumThreads()

    The number of threads in the thread group.

    GetNumThreads()

    The number of threads in the thread group.

    Init()

    Init() and Shutdown() will be called on the thread which calls Run() (ie the update manager worker thread)

    Init()

    Init() and Shutdown() will be called on the thread which calls Run() (ie the update manager worker thread)

    NonCopyable(NonCopyable &&)

    Defaulted to allow move.

    operator=(NonCopyable &&)

    Defaulted to allow move.

    Release()

    This function will be called when MultithreadCpuWorker is destroyed.

    Release()

    This function will be called when MultithreadCpuWorker is destroyed.

    Release()

    Free this object that was created within the Enlighten libraries.

    Run(TaskProcessor *, const char *)

    Run tasks using threads in the thread group.

    Run(TaskProcessor *, const char *)

    Run tasks using threads in the thread group.

    Shutdown()

    One-time shut down function.

    Shutdown()

    One-time shut down function.


    virtual Geo::s32 Enlighten::DefaultThreadGroup::GetNumThreads

    public: virtual Geo::s32 GetNumThreads()

    The number of threads in the thread group.


    virtual Geo::s32 Enlighten::IThreadGroup::GetNumThreads

    public: Geo::s32 GetNumThreads()

    The number of threads in the thread group.


    virtual void Enlighten::DefaultThreadGroup::Init

    public: virtual void Init()

    Init() and Shutdown() will be called on the thread which calls Run() (ie the update manager worker thread)

    One-time initialisation function


    virtual void Enlighten::IThreadGroup::Init

    public: void Init()

    Init() and Shutdown() will be called on the thread which calls Run() (ie the update manager worker thread)

    One-time initialisation function


    Geo::NonCopyable::NonCopyable

    public: NonCopyable
    (
        NonCopyable &&
    )

    Defaulted to allow move.


    NonCopyable& Geo::NonCopyable::operator=

    public: NonCopyable & operator=
    (
        NonCopyable &&
    )

    Defaulted to allow move.


    virtual void Enlighten::DefaultThreadGroup::Release

    public: virtual void Release()

    This function will be called when MultithreadCpuWorker is destroyed.


    virtual void Enlighten::IThreadGroup::Release

    public: void Release()

    This function will be called when MultithreadCpuWorker is destroyed.


    virtual void Geo::IGeoReleasable::Release

    public: void Release()

    Free this object that was created within the Enlighten libraries.

    Expect this to behave in a similar way to calling 'delete(this)'


    virtual void Enlighten::DefaultThreadGroup::Run

    public: virtual void Run
    (
        TaskProcessor * taskProcessors,
        const char * name
    )

    Run tasks using threads in the thread group.

    The array of task processors will have the number of elements returned by GetNumThreads(). The name parameter will describe which Enlighten processing stage is being run, for profiling purposes.


    virtual void Enlighten::IThreadGroup::Run

    public: void Run
    (
        TaskProcessor * taskProcessors,
        const char * name
    )

    Run tasks using threads in the thread group.

    The array of task processors will have the number of elements returned by GetNumThreads(). The name parameter will describe which Enlighten processing stage is being run, for profiling purposes.


    virtual void Enlighten::DefaultThreadGroup::Shutdown

    public: virtual void Shutdown()

    One-time shut down function.


    virtual void Enlighten::IThreadGroup::Shutdown

    public: void Shutdown()

    One-time shut down function.

    , multiple selections available,
    {"serverDuration": 10, "requestCorrelationId": "3db6e55d7aac4636991d1379ff557e69"}