Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.8.8601 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
@ AkMemID_Processing
Anything tied to instancing and processing of the DSP graph.
AKSOUNDENGINE_API void DumpToFile(const AkOSChar *pszFilename)
@ AkMemID_SpatialAudioPaths
Spatial audio paths data.
@ AkMemID_MonitorQueue
Monitor Queue.
@ AkMemID_TempAudioRender
Temporary allocations for audio render.
@ AkMemID_FilePackage
File packager.
AKSOUNDENGINE_API void TermForThread()
AKSOUNDENGINE_API void * dRealloc(AkMemPoolId in_poolId, void *in_pAlloc, size_t in_uSize, const char *in_pszFile, AkUInt32 in_uLine)
bool bDebugDetailedStats
Enable to track detailed stats and include them in the detailed stat dump. Detailed stats include the...
AkUInt64 uPeakUsed
Peak used memory (in bytes)
AkUInt32 uMinimumBlockCount
The number of blocks of memory the system is initialized with and is the minimum kept around forever....
AkUInt64 uDeviceUsed
Total device memory used including all categories (in bytes)
bool bDebugClearMemory
Enable to clear any allocation to a deterministic garbage value. Useful to make sure memory is initia...
@ AkMemID_StreamingIO
Streaming Manager I/O memory.
AKSOUNDENGINE_API void * dMalloc(AkMemPoolId in_poolId, size_t in_uSize, const char *in_pszFile, AkUInt32 in_uLine)
@ AkMemID_Media
Media from the Wwise project.
@ AkMemID_Integration
Game engine integration allocations.
AkUInt32 uMemAllocated
Allocated memory (in bytes).
@ AkMemID_Object
Generic placeholder for allocations tied to the Wwise project.
AKSOUNDENGINE_API void * dMalign(AkMemPoolId in_poolId, size_t in_uSize, AkUInt32 in_uAlignment, const char *in_pszFile, AkUInt32 in_uLine)
AkUInt32 uPeakBlockUsed
The peak amount of used memory in any single block since initialization.
AKSOUNDENGINE_API void Free(AkMemPoolId in_poolId, void *in_pMemAddress)
#define AK_EXTERNAPIFUNC(_type, _name)
AKSOUNDENGINE_API void * Malloc(AkMemPoolId in_poolId, size_t in_uSize)
bool bDebugEnableSentinels
Enable to write out sentinels between most allocations to help detect memory overwrites,...
AKSOUNDENGINE_API void TrimForThread()
AkUInt32 uPeakBlocksUsed
The peak value for uBlocksUsed since initialization.
AkInt32 AkMemPoolId
Memory pool ID.
AkUInt32 uMaximumUnusedBlocks
The maximum number of blocks that the system keeps in an unused state, and avoids freeing....
@ AkMemID_Profiler
Profiler.
AkMemID
Memory category IDs.
AkUInt32 uAllocs
Number of allocation calls since initialization.
AKSOUNDENGINE_API void Term()
AKSOUNDENGINE_API void GetGlobalStats(GlobalStats &out_stats)
AKSOUNDENGINE_API void InitForThread()
@ AkMemID_SpatialAudioGeometry
Spatial audio geometry data.
AkUInt64 uReserved
Total reserved memory. (Used and unused). Will return 0 if the reserved memory is not traceable.
AkUInt32 uMemUsed
Used memory (in bytes).
AkUInt64 uMax
Maximum total allocation size, specified in the initialization settings through uMemAllocationSizeLim...
AKSOUNDENGINE_API void * dReallocAligned(AkMemPoolId in_poolId, void *in_pAlloc, size_t in_uSize, AkUInt32 in_uAlignment, const char *in_pszFile, AkUInt32 in_uLine)
AKSOUNDENGINE_API void GetStats(Type in_eType, Stats &out_stats)
Get simple statistics for a given temporary-memory pool.
@ AkMemID_JobMgr
Allocations for Sound Engine jobs and job dependencies.
AKSOUNDENGINE_API void * Malign(AkMemPoolId in_poolId, size_t in_uSize, AkUInt32 in_uAlignment)
@ AkMemID_SoundEngine
Base sound engine allocations (managers, etc).
Type
IDs of temporary memory pools used by the sound engine.
AKSOUNDENGINE_API void StartProfileThreadUsage()
@ AkMemID_GameSim
Game Simulator allocations.
@ AkMemID_GameObject
Game Objects and related.
@ AkMemID_Streaming
Streaming Manager objects.
@ AkMemID_NUM
Category count.
@ AkMemID_MASK
Mask for category IDs.
AKSOUNDENGINE_API void * Realloc(AkMemPoolId in_poolId, void *in_pAlloc, size_t in_uSize)
AkUInt32 uBlocksUsed
Number of individual blocks used.
AkUInt32 uPeakMemAllocated
The peak value for uMemAllocated since initialization.
@ AkMemID_Structure
Structures from the Wwise project.
bool bDebugStandaloneAllocs
Enable to force the block size to be as small as possible for each allocation (smaller than can be ac...
@ AkMemID_Event
Events from the Wwise project.
AKSOUNDENGINE_API AkUInt64 StopProfileThreadUsage()
Initialization settings for temporary-memory pools. Separate settings are specified for each temporar...
AKSOUNDENGINE_API void DumpTempAllocsToFile(Type in_eType, const AkOSChar *pszFilename)
bool bDebugFlushBlocks
Enable to forcefully release all blocks at the end of a tick and recreate them from scratch every tic...
uint64_t AkUInt64
Unsigned 64-bit integer.
AkUInt64 uUsed
Total memory used including all categories (in bytes)
AkUInt64 uUsed
Used memory (in bytes)
@ AkMemID_ProcessingPlugin
Plug-in allocations related to the DSP graph.
AKSOUNDENGINE_API void GetCategoryStats(AkMemPoolId in_poolId, CategoryStats &out_poolStats)
AkUInt32 uMinimumBlockSize
The minimum size of each block. If a new allocation requests a new block of memory,...
uint32_t AkUInt32
Unsigned 32-bit integer.
@ AkMemType_NoTrack
Do not track this allocation.
AKSOUNDENGINE_API bool IsInitialized()
@ AkMemID_SpatialAudio
Spatial audio.
AKSOUNDENGINE_API void * ReallocAligned(AkMemPoolId in_poolId, void *in_pAlloc, size_t in_uSize, AkUInt32 in_uAlignment)
@ AkMemType_Device
Device memory type bit.
@ AkMemType_Media
Media memory type bit.
AkUInt32 uPeakMemUsed
The peak value for uMemUsed since initialization.
AkUInt32 uFrees
Number of free calls since initialization.
Tell 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