class Geo::IGeoSerialisable

    └>Geo::IGeoReleasable

A class implementing IGeoSerialisable adds the ability to save and load instances of the type from an IGeoStream.

It also implements IGeoReleasable, meaning that the data is allocated and freed from within the Enlighten libraries. Many API calls return classes that implement this interface, you can usually call Save() on a returned object and then create a new instance, call Load() and have the data ready for another API call.

Functions

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::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.