Table of Contents

include/AK/SoundEngine/Common/AkModule.h

Go to the documentation of this file.
00001 /*******************************************************************************
00002 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
00003 released in source code form as part of the SDK installer package.
00004 
00005 Commercial License Usage
00006 
00007 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
00008 may use this file in accordance with the end user license agreement provided 
00009 with the software or, alternatively, in accordance with the terms contained in a
00010 written agreement between you and Audiokinetic Inc.
00011 
00012 Apache License Usage
00013 
00014 Alternatively, this file may be used under the Apache License, Version 2.0 (the 
00015 "Apache License"); you may not use this file except in compliance with the 
00016 Apache License. You may obtain a copy of the Apache License at 
00017 http://www.apache.org/licenses/LICENSE-2.0.
00018 
00019 Unless required by applicable law or agreed to in writing, software distributed
00020 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
00021 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
00022 the specific language governing permissions and limitations under the License.
00023 
00024   Version: <VERSION>  Build: <BUILDNUMBER>
00025   Copyright (c) <COPYRIGHTYEAR> Audiokinetic Inc.
00026 *******************************************************************************/
00027 
00028 /// \file 
00029 /// Audiokinetic's definitions and factory of overridable Memory Manager module.
00030 
00031 #pragma once
00032 
00033 #include <AK/SoundEngine/Common/AkTypes.h>
00034 
00035 /// \name Audiokinetic Memory Manager's implementation-specific definitions.
00036 //@{
00037 /// Memory Manager's initialization settings.
00038 /// \sa AK::MemoryMgr
00039 struct AkMemSettings
00040 {   
00041     AkMemSettings()
00042     {
00043         uMaxNumPools = 32;              // Default number of pools.
00044         uDebugFlags = 0;
00045     }
00046     AkUInt32 uMaxNumPools;              ///< Maximum number of memory pools.  32 by default, increase as needed.
00047     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.
00048 };
00049 //@}
00050 
00051 namespace AK
00052 {
00053     /// \name Audiokinetic implementation-specific modules factories.
00054     //@{
00055     namespace MemoryMgr
00056     {
00057         /// Memory Manager initialization.
00058         /// \sa AK::MemoryMgr
00059         AK_EXTERNAPIFUNC(AKRESULT, Init)(
00060             AkMemSettings * in_pSettings        ///< Memory manager initialization settings.
00061             );
00062     }
00063     //@}
00064 }
00065