Wwise SDK 2018.1.11
_ak_memory_mgr_8h_source
Version
menu_open
link
Wwise SDK 2018.1.11
|
AkMemoryMgr.h
Go to the documentation of this file.
41 /// Set the debug name for a pool. This is the name shown in the Memory tab of the Advanced Profiler.
98 /// Memory management debug tools. When specified in Init, each memory allocation will have a extra tag that can be verified periodically.
99 /// Enabling this will use a lot of CPU and additional memory. This should not be enabled unless required by Audiokinetic's support. These are enabled in Debug configuration only.
108 /// \warning This function is not thread-safe. It should not be called at the same time as MemoryMgr::Init or MemoryMgr::Term.
139 ///< When allocating space for sound bank data, we recommend using AK_BANK_PLATFORM_DATA_ALIGNMENT.
200 /// If this function cannot be implemented if your memory manager, at least set the member uUsed to 0, that
247 /// \return A pointer to the start of the allocated memory (NULL if the system is out of memory)
258 /// \return A pointer to the start of the allocated memory (NULL if the system is out of memory)
267 /// \return A pointer to the start of the allocated memory (NULL if the system is out of memory)
286 /// Allocate memory from a pool, overriding the pool's default memory alignment. Needs to be used
288 /// \return A pointer to the start of the allocated memory (NULL if the system is out of memory)
300 /// Allocate memory from a pool, overriding the pool's default memory alignment. Needs to be used
302 /// \return A pointer to the start of the allocated memory (NULL if the system is out of memory)
311 /// Free memory from a pool, overriding the pool's default memory alignment. Needs to be used in
328 /// Get a block from a Fixed-Size Block type pool. To be used with pools created with AkFixedSizeBlocksMode
330 /// \return A pointer to the start of the allocated memory (NULL if the system is out of memory)
331 /// The size of the memory block is always in_uBlockSize, specified in AK::MemoryMgr::CreatePool.
363 /// \note Not implementing this will result in the Soundbank tab of the Wwise Profiler to show 0 bytes for memory usage.
369 /// \return The amount of memory allocated by this thread since \ref StartProfileThreadUsage was called.
370 /// \note Not implementing this will result in the Soundbank tab of the Wwise Profiler to show 0 bytes for memory usage.
378 /// In the default implementation it is not called in Release otherwise will assert if overrun found.
386 /// The list contains the size allocated and the source file and line number where the memory allocation was done.
bool __cdecl IsInitialized()
AKRESULT __cdecl Free(AkMemPoolId in_poolId, void *in_pMemAddress)
AKRESULT __cdecl SetMonitoring(AkMemPoolId in_poolId, bool in_bDoMonitor)
void *__cdecl GetBlock(AkMemPoolId in_poolId)
AkMemPoolId __cdecl CreatePool(void *in_pMemAddress, AkUInt32 in_uMemSize, AkUInt32 in_uBlockSize, AkUInt32 in_eAttributes, AkUInt32 in_uBlockAlign=0)
Definition: AkMemoryMgr.h:73
AKRESULT __cdecl DestroyPool(AkMemPoolId in_poolId)
Performs a check for buffer overflow once per audio frame.
Definition: AkMemoryMgr.h:103
Definition: AkMemoryMgr.h:90
void __cdecl StartProfileThreadUsage(AkMemPoolId in_PoolId)
void __cdecl GetPoolMemoryUsed(AkMemPoolId in_poolId, PoolMemInfo &out_memInfo)
AkUInt32 __cdecl GetBlockSize(AkMemPoolId in_poolId)
AKRESULT __cdecl Falign(AkMemPoolId in_poolId, void *in_pMemAddress)
void *__cdecl Malign(AkMemPoolId in_poolId, size_t in_uSize, AkUInt32 in_uAlignment)
AKRESULT __cdecl CheckPoolId(AkMemPoolId in_poolId)
AKRESULT __cdecl ReleaseBlock(AkMemPoolId in_poolId, void *in_pMemAddress)
AkMemPoolAttributes __cdecl GetPoolAttributes(AkMemPoolId in_poolId)
AkUInt32 __cdecl StopProfileThreadUsage(AkMemPoolId in_PoolId)
void *__cdecl Malloc(AkMemPoolId in_poolId, size_t in_uSize)
AKRESULT __cdecl GetPoolStats(AkMemPoolId in_poolId, PoolStats &out_stats)
AKRESULT __cdecl SetPoolName(AkMemPoolId in_poolId, const char *in_pszPoolName)
void __cdecl CheckForOverwrite(AkUInt32 in_uPoolID)
void __cdecl Term()
AkOSChar *__cdecl GetPoolName(AkMemPoolId in_poolId)
AkInt32 __cdecl GetNumPools()
Performs a for buffer overflow when an allocation is freed.
Definition: AkMemoryMgr.h:102
void *__cdecl Realloc(AkMemPoolId in_poolId, void *in_pAlloc, size_t in_uSize)
Performs a check for buffer overflow once per audio voice.
Definition: AkMemoryMgr.h:104
AkInt32 __cdecl GetMaxPools()
Was this page helpful?
Need Support?
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageTell us about your project. We're here to help.
Register your project and we'll help you get started with no strings attached!
Get started with Wwise