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. |
| 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 pointer to the light values. |
| GetLightValues() | Return a const pointer to the light values. |
| GetNumLightValues() | Return the number of light values. |
| GetSize() | Gets the total size (in bytes) of this buffer. |
| GetStatic() | The number of updates since the last change. |
| GetSystemId() | Return the system guid for this InputLightingBuffer. |
| IsFrozen() | Queries the frozen flag of this buffer. |
| PostUpdate(bool) | Called after the buffer is updated. |
Variables
| Name | Description |
|---|---|
| Geo::u32 m_Frozen | Frozen flag in sign bit, remaining bits store the number of updates since the last change. |
| 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. |
| Anchor | ||||
|---|---|---|---|---|
|
static Geo::u32 Enlighten::InputLightingBuffer::CalculateBufferSize
...
public: Geo::u32 CalculateBufferSize
(
const InputWorkspace * inputWorkspace,
PrecisionHint::Value precisionHint
)
...
Factory Methods.
| Anchor | ||||
|---|---|---|---|---|
|
void Enlighten::InputLightingBuffer::ConvertEndian
...
public: void ConvertEndian
(
Geo::EConvertEndianMode mode
)
...
Converts the endian-ness of this buffer.
| Anchor | ||||
|---|---|---|---|---|
|
bool Enlighten::InputLightingBuffer::Copy
...
public: bool Copy
(
const InputLightingBuffer & source
)
...
Copy the contents from a source buffer.
| Anchor | ||||
|---|---|---|---|---|
|
static InputLightingBuffer* Enlighten::InputLightingBuffer::Create
...
public: InputLightingBuffer * Create
(
const InputWorkspace * inputWorkspace,
void * memory,
PrecisionHint::Value precisionHint
)
...
Factory Methods.
| Anchor | ||||
|---|---|---|---|---|
|
static InputLightingBuffer* Enlighten::InputLightingBuffer::Create
...
public: InputLightingBuffer * Create
(
Geo::s32 environmentResolution,
void * memory,
PrecisionHint::Value precisionHint
)
...
Factory Methods.
| Anchor | ||||
|---|---|---|---|---|
|
static InputLightingBuffer* Enlighten::InputLightingBuffer::Create
...
public: InputLightingBuffer * Create
(
const InputLightingBuffer & source,
void * memory
)
...
Factory Methods.
| Anchor | ||||
|---|---|---|---|---|
|
static InputLightingBuffer* Enlighten::InputLightingBuffer::Create
...
public: InputLightingBuffer * Create
(
void * memory,
const InputLightingBuffer & source
)
...
Factory Methods.
| Anchor | ||||
|---|---|---|---|---|
|
LightValueIterator Enlighten::InputLightingBuffer::GetLightValues
...
public: LightValueIterator GetLightValues()
...
Return a pointer to the light values.
| Anchor | ||||
|---|---|---|---|---|
|
ConstLightValueIterator Enlighten::InputLightingBuffer::GetLightValues
...
public: ConstLightValueIterator GetLightValues() const
...
Return a const pointer to the light values.
| Anchor | ||||
|---|---|---|---|---|
|
Geo::u32 Enlighten::InputLightingBuffer::GetNumLightValues
...
public: Geo::u32 GetNumLightValues() const
...
Return the number of light values.
| Anchor | ||||
|---|---|---|---|---|
|
Geo::u32 Enlighten::InputLightingBuffer::GetSize
...
public: Geo::u32 GetSize() const
...
Gets the total size (in bytes) of this buffer.
| Anchor | ||||
|---|---|---|---|---|
|
Geo::s32 Enlighten::InputLightingBuffer::GetStatic
...
public: Geo::s32 GetStatic() const
...
The number of updates since the last change.
| Anchor | ||||
|---|---|---|---|---|
|
Geo::GeoGuid Enlighten::InputLightingBuffer::GetSystemId
...
public: Geo::GeoGuid GetSystemId() const
...
Return the system guid for this InputLightingBuffer.
| Anchor | ||||
|---|---|---|---|---|
|
bool Enlighten::InputLightingBuffer::IsFrozen
...
public: bool IsFrozen() const
...
Queries the frozen flag of this buffer.
| Anchor | ||||
|---|---|---|---|---|
|
void Enlighten::InputLightingBuffer::PostUpdate
...
public: void PostUpdate
(
bool freeze
)
...
Called after the buffer is updated.