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 3.10 Documentation
Results will update as you type.
  • Modules
  • Namespaces
    • namespace Enlighten
      • class Enlighten A8CpuTextureSampler
      • class Enlighten Alpha8Normalised
      • class Enlighten AsyncTaskThreadGroup
      • class Enlighten AutoProbeVolumes
      • class Enlighten BakedProbeOutputInfo
      • class Enlighten BakeInputLight
      • class Enlighten BakeInputMeshInfo
      • class Enlighten BakeMaterialInfo
      • class Enlighten BaseAlbedoHandler
      • class Enlighten BaseCubeMap
      • class Enlighten BaseDynamicObject
      • class Enlighten BaseEnvironment
      • class Enlighten BaseLightMeta
      • class Enlighten BaseProbeSet
      • class Enlighten BaseSystem
      • class Enlighten BaseSystemSolutionSpace
      • class Enlighten BaseUpdateManager
      • 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 ClusterProbeBounceSampleData
      • class Enlighten ClusterProbeSample
      • 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 CpuUpdateManager
      • class Enlighten CpuWorker
      • class Enlighten CubeMapDataBlock
      • class Enlighten CubeMapMeta
      • class Enlighten DefaultGeometryTransparencySampler
      • class Enlighten DefaultThreadGroup
      • class Enlighten DirectInputLightingParameters
    Calendars
You‘re viewing this with anonymous access, so some content might be blocked.
/
class Enlighten BaseProbeSet

    This is the documentation for Enlighten.

    class Enlighten BaseProbeSet

    Nov 21, 2019

    class Enlighten::BaseProbeSet

        └>Geo::IGeoReleasable

    Class used by the update manager to hold all of the resources for a probe set together.

    This class is used as-is by the CPU and console update managers. Note that currently the update manager system can only solve whole probe sets at once - there is not yet any mechanism for solving only subsets.

    Functions

    Name Description
    GetUpdateMarker()

    Get the current value of the update marker. The marker changes every time the probe set is updated.

    Release()

    Free this object that was created within the Enlighten libraries.

    Release()

    Free this object that was created within the Enlighten libraries.

    SetBakedOutput(const BakedProbeOutputInfo &)

    Property-setting functions which can be enqueued with EnqueueSetObjectParameter.

    SetBakedOutputMultiplier(float)

    Property-setting functions which can be enqueued with EnqueueSetObjectParameter.

    SetEmissiveEnvironment(Geo::GeoGuid)

    Property-setting functions which can be enqueued with EnqueueSetObjectParameter.

    SetFramesPerUpdate(Geo::s32)

    Property-setting functions which can be enqueued with EnqueueSetObjectParameter.

    SetFramesPerUpdateForLod(Geo::s32, Geo::s32)

    Property-setting functions which can be enqueued with EnqueueSetObjectParameter.

    SetFramesPerUpdateForLod(Geo::GeoPair< Geo::s32, Geo::s32 >)

    Property-setting functions which can be enqueued with EnqueueSetObjectParameter.

    SetLod(Geo::s32)

    Property-setting functions which can be enqueued with EnqueueSetObjectParameter.

    SetTemporalCoherenceThreshold(float)

    Property-setting functions which can be enqueued with EnqueueSetObjectParameter.

    SetUpdateCounter(Geo::s32)

    Property-setting functions which can be enqueued with EnqueueSetObjectParameter.


    Geo::u32 Enlighten::BaseProbeSet::GetUpdateMarker

    public: Geo::u32 GetUpdateMarker() const

    Get the current value of the update marker. The marker changes every time the probe set is updated.


    virtual void Enlighten::BaseProbeSet::Release

    protected: virtual 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 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)'


    void Enlighten::BaseProbeSet::SetBakedOutput

    public: void SetBakedOutput
    (
        const BakedProbeOutputInfo & bakeInfo
    )

    Property-setting functions which can be enqueued with EnqueueSetObjectParameter.


    void Enlighten::BaseProbeSet::SetBakedOutputMultiplier

    public: void SetBakedOutputMultiplier
    (
        float bakeMultiplier
    )

    Property-setting functions which can be enqueued with EnqueueSetObjectParameter.


    void Enlighten::BaseProbeSet::SetEmissiveEnvironment

    public: void SetEmissiveEnvironment
    (
        Geo::GeoGuid id
    )

    Property-setting functions which can be enqueued with EnqueueSetObjectParameter.


    void Enlighten::BaseProbeSet::SetFramesPerUpdate

    public: void SetFramesPerUpdate
    (
        Geo::s32 f
    )

    Property-setting functions which can be enqueued with EnqueueSetObjectParameter.


    void Enlighten::BaseProbeSet::SetFramesPerUpdateForLod

    public: void SetFramesPerUpdateForLod
    (
        Geo::s32 f,
        Geo::s32 relativeLod
    )

    Property-setting functions which can be enqueued with EnqueueSetObjectParameter.


    void Enlighten::BaseProbeSet::SetFramesPerUpdateForLod

    public: void SetFramesPerUpdateForLod
    (
        Geo::GeoPair< Geo::s32, Geo::s32 > p
    )

    Property-setting functions which can be enqueued with EnqueueSetObjectParameter.


    void Enlighten::BaseProbeSet::SetLod

    public: void SetLod
    (
        Geo::s32 lod
    )

    Property-setting functions which can be enqueued with EnqueueSetObjectParameter.


    void Enlighten::BaseProbeSet::SetTemporalCoherenceThreshold

    public: void SetTemporalCoherenceThreshold
    (
        float t
    )

    Property-setting functions which can be enqueued with EnqueueSetObjectParameter.


    void Enlighten::BaseProbeSet::SetUpdateCounter

    public: void SetUpdateCounter
    (
        Geo::s32 c
    )

    Property-setting functions which can be enqueued with EnqueueSetObjectParameter.

    , multiple selections available,
    {"serverDuration": 8, "requestCorrelationId": "aa9f3d89ffd04eee99897ad92536854e"}