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 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
  • class Enlighten RadCubeMapCore
    Calendars
You‘re viewing this with anonymous access, so some content might be blocked.
/
class Enlighten PppiWorld

    This is the documentation for Enlighten.

    class Enlighten PppiWorld

    Nov 21, 2019

    class Enlighten::PppiWorld

    Updates output textures for all probe sets in the world.

    Functions

    Name Description
    AddProbeSet(const RadProbeSetCore *, float *)

    Add a probe set to the world.

    GetAtlasBlockCount()

    Returns the number of blocks currently allocated within the atlas.

    GetRequiredOutputTextures(PppiConfiguration)

    Returns the required textures. Always provide the same configuration to the constructor of PppiWorld.

    PppiWorld(PppiConfiguration)

    Construct with an optional configuration.

    ProbeSetOutputChanged(PppiProbeSetHandle, PppiProbeSetLod)

    Notify that the probe output changed for the given probe set.

    RemoveProbeSet(PppiProbeSetHandle)

    Remove a probe set from the world.

    SetOutputWorkspace(const PppiOutputWorkspace &, IPppiTextureUpdateHandler *)

    Use the provided output textures.

    Update(UpdatePppiStats &, const Geo::v128 &, const IViewVolumeIntersector *, float)

    Update indirection texture based on the view origin.

    UpdateBorder(const PppiIrradiance &)

    Update the lighting for areas not covered by any probe set.


    PppiProbeSetHandle Enlighten::PppiWorld::AddProbeSet

    public: PppiProbeSetHandle AddProbeSet
    (
        const RadProbeSetCore * probeSet,
        float * probeOutput
    )

    Add a probe set to the world.

    Parameters
    [in] probeSet

    The probe set to add

    [in] probeOutput

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


    Geo::s32 Enlighten::PppiWorld::GetAtlasBlockCount

    public: Geo::s32 GetAtlasBlockCount() const

    Returns the number of blocks currently allocated within the atlas.

    Use this to determine the appropriate size of the atlas.


    static PppiOutputTextureRequirements Enlighten::PppiWorld::GetRequiredOutputTextures

    public: PppiOutputTextureRequirements GetRequiredOutputTextures
    (
        PppiConfiguration configuration
    )

    Returns the required textures. Always provide the same configuration to the constructor of PppiWorld.


    Enlighten::PppiWorld::PppiWorld

    public: PppiWorld
    (
        PppiConfiguration configuration
    )

    Construct with an optional configuration.


    void Enlighten::PppiWorld::ProbeSetOutputChanged

    public: void ProbeSetOutputChanged
    (
        PppiProbeSetHandle handle,
        PppiProbeSetLod lod
    )

    Notify that the probe output changed for the given probe set.

    Call before Update()

    Parameters
    [in] handle

    The handle of the probe set that was solved.

    [in] lod

    The level of detail at which the probe set was solved.


    void Enlighten::PppiWorld::RemoveProbeSet

    public: void RemoveProbeSet
    (
        PppiProbeSetHandle handle
    )

    Remove a probe set from the world.

    Parameters
    [in] handle

    The handle of the probe set to remove


    void Enlighten::PppiWorld::SetOutputWorkspace

    public: void SetOutputWorkspace
    (
        const PppiOutputWorkspace & outputWorkspace,
        IPppiTextureUpdateHandler * updateHandler
    )

    Use the provided output textures.

    Call before adding the first probe set.

    Parameters
    [in] outputWorkspace

    The output textures.

    [in] updateHandler

    If non-null, will be called after partial updates of the output textures. Owned by the caller. May be called at any time before PppiWorld is destroyed.


    PppiShaderParameters Enlighten::PppiWorld::Update

    public: PppiShaderParameters Update
    (
        UpdatePppiStats & outStats,
        const Geo::v128 & viewOrigin,
        const IViewVolumeIntersector * viewVolume,
        float lodDistance
    )

    Update indirection texture based on the view origin.

    Update atlas texture with output for all probe sets that changed since the last update.

    Parameters
    [out] outStats

    Profile numbers for the update.

    [in] viewOrigin

    The position in world units at which the greatest level of detail is required. This is usually the camera position.

    [in] viewVolume

    The view volume within which probe sets are updated.

    [in] lodDistance

    The distance in voxel units from the view origin at which to begin reduction of the level of detail, zero for maximum.


    void Enlighten::PppiWorld::UpdateBorder

    public: void UpdateBorder
    (
        const PppiIrradiance & border
    )

    Update the lighting for areas not covered by any probe set.

    , multiple selections available,
    {"serverDuration": 10, "requestCorrelationId": "15cf9dad081b4506929b3e9c1ac3293b"}