This is the documentation for Enlighten.

class Enlighten IPrecompOutputCubeMap

class Enlighten::IPrecompOutputCubeMap

    └>Geo::IGeoSerialisable
        └>Geo::IGeoReleasable

Handle to the precompute output data for cube maps.

This contains the result of the precompute, but not in a compressed form usable by the runtime.

Functions

Name Description
Create()

Create a new empty IPrecompOutputCubeMap.

GetBuildParameters()

Read only access to the build parameters for this cube map.

GetId()

Return the unique ID of this cube map.

GetLocation()

Access the cube map location.

GetName()

Get the full name.

Load(IGeoInputStream &, Geo::u32)

Load an instance of this class from an IGeoInputStream.

NonCopyable(NonCopyable &&)

Defaulted to allow move.

operator=(NonCopyable &&)

Defaulted to allow move.

Release()

Free this object that was created within the Enlighten libraries.

Save(IGeoStream &, Geo::u32)

Save an instance of this class to an IGeoStream.


static IPrecompOutputCubeMap* Enlighten::IPrecompOutputCubeMap::Create


public: IPrecompOutputCubeMap * Create()


Create a new empty IPrecompOutputCubeMap.


virtual const IPrecompCubeMapBuildParameters* Enlighten::IPrecompOutputCubeMap::GetBuildParameters


public: const IPrecompCubeMapBuildParameters * GetBuildParameters() const


Read only access to the build parameters for this cube map.

Returns

A valid pointer or NULL if this class did not result from a precompute


virtual Geo::GeoGuid Enlighten::IPrecompOutputCubeMap::GetId


public: Geo::GeoGuid GetId() const


Return the unique ID of this cube map.


virtual const Geo::Matrix& Enlighten::IPrecompOutputCubeMap::GetLocation


public: const Geo::Matrix & GetLocation() const


Access the cube map location.


virtual const char* Enlighten::IPrecompOutputCubeMap::GetName


public: const char * GetName() const


Get the full name.


virtual bool Geo::IGeoSerialisable::Load


public: bool Load
(
    IGeoInputStream & stream,
    Geo::u32 section
)


Load an instance of this class from an IGeoInputStream.

The stream must be ready to read from. You can load sections of an object by passing a bitmask representing the desired sections rather than Iff::AllSectionsMask, which will load all sections. It is also safe to call this method on an object multiple times with different section arguments to load multiple parts.


Geo::NonCopyable::NonCopyable


public: NonCopyable
(
    NonCopyable &&
)


Defaulted to allow move.


NonCopyable& Geo::NonCopyable::operator=


public: NonCopyable & operator=
(
    NonCopyable &&
)


Defaulted to allow move.


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 bool Geo::IGeoSerialisable::Save


public: bool Save
(
    IGeoStream & stream,
    Geo::u32 section
) const


Save an instance of this class to an IGeoStream.

The stream must be ready to write to. You can save sections of an object by passing a bitmask representing the desired sections rather than Iff::AllSectionsMask, which will save all sections that are available.