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

You‘re viewing this with anonymous access, so some content might be blocked.
/
class Enlighten InputLightingBuffer

    This is the documentation for Enlighten.

    class Enlighten InputLightingBuffer

    Nov 21, 2019

    class Enlighten::InputLightingBuffer

    A single frame of the InputWorkspace lighting (internal).

    Runtime data allocated by end user that stores one frame of light bounce.

    The data for this class lies immediately after it in memory.

    Functions

    Name Description
    CalculateBufferSize(const InputWorkspace *, PrecisionHint::Value)

    Factory Methods.

    ClearFrozen()

    Clears the frozen flag of this buffer.

    ConvertEndian(Geo::EConvertEndianMode)

    Converts the endian-ness of this buffer.

    Copy(const InputLightingBuffer &)

    Copy the contents from a source buffer.

    Create(const InputWorkspace *, void *, PrecisionHint::Value)

    Factory Methods.

    Create(Geo::s32, void *, PrecisionHint::Value)

    Factory Methods.

    Create(const InputLightingBuffer &, void *)

    Factory Methods.

    Create(void *, const InputLightingBuffer &)

    Factory Methods.

    GetLightValues()

    Return a const pointer to the light values.

    GetLightValues()

    Return a pointer to the light values.

    GetNumLightValues()

    Return the number of light values.

    GetSize()

    Gets the total size (in bytes) of this buffer.

    GetSystemId()

    Return the system guid for this InputLightingBuffer.

    IsFrozen()

    Queries the frozen flag of this buffer.

    IsStatic()

    Is this lighting buffer static?

    SetFrozen()

    Sets the frozen flag of this buffer.

    SetStatic(bool)

    Sets the static flag of this buffer.

    Variables

    Name Description
    Geo::u32 m_Frozen

    Frozen flag.

    Geo::s32 m_NumClusters

    Number of clusters in the leaf level.

    Geo::u32 m_ObjectSize

    Total size of this buffer (in bytes).

    PrecisionHint::Value m_Precision

    Precision.

    Geo::GeoGuid m_SystemId

    The system GUID for this buffer.


    static Geo::u32 Enlighten::InputLightingBuffer::CalculateBufferSize


    public: Geo::u32 CalculateBufferSize
    (
        const InputWorkspace * inputWorkspace,
        PrecisionHint::Value precisionHint
    )


    Factory Methods.


    void Enlighten::InputLightingBuffer::ClearFrozen


    public: void ClearFrozen()


    Clears the frozen flag of this buffer.


    void Enlighten::InputLightingBuffer::ConvertEndian


    public: void ConvertEndian
    (
        Geo::EConvertEndianMode mode
    )


    Converts the endian-ness of this buffer.


    bool Enlighten::InputLightingBuffer::Copy


    public: bool Copy
    (
        const InputLightingBuffer & source
    )


    Copy the contents from a source buffer.


    static InputLightingBuffer* Enlighten::InputLightingBuffer::Create


    public: InputLightingBuffer * Create
    (
        const InputWorkspace * inputWorkspace,
        void * memory,
        PrecisionHint::Value precisionHint
    )


    Factory Methods.


    static InputLightingBuffer* Enlighten::InputLightingBuffer::Create


    public: InputLightingBuffer * Create
    (
        Geo::s32 environmentResolution,
        void * memory,
        PrecisionHint::Value precisionHint
    )


    Factory Methods.


    static InputLightingBuffer* Enlighten::InputLightingBuffer::Create


    public: InputLightingBuffer * Create
    (
        const InputLightingBuffer & source,
        void * memory
    )


    Factory Methods.


    static InputLightingBuffer* Enlighten::InputLightingBuffer::Create


    public: InputLightingBuffer * Create
    (
        void * memory,
        const InputLightingBuffer & source
    )


    Factory Methods.


    ConstLightValueIterator Enlighten::InputLightingBuffer::GetLightValues


    public: ConstLightValueIterator GetLightValues() const


    Return a const pointer to the light values.


    LightValueIterator Enlighten::InputLightingBuffer::GetLightValues


    public: LightValueIterator GetLightValues()


    Return a pointer to the light values.


    Geo::u32 Enlighten::InputLightingBuffer::GetNumLightValues


    public: Geo::u32 GetNumLightValues() const


    Return the number of light values.


    Geo::u32 Enlighten::InputLightingBuffer::GetSize


    public: Geo::u32 GetSize() const


    Gets the total size (in bytes) of this buffer.


    Geo::GeoGuid Enlighten::InputLightingBuffer::GetSystemId


    public: Geo::GeoGuid GetSystemId() const


    Return the system guid for this InputLightingBuffer.


    bool Enlighten::InputLightingBuffer::IsFrozen


    public: bool IsFrozen() const


    Queries the frozen flag of this buffer.


    bool Enlighten::InputLightingBuffer::IsStatic


    public: bool IsStatic() const


    Is this lighting buffer static?


    void Enlighten::InputLightingBuffer::SetFrozen


    public: void SetFrozen()


    Sets the frozen flag of this buffer.


    void Enlighten::InputLightingBuffer::SetStatic


    public: void SetStatic
    (
        bool isStatic
    )


    Sets the static flag of this buffer.

    , multiple selections available,
    {"serverDuration": 11, "requestCorrelationId": "438f020e0f3f4c5593fbc149f6c795c9"}