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 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
  • class Enlighten PipelineExcludedInstance
  • class Enlighten PipelineGeom
  • class Enlighten PipelineGeometryProperties
  • class Enlighten PipelineGlobalParameters
  • class Enlighten PipelineInstanceParameters
  • class Enlighten PipelineLineWriter
  • class Enlighten PipelineMesh
  • class Enlighten PipelinePaths
  • class Enlighten PipelineProbeRegion
  • class Enlighten PipelineProbeVolume
  • class Enlighten PipelineRadiosityInstance
  • class Enlighten PipelineScene
  • class Enlighten PipelineTransform
  • class Enlighten PointLight
  • class Enlighten PointLightMeta
  • class Enlighten PointProjection
  • class Enlighten PointProjectionOptions
  • class Enlighten PointProjectionScratchMem
  • class Enlighten PointProjectionSurface
  • class Enlighten PointProjectionVersion
  • class Enlighten PppiManager
  • class Enlighten PppiWorld
  • class Enlighten PrecompInputAutoProbeVolume
  • class Enlighten PrecompInputFace
  • class Enlighten PrecompInputInstance
  • class Enlighten PrecompInputOctreeBoxSet
  • class Enlighten PrecompInputOctreePointSet
  • class Enlighten PrecompInputOctreeVolume
  • class Enlighten PrecompInputVertex
  • class Enlighten PrecompMaterialInfo
  • class Enlighten PrecompMeshProperties
  • class Enlighten PrecompOctreeNode
  • class Enlighten PrecompOctreeProbeKey
  • class Enlighten PrecomputedVisibilityData
  • class Enlighten PrecomputedVisibilityWorkspace
  • class Enlighten PrecomputeError
  • class Enlighten PrecomputeLoaderBuilder
  • class Enlighten PrecomputeParameters
  • class Enlighten PrecomputePipeline
  • class Enlighten PrecomputeProcess
  • class Enlighten PrecompVolumeQueryBox
  • class Enlighten PrecompVoxelId
  • class Enlighten PrecompVoxelOctree
  • class Enlighten PrecompVoxelOctreePath
  • class Enlighten PrecompVoxelOctreeVolume
  • class Enlighten ProbeBounceBuffer
  • class Enlighten ProbeBounceWorkspace
  • class Enlighten ProbeInterpolant
  • class Enlighten ProbeInterpolationTask
  • class Enlighten ProbeSetDataBlock
  • class Enlighten ProbeSetManagerVoxel
  • class Enlighten ProbeSetMeta
  • class Enlighten ProbeSetOctreeNode
  • class Enlighten ProbeSetVirtualProbe
  • class Enlighten ProfileHistory
  • class Enlighten QuadIterator
  • class Enlighten QuadShader
  • class Enlighten QuickFlatClusterShader
  • class Enlighten QuickQuadShader
  • class Enlighten R9G9B9E5CpuTextureSampler
  • class Enlighten R11G11B10CpuTextureSampler
    Calendars
