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.
  • class Enlighten InterpolatedPoint
  • class Enlighten InterpolationInputSet
  • class Enlighten IPppiTextureUpdateHandler
  • 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 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 IPrecomputeLoaderCubeMap
  • class Enlighten IPrecomputeLoaderGeometry
  • class Enlighten IPrecomputeLoaderProbeSet
  • class Enlighten IPrecomputeLoaderSystem
  • class Enlighten IPrecompVolumeQuery
  • class Enlighten IProbeSetManager
  • class Enlighten IrradianceOutputDesc
  • class Enlighten ISystemSolutionSpace
  • class Enlighten IThreadGroup
  • class Enlighten IUpdateManager
  • class Enlighten IUpdateManagerWorker
  • class Enlighten IViewVolumeIntersector
  • class Enlighten LightMethodSelector
  • class Enlighten LightTransportPixel
  • class Enlighten LightValue64
  • class Enlighten LightValueIterator
  • class Enlighten Line2D
  • class Enlighten LongRunningProcess
  • 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
  • class Enlighten MergeProcessParams
  • class Enlighten MergeStats
  • class Enlighten MergeTriGroupParams
  • class Enlighten MetaBlock
  • class Enlighten MetaBlockBuilder
  • class Enlighten MultithreadCpuUpdateManager
  • class Enlighten MultithreadCpuWorker
  • class Enlighten MultithreadCpuWorkerCommon
  • class Enlighten NullGeometryTransparencySampler
  • class Enlighten NullMaterialEmissiveSampler
  • class Enlighten NullMaterialTransparencySampler
  • class Enlighten NullSampler
  • class Enlighten OctreeBuilder
  • class Enlighten OctreeSearchResult
  • class Enlighten OutputOctreeBuilder
  • class Enlighten PackedDusterPoint
  • class Enlighten PipelineCubemap
  • class Enlighten PipelineError
    Calendars

