This is the documentation for Enlighten.
class Enlighten GenericColourBuffer
template<typename>
class Enlighten::GenericColourBuffer
Generic class to store an array of values for a given system.
The type of values stored is determined by the 'C' template parameter. Unlike the IncidentLightingBuffer and InputLightingBuffer, this class does not support run-time selection of format precision. This class requires that the 'C' type define an ExpandedType. This allows having a compressed format that expands to a v128 or possibly just a single float. The compressed format is expanded on read and compressed on write although that logic belongs in the 'C' object.
Classes
Typedefs
Name | Description |
|---|---|
C ColourType | Colour type. |
ConstIterator< ColourType > ConstIteratorType | Const Iterator type. |
Iterator< ColourType > IteratorType | Iterator type. |
Variables
Name | Description |
|---|---|
Geo::u32 m_NumValues | Number of clusters. |
Geo::GeoGuid m_ObjectId | Id of the system/cube map that these lighting values apply to. |
Geo::u32 m_Padding[2] | Unused padding. Explicitly declared so can be zero-initialised. |
Geo::s32 m_PayloadOffset | Byte offset from beginning of the header to the colour data. |
Functions
Name | Description |
|---|---|
Return a const iterator at the beginning of this buffer. | |
Return an iterator at the beginning of this buffer. | |
Endian swap the members of the header. | |
Endian swap the buffer contents. | |
Returns the size of the buffer in bytes. | |
Reset the contents of this buffer to zero/black. | |
Endian swap the buffer. | |
Copy values from another buffer. | |
Creates a buffer in memory. | |
Creates a copy in memory. | |
Return a const iterator at the end of this buffer. | |
Return an iterator at the end of this buffer. | |
Main constructor. | |
Copy constructor. | |
Returns the number of values in this buffer. | |
Returns the size of this buffer in bytes. | |
Returns the guid of the system that this buffer correlates to. |