nw::snd::SoundHeap::SaveState Member Function

#include <nw/snd/snd_SoundHeap.h>
int SaveState();

None.

Returns the hierarchical level after the state save. Returns -1 if the state save fails.

Saves the current state of the sound heap.

The hierarchical level immediately after heap creation is 0. The hierarchical level increases by 1 each time this function is called. By calling LoadState, you can restore the state immediately after the specified level was saved.

Saving the state will consume a small amount of the heap. If there is not enough free space in the heap, the function call fails.

2009/12/28

Initial version.