You‘re viewing this with anonymous access, so some content might be blocked.
/
class Enlighten PppiManager

    This is the documentation for Enlighten.

    class Enlighten PppiManager

    Nov 21, 2019

    class Enlighten::PppiManager

    Class that manages the various resources needed for octree probe interpolation.

    Notably: The auxiliary data for probe sets that need to be written to the atlas The atlas of probe sets The indirection map referencing the atlas

    Functions

    Name Description
    AddProbeSet(const Enlighten::RadProbeSetCore *, float *)

    Adds a probe set to the PppiManager.

    BeginUpdate()

    Must be called before updates to the PppiManager, including adding/removing/updating probe sets and moving the view origin.

    BeginUpdate(const PppiIrradiance &)

    Must be called before updates to the PppiManager, including adding/removing/updating probe sets and moving the view origin.

    EndUpdate()

    Call this after all updates to the PppiManager are complete at the end of the frame. /.

    GetAtlasNumAllocatedBlocks()

    Get the number of blocks currently allocated within the atlas.

    GetAtlasTextureSize()

    Gets the edge length of the atlas 3D volume texture.

    GetIndirectionClipmapOrigin()

    Gets the world-space quantised origin of the indirection clipmap.

    GetVoxelSize()

    Get voxel size.

    HasProbeSet(const Enlighten::RadProbeSetCore *)

    Checks whether a probe set is part of the PppiManager.

    Init(const PppiOutputWorkspace &)

    Initialises the PppiManager with the given textures.

    RemoveProbeSet(const Enlighten::RadProbeSetCore *)

    Removes a probe set from the PppiManager.

    SetViewOrigin(const Geo::v128 &)

    Sets the viewer's origin in the world.

    UpdateProbeSet(const Enlighten::RadProbeSetCore *, Geo::s32, bool, UpdatePppiAtlasStats &)

    Updates a probe set, writing its values to the Atlas.


    void Enlighten::PppiManager::AddProbeSet

    public: void AddProbeSet
    (
        const Enlighten::RadProbeSetCore * probeSet,
        float * ProbeOutput
    )

    Adds a probe set to the PppiManager.

    Parameters
    [in] probeSet

    The probe set to add

    [in] ProbeOutput

    The output buffer where this probe set's values will be written


    void Enlighten::PppiManager::BeginUpdate

    public: void BeginUpdate()

    Must be called before updates to the PppiManager, including adding/removing/updating probe sets and moving the view origin.


    void Enlighten::PppiManager::BeginUpdate

    public: void BeginUpdate
    (
        const PppiIrradiance & border
    )

    Must be called before updates to the PppiManager, including adding/removing/updating probe sets and moving the view origin.


    UpdateRegions Enlighten::PppiManager::EndUpdate

    public: UpdateRegions EndUpdate()

    Call this after all updates to the PppiManager are complete at the end of the frame. /.

    Returns

    The set of regions within the PPPI output textures that have been updated and therefore need uploading to the GPU.


    Geo::s32 Enlighten::PppiManager::GetAtlasNumAllocatedBlocks

    public: Geo::s32 GetAtlasNumAllocatedBlocks() const

    Get the number of blocks currently allocated within the atlas.


    Geo::s32 Enlighten::PppiManager::GetAtlasTextureSize

    public: Geo::s32 GetAtlasTextureSize() const

    Gets the edge length of the atlas 3D volume texture.


    Geo::GeoPoint3D Enlighten::PppiManager::GetIndirectionClipmapOrigin

    public: Geo::GeoPoint3D GetIndirectionClipmapOrigin() const

    Gets the world-space quantised origin of the indirection clipmap.


    float Enlighten::PppiManager::GetVoxelSize

    public: float GetVoxelSize() const

    Get voxel size.

    Returns

    The size in world units of each leaf node in the octree


    bool Enlighten::PppiManager::HasProbeSet

    public: bool HasProbeSet
    (
        const Enlighten::RadProbeSetCore * probeSet
    ) const

    Checks whether a probe set is part of the PppiManager.

    Parameters
    [in] probeSet

    The probe set

    Returns

    true if the probe set is part of the PppiManager


    UpdateRegions Enlighten::PppiManager::Init

    public: UpdateRegions Init
    (
        const PppiOutputWorkspace & outputWorkspace
    )

    Initialises the PppiManager with the given textures.

    Parameters
    [in] outputWorkspace

    The PPPI output textures that will be updated.


    void Enlighten::PppiManager::RemoveProbeSet

    public: void RemoveProbeSet
    (
        const Enlighten::RadProbeSetCore * probeSet
    )

    Removes a probe set from the PppiManager.

    Parameters
    [in] probeSet

    The probe set to remove


    void Enlighten::PppiManager::SetViewOrigin

    public: void SetViewOrigin
    (
        const Geo::v128 & ViewOrigin
    )

    Sets the viewer's origin in the world.

    This needs to be called to keep the indirection map valid

    Parameters
    [in] ViewOrigin

    The origin the indirection map shall be centered around


    void Enlighten::PppiManager::UpdateProbeSet

    public: void UpdateProbeSet
    (
        const Enlighten::RadProbeSetCore * probeSet,
        Geo::s32 lod,
        bool probeOutputDirty,
        UpdatePppiAtlasStats & outStats
    )

    Updates a probe set, writing its values to the Atlas.

    Parameters
    [in] probeSet

    The probe set to update

    [in] lod

    The desired lod level

    [in] probeOutputDirty

    Has the probe set output changed since the last update.

    [out] outStats

    Will be updated to contain useful profiling stats.

    , multiple selections available,
    {"serverDuration": 12, "requestCorrelationId": "9528d738ebac4736b2614b2ebc90c156"}