You‘re viewing this with anonymous access, so some content might be blocked.
/
class Enlighten IProbeSetManager

    This is the documentation for Enlighten.

    class Enlighten IProbeSetManager

    Nov 21, 2019

    class Enlighten::IProbeSetManager

    Probe Set Manager interface class.

    Functions

    Name Description
    GetInterpolationInputSet(Geo::u32)

    Get an interpolation set that corresponds to given index - this index needs to be comaptible with ProbeInterpolant::m_ProbeSetIndex filled by the GetProbeInterpolants(...) method.

    GetMaxWeightForProbeSet(Geo::GeoGuid const &, float &)

    Set a maximum interpolation weight for the given Probe Set.

    GetNumProbeSets()

    Get the total number of Probe Sets under management.

    GetProbeInterpolants(Geo::v128 const &, ProbeInterpolant *, Geo::s32, Geo::s32 &)

    Retrieves the probes interpolants for a given point.

    GetProbeInterpolants(Geo::v128 const &, ProbeInterpolant *, Geo::s32, Geo::s32 &, Geo::u32)

    Retrieves the probes interpolants for a given point and specified LOD.

    MarkAllProbeSetsAsUnloaded()

    Marks all Interpolation Input Sets as unloaded.

    MarkProbeSetAsLoaded(Enlighten::InterpolationInputSet const &)

    Marks given Interpolation Input Set as loaded.

    MarkProbeSetAsUnloaded(Geo::GeoGuid const &)

    Marks given Interpolation Input Set as unloaded.

    OnAllLoadedProbeSetsArrayChanged(Enlighten::InterpolationInputSet const *, Geo::s32)

    Allows the probe set manager a chance to observe the contiguous memory block in which the runtime stores all loaded input sets.

    SetMaxWeightForProbeSet(Geo::GeoGuid const &, float)

    Set a maximum interpolation weight for the given Probe Set.


    virtual Enlighten::InterpolationInputSet const* Enlighten::IProbeSetManager::GetInterpolationInputSet


    public: Enlighten::InterpolationInputSet const * GetInterpolationInputSet
    (
        Geo::u32 index
    ) const


    Get an interpolation set that corresponds to given index - this index needs to be comaptible with ProbeInterpolant::m_ProbeSetIndex filled by the GetProbeInterpolants(...) method.

    May return NULL is Probe Set that corresponds to index is unloaded. Note, however that none of the ProbeInterpolant::m_ProbeSetIndex indices returned from GetProbeInterpolants(...) should correspond to an unloaded Probe Sets.

    Returns

    The InterpolationI Input Set for a given index or NULL if that Probe Set in unloaded.


    virtual bool Enlighten::IProbeSetManager::GetMaxWeightForProbeSet


    public: bool GetMaxWeightForProbeSet
    (
        Geo::GeoGuid const & probeSet,
        float & maxWeight
    ) const


    Set a maximum interpolation weight for the given Probe Set.

    . Needs to perform a search OLog(N). Where N is number of probe sets under management.

    Parameters
    [in] probeSet

    The GUID of the Probe Set.

    [out] maxWeight

    New maximum interpolation weight.

    Returns

    TRUE if the Probe Set is under ProbeSetManager management, otherwise FALSE.


    virtual Geo::s32 Enlighten::IProbeSetManager::GetNumProbeSets


    public: Geo::s32 GetNumProbeSets() const


    Get the total number of Probe Sets under management.

    Returns

    the total number of Probe Sets under management.


    virtual bool Enlighten::IProbeSetManager::GetProbeInterpolants


    public: bool GetProbeInterpolants
    (
        Geo::v128 const & point,
        ProbeInterpolant * interpolants,
        Geo::s32 numMaxInterpolants,
        Geo::s32 & numUsedInterpolants
    ) const


    Retrieves the probes interpolants for a given point.

    Only loaded Probe Sets are considered for interpolation.

    Parameters
    [in] point

    Location used for the interpolation.

    [out] interpolants

    Output probe interpolants.

    [in] numMaxInterpolants

    Size of the output interpolants array.

    [out] numUsedInterpolants

    Number of interpolants actually used.

    Returns

    TRUE if the input to this function is valid and the interpolation is successful, otherwise FALSE.


    virtual bool Enlighten::IProbeSetManager::GetProbeInterpolants


    public: bool GetProbeInterpolants
    (
        Geo::v128 const & point,
        ProbeInterpolant * interpolants,
        Geo::s32 numMaxInterpolants,
        Geo::s32 & numUsedInterpolants,
        Geo::u32 lod
    ) const


    Retrieves the probes interpolants for a given point and specified LOD.

    Only loaded Probe Sets are considered for interpolation. This interface is only supported to enable Transparency and Contributing Probe when using Probe LOD with PPPI.

    Parameters
    [in] point

    Location used for the interpolation.

    [out] interpolants

    Output probe interpolants.

    [in] numMaxInterpolants

    Size of the output interpolants array.

    [out] numUsedInterpolants

    Number of interpolants actually used.

    [in] lod

    The LOD to select which interpolants should be returned.

    Returns

    TRUE if the input to this function is valid and the interpolation is successful, otherwise FALSE.


    virtual bool Enlighten::IProbeSetManager::MarkAllProbeSetsAsUnloaded


    public: bool MarkAllProbeSetsAsUnloaded()


    Marks all Interpolation Input Sets as unloaded.

    Unloaded input sets are not used for interpolation.

    Returns

    TRUE if the InterpolationInputSet is under ProbeSetManager management and can be marked as unloaded, otherwise FALSE.


    virtual bool Enlighten::IProbeSetManager::MarkProbeSetAsLoaded


    public: bool MarkProbeSetAsLoaded
    (
        Enlighten::InterpolationInputSet const & loadedProbeSet
    )


    Marks given Interpolation Input Set as loaded.

    Only loaded input sets are used for interpolation.

    Parameters
    [in] loadedProbeSet

    The Interpolation Input Set to be marked as loaded. It has to contain a valid RadProbeSetCore field.

    Returns

    TRUE if the InterpolationInputSet is under ProbeSetManager management and can be marked as loaded, otherwise FALSE.


    virtual bool Enlighten::IProbeSetManager::MarkProbeSetAsUnloaded


    public: bool MarkProbeSetAsUnloaded
    (
        Geo::GeoGuid const & unloadedProbeSet
    )


    Marks given Interpolation Input Set as unloaded.

    Unloaded input sets are not used for interpolation.

    Parameters
    [in] unloadedProbeSet

    The GUID of the Probe Set to be marked as unloaded.

    Returns

    TRUE if the InterpolationInputSet is under ProbeSetManager management and can be marked as unloaded, otherwise FALSE.


    virtual void Enlighten::IProbeSetManager::OnAllLoadedProbeSetsArrayChanged


    public: virtual void OnAllLoadedProbeSetsArrayChanged
    (
        Enlighten::InterpolationInputSet const * allLoadedProbeSets,
        Geo::s32 numLoadedProbeSets
    )


    Allows the probe set manager a chance to observe the contiguous memory block in which the runtime stores all loaded input sets.

    The manager can then use this knowledge to speed up other operations as needed (e.g. if the manager's implementation of GetProbeInterpolants() uses the variant of Enlighten::GetProbeInterpolants() supporting multiple probe sets). Note that multiple load and unload notifications (as noted by MarkProbeSetAsLoaded and MarkProbeSetAsUnloaded, respectively) may be batched into a single call to this function.

    Parameters
    [in] allLoadedProbeSets

    Starting address of the input set array managed by the runtime.

    [in] numLoadedProbeSets

    Size of the input set array.


    virtual bool Enlighten::IProbeSetManager::SetMaxWeightForProbeSet


    public: bool SetMaxWeightForProbeSet
    (
        Geo::GeoGuid const & probeSet,
        float maxWeight
    )


    Set a maximum interpolation weight for the given Probe Set.

    Needs to perform a search OLog(N). Where N is number of probe sets under management.

    Parameters
    [in] probeSet

    The GUID of the Probe Set.

    [in] maxWeight

    New maximum interpolation weight. Has to be a value between 0.0 and 1.0

    Returns

    TRUE if the Probe Set is under ProbeSetManager management, otherwise FALSE.

    , multiple selections available,
    {"serverDuration": 10, "requestCorrelationId": "ade4e869e4ec49298c2fa83296d11748"}