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 4.03 Documentation
Results will update as you type.
  • class Enlighten IPrecompute
  • class Enlighten IProbeSetManager
  • class Enlighten IrradianceOutputDesc
  • class Enlighten ISystemSolutionSpace
  • class Enlighten IThreadGroup
  • class Enlighten IUpdateManager
  • class Enlighten IUpdateManagerWorker
  • class Enlighten LightMethodSelector
  • class Enlighten LightTransportPixel
  • class Enlighten LightValue64
  • class Enlighten LightValueIterator
  • class Enlighten Line2D
  • 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 MultithreadCpuUpdateManager
  • class Enlighten MultithreadCpuWorker
  • class Enlighten MultithreadCpuWorkerCommon
  • class Enlighten NullGeometryTransparencySampler
  • class Enlighten NullMaterialEmissiveSampler
  • class Enlighten NullMaterialTransparencySampler
  • class Enlighten NullSampler
  • class Enlighten OctreeSearchResult
  • class Enlighten PackedDusterPoint
  • class Enlighten PipelineBoxSetProbeRegion
  • class Enlighten PipelineCubemap
  • class Enlighten PipelineError
  • class Enlighten PipelineExcludedInstance
  • class Enlighten PipelineGeom
  • class Enlighten PipelineGeometryProperties
  • class Enlighten PipelineGlobalParameters
  • class Enlighten PipelineInstanceParameters
  • class Enlighten PipelineMesh
  • class Enlighten PipelinePaths
  • class Enlighten PipelinePointSetProbeRegion
  • class Enlighten PipelineProbeVolume
  • class Enlighten PipelineProgressBase
  • class Enlighten PipelineRadiosityInstance
  • class Enlighten PipelineScene
  • class Enlighten PipelineTransform
  • class Enlighten PipelineUnlitInstance
  • class Enlighten PipelineVolumeProbeRegion
  • class Enlighten PointLight
  • class Enlighten PointProjection
  • class Enlighten PointProjectionOptions
  • class Enlighten PointProjectionScratchMem
  • class Enlighten PointProjectionSurface
  • class Enlighten PointProjectionVersion
  • class Enlighten PppiWorld
  • class Enlighten PrecompInputFace
  • class Enlighten PrecompInputInstance
  • class Enlighten PrecompInputVertex
  • class Enlighten PrecompMaterialInfo
  • class Enlighten PrecompMeshInstanceView
  • class Enlighten PrecompMeshProperties
  • class Enlighten PrecompOctreeNode
  • class Enlighten PrecompOctreeProbeKey
  • class Enlighten PrecomputedVisibilityData
  • class Enlighten PrecomputedVisibilityWorkspace
  • class Enlighten PrecomputeParameters
  • class Enlighten PrecomputePipeline
  • class Enlighten PrecompVoxelId
  • class Enlighten PrecompVoxelOctree
  • class Enlighten PrecompVoxelOctreePath
  • class Enlighten PrecompVoxelOctreeVolume
  • class Enlighten ProbeInterpolant
  • class Enlighten ProbeInterpolationTask
  • class Enlighten ProbeSetManagerOctree
  • class Enlighten ProbeSetOctreeNode
  • class Enlighten ProbeSetVirtualProbe
  • class Enlighten ProfileHistory
    Calendars
You‘re viewing this with anonymous access, so some content might be blocked.
/
class Enlighten PipelineGlobalParameters

    This is the documentation for Enlighten.

    class Enlighten PipelineGlobalParameters

    Sept 09, 2025

    class Enlighten::PipelineGlobalParameters

    The parameters that affect the precompute for all instances in the scene.

    Variables

    Name Description
    bool m_AlignedEdgeStitching

    If true, aligned edge stitching option is on. Note this option may slow down pre-computation.

    PipelineWorldAxes m_Axes

    Whether to invert each of the X Y and Z axes of world space.

    bool m_ComputeClusterProbeSampleOffsetData

    If true, enables transmittance, aka runtime transparency.

    PipelineEnvironmentResolution m_CubemapEnvironmentResolution

    The resolution of cubemaps in the scene.

    ePrecompCubeMapQuality m_CubemapIrradianceQuality

    The number of rays to cast (per cubemap position) for computing irradiance form factors.

    bool m_CullProbes

    If true, probes are not created in areas that see invalid back-faces.

    float m_DependencyIncludedSystemDistance

    Internal.

    Geo::u32 m_DirectionalVisibilitySlices

    The number of directions for which directional-light shadows are precomputed.

    bool m_EnableValidation

    If true, report an error when any invalid object is added to the scene.

    PipelineEnvironmentResolution m_EnvironmentResolution

    The resolution of the emissive environment.

    Enlighten::EnvironmentValidity m_EnvironmentValidity

    When specified, probes are not automatically placed in areas that can see far below the horizon. This prevents automatic placement of probes in areas under and outside the world.

    bool m_ExcludeEnvironmentInPrimaryBounce

    If true, the emissive environment affects only light bounced from surfaces. Use this when you apply sky lighting in your own pixel shader.

    PipelineFormFactorBudget m_IrradianceBudget

    The number of form factors to store per lightmap pixel.

    ePrecompQuality m_IrradianceQuality

    The number of rays to cast (per sample location) for computing irradiance form factors.

    eSHOrder m_ProbeEnvironmentVisibilityShOrder

    The number of spherical harmonic coefficients computed for environment visibility.

    PipelineFormFactorBudget m_ProbeIrradianceBudget

    The number of form factors to store per probe.

    ePrecompQuality m_ProbeIrradianceQuality

    The number of rays to cast (per probe position) for computing irradiance form factors.

    PipelineProbeLodBias m_ProbeLodBias

    The number of LOD levels by which to reduce the maximum distance at which per pixel probe lighting falls back to sky lighting.

    float m_ProbeRegionErrorThreshold

    To trade density of generated probes for accuracy.

    float m_ProbeRegionVoxelSize

    The minimum spacing between probes created for a probe octree.

    eSHOrder m_ProbeShOrder

    The number of spherical harmonic coefficients computed for probe output.

    Geo::u32 m_SamplesPerCluster

    The number of input lighting samples (duster points) created per cluster.

    Geo::GeoVector3 m_TerrainU

    When using terrain LOD: the horizontal axis of the terrain heightmap.

    Geo::GeoVector3 m_TerrainV

    When using terrain LOD: the vertical axis of the terrain heightmap.

    float m_WaterPlane

    If the value is not WaterPlaneInvalid, probes placed over terrain are allowed only above the plane defined by this distance and the world up axis.

    const float WaterPlaneInvalid

    Represents an unspecified water plane.

    Functions

    Name Description
    PipelineGlobalParameters(PipelineWorldAxes, float)

    Constructor.


    Enlighten::PipelineGlobalParameters::PipelineGlobalParameters

    public: PipelineGlobalParameters
    (
        PipelineWorldAxes axes,
        float probeRegionVoxelSize
    )

    Constructor.

    , multiple selections available,
    {"serverDuration": 8, "requestCorrelationId": "f4317eaadf7347d2a322a5d973709085"}