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 ExporterCubemap
  • class Enlighten ExporterGeom
  • class Enlighten ExporterGlobalParameters
  • class Enlighten ExporterInstanceParameters
  • class Enlighten ExporterLineWriter
  • class Enlighten ExporterMesh
  • class Enlighten ExporterPaths
  • class Enlighten ExporterProbeRegion
  • class Enlighten ExporterProbeVolume
  • class Enlighten ExporterScene
  • class Enlighten ExporterTransform
  • class Enlighten FitModel
  • class Enlighten FixedTimeLimiter
  • class Enlighten Fp16CpuTextureSampler
  • class Enlighten FrustumLight
  • class Enlighten FunctorCommand
  • class Enlighten GenericColourBuffer
  • class Enlighten GeoClusterNode
  • class Enlighten GeoClusterNodeForest
  • class Enlighten GeoClusterNodeTree
  • class Enlighten GeoDirectionalPoint
  • class Enlighten GeometryDataBlock
  • class Enlighten GeomMeshMeta
  • class Enlighten GeomMeta
  • class Enlighten GeomProperties
  • class Enlighten GeoRayOrigin
  • class Enlighten GlTextureUpdater
  • class Enlighten GpuTextureWrapper
  • class Enlighten IAsyncTask
  • class Enlighten IBake
  • class Enlighten IBakeInputGeometryLightingNormals
  • class Enlighten IBakeInputGeometryTangents
  • class Enlighten IBakeInputGeometryUvs
  • class Enlighten IBakeInputLighting
  • class Enlighten IBakeInputMaterial
  • class Enlighten IBakeInputMeshLightingNormals
  • class Enlighten IBakeInputMeshTangents
  • class Enlighten IBakeInputMeshUvs
  • class Enlighten IBakeInputProperties
  • class Enlighten IBakeInputRayOriginPositions
  • class Enlighten IBakeInputRuntime
  • class Enlighten IBakeInputSystem
  • class Enlighten IBakeOutputProbeSet
  • 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
    Calendars
You‘re viewing this with anonymous access, so some content might be blocked.
/
class Enlighten IBakeInputRuntime

    This is the documentation for Enlighten.

    class Enlighten IBakeInputRuntime

    Nov 21, 2019

    class Enlighten::IBakeInputRuntime

        └>Geo::IGeoSerialisable
            └>Geo::IGeoReleasable

    The Enlighten runtime objects; RadDataCore, InputWorkspace, et al.

    Functions

    Name Description
    AddProbeSet(RadProbeSetCore *, CpuEnvironment *, const IPrecompOutputProbeSet *)

    Adds an Enlighten probeset to the runtime solver.

    AddSystem(RadSystemCore *, IPrecompRadiosityNormalTexture *, CpuEnvironment *, InputWorkspace *, ClusterAlbedoWorkspaceMaterialData *)

    Adds an Enlighten system to the runtime solver.

    Create()

    Create a new IBakeInputRuntime.

    Load(IGeoInputStream &, Geo::u32)

    Load an instance of this class from an IGeoInputStream.

    Release()

    Free this object that was created within the Enlighten libraries.

    Save(IGeoStream &, Geo::u32)

    Save an instance of this class to an IGeoStream.

    SetBounceScale(float)

    Set the bounce scale used during the indirect lighting calculation based on the runtime data.

    SetDefaultEnvironment(CpuEnvironment *)

    Adds an emissive environment to the light input. Takes ownership.


    virtual bool Enlighten::IBakeInputRuntime::AddProbeSet

    public: bool AddProbeSet
    (
        RadProbeSetCore * probeSet,
        CpuEnvironment * environment,
        const IPrecompOutputProbeSet * pOutputProbeSet
    )

    Adds an Enlighten probeset to the runtime solver.

    Takes ownership.

    Parameters
    [in] probeSet

    RadProbeSetCore that contains the precomputed data for the probe set

    [in] environment

    Environment map to be used by probe set

    [in] pOutputProbeSet

    IPrecompOutputProbeSet for the probe set created during the precompute


    virtual bool Enlighten::IBakeInputRuntime::AddSystem

    public: bool AddSystem
    (
        RadSystemCore * radCore,
        IPrecompRadiosityNormalTexture * normalTexture,
        CpuEnvironment * environment,
        InputWorkspace * inputWorkspace,
        ClusterAlbedoWorkspaceMaterialData * cawMaterialData
    )

    Adds an Enlighten system to the runtime solver.

    Takes ownership.

    Parameters
    [in] radCore

    RadSystemCore that contains the precomputed data for the system

    [in] normalTexture

    Radiosity normal texture to be used by system

    [in] environment

    Environment map to be used by system

    [in] inputWorkspace

    InputWorkspace to use for system

    [in] cawMaterialData

    Material data to use for system


    static IBakeInputRuntime* Enlighten::IBakeInputRuntime::Create

    public: IBakeInputRuntime * Create()

    Create a new IBakeInputRuntime.


    virtual bool Geo::IGeoSerialisable::Load

    public: bool Load
    (
        IGeoInputStream & stream,
        Geo::u32 section
    )

    Load an instance of this class from an IGeoInputStream.

    The stream must be ready to read from. You can load sections of an object by passing a bitmask representing the desired sections rather than Iff::AllSectionsMask, which will load all sections. It is also safe to call this method on an object multiple times with different section arguments to load multiple parts.


    virtual void Geo::IGeoReleasable::Release

    public: void Release()

    Free this object that was created within the Enlighten libraries.

    Expect this to behave in a similar way to calling 'delete(this)'


    virtual bool Geo::IGeoSerialisable::Save

    public: bool Save
    (
        IGeoStream & stream,
        Geo::u32 section
    ) const

    Save an instance of this class to an IGeoStream.

    The stream must be ready to write to. You can save sections of an object by passing a bitmask representing the desired sections rather than Iff::AllSectionsMask, which will save all sections that are available.


    virtual bool Enlighten::IBakeInputRuntime::SetBounceScale

    public: bool SetBounceScale
    (
        float bounceScale
    )

    Set the bounce scale used during the indirect lighting calculation based on the runtime data.

    The bounce scale needs to be a value in the range [0..1] otherwise it is not set and this function returns false.


    virtual bool Enlighten::IBakeInputRuntime::SetDefaultEnvironment

    public: bool SetDefaultEnvironment
    (
        CpuEnvironment * environment
    )

    Adds an emissive environment to the light input. Takes ownership.

    , multiple selections available,
    {"serverDuration": 11, "requestCorrelationId": "35da2c2e87c948419faae331e7f4210f"}