This is the documentation for Enlighten.

class Enlighten BaseEnvironment

class Enlighten::BaseEnvironment

    └>Geo::IGeoReleasable

Trivial base class used to lend a base type to environment maps.

This class is extended for use with the CPU manager.

Variables

Name Description
InputLightingBuffer * m_EmissiveEnvironment

The underlying Enlighten object.

PrecisionHint::Value m_InputLightingPrecisionHint

Precision hint of the input lighting buffer.

Geo::s32 m_Resolution

Power-of-two face resolution of the environment cube map.

Functions

Name Description
BaseEnvironment(Geo::s32, PrecisionHint::Value)

Constructs an environment object of the given resolution.

CreateInputLightingBuffer()

Creates the input lighting buffer.

GetInputLightingPrecisionHint()

Gets the precision hint of the input lighting buffer.

NonCopyable(NonCopyable &&)

Defaulted to allow move.

operator=(NonCopyable &&)

Defaulted to allow move.

Release()

Free this object that was created within the Enlighten libraries.

Release()

Free this object that was created within the Enlighten libraries.

UpdateEnvironmentInputLighting()

Updates the input lighting buffer.


Enlighten::BaseEnvironment::BaseEnvironment


public: BaseEnvironment
(
    Geo::s32 resolution,
    PrecisionHint::Value precision
)


Constructs an environment object of the given resolution.


virtual void Enlighten::BaseEnvironment::CreateInputLightingBuffer


public: virtual void CreateInputLightingBuffer()


Creates the input lighting buffer.


PrecisionHint::Value Enlighten::BaseEnvironment::GetInputLightingPrecisionHint


public: PrecisionHint::Value GetInputLightingPrecisionHint() const


Gets the precision hint of the input lighting buffer.


Geo::NonCopyable::NonCopyable


public: NonCopyable
(
    NonCopyable &&
)


Defaulted to allow move.


NonCopyable& Geo::NonCopyable::operator=


public: NonCopyable & operator=
(
    NonCopyable &&
)


Defaulted to allow move.


virtual void Enlighten::BaseEnvironment::Release


public: virtual void Release()


Free this object that was created within the Enlighten libraries.

Expect this to behave in a similar way to calling 'delete(this)'


virtual void Geo::IGeoReleasable::Release


public: void Release()


Free this object that was created within the Enlighten libraries.

Expect this to behave in a similar way to calling 'delete(this)'


virtual void Enlighten::BaseEnvironment::UpdateEnvironmentInputLighting


public: void UpdateEnvironmentInputLighting()


Updates the input lighting buffer.