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 IMeshSimpOutput
  • class Enlighten ImporterScene
  • class Enlighten IncidentLightingBuffer
  • class Enlighten IndirectInputLightingInternalParameters
  • class Enlighten IndirectInputLightingParameters
  • class Enlighten InputLightBase
  • class Enlighten InputLightFalloffTable
  • class Enlighten InputLightingBuffer
  • class Enlighten InputOctreeBuilder
  • 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 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
    Calendars
You‘re viewing this with anonymous access, so some content might be blocked.
/
class Enlighten IPrecompProbeSetBuildParameters

    This is the documentation for Enlighten.

    class Enlighten IPrecompProbeSetBuildParameters

    Nov 21, 2019

    class Enlighten::IPrecompProbeSetBuildParameters

    A class defining parameters for SH sample probe building.

    Functions

    Name Description
    GetBudget()

    The number of form factors to store per output sample.

    GetCoefficientBasisX()

    The basis vectors for the probe coefficients.

    GetCoefficientBasisY()

    The basis vectors for the probe coefficients.

    GetCoefficientBasisZ()

    The basis vectors for the probe coefficients.

    GetCoefficientOrder()

    The desired output order of the coefficients.

    GetCullingThreshold()

    Determines the threshold of valid visibility below which a point is culled.

    GetDependencyIncludedSystemDistance()

    Bounding box of the probe set (i.e. bounding box containing all the probes) whose dependencies are being calculated is.

    GetDependencyLocalityDistance()

    Maximum distance at which a given system will be considered local.

    GetDependencyVisibilityThreshold()

    Do not consider a system as a dependency if its visibility is smaller than the threshold.

    GetEnvironmentResolution()

    The resolution for each face of the environment map.

    GetErrorThreshold()

    Determines the threshold of interpolation error below which a point may be removed.

    GetExcludeEnvironmentInPrimaryBounce()

    Whether to exclude environment when solving the probes directly.

    GetIndividualProbes()

    Whether to treat the probes in this set entirely individually, and disable optimisations in the EntireProbeSetSolver which share data between probes.

    GetNumEnvironmentVisibilitySHCoefficients()

    The number of SH coefficients used for environment visibility.

    GetNumSHCoefficients()

    The number of SH coefficients used.

    GetQuality()

    The number of rays to cast for computing form factors.

    GetUseCulling()

    Whether to cull probes that are not in valid locations.

    GetVisibilityThreshold()

    The necessary visibility of a cluster to be used as form factor.

    SetBudget(Geo::s32)

    The number of form factors to store per output sample.

    SetCoefficientBasis(const Geo::v128 &, const Geo::v128 &, const Geo::v128 &)

    The basis vectors for the probe coefficients.

    SetCoefficientOrder(const Geo::s8 *)

    The desired output order of the coefficients.

    SetCullingThreshold(float)

    Determines the threshold of valid visibility below which a point is culled.

    SetDependencyIncludedSystemDistance(float)

    Bounding box of the probe set (i.e. bounding box containing all the probes) whose dependencies are being calculated is.

    SetDependencyLocalityDistance(float)

    Maximum distance at which a given system will be considered local.

    SetDependencyVisibilityThreshold(float)

    Do not consider a system as a dependency if its visibility is smaller than the threshold.

    SetEnvironmentResolution(Geo::s32)

    The resolution for each face of the environment map.

    SetErrorThreshold(float)

    Determines the threshold of interpolation error below which a point may be removed.

    SetExcludeEnvironmentInPrimaryBounce(bool)

    Whether to exclude environment when solving the probes directly.

    SetIndividualProbes(bool)

    Whether to treat the probes in this set entirely individually, and disable optimisations in the EntireProbeSetSolver which share data between probes.

    SetNumEnvironmentVisibilitySHCoefficients(Geo::s32)

    The number of SH coefficients used for environment visibility.

    SetNumSHCoefficients(Geo::s32)

    The number of SH coefficients used.

    SetQuality(Geo::s32)

    The number of rays to cast for computing form factors.

    SetUseCulling(bool)

    Whether to cull probes that are not in valid locations.

    SetVisibilityThreshold(float)

    The necessary visibility of a cluster to be used as form factor.


    virtual Geo::s32 Enlighten::IPrecompProbeSetBuildParameters::GetBudget

    public: Geo::s32 GetBudget() const

    The number of form factors to store per output sample.


    virtual const Geo::v128& Enlighten::IPrecompProbeSetBuildParameters::GetCoefficientBasisX

    public: const Geo::v128 & GetCoefficientBasisX() const

    The basis vectors for the probe coefficients.

    Must be axis aligned and orthonormal. Defaults to (+x, +y, +z).


    virtual const Geo::v128& Enlighten::IPrecompProbeSetBuildParameters::GetCoefficientBasisY

    public: const Geo::v128 & GetCoefficientBasisY() const

    The basis vectors for the probe coefficients.

    Must be axis aligned and orthonormal. Defaults to (+x, +y, +z).


    virtual const Geo::v128& Enlighten::IPrecompProbeSetBuildParameters::GetCoefficientBasisZ

    public: const Geo::v128 & GetCoefficientBasisZ() const

    The basis vectors for the probe coefficients.

    Must be axis aligned and orthonormal. Defaults to (+x, +y, +z).


    virtual const Geo::s8* Enlighten::IPrecompProbeSetBuildParameters::GetCoefficientOrder

    public: const Geo::s8 * GetCoefficientOrder() const

    The desired output order of the coefficients.

    Must be called after SetNumSHCoefficients. The length of the array must be 4 for L1 probe sets, and 9 for L2. Each value maps the indexed coefficient to the position of the index in the coefficientOrder array. By default the order is {012345678} which maps to an output order of: Y_00, Y_11, Y_10, Y_1-1; Y_20, Y_21, Y_2-1, Y_2-2, Y_22


    virtual float Enlighten::IPrecompProbeSetBuildParameters::GetCullingThreshold

    public: float GetCullingThreshold() const

    Determines the threshold of valid visibility below which a point is culled.


    virtual float Enlighten::IPrecompProbeSetBuildParameters::GetDependencyIncludedSystemDistance

    public: float GetDependencyIncludedSystemDistance() const

    Bounding box of the probe set (i.e. bounding box containing all the probes) whose dependencies are being calculated is.

    All systems whose bounding boxes intersect this expanded bounding box will be fully represented in ray tracing when calculating dependencies. Other systems will be represented as bounding boxes only.


    virtual float Enlighten::IPrecompProbeSetBuildParameters::GetDependencyLocalityDistance

    public: float GetDependencyLocalityDistance() const

    Maximum distance at which a given system will be considered local.


    virtual float Enlighten::IPrecompProbeSetBuildParameters::GetDependencyVisibilityThreshold

    public: float GetDependencyVisibilityThreshold() const

    Do not consider a system as a dependency if its visibility is smaller than the threshold.

    Specify 0 to accept systems with any visibility.


    virtual Geo::s32 Enlighten::IPrecompProbeSetBuildParameters::GetEnvironmentResolution

    public: Geo::s32 GetEnvironmentResolution() const

    The resolution for each face of the environment map.


    virtual float Enlighten::IPrecompProbeSetBuildParameters::GetErrorThreshold

    public: float GetErrorThreshold() const

    Determines the threshold of interpolation error below which a point may be removed.


    virtual bool Enlighten::IPrecompProbeSetBuildParameters::GetExcludeEnvironmentInPrimaryBounce

    public: bool GetExcludeEnvironmentInPrimaryBounce() const

    Whether to exclude environment when solving the probes directly.


    virtual bool Enlighten::IPrecompProbeSetBuildParameters::GetIndividualProbes

    public: bool GetIndividualProbes() const

    Whether to treat the probes in this set entirely individually, and disable optimisations in the EntireProbeSetSolver which share data between probes.

    This is useful for probe sets of "dedicated" probes which are positioned exactly where required by static meshes, but not near each other. The default value is false.


    virtual Geo::s32 Enlighten::IPrecompProbeSetBuildParameters::GetNumEnvironmentVisibilitySHCoefficients

    public: Geo::s32 GetNumEnvironmentVisibilitySHCoefficients() const

    The number of SH coefficients used for environment visibility.

    Can be Enlighten::SH_ORDER_DISABLED, Enlighten::SH_ORDER_L0, Enlighten::SH_ORDER_L1 or Enlighten::SH_ORDER_L2.


    virtual Geo::s32 Enlighten::IPrecompProbeSetBuildParameters::GetNumSHCoefficients

    public: Geo::s32 GetNumSHCoefficients() const

    The number of SH coefficients used.

    Can be Enlighten::SH_ORDER_L1 or Enlighten::SH_ORDER_L2.


    virtual Geo::s32 Enlighten::IPrecompProbeSetBuildParameters::GetQuality

    public: Geo::s32 GetQuality() const

    The number of rays to cast for computing form factors.


    virtual bool Enlighten::IPrecompProbeSetBuildParameters::GetUseCulling

    public: bool GetUseCulling() const

    Whether to cull probes that are not in valid locations.


    virtual float Enlighten::IPrecompProbeSetBuildParameters::GetVisibilityThreshold

    public: float GetVisibilityThreshold() const

    The necessary visibility of a cluster to be used as form factor.


    virtual void Enlighten::IPrecompProbeSetBuildParameters::SetBudget

    public: void SetBudget
    (
        Geo::s32 budget
    )

    The number of form factors to store per output sample.


    virtual void Enlighten::IPrecompProbeSetBuildParameters::SetCoefficientBasis

    public: void SetCoefficientBasis
    (
        const Geo::v128 & basisX,
        const Geo::v128 & basisY,
        const Geo::v128 & basisZ
    )

    The basis vectors for the probe coefficients.

    Must be axis aligned and orthonormal. Defaults to (+x, +y, +z).


    virtual void Enlighten::IPrecompProbeSetBuildParameters::SetCoefficientOrder

    public: void SetCoefficientOrder
    (
        const Geo::s8 * coefficientOrder
    )

    The desired output order of the coefficients.

    Must be called after SetNumSHCoefficients. The length of the array must be 4 for L1 probe sets, and 9 for L2. Each value maps the indexed coefficient to the position of the index in the coefficientOrder array. By default the order is {012345678} which maps to an output order of: Y_00, Y_11, Y_10, Y_1-1; Y_20, Y_21, Y_2-1, Y_2-2, Y_22


    virtual void Enlighten::IPrecompProbeSetBuildParameters::SetCullingThreshold

    public: void SetCullingThreshold
    (
        float cullingThreshold
    )

    Determines the threshold of valid visibility below which a point is culled.


    virtual void Enlighten::IPrecompProbeSetBuildParameters::SetDependencyIncludedSystemDistance

    public: void SetDependencyIncludedSystemDistance
    (
        float v
    )

    Bounding box of the probe set (i.e. bounding box containing all the probes) whose dependencies are being calculated is.

    All systems whose bounding boxes intersect this expanded bounding box will be fully represented in ray tracing when calculating dependencies. Other systems will be represented as bounding boxes only.


    virtual void Enlighten::IPrecompProbeSetBuildParameters::SetDependencyLocalityDistance

    public: void SetDependencyLocalityDistance
    (
        float v
    )

    Maximum distance at which a given system will be considered local.


    virtual void Enlighten::IPrecompProbeSetBuildParameters::SetDependencyVisibilityThreshold

    public: void SetDependencyVisibilityThreshold
    (
        float v
    )

    Do not consider a system as a dependency if its visibility is smaller than the threshold.

    Specify 0 to accept systems with any visibility.


    virtual void Enlighten::IPrecompProbeSetBuildParameters::SetEnvironmentResolution

    public: void SetEnvironmentResolution
    (
        Geo::s32 v
    )

    The resolution for each face of the environment map.


    virtual void Enlighten::IPrecompProbeSetBuildParameters::SetErrorThreshold

    public: void SetErrorThreshold
    (
        float errorThreshold
    )

    Determines the threshold of interpolation error below which a point may be removed.


    virtual void Enlighten::IPrecompProbeSetBuildParameters::SetExcludeEnvironmentInPrimaryBounce

    public: void SetExcludeEnvironmentInPrimaryBounce
    (
        bool v
    )

    Whether to exclude environment when solving the probes directly.


    virtual void Enlighten::IPrecompProbeSetBuildParameters::SetIndividualProbes

    public: void SetIndividualProbes
    (
        bool b
    )

    Whether to treat the probes in this set entirely individually, and disable optimisations in the EntireProbeSetSolver which share data between probes.

    This is useful for probe sets of "dedicated" probes which are positioned exactly where required by static meshes, but not near each other. The default value is false.


    virtual void Enlighten::IPrecompProbeSetBuildParameters::SetNumEnvironmentVisibilitySHCoefficients

    public: void SetNumEnvironmentVisibilitySHCoefficients
    (
        Geo::s32 numCoefficients
    )

    The number of SH coefficients used for environment visibility.

    Can be Enlighten::SH_ORDER_DISABLED, Enlighten::SH_ORDER_L0, Enlighten::SH_ORDER_L1 or Enlighten::SH_ORDER_L2.


    virtual void Enlighten::IPrecompProbeSetBuildParameters::SetNumSHCoefficients

    public: void SetNumSHCoefficients
    (
        Geo::s32 numCoefficients
    )

    The number of SH coefficients used.

    Can be Enlighten::SH_ORDER_L1 or Enlighten::SH_ORDER_L2.


    virtual void Enlighten::IPrecompProbeSetBuildParameters::SetQuality

    public: void SetQuality
    (
        Geo::s32 quality
    )

    The number of rays to cast for computing form factors.


    virtual void Enlighten::IPrecompProbeSetBuildParameters::SetUseCulling

    public: void SetUseCulling
    (
        bool useCulling
    )

    Whether to cull probes that are not in valid locations.


    virtual void Enlighten::IPrecompProbeSetBuildParameters::SetVisibilityThreshold

    public: void SetVisibilityThreshold
    (
        float visibilityThreshold
    )

    The necessary visibility of a cluster to be used as form factor.

    , multiple selections available,
    {"serverDuration": 9, "requestCorrelationId": "6a93990cfd3f4f5ab5adc7491bb1a1af"}