This is the documentation for Enlighten.

class Enlighten ClusterMaterialComponent

template<typename ColourType>
class Enlighten::ClusterMaterialComponent

Enlighten internal class for per material dynamic updates.

Typedefs

Name Description
ColourType::ExpandedType ValueType

The publicly exposed type that is read and written.

Functions

Name Description
ByteSwap()

Byte swaps the members of this component.

ClusterMaterialComponent()

Constructor.

GetCurrent()

Gets the current value of this component.

GetWritten()

Gets the last-written value of this component.

Initialise(bool)

Initialises this component as static or dynamic.

IsDynamic()

Queries if this component is dynamic.

Quantise(const ValueType &)

Quantise the ValueType value based on the ColourType storage.

SetCurrent(ValueType)

Sets the current value of this component.

SetWritten()

Sets the last-written value of this component to the current value.


void Enlighten::ClusterMaterialComponent< ColourType >::ByteSwap


public: void ByteSwap()


Byte swaps the members of this component.


Enlighten::ClusterMaterialComponent< ColourType >::ClusterMaterialComponent


public: ClusterMaterialComponent()


Constructor.


ValueType Enlighten::ClusterMaterialComponent< ColourType >::GetCurrent


public: ValueType GetCurrent() const


Gets the current value of this component.


ValueType Enlighten::ClusterMaterialComponent< ColourType >::GetWritten


public: ValueType GetWritten() const


Gets the last-written value of this component.


void Enlighten::ClusterMaterialComponent< ColourType >::Initialise


public: void Initialise
(
    bool dynamic
)


Initialises this component as static or dynamic.


bool Enlighten::ClusterMaterialComponent< ColourType >::IsDynamic


public: bool IsDynamic() const


Queries if this component is dynamic.


Enlighten::ClusterMaterialComponent< ColourType >::ValueType Enlighten::ClusterMaterialComponent< ColourType >::Quantise


public: ValueType Quantise
(
    const ValueType & val
)


Quantise the ValueType value based on the ColourType storage.


void Enlighten::ClusterMaterialComponent< ColourType >::SetCurrent


public: void SetCurrent
(
    ValueType newCurrent
)


Sets the current value of this component.


void Enlighten::ClusterMaterialComponent< ColourType >::SetWritten


public: void SetWritten()


Sets the last-written value of this component to the current value.