nw::snd::SoundHeap Class

Header file: nw/snd/snd_SoundHeap.h

Syntax

class SoundHeap : public nw::snd::SoundMemoryAllocatable

Description

A heap class used for sound data.

In sound heaps, you can set a callback function to be called when a memory block is freed by the sound heap. This feature is used in the Sound library to perform processing to safely free the data when a memory block that contains sound data has been released.

typedef Definitions

DisposeCallback Called when a memory block has been destroyed.

Member Functions

Constructors/Destructors
SoundHeap Constructor.
V ~SoundHeap Destructor.
Heap Operations
Create Creates the sound heap.
Destroy Destroys the sound heap.
V Alloc Allocates memory from the sound heap.
Clear Frees all allocated memory blocks.
IsValid Checks whether the sound heap is enabled.
Hierarchy Control
SaveState Saves the current state of the sound heap.
LoadState Restores the state of the saved sound heap.
GetCurrentLevel Obtains the current hierarchical level of the sound heap.
Getting Information
GetSize Gets the size of the heap in memory.
GetFreeSize Gets the amount of free heap space in memory.
Dump Dumps the contents of the heap.

Class Hierarchy

nw::snd::SoundMemoryAllocatable
  nw::snd::SoundHeap

Revision History

2009/12/28
Initial version.

CONFIDENTIAL