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 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
  • class Enlighten IPppiTextureUpdateHandler
  • class Enlighten IPrecompBuildParameters
    Calendars
You‘re viewing this with anonymous access, so some content might be blocked.
/
class Enlighten IBakeOutputProbeSet

    This is the documentation for Enlighten.

    class Enlighten IBakeOutputProbeSet

    Nov 21, 2019

    class Enlighten::IBakeOutputProbeSet

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

    Baking output for a probe set.

    Functions

    Name Description
    Create()

    Create a new and empty IBakeOutputProbeSet.

    Create(Geo::s32, Geo::s32)

    Create a new IBakeOutputProbeSet for the given number of elements.

    CreateU8Output(float, Geo::u8 *)

    Get the probe values in U8 format.

    GetMaxValue()

    Retrieves the largest coefficient used in any probe.

    GetNumElements()

    Returns the number of elements in the output data.

    GetNumProbes()

    Returns the number of probes in the probe set.

    GetOutput()

    Get the probe values.

    GetOutput()

    Get the probe values.

    GetShOrder()

    Returns the SH order of the probe set.

    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.


    static IBakeOutputProbeSet* Enlighten::IBakeOutputProbeSet::Create

    public: IBakeOutputProbeSet * Create()

    Create a new and empty IBakeOutputProbeSet.


    static IBakeOutputProbeSet* Enlighten::IBakeOutputProbeSet::Create

    public: IBakeOutputProbeSet * Create
    (
        Geo::s32 shOrder,
        Geo::s32 numProbes
    )

    Create a new IBakeOutputProbeSet for the given number of elements.


    virtual void Enlighten::IBakeOutputProbeSet::CreateU8Output

    public: void CreateU8Output
    (
        float scale,
        Geo::u8 * output
    ) const

    Get the probe values in U8 format.

    Parameters
    [in] scale

    The scale to apply to the values to bring them into the range [0,1]. For example 1.0/GetMaxValue().

    [in] output

    Must refer to a block of memory at least GetNumElements() bytes in size.


    virtual float Enlighten::IBakeOutputProbeSet::GetMaxValue

    public: float GetMaxValue() const

    Retrieves the largest coefficient used in any probe.


    virtual Geo::s32 Enlighten::IBakeOutputProbeSet::GetNumElements

    public: Geo::s32 GetNumElements() const

    Returns the number of elements in the output data.


    virtual Geo::s32 Enlighten::IBakeOutputProbeSet::GetNumProbes

    public: Geo::s32 GetNumProbes() const

    Returns the number of probes in the probe set.


    virtual const float* Enlighten::IBakeOutputProbeSet::GetOutput

    public: const float * GetOutput() const

    Get the probe values.

    The data is owned by this object.


    virtual float* Enlighten::IBakeOutputProbeSet::GetOutput

    public: float * GetOutput()

    Get the probe values.

    The data is owned by this object.


    virtual Geo::s32 Enlighten::IBakeOutputProbeSet::GetShOrder

    public: Geo::s32 GetShOrder() const

    Returns the SH order of the probe set.


    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.

    , multiple selections available,
    {"serverDuration": 10, "requestCorrelationId": "207d162de5d34610b219957afb8aaada"}