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 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
  • 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 PipelineRadiosityInstance

    This is the documentation for Enlighten.

    class Enlighten PipelineRadiosityInstance

    Sept 09, 2025

    class Enlighten::PipelineRadiosityInstance

        └>Enlighten::PipelineRadiosityProperties

    An instance object, corresponding to an <instance> element in the .scene file.

    Typedefs

    Name Description
    PipelineInstanceMaterial MaterialOverride

    Overrides the nth material of each mesh with the geometry object.

    Geo::GeoArray< MaterialOverride > MaterialOverrides

    An array of MaterialOverride instances.

    Variables

    Name Description
    Geo::GeoFileString m_BakeLightmapName

    Used only for baked lighting. Specify the name of the atlas into which the baked lightmap for this instance is packed.

    Geo::GeoFileString m_BakeLightmapType

    Used only for baked lighting. Specify the parameters of the baked lightmap for this instance.

    Geo::GeoFileString m_Geom

    The key of the geom this instance references.

    Geo::GeoFileString m_Group

    (optional) The name of the group the instance is associated with. Prevents automatic grouping of this instance.

    const PipelineRadiosityGroupType m_GroupType

    Whether the instance group can be automatically split by the precompute.

    Geo::GeoGuid m_Guid

    The globally unique identifier of this instance.

    PipelineRadiosityLightingType m_Lighting

    The way an instance receives Enlighten lighting output.

    MaterialOverrides m_Materials

    Overrides the materials specified in the geom.

    Geo::GeoFileString m_Name

    The name of this instance.

    Geo::GeoFileString m_Paramset

    The name of the paramset the instance refers to, found within the .paramset file.

    Geo::GeoFileString m_ProbeParamset

    The optional name of the probe parameter set associated with the probes placed for this instance.

    ProbeOctreeResolution m_ProbeResolution

    The resolution at which probes are placed to provide lighting for this instance.

    PipelineRadiosityShadowType m_Shadow

    Whether this instance casts an indirect shadow.

    PipelineTransform m_Transform

    The local to world transform.

    Geo::GeoFileString m_Zone

    The name of the zone the instance is associated with.

    Functions

    Name Description
    LightmapRadiosity()

    An instance with these properties is included in the radiosity computation and lit using a lightmap.

    PipelineRadiosityInstance(Geo::GeoFileString, Geo::GeoFileString, PipelineRadiosityProperties, Geo::GeoFileString, Geo::GeoFileString, PipelineTransform, MaterialOverrides)

    Constructor.

    PipelineRadiosityInstance(Geo::GeoFileString, Geo::GeoFileString, PipelineRadiosityProperties, PipelineRadiosityGroupType, Geo::GeoFileString, Geo::GeoFileString, PipelineTransform, MaterialOverrides)

    Constructor.

    PipelineRadiosityProperties(PipelineRadiosityLightingType, PipelineRadiosityShadowType)

    Constructor.

    ProbeRadiosity()

    An instance with these properties is included in the radiosity computation and lit using probes.


    static PipelineRadiosityProperties Enlighten::PipelineRadiosityProperties::LightmapRadiosity

    public: PipelineRadiosityProperties LightmapRadiosity()

    An instance with these properties is included in the radiosity computation and lit using a lightmap.


    Enlighten::PipelineRadiosityInstance::PipelineRadiosityInstance

    public: PipelineRadiosityInstance
    (
        Geo::GeoFileString name,
        Geo::GeoFileString geom,
        PipelineRadiosityProperties properties,
        Geo::GeoFileString zone,
        Geo::GeoFileString paramset,
        PipelineTransform transform,
        MaterialOverrides materials
    )

    Constructor.


    Enlighten::PipelineRadiosityInstance::PipelineRadiosityInstance

    public: PipelineRadiosityInstance
    (
        Geo::GeoFileString name,
        Geo::GeoFileString geom,
        PipelineRadiosityProperties properties,
        PipelineRadiosityGroupType groupType,
        Geo::GeoFileString group,
        Geo::GeoFileString paramset,
        PipelineTransform transform,
        MaterialOverrides materials
    )

    Constructor.


    Enlighten::PipelineRadiosityProperties::PipelineRadiosityProperties

    public: PipelineRadiosityProperties
    (
        PipelineRadiosityLightingType lighting,
        PipelineRadiosityShadowType shadow
    )

    Constructor.


    static PipelineRadiosityProperties Enlighten::PipelineRadiosityProperties::ProbeRadiosity

    public: PipelineRadiosityProperties ProbeRadiosity()

    An instance with these properties is included in the radiosity computation and lit using probes.

    , multiple selections available,
    {"serverDuration": 13, "requestCorrelationId": "290128a2d46848a0a48d6d509609c774"}