This is the documentation for Enlighten.
class Enlighten RadDataBlock
- William Joseph
- geosw (Unlicensed)
class Enlighten::RadDataBlock
Facilitates storage of core Enlighten data.
This class effectively forms a header for a block of data generated by the Enlighten precompute system. It provides enough control over the data to allow you to copy, relocate or serialise the data block abstractly. All data referenced by this header is inherently relocatable and can be manipulated as a black box lump of memory.
The data itself is referenced by the m_DataStart pointer and will always be a contiguous block of memory of length m_Length. The type of data the class is referring to is specified by m_DataType. The m_DataType variable tells the Enlighten library what data you are storing and so must be correct for operations on the data to succeed.
The alignment of the data reference by m_DataStart is important and differs depending on the data type.
Note
For flexibility the members of this class are publically accessible.
Variables
| Name | Description |
|---|---|
| Geo::u16 m_DataType | The type of Enlighten data this block contains. |
| Geo::s32 m_Length | The length of the data block in bytes. |
| Geo::u16 m_SolverType | The solver for which this data was created. |
Functions
| Name | Description |
|---|---|
| GetRequiredAlignment() | Get the necessary memory alignment for the data referenced by m_DataStart. |
| RadDataBlock() | Default constructor just clears values to a safe invalid state. |
static Geo::s32 Enlighten::RadDataBlock::GetRequiredAlignment
public: Geo::s32 GetRequiredAlignment()
Get the necessary memory alignment for the data referenced by m_DataStart.
Enlighten::RadDataBlock::RadDataBlock
public: RadDataBlock()
Default constructor just clears values to a safe invalid state.