This is the documentation for Enlighten.
class Enlighten CpuEnvironment
class Enlighten::CpuEnvironment
  └>Enlighten::BaseEnvironment
    └>Geo::IGeoReleasable
Class used by the CPU and console update managers to represent an environment map.
In particular, it allows the application to update the environment map in a thread-safe manner.
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. |
Geo::v128 * m_Values | The application-settable base values. |
Functions
Name | Description |
---|---|
BaseEnvironment(Geo::s32, PrecisionHint::Value) | Constructs an environment object of the given resolution. |
Clone() | Creates a copy of the CPU environment and its data values. |
CpuEnvironment(Geo::s32, PrecisionHint::Value) | Constructs a CPU environment of the given resolution. |
Create() | Creates a CPU environment of (default) resolution 2. Used in GeoMobileDemo. |
CreateInputLightingBuffer() | Creates the input lighting buffer. |
GetInputLightingPrecisionHint() | Gets the precision hint of the input lighting buffer. |
Load(Geo::IGeoInputStream &, Geo::u32) | Deserialises a CPU environment from a stream. |
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. |
Save(Geo::IGeoStream &, Geo::u32) | Serialises a CPU environment to a stream. |
UpdateEnvironmentInputLighting() | Updates the input lighting buffer. |
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.
CpuEnvironment* Enlighten::CpuEnvironment::Clone
public: CpuEnvironment * Clone() const
Creates a copy of the CPU environment and its data values.
Enlighten::CpuEnvironment::CpuEnvironment
public: CpuEnvironment
(
  Geo::s32 resolution,
  PrecisionHint::Value precision
)
Constructs a CPU environment of the given resolution.
static CpuEnvironment* Enlighten::CpuEnvironment::Create
public: CpuEnvironment * Create()
Creates a CPU environment of (default) resolution 2. Used in GeoMobileDemo.
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.
bool Enlighten::CpuEnvironment::Load
public: bool Load
(
  Geo::IGeoInputStream & stream,
  Geo::u32 section
)
Deserialises a CPU environment from a stream.
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)'
bool Enlighten::CpuEnvironment::Save
public: bool Save
(
  Geo::IGeoStream & stream,
  Geo::u32 section
) const
Serialises a CPU environment to a stream.
virtual void Enlighten::CpuEnvironment::UpdateEnvironmentInputLighting
public: virtual void UpdateEnvironmentInputLighting()
Updates the input lighting buffer.
virtual void Enlighten::BaseEnvironment::UpdateEnvironmentInputLighting
public: void UpdateEnvironmentInputLighting()
Updates the input lighting buffer.