Table of Contents

Wwise SDK 2018.1.11
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  Version: <VERSION> Build: <BUILDNUMBER>
25  Copyright (c) <COPYRIGHTYEAR> Audiokinetic Inc.
26 *******************************************************************************/
27 
28 /// \file
29 /// Audiokinetic's definitions and factory of overridable Memory Manager module.
30 
31 #pragma once
32 
34 
35 /// \name Audiokinetic Memory Manager's implementation-specific definitions.
36 //@{
37 /// Memory Manager's initialization settings.
38 /// \sa AK::MemoryMgr
40 {
42  {
43  uMaxNumPools = 32; // Default number of pools.
44  uDebugFlags = 0;
45  }
46  AkUInt32 uMaxNumPools; ///< Maximum number of memory pools. 32 by default, increase as needed.
47  AkUInt32 uDebugFlags; ///< Debug flags from AK::MemoryMgr::DebugFlags enum. Should be 0. This flag is ignored when not in DEBUG. Memory usage will be higher when this debug tool is enabled.
48 };
49 //@}
50 
51 namespace AK
52 {
53  /// \name Audiokinetic implementation-specific modules factories.
54  //@{
55  namespace MemoryMgr
56  {
57  /// Memory Manager initialization.
58  /// \sa AK::MemoryMgr
60  AkMemSettings * in_pSettings ///< Memory manager initialization settings.
61  );
62  }
63  //@}
64 }
65 
AkUInt32 uDebugFlags
Debug flags from AK::MemoryMgr::DebugFlags enum. Should be 0. This flag is ignored when not in DEBUG....
Definition: AkModule.h:47
AKRESULT
Standard function call result.
Definition: AkTypes.h:126
Audiokinetic namespace.
#define AK_EXTERNAPIFUNC(__TYPE__, __NAME__)
AkUInt32 uMaxNumPools
Maximum number of memory pools. 32 by default, increase as needed.
Definition: AkModule.h:46
AKRESULT __cdecl Init(AkMemSettings *in_pSettings)
uint32_t AkUInt32
Unsigned 32-bit integer.
Definition: AkTypes.h:79
AkMemSettings()
Definition: AkModule.h:41