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 IClusteringOutput
  • class Enlighten IGpuTexture
  • class Enlighten IGpuTextureAllocator
  • class Enlighten IGpuTextureUpdater
  • class Enlighten ILightTransportOutput
  • class Enlighten ILimiter
  • class Enlighten IMeshSimpOutput
  • class Enlighten IncidentLightingBuffer
  • class Enlighten IndirectInputLightingInternalParameters
  • class Enlighten IndirectInputLightingParameters
  • class Enlighten InputLightBase
  • class Enlighten InputLightFalloffTable
  • class Enlighten InputLightingBuffer
  • class Enlighten InputTextureSamplerParameters
  • class Enlighten InputWorkspace
  • class Enlighten InputWorkspaceDebugIterator
  • class Enlighten InputWorkspaceDebugPoint
  • class Enlighten InputWorkspaceDynamicInternal
  • class Enlighten InputWorkspaceInternal
  • class Enlighten InputWorkspaceMetaData
  • class Enlighten InternalLightFalloffTable
  • class Enlighten InterpolatedPoint
  • class Enlighten InterpolationInputSet
  • class Enlighten IPppiComputeUpdateHandler
  • class Enlighten IPppiProbeSetStateHandler
  • class Enlighten IPrecompBuildParameters
  • class Enlighten IPrecompCubeMapBuildParameters
  • class Enlighten IPrecompCubeMapCore
  • class Enlighten IPrecompDepthCubeMap
  • class Enlighten IPrecompGeneratedSystems
  • class Enlighten IPrecompInputCubeMap
  • class Enlighten IPrecompInputGeometry
  • class Enlighten IPrecompInputItemDependencies
  • class Enlighten IPrecompInputMesh
  • class Enlighten IPrecompInputProbeOctree
  • class Enlighten IPrecompInputProbeRegion
  • class Enlighten IPrecompInputProbeSet
  • class Enlighten IPrecompInputSystem
  • class Enlighten IPrecompMeshValidation
  • class Enlighten IPrecompOutputCubeMap
  • class Enlighten IPrecompOutputProbeOctree
  • class Enlighten IPrecompOutputProbeSet
  • class Enlighten IPrecompPackedGeometry
  • class Enlighten IPrecompPackedInstance
  • class Enlighten IPrecompPackedSystem
  • class Enlighten IPrecompProbeAtlasMaxima
  • class Enlighten IPrecompProbeOctree
  • class Enlighten IPrecompProbeOctreeLayout
  • class Enlighten IPrecompProbeSetBuildParameters
  • class Enlighten IPrecompProbeSetRadiosity
  • class Enlighten IPrecompRadiosityNormalTexture
  • class Enlighten IPrecompSystemClustering
  • class Enlighten IPrecompSystemCompressedLightTransport
  • class Enlighten IPrecompSystemDependencies
  • class Enlighten IPrecompSystemDuster
  • class Enlighten IPrecompSystemLightTransport
  • class Enlighten IPrecompSystemPreClustering
  • class Enlighten IPrecompSystemRadiosity
  • class Enlighten IPrecompSystemsDependencies
  • class Enlighten IPrecompute
  • class Enlighten IProbeSetManager
  • class Enlighten IrradianceOutputDesc
  • class Enlighten ISystemSolutionSpace
  • class Enlighten IThreadGroup
  • class Enlighten IUpdateManager
  • class Enlighten IUpdateManagerWorker
  • class Enlighten LightMethodSelector
  • class Enlighten LightTransportPixel
  • class Enlighten LightValue64
  • class Enlighten LightValueIterator
  • class Enlighten Line2D
  • class Enlighten LrbCpuTextureSampler
  • class Enlighten MaterialAlbedoSampler
  • class Enlighten MaterialComponentBuffer
  • class Enlighten MaterialEmissiveSampler
  • class Enlighten MaterialGuids
  • class Enlighten MaterialSampler
  • class Enlighten MaterialTransparencySampler
  • class Enlighten MergeGeometry
  • class Enlighten MergeGeometryCache
  • class Enlighten MergeMap
    Calendars
You‘re viewing this with anonymous access, so some content might be blocked.
/
class Enlighten IPrecompOutputProbeOctree

    This is the documentation for Enlighten.

    class Enlighten IPrecompOutputProbeOctree

    Sept 09, 2025

    class Enlighten::IPrecompOutputProbeOctree

        └>Geo::IGeoSerialisable
            └>Geo::IGeoReleasable

    An octree of probe positions grouped into probe sets.

    The octree tiles covered by local probe sets define the area covered by this octree. Combine adjacent probe sets with the local probe sets of other octrees for seamless lighting.

    Functions

    Name Description
    Create()

    Create a new empty IPrecompOutputProbeOctree.

    GetAdjacentProbeSetCount()

    The number of sets of adjacent probe positions.

    GetBuildParameters()

    Read only access to the build parameters for this probe octree.

    GetLocalProbeSetCount()

    The number of sets of local probe positions.

    GetName()

    Get the full name.

    GetProbeSetOctreeCode(Geo::s32)

    Returns the octree code for the specified probe set.

    GetTotalProbeSetCount()

    The total number of sets of probe positions.

    Load(IGeoInputStream &, Geo::u32)

    Load an instance of this class from an IGeoInputStream.

    NonCopyable(NonCopyable &&)

    Defaulted to allow move.

    operator=(NonCopyable &&)

    Defaulted to allow move.

    Release()

    Free this object that was created within the Enlighten libraries.

    Save(IGeoStream &, Geo::u32)

    Save an instance of this class to an IGeoStream.


    static IPrecompOutputProbeOctree* Enlighten::IPrecompOutputProbeOctree::Create

    public: IPrecompOutputProbeOctree * Create()

    Create a new empty IPrecompOutputProbeOctree.


    virtual Geo::s32 Enlighten::IPrecompOutputProbeOctree::GetAdjacentProbeSetCount

    public: Geo::s32 GetAdjacentProbeSetCount() const

    The number of sets of adjacent probe positions.

    Adjacent probe sets are arranged contiguously at the end of the range.


    virtual const IPrecompProbeSetBuildParameters* Enlighten::IPrecompOutputProbeOctree::GetBuildParameters

    public: const IPrecompProbeSetBuildParameters * GetBuildParameters() const

    Read only access to the build parameters for this probe octree.


    virtual Geo::s32 Enlighten::IPrecompOutputProbeOctree::GetLocalProbeSetCount

    public: Geo::s32 GetLocalProbeSetCount() const

    The number of sets of local probe positions.

    Local probe sets are arranged contiguously at the start of the range.


    virtual const char* Enlighten::IPrecompOutputProbeOctree::GetName

    public: const char * GetName() const

    Get the full name.


    virtual PrecompOctreeCode Enlighten::IPrecompOutputProbeOctree::GetProbeSetOctreeCode

    public: PrecompOctreeCode GetProbeSetOctreeCode
    (
        Geo::s32 probeSetIndex
    ) const

    Returns the octree code for the specified probe set.


    virtual Geo::s32 Enlighten::IPrecompOutputProbeOctree::GetTotalProbeSetCount

    public: Geo::s32 GetTotalProbeSetCount() const

    The total number of sets of probe positions.

    This is the same as GetNumLocalProbeSets() + GetNumAdjacentProbeSets().


    virtual bool Geo::IGeoSerialisable::Load

    public: bool Load
    (
        IGeoInputStream & stream,
        Geo::u32 section
    )

    Load an instance of this class from an IGeoInputStream.

    The stream must be ready to read from. You can load sections of an object by passing a bitmask representing the desired sections rather than Iff::AllSectionsMask, which will load all sections. It is also safe to call this method on an object multiple times with different section arguments to load multiple parts.


    Geo::NonCopyable::NonCopyable

    public: NonCopyable
    (
        NonCopyable &&
    )

    Defaulted to allow move.


    NonCopyable& Geo::NonCopyable::operator=

    public: NonCopyable & operator=
    (
        NonCopyable &&
    )

    Defaulted to allow move.


    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 bool Geo::IGeoSerialisable::Save

    public: bool Save
    (
        IGeoStream & stream,
        Geo::u32 section
    ) const

    Save an instance of this class to an IGeoStream.

    The stream must be ready to write to. You can save sections of an object by passing a bitmask representing the desired sections rather than Iff::AllSectionsMask, which will save all sections that are available.

    , multiple selections available,
    {"serverDuration": 11, "requestCorrelationId": "25096e0113e544acb19be10e94326f35"}