This is the documentation for Enlighten.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

class Geo::GeoDepthCubeMap

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

A simple storage class for a floating point cube map.

Functions

Name Description
Create()

Create a new GeoDepthCubeMap.

GetData(Geo::s32)

Gets the data array for the given face.

GetData(Geo::s32)

Gets the data array for the given face.

GetWidth()

Gets the width.

Load(Geo::IGeoInputStream &, Geo::u32)

Geo::IGeoSerialisable implementation.

Load(IGeoInputStream &, Geo::u32)

Load an instance of this class from an IGeoInputStream.

Release()

Geo::IGeoSerialisable implementation.

Release()

Free this object that was created within the Enlighten libraries.

Save(Geo::IGeoStream &, Geo::u32)

Geo::IGeoSerialisable implementation.

Save(IGeoStream &, Geo::u32)

Save an instance of this class to an IGeoStream.

SetResolution(Geo::s32)

Sets the resolution.

SetValue(Geo::s32, Geo::s32, Geo::s32, float)

Sets the value at the given face and (x, y) position.


static GeoDepthCubeMap* Geo::GeoDepthCubeMap::Create


public: GeoDepthCubeMap * Create()


Create a new GeoDepthCubeMap.


const float* Geo::GeoDepthCubeMap::GetData


public: const float * GetData
(
    Geo::s32 f
) const


Gets the data array for the given face.


float* Geo::GeoDepthCubeMap::GetData


public: float * GetData
(
    Geo::s32 f
)


Gets the data array for the given face.


Geo::s32 Geo::GeoDepthCubeMap::GetWidth


public: Geo::s32 GetWidth() const


Gets the width.


virtual bool Geo::GeoDepthCubeMap::Load


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


Geo::IGeoSerialisable implementation.


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.


virtual void Geo::GeoDepthCubeMap::Release


public: virtual void Release()


Geo::IGeoSerialisable implementation.


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::GeoDepthCubeMap::Save


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


Geo::IGeoSerialisable implementation.


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.


bool Geo::GeoDepthCubeMap::SetResolution


public: bool SetResolution
(
    Geo::s32 w
)


Sets the resolution.


void Geo::GeoDepthCubeMap::SetValue


public: void SetValue
(
    Geo::s32 f,
    Geo::s32 x,
    Geo::s32 y,
    float value
)


Sets the value at the given face and (x, y) position.

  • No labels