Wwise SDK 2019.1.11
_ak_memory_mgr_8h_source
Version
menu_open
link
Wwise SDK 2019.1.11
|
AkMemoryMgr.h
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.
AKSOUNDENGINE_API AkOSChar * GetPoolName(AkMemPoolId in_poolId)
AKSOUNDENGINE_API AkUInt32 StopProfileThreadUsage(AkMemPoolId in_PoolId)
AKSOUNDENGINE_API AKRESULT Falign(AkMemPoolId in_poolId, void *in_pMemAddress)
AKSOUNDENGINE_API AKRESULT SetPoolName(AkMemPoolId in_poolId, const char *in_pszPoolName)
AKSOUNDENGINE_API AkMemPoolId CreatePool(void *in_pMemAddress, AkUInt32 in_uMemSize, AkUInt32 in_uBlockSize, AkUInt32 in_eAttributes, AkUInt32 in_uBlockAlign=0)
AKSOUNDENGINE_API AKRESULT CheckPoolId(AkMemPoolId in_poolId)
@ CheckOverwriteAtFree
Performs a for buffer overflow when an allocation is freed.
Definition: AkMemoryMgr.h:102
Definition: AkMemoryMgr.h:91
AKSOUNDENGINE_API void * Malloc(AkMemPoolId in_poolId, size_t in_uSize)
AKSOUNDENGINE_API AKRESULT Free(AkMemPoolId in_poolId, void *in_pMemAddress)
AKSOUNDENGINE_API AKRESULT GetPoolStats(AkMemPoolId in_poolId, PoolStats &out_stats)
AKSOUNDENGINE_API void Term()
AKSOUNDENGINE_API void GetPoolMemoryUsed(AkMemPoolId in_poolId, PoolMemInfo &out_memInfo)
AKSOUNDENGINE_API void CheckForOverwrite(AkUInt32 in_uPoolID)
AKSOUNDENGINE_API AKRESULT SetMonitoring(AkMemPoolId in_poolId, bool in_bDoMonitor)
AKSOUNDENGINE_API void * Malign(AkMemPoolId in_poolId, size_t in_uSize, AkUInt32 in_uAlignment)
AKSOUNDENGINE_API AkMemPoolAttributes GetPoolAttributes(AkMemPoolId in_poolId)
AKSOUNDENGINE_API AkUInt32 GetBlockSize(AkMemPoolId in_poolId)
AKSOUNDENGINE_API void * Realloc(AkMemPoolId in_poolId, void *in_pAlloc, size_t in_uSize)
AKSOUNDENGINE_API AkInt32 GetNumPools()
AKSOUNDENGINE_API void * GetBlock(AkMemPoolId in_poolId)
@ CheckOverwritePerFrame
Performs a check for buffer overflow once per audio frame.
Definition: AkMemoryMgr.h:103
AKSOUNDENGINE_API bool IsInitialized()
AKSOUNDENGINE_API AKRESULT DestroyPool(AkMemPoolId in_poolId)
Definition: AkMemoryMgr.h:74
AKSOUNDENGINE_API void StartProfileThreadUsage(AkMemPoolId in_PoolId)
AKSOUNDENGINE_API AKRESULT ReleaseBlock(AkMemPoolId in_poolId, void *in_pMemAddress)
@ CheckOverwritePerVoice
Performs a check for buffer overflow once per audio voice
Definition: AkMemoryMgr.h:104
AKSOUNDENGINE_API AkInt32 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