This is the documentation for Enlighten.

class Enlighten InputLightingBuffer

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.