Version
menu_open
link
Wwise SDK 2022.1.12
AkModule.h
Go to the documentation of this file.
1 /*******************************************************************************
2 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
3 released in source code form as part of the SDK installer package.
4 
5 Commercial License Usage
6 
7 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
8 may use this file in accordance with the end user license agreement provided
9 with the software or, alternatively, in accordance with the terms contained in a
10 written agreement between you and Audiokinetic Inc.
11 
12 Apache License Usage
13 
14 Alternatively, this file may be used under the Apache License, Version 2.0 (the
15 "Apache License"); you may not use this file except in compliance with the
16 Apache License. You may obtain a copy of the Apache License at
17 http://www.apache.org/licenses/LICENSE-2.0.
18 
19 Unless required by applicable law or agreed to in writing, software distributed
20 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
21 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
22 the specific language governing permissions and limitations under the License.
23 
24  Copyright (c) 2024 Audiokinetic Inc.
25 *******************************************************************************/
26 
27 /// \file
28 /// Audiokinetic's definitions and factory of overridable Memory Manager module.
29 
30 #pragma once
31 
32 #include <AK/SoundEngine/Common/AkTypes.h>
33 #include <AK/SoundEngine/Common/AkMemoryMgr.h>
34 
35 /// \name Audiokinetic Memory Manager's implementation-specific definitions.
36 //@{
37 
38 typedef void ( AKSOUNDENGINE_CALL *AkMemInitForThread ) (
39  );
40 
41 typedef void ( AKSOUNDENGINE_CALL *AkMemTermForThread ) (
42  );
43 
44 typedef void ( AKSOUNDENGINE_CALL *AkMemTrimForThread ) (
45  );
46 
47 typedef void* ( AKSOUNDENGINE_CALL *AkMemMalloc ) (
48  AkMemPoolId poolId,
49  size_t uSize
50  );
51 
52 typedef void* ( AKSOUNDENGINE_CALL *AkMemMalign ) (
53  AkMemPoolId poolId,
54  size_t uSize,
55  AkUInt32 uAlignment
56  );
57 
58 typedef void* ( AKSOUNDENGINE_CALL *AkMemRealloc ) (
59  AkMemPoolId poolId,
60  void* pAddress,
61  size_t uSize
62  );
63 
64 
65 typedef void* ( AKSOUNDENGINE_CALL *AkMemReallocAligned ) (
66  AkMemPoolId poolId,
67  void* pAddress,
68  size_t uSize,
69  AkUInt32 uAlignment
70  );
71 
72 typedef void ( AKSOUNDENGINE_CALL *AkMemFree ) (
73  AkMemPoolId poolId,
74  void* pAddress
75  );
76 
77 typedef size_t ( AKSOUNDENGINE_CALL *AkMemTotalReservedMemorySize ) (
78  );
79 
80 typedef size_t ( AKSOUNDENGINE_CALL *AkMemSizeOfMemory ) (
81  AkMemPoolId poolId,
82  void* pAddress
83  );
84 
85 typedef void ( AKSOUNDENGINE_CALL *AkMemDebugMalloc ) (
86  AkMemPoolId poolId,
87  size_t uSize,
88  void* pAddress,
89  char const* pszFile,
90  AkUInt32 uLine
91  );
92 
93 typedef void ( AKSOUNDENGINE_CALL *AkMemDebugMalign ) (
94  AkMemPoolId poolId,
95  size_t uSize,
96  AkUInt32 uAlignment,
97  void* pAddress,
98  char const* pszFile,
99  AkUInt32 uLine
100  );
101 
102 typedef void ( AKSOUNDENGINE_CALL *AkMemDebugRealloc ) (
103  AkMemPoolId poolId,
104  void* pOldAddress,
105  size_t uSize,
106  void* pNewAddress,
107  char const* pszFile,
108  AkUInt32 uLine
109  );
110 
111 typedef void ( AKSOUNDENGINE_CALL *AkMemDebugReallocAligned ) (
112  AkMemPoolId poolId,
113  void* pOldAddress,
114  size_t uSize,
115  AkUInt32 uAlignment,
116  void* pNewAddress,
117  char const* pszFile,
118  AkUInt32 uLine
119  );
120 
121 typedef void ( AKSOUNDENGINE_CALL *AkMemDebugFree ) (
122  AkMemPoolId poolId,
123  void* pAddress
124  );
125 
126 typedef void* ( *AkMemAllocVM ) (
127  size_t size,
128  size_t* extra
129  );
130 
131 typedef void ( *AkMemFreeVM ) (
132  void* address,
133  size_t size,
134  size_t extra,
135  size_t release
136  );
137 
138 enum AkSpanCount
139 {
140  // Span count attempts to be as low as possible. Offers lowest memory usage, but reduces CPU performance due to increased calls to pfAllocVM and other memory allocation hooks.
141  AkSpanCount_Small = 0,
142 
143  // Span count attempts to match 512KiB mappings. Offers moderate balance between memory and CPU usage.
144  AkSpanCount_Medium,
145 
146  // Span count attempts to match 2MiB, or AK_VM_HUGE_PAGE_SIZE, mappings. Offers best overall CPU performance due to use of 2MiB page mappings, but increased memory usage.
147  AkSpanCount_Huge,
148 
149  AkSpanCount_END,
150 };
151 
152 /// Initialization settings for the default implementation of the Memory Manager. For more details, see \ref memorymanager_init.
153 /// \sa AK::MemoryMgr
154 struct AkMemSettings
155 {
156  /// @name High-level memory allocation hooks. When not NULL, redirect allocations normally forwarded to rpmalloc.
157  //@{
158  AkMemInitForThread pfInitForThread; ///< (Optional) Thread-specific allocator initialization hook.
159  AkMemTermForThread pfTermForThread; ///< (Optional) Thread-specific allocator termination hook.
160  //AkMemTrimForThread pfTrimForThread; ///< (Optional) Thread-specific allocator "trimming" hook. Used to relinquish memory resources when threads enter a period of inactivity.
161  AkMemMalloc pfMalloc; ///< (Optional) Memory allocation hook.
162  AkMemMalign pfMalign; ///< (Optional) Memory allocation hook.
163  AkMemRealloc pfRealloc; ///< (Optional) Memory allocation hook.
164  AkMemReallocAligned pfReallocAligned; ///< (Optional) Memory allocation hook.
165  AkMemFree pfFree; ///< (Optional) Memory allocation hook.
166  AkMemTotalReservedMemorySize pfTotalReservedMemorySize; ///< (Optional) Memory allocation statistics hook.
167  AkMemSizeOfMemory pfSizeOfMemory; ///< (Optional) Memory allocation statistics hook.
168  //@}
169 
170  /// @name Configuration.
171  //@{
172  AkUInt64 uMemAllocationSizeLimit; ///< When non-zero, limits the total amount of virtual and device memory allocated by AK::MemoryMgr.
173  bool bUseDeviceMemAlways; ///< Use device memory for all allocations (on applicable platforms).
174  //@}
175 
176  /// @name Page allocation hooks, used by rpmalloc. Default to AKPLATFORM::AllocVM et al.
177  //@{
178  AkMemAllocVM pfAllocVM; ///< Virtual page allocation hook.
179  AkMemFreeVM pfFreeVM; ///< Virtual page allocation hook.
180  AkMemAllocVM pfAllocDevice; ///< Device page allocation hook.
181  AkMemFreeVM pfFreeDevice; ///< Device page allocation hook.
182  AkUInt32 uVMPageSize; ///< Virtual memory page size. Defaults to 0 which means auto-detect.
183  AkUInt32 uDevicePageSize; ///< Device memory page size. Defaults to 0 which means auto-detect.
184  AkUInt32 uMaxThreadLocalHeapAllocSize; ///< All memory allocations of sizes larger than this value will go to a global heap shared across all threads. Defaults to 0 which means all allocations go to a global heap.
185  //@}
186 
187  /// @name Memory allocation debugging.
188  //@{
189  AkMemDebugMalloc pfDebugMalloc; ///< (Optional) Memory allocation debugging hook. Used for tracking calls to pfMalloc.
190  AkMemDebugMalign pfDebugMalign; ///< (Optional) Memory allocation debugging hook. Used for tracking calls to pfMalign.
191  AkMemDebugRealloc pfDebugRealloc; ///< (Optional) Memory allocation debugging hook. Used for tracking calls to pfRealloc.
192  AkMemDebugReallocAligned pfDebugReallocAligned; ///< (Optional) Memory allocation debugging hook. Used for tracking calls to pfReallocAligned.
193  AkMemDebugFree pfDebugFree; ///< (Optional) Memory allocation debugging hook. Used for tracking calls to pfFree.
194  AkUInt32 uMemoryDebugLevel; ///< Default 0 disabled. 1 debug enabled. 2 stomp allocator enabled. 3 stomp allocator and debug enabled. User implementations may use multiple non-zero values to offer different features.
195  //@}
196 
197  // Moved to end-of-struct to maintain stability across 2022.1 modules.
198  AkMemTrimForThread pfTrimForThread; ///< (Optional) Thread-specific allocator "trimming" hook.
199  AkSpanCount uVMSpanCount; ///< Virtual memory span count for each map operation in rpmalloc. Defaults to AkSpanCount_Huge. For more information, refer to \ref goingfurther_optimizingmempools_spancount.
200  AkSpanCount uDeviceSpanCount; ///< Device memory span count for each map operation in rpmalloc. Defaults to AkSpanCount_Huge. For more information, refer to \ref goingfurther_optimizingmempools_spancount.
201 };
202 //@}
203 
204 namespace AK
205 {
206 
207 namespace MemoryMgr
208 {
209 
210 /// Initialize the default implementation of the Memory Manager.
211 /// \sa AK::MemoryMgr
212 AK_EXTERNAPIFUNC( AKRESULT, Init ) (
213  AkMemSettings * in_pSettings ///< Memory manager initialization settings.
214  );
215 
216 /// Obtain the default initialization settings for the default implementation of the Memory Manager.
217 AK_EXTERNAPIFUNC( void, GetDefaultSettings ) (
218  AkMemSettings & out_pMemSettings ///< Memory manager default initialization settings.
219  );
220 
221 }
222 
223 }
224 
225 #if defined AK_WIN || defined AK_LINUX || defined AK_SONY || defined AK_XBOX || defined AK_APPLE || defined AK_EMSCRIPTEN
226 #define AK_CRT_ALLOCATOR_SUPPORTED
227 #endif
228 
229 #ifdef AK_CRT_ALLOCATOR_SUPPORTED
230 namespace AK
231 {
232 
233 namespace MemoryMgr
234 {
235 
236 /// @name C runtime allocator functions for the default implementation of the Memory Manager.
237 //@{
238 
239 AK_EXTERNAPIFUNC( void, AkCrtAllocatorInitForThread )();
240 
241 AK_EXTERNAPIFUNC( void, AkCrtAllocatorTermForThread )();
242 
243 AK_EXTERNAPIFUNC( void, AkCrtAllocatorTrimForThread )();
244 
245 AK_EXTERNAPIFUNC( void*, AkCrtAllocatorMalloc )(
246  AkMemPoolId poolId,
247  size_t uSize
248  );
249 
250 AK_EXTERNAPIFUNC( void*, AkCrtAllocatorMalign )(
251  AkMemPoolId poolId,
252  size_t uSize,
253  AkUInt32 uAlignment
254  );
255 
256 AK_EXTERNAPIFUNC( void*, AkCrtAllocatorRealloc )(
257  AkMemPoolId poolId,
258  void* pAddress,
259  size_t uSize
260  );
261 
262 AK_EXTERNAPIFUNC( void*, AkCrtAllocatorReallocAligned )(
263  AkMemPoolId poolId,
264  void* pAddress,
265  size_t uSize,
266  AkUInt32 uAlignment
267  );
268 
269 AK_EXTERNAPIFUNC( void, AkCrtAllocatorFree )(
270  AkMemPoolId poolId,
271  void* pAddress
272  );
273 
274 AK_EXTERNAPIFUNC( size_t, AkCrtAllocatorTotalReservedMemorySize )();
275 
276 AK_EXTERNAPIFUNC( size_t, AkCrtAllocatorSizeOfMemory )(
277  AkMemPoolId poolID,
278  void* pAddress
279  );
280 
281 //@}
282 
283 }
284 
285 }
286 
287 #endif // AK_CRT_ALLOCATOR_SUPPORTED
288 
289 #if !defined AK_EMSCRIPTEN
290 #define AK_STOMP_ALLOCATOR_SUPPORTED
291 #endif
292 
293 #ifdef AK_STOMP_ALLOCATOR_SUPPORTED
294 
295 namespace AK
296 {
297 
298 namespace MemoryMgr
299 {
300 
301 /// @name Stomp allocator functions for the default implementation of the Memory Manager.
302 //@{
303 
304 AK_EXTERNAPIFUNC( void, AkStompAllocatorInitForThread )();
305 
306 AK_EXTERNAPIFUNC( void, AkStompAllocatorTermForThread )();
307 
308 AK_EXTERNAPIFUNC( void, AkStompAllocatorTrimForThread )();
309 
310 AK_EXTERNAPIFUNC( void*, AkStompAllocatorMalloc )(
311  AkMemPoolId poolId,
312  size_t uSize
313  );
314 
315 AK_EXTERNAPIFUNC( void*, AkStompAllocatorMalign )(
316  AkMemPoolId poolId,
317  size_t uSize,
318  AkUInt32 uAlignment
319  );
320 
321 AK_EXTERNAPIFUNC( void*, AkStompAllocatorRealloc )(
322  AkMemPoolId poolId,
323  void* pAddress,
324  size_t uSize
325  );
326 
327 AK_EXTERNAPIFUNC( void*, AkStompAllocatorReallocAligned )(
328  AkMemPoolId poolId,
329  void* pAddress,
330  size_t uSize,
331  AkUInt32 uAlignment
332  );
333 
334 AK_EXTERNAPIFUNC( void, AkStompAllocatorFree )(
335  AkMemPoolId poolId,
336  void* pAddress
337  );
338 
339 AK_EXTERNAPIFUNC( size_t, AkStompAllocatorTotalReservedMemorySize )();
340 
341 AK_EXTERNAPIFUNC( size_t, AkStompAllocatorSizeOfMemory )(
342  AkMemPoolId poolID,
343  void* pAddress
344  );
345 
346 //@}
347 
348 }
349 
350 }
351 #endif // AK_STOMP_ALLOCATOR_SUPPORTED
352 
353 namespace AK
354 {
355 
356 namespace MemoryMgr
357 {
358 
359 /// @name Debug tool hooks for the default implementation of the Memory Manager.
360 //@{
361 
362 AK_EXTERNAPIFUNC( AKRESULT, AkMemDebugToolInit )();
363 
364 AK_EXTERNAPIFUNC( void, AkMemDebugToolTerm )();
365 
366 AK_EXTERNAPIFUNC( void, AkMemDebugToolMalloc ) (
367  AkMemPoolId poolId,
368  size_t uSize,
369  void* pAddress,
370  char const* pszFile,
371  AkUInt32 uLine
372  );
373 
374 AK_EXTERNAPIFUNC( void, AkMemDebugToolMalign ) (
375  AkMemPoolId poolId,
376  size_t uSize,
377  AkUInt32 uAlignment,
378  void* pAddress,
379  char const* pszFile,
380  AkUInt32 uLine
381  );
382 
383 AK_EXTERNAPIFUNC( void, AkMemDebugToolRealloc ) (
384  AkMemPoolId poolId,
385  void* pOldAddress,
386  size_t uSize,
387  void* pNewAddress,
388  char const* pszFile,
389  AkUInt32 uLine
390  );
391 
392 AK_EXTERNAPIFUNC( void, AkMemDebugToolReallocAligned ) (
393  AkMemPoolId poolId,
394  void* pOldAddress,
395  size_t uSize,
396  AkUInt32 uAlignment,
397  void* pNewAddress,
398  char const* pszFile,
399  AkUInt32 uLine
400  );
401 
402 AK_EXTERNAPIFUNC( void, AkMemDebugToolFree ) (
403  AkMemPoolId poolId,
404  void* pAddress
405  );
406 
407 //@}
408 
409 }
410 
411 }
AkMemDebugMalloc
void(* AkMemDebugMalloc)(AkMemPoolId poolId, size_t uSize, void *pAddress, char const *pszFile, AkUInt32 uLine)
Definition: AkModule.h:85
AK::MemoryMgr::AkMemDebugToolInit
AKSOUNDENGINE_API AKRESULT AkMemDebugToolInit()
AK
Audiokinetic namespace.
Definition: AkWwiseSDKVersion.cs:31
AkMemSettings::pfTermForThread
AkMemTermForThread pfTermForThread
(Optional) Thread-specific allocator termination hook.
Definition: AkModule.h:159
AkMemInitForThread
void(* AkMemInitForThread)()
Definition: AkModule.h:38
AkSpanCount_Medium
@ AkSpanCount_Medium
Definition: AkModule.h:144
AK::MemoryMgr::AkMemDebugToolMalloc
AKSOUNDENGINE_API void AkMemDebugToolMalloc(AkMemPoolId poolId, size_t uSize, void *pAddress, char const *pszFile, AkUInt32 uLine)
AkMemSettings::uMaxThreadLocalHeapAllocSize
AkUInt32 uMaxThreadLocalHeapAllocSize
All memory allocations of sizes larger than this value will go to a global heap shared across all thr...
Definition: AkModule.h:184
AkMemSettings::pfInitForThread
AkMemInitForThread pfInitForThread
(Optional) Thread-specific allocator initialization hook.
Definition: AkModule.h:158
AkMemSettings::pfFree
AkMemFree pfFree
(Optional) Memory allocation hook.
Definition: AkModule.h:165
AkMemSettings::pfMalign
AkMemMalign pfMalign
(Optional) Memory allocation hook.
Definition: AkModule.h:162
AK::MemoryMgr::Init
AKSOUNDENGINE_API AKRESULT Init(AkMemSettings *in_pSettings)
AkSpanCount
AkSpanCount
Definition: AkModule.h:139
AK::MemoryMgr::AkStompAllocatorFree
AKSOUNDENGINE_API void AkStompAllocatorFree(AkMemPoolId poolId, void *pAddress)
AK::MemoryMgr::AkCrtAllocatorInitForThread
AKSOUNDENGINE_API void AkCrtAllocatorInitForThread()
AkMemSettings::uVMSpanCount
AkSpanCount uVMSpanCount
Virtual memory span count for each map operation in rpmalloc. Defaults to AkSpanCount_Huge....
Definition: AkModule.h:199
AK::MemoryMgr::AkStompAllocatorMalloc
AKSOUNDENGINE_API void * AkStompAllocatorMalloc(AkMemPoolId poolId, size_t uSize)
AK_EXTERNAPIFUNC
#define AK_EXTERNAPIFUNC(_type, _name)
Definition: AkSoundEngineExport.h:81
AkMemSettings::pfRealloc
AkMemRealloc pfRealloc
(Optional) Memory allocation hook.
Definition: AkModule.h:163
AkMemSettings::pfFreeVM
AkMemFreeVM pfFreeVM
Virtual page allocation hook.
Definition: AkModule.h:179
AKRESULT
AKRESULT
Standard function call result.
Definition: AkTypes.h:199
AkMemRealloc
void *(* AkMemRealloc)(AkMemPoolId poolId, void *pAddress, size_t uSize)
Definition: AkModule.h:58
AK::MemoryMgr::AkMemDebugToolFree
AKSOUNDENGINE_API void AkMemDebugToolFree(AkMemPoolId poolId, void *pAddress)
AkSpanCount_Huge
@ AkSpanCount_Huge
Definition: AkModule.h:147
AkMemPoolId
AkInt32 AkMemPoolId
Memory pool ID.
Definition: AkTypes.h:130
AkMemSettings::pfDebugRealloc
AkMemDebugRealloc pfDebugRealloc
(Optional) Memory allocation debugging hook. Used for tracking calls to pfRealloc.
Definition: AkModule.h:191
AkMemDebugRealloc
void(* AkMemDebugRealloc)(AkMemPoolId poolId, void *pOldAddress, size_t uSize, void *pNewAddress, char const *pszFile, AkUInt32 uLine)
Definition: AkModule.h:102
AkMemAllocVM
void *(* AkMemAllocVM)(size_t size, size_t *extra)
Definition: AkModule.h:126
AkMemSettings::pfDebugReallocAligned
AkMemDebugReallocAligned pfDebugReallocAligned
(Optional) Memory allocation debugging hook. Used for tracking calls to pfReallocAligned.
Definition: AkModule.h:192
AkMemReallocAligned
void *(* AkMemReallocAligned)(AkMemPoolId poolId, void *pAddress, size_t uSize, AkUInt32 uAlignment)
Definition: AkModule.h:65
AK::MemoryMgr::AkMemDebugToolTerm
AKSOUNDENGINE_API void AkMemDebugToolTerm()
AK::MemoryMgr::AkCrtAllocatorMalign
AKSOUNDENGINE_API void * AkCrtAllocatorMalign(AkMemPoolId poolId, size_t uSize, AkUInt32 uAlignment)
AkMemSettings::pfTrimForThread
AkMemTrimForThread pfTrimForThread
(Optional) Thread-specific allocator "trimming" hook.
Definition: AkModule.h:198
AK::MemoryMgr::AkMemDebugToolMalign
AKSOUNDENGINE_API void AkMemDebugToolMalign(AkMemPoolId poolId, size_t uSize, AkUInt32 uAlignment, void *pAddress, char const *pszFile, AkUInt32 uLine)
AkMemMalloc
void *(* AkMemMalloc)(AkMemPoolId poolId, size_t uSize)
Definition: AkModule.h:47
AK::MemoryMgr::AkStompAllocatorTermForThread
AKSOUNDENGINE_API void AkStompAllocatorTermForThread()
AK::MemoryMgr::AkCrtAllocatorFree
AKSOUNDENGINE_API void AkCrtAllocatorFree(AkMemPoolId poolId, void *pAddress)
AkMemSettings::pfReallocAligned
AkMemReallocAligned pfReallocAligned
(Optional) Memory allocation hook.
Definition: AkModule.h:164
AkMemSettings::pfFreeDevice
AkMemFreeVM pfFreeDevice
Device page allocation hook.
Definition: AkModule.h:181
AkMemTotalReservedMemorySize
size_t(* AkMemTotalReservedMemorySize)()
Definition: AkModule.h:77
AK::MemoryMgr::AkStompAllocatorRealloc
AKSOUNDENGINE_API void * AkStompAllocatorRealloc(AkMemPoolId poolId, void *pAddress, size_t uSize)
AkMemSettings::pfAllocVM
AkMemAllocVM pfAllocVM
Virtual page allocation hook.
Definition: AkModule.h:178
AK::MemoryMgr::AkCrtAllocatorRealloc
AKSOUNDENGINE_API void * AkCrtAllocatorRealloc(AkMemPoolId poolId, void *pAddress, size_t uSize)
AkMemTermForThread
void(* AkMemTermForThread)()
Definition: AkModule.h:41
AkMemSettings::uMemAllocationSizeLimit
AkUInt64 uMemAllocationSizeLimit
When non-zero, limits the total amount of virtual and device memory allocated by AK::MemoryMgr.
Definition: AkModule.h:172
AkMemDebugReallocAligned
void(* AkMemDebugReallocAligned)(AkMemPoolId poolId, void *pOldAddress, size_t uSize, AkUInt32 uAlignment, void *pNewAddress, char const *pszFile, AkUInt32 uLine)
Definition: AkModule.h:111
AK::MemoryMgr::AkStompAllocatorInitForThread
AKSOUNDENGINE_API void AkStompAllocatorInitForThread()
AK::MemoryMgr::AkCrtAllocatorSizeOfMemory
AKSOUNDENGINE_API size_t AkCrtAllocatorSizeOfMemory(AkMemPoolId poolID, void *pAddress)
AkMemTrimForThread
void(* AkMemTrimForThread)()
Definition: AkModule.h:44
AkMemFree
void(* AkMemFree)(AkMemPoolId poolId, void *pAddress)
Definition: AkModule.h:72
AK::MemoryMgr::AkMemDebugToolReallocAligned
AKSOUNDENGINE_API void AkMemDebugToolReallocAligned(AkMemPoolId poolId, void *pOldAddress, size_t uSize, AkUInt32 uAlignment, void *pNewAddress, char const *pszFile, AkUInt32 uLine)
AK::MemoryMgr::GetDefaultSettings
AKSOUNDENGINE_API void GetDefaultSettings(AkMemSettings &out_pMemSettings)
Obtain the default initialization settings for the default implementation of the Memory Manager.
AkMemMalign
void *(* AkMemMalign)(AkMemPoolId poolId, size_t uSize, AkUInt32 uAlignment)
Definition: AkModule.h:52
AkMemSettings::uMemoryDebugLevel
AkUInt32 uMemoryDebugLevel
Default 0 disabled. 1 debug enabled. 2 stomp allocator enabled. 3 stomp allocator and debug enabled....
Definition: AkModule.h:194
AkMemSettings::uDeviceSpanCount
AkSpanCount uDeviceSpanCount
Device memory span count for each map operation in rpmalloc. Defaults to AkSpanCount_Huge....
Definition: AkModule.h:200
AK::MemoryMgr::AkCrtAllocatorMalloc
AKSOUNDENGINE_API void * AkCrtAllocatorMalloc(AkMemPoolId poolId, size_t uSize)
AKSOUNDENGINE_CALL
#define AKSOUNDENGINE_CALL
Calling convention for the Wwise API.
Definition: AkTypes.h:118
AkMemSettings::uDevicePageSize
AkUInt32 uDevicePageSize
Device memory page size. Defaults to 0 which means auto-detect.
Definition: AkModule.h:183
AkMemSettings::pfTotalReservedMemorySize
AkMemTotalReservedMemorySize pfTotalReservedMemorySize
(Optional) Memory allocation statistics hook.
Definition: AkModule.h:166
AK::MemoryMgr::AkStompAllocatorReallocAligned
AKSOUNDENGINE_API void * AkStompAllocatorReallocAligned(AkMemPoolId poolId, void *pAddress, size_t uSize, AkUInt32 uAlignment)
AkMemSettings::pfMalloc
AkMemMalloc pfMalloc
(Optional) Memory allocation hook.
Definition: AkModule.h:161
AkSpanCount_Small
@ AkSpanCount_Small
Definition: AkModule.h:141
AK::MemoryMgr::AkCrtAllocatorTermForThread
AKSOUNDENGINE_API void AkCrtAllocatorTermForThread()
AK::MemoryMgr::AkStompAllocatorMalign
AKSOUNDENGINE_API void * AkStompAllocatorMalign(AkMemPoolId poolId, size_t uSize, AkUInt32 uAlignment)
AkUInt64
uint64_t AkUInt64
Unsigned 64-bit integer.
Definition: AkNumeralTypes.h:39
AkMemFreeVM
void(* AkMemFreeVM)(void *address, size_t size, size_t extra, size_t release)
Definition: AkModule.h:131
AK::MemoryMgr::AkStompAllocatorTrimForThread
AKSOUNDENGINE_API void AkStompAllocatorTrimForThread()
AkMemSettings::pfDebugMalloc
AkMemDebugMalloc pfDebugMalloc
(Optional) Memory allocation debugging hook. Used for tracking calls to pfMalloc.
Definition: AkModule.h:189
AK::MemoryMgr::AkStompAllocatorTotalReservedMemorySize
AKSOUNDENGINE_API size_t AkStompAllocatorTotalReservedMemorySize()
AkSpanCount_END
@ AkSpanCount_END
Definition: AkModule.h:149
AkUInt32
uint32_t AkUInt32
Unsigned 32-bit integer.
Definition: AkNumeralTypes.h:38
AkMemSizeOfMemory
size_t(* AkMemSizeOfMemory)(AkMemPoolId poolId, void *pAddress)
Definition: AkModule.h:80
AkMemSettings::uVMPageSize
AkUInt32 uVMPageSize
Virtual memory page size. Defaults to 0 which means auto-detect.
Definition: AkModule.h:182
AkMemDebugMalign
void(* AkMemDebugMalign)(AkMemPoolId poolId, size_t uSize, AkUInt32 uAlignment, void *pAddress, char const *pszFile, AkUInt32 uLine)
Definition: AkModule.h:93
AK::MemoryMgr::AkCrtAllocatorTotalReservedMemorySize
AKSOUNDENGINE_API size_t AkCrtAllocatorTotalReservedMemorySize()
AK::MemoryMgr::AkCrtAllocatorTrimForThread
AKSOUNDENGINE_API void AkCrtAllocatorTrimForThread()
AkMemDebugFree
void(* AkMemDebugFree)(AkMemPoolId poolId, void *pAddress)
Definition: AkModule.h:121
AkMemSettings::pfDebugFree
AkMemDebugFree pfDebugFree
(Optional) Memory allocation debugging hook. Used for tracking calls to pfFree.
Definition: AkModule.h:193
AkMemSettings::pfSizeOfMemory
AkMemSizeOfMemory pfSizeOfMemory
(Optional) Memory allocation statistics hook.
Definition: AkModule.h:167
AkMemSettings::pfDebugMalign
AkMemDebugMalign pfDebugMalign
(Optional) Memory allocation debugging hook. Used for tracking calls to pfMalign.
Definition: AkModule.h:190
AK::MemoryMgr::AkMemDebugToolRealloc
AKSOUNDENGINE_API void AkMemDebugToolRealloc(AkMemPoolId poolId, void *pOldAddress, size_t uSize, void *pNewAddress, char const *pszFile, AkUInt32 uLine)
AK::MemoryMgr::AkCrtAllocatorReallocAligned
AKSOUNDENGINE_API void * AkCrtAllocatorReallocAligned(AkMemPoolId poolId, void *pAddress, size_t uSize, AkUInt32 uAlignment)
AK::MemoryMgr::AkStompAllocatorSizeOfMemory
AKSOUNDENGINE_API size_t AkStompAllocatorSizeOfMemory(AkMemPoolId poolID, void *pAddress)
AkMemSettings::pfAllocDevice
AkMemAllocVM pfAllocDevice
Device page allocation hook.
Definition: AkModule.h:180
AkMemSettings::bUseDeviceMemAlways
bool bUseDeviceMemAlways
Use device memory for all allocations (on applicable platforms).
Definition: AkModule.h:173

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

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