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 IBakeOutputProbeSetVisibility
  • class Enlighten IBakeOutputSystemAO
  • class Enlighten IBakeOutputSystemDirect
  • class Enlighten IBakeOutputSystemFinalGather
  • class Enlighten IBakeOutputSystemIndirect
  • class Enlighten IBakeOutputSystemRadiosityNormal
  • class Enlighten IBakeOutputSystemVisibility
  • class Enlighten IBakeRuntimeLighting
  • class Enlighten IBakeSolvedRuntime
  • class Enlighten IBakeSystemResource
  • class Enlighten IBakeTextureManager
  • class Enlighten IBakeVisibilityBuffer
  • class Enlighten IClusteringOutput
  • class Enlighten IGpuTexture
  • class Enlighten IGpuTextureAllocator
  • class Enlighten IGpuTextureUpdater
  • class Enlighten ILightTransportOutput
  • class Enlighten ILimiter
  • class Enlighten ILogHandler
  • 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
    Calendars
You‘re viewing this with anonymous access, so some content might be blocked.
/
class Enlighten IPrecompCubeMapBuildParameters

    This is the documentation for Enlighten.

    class Enlighten IPrecompCubeMapBuildParameters

    Nov 21, 2019

    class Enlighten::IPrecompCubeMapBuildParameters

    Precompute parameters for cube maps.

    Please see the Technical Guide in the main SDK document for full documentation of these parameters and their use.

    Functions

    Name Description
    GetBudget()

    The number of form factors to store per output sample.

    GetDependencyIncludedSystemDistance()

    Bounding box (-this distance; +this distance) in all directions is created around the location of the cube map.

    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.

    GetQuality()

    The number of rays to cast for computing form factors.

    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.

    SetDependencyIncludedSystemDistance(float)

    Bounding box (-this distance; +this distance) in all directions is created around the location of the cube map.

    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.

    SetQuality(Geo::s32)

    The number of rays to cast for computing form factors.

    SetVisibilityThreshold(float)

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


    virtual Geo::s32 Enlighten::IPrecompCubeMapBuildParameters::GetBudget

    public: Geo::s32 GetBudget() const

    The number of form factors to store per output sample.


    virtual float Enlighten::IPrecompCubeMapBuildParameters::GetDependencyIncludedSystemDistance

    public: float GetDependencyIncludedSystemDistance() const

    Bounding box (-this distance; +this distance) in all directions is created around the location of the cube map.

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


    virtual float Enlighten::IPrecompCubeMapBuildParameters::GetDependencyLocalityDistance

    public: float GetDependencyLocalityDistance() const

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


    virtual float Enlighten::IPrecompCubeMapBuildParameters::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::IPrecompCubeMapBuildParameters::GetEnvironmentResolution

    public: Geo::s32 GetEnvironmentResolution() const

    The resolution for each face of the environment map.


    virtual Geo::s32 Enlighten::IPrecompCubeMapBuildParameters::GetQuality

    public: Geo::s32 GetQuality() const

    The number of rays to cast for computing form factors.


    virtual float Enlighten::IPrecompCubeMapBuildParameters::GetVisibilityThreshold

    public: float GetVisibilityThreshold() const

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


    virtual void Enlighten::IPrecompCubeMapBuildParameters::SetBudget

    public: void SetBudget
    (
        Geo::s32 budget
    )

    The number of form factors to store per output sample.


    virtual void Enlighten::IPrecompCubeMapBuildParameters::SetDependencyIncludedSystemDistance

    public: void SetDependencyIncludedSystemDistance
    (
        float v
    )

    Bounding box (-this distance; +this distance) in all directions is created around the location of the cube map.

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


    virtual void Enlighten::IPrecompCubeMapBuildParameters::SetDependencyLocalityDistance

    public: void SetDependencyLocalityDistance
    (
        float v
    )

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


    virtual void Enlighten::IPrecompCubeMapBuildParameters::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::IPrecompCubeMapBuildParameters::SetEnvironmentResolution

    public: void SetEnvironmentResolution
    (
        Geo::s32 v
    )

    The resolution for each face of the environment map.


    virtual void Enlighten::IPrecompCubeMapBuildParameters::SetQuality

    public: void SetQuality
    (
        Geo::s32 quality
    )

    The number of rays to cast for computing form factors.


    virtual void Enlighten::IPrecompCubeMapBuildParameters::SetVisibilityThreshold

    public: void SetVisibilityThreshold
    (
        float visibilityThreshold
    )

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

    , multiple selections available,
    {"serverDuration": 9, "requestCorrelationId": "adb0482c69774980b88b5b12f3eea1db"}