Version
menu_open
link
Wwise SDK 2018.1.11
AkKeyDef.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 #ifndef _KEYDEF_H_
29 #define _KEYDEF_H_
30 
31 #include <AK/Tools/Common/AkArray.h> //For ArrayPoolDefault
32 
33 template <class T_KEY, class T_ITEM>
34 struct MapStruct
35 {
36  T_KEY key;
37  T_ITEM item;
38  bool operator ==(const MapStruct& in_Op) const
39  {
40  return ( (key == in_Op.key) /*&& (item == in_Op.item)*/ );
41  }
42 
44  {
45  key = in_rSource.key;
46  item.Transfer(in_rSource.item); //transfer ownership of resources.
47  }
48 };
49 
50 
51 // A helper struct that can be used as a T_ITEM in an CAkKeyArray, when you need to only preform a shallow copy
52 // on the data that you are referencing. For example if you wanted to to use an AkArray type.
53 // NOTE: AllocData() and FreeData() must be explicitly called, or else pData can be manually Alloc'd/Free'd.
54 template < typename T_KEY, typename T_DATA, class T_ALLOC = ArrayPoolDefault >
55 struct AkKeyDataPtrStruct: public T_ALLOC
56 {
58  AkKeyDataPtrStruct(T_KEY in_key): key(in_key), pData(NULL) {}
59 
60  T_KEY key;
61  T_DATA* pData;
63  {
64  return ( key == in_Op.key );
65  }
66 
67  bool AllocData()
68  {
69  AKASSERT( !pData );
70  pData = (T_DATA*) T_ALLOC::Alloc( sizeof( T_DATA ));
71  if (pData)
72  {
73  AkPlacementNew( pData ) T_DATA();
74  return true;
75  }
76  return false;
77  }
78 
79  void FreeData()
80  {
81  if( pData )
82  {
83  pData->~T_DATA();
85  pData = NULL;
86  }
87  }
88 
89  static AkForceInline T_KEY& Get( AkKeyDataPtrStruct<T_KEY, T_DATA>& in_val ) { return in_val.key; }
90 };
91 
92 #endif //_KEYDEF_H_
AKRESULT __cdecl Free(AkMemPoolId in_poolId, void *in_pMemAddress)
AkKeyDataPtrStruct(T_KEY in_key)
Definition: AkKeyDef.h:58
bool operator==(const AkKeyDataPtrStruct< T_KEY, T_DATA > &in_Op) const
Definition: AkKeyDef.h:62
#define AKASSERT(Condition)
Definition: AkAssert.h:69
static AkForceInline T_KEY & Get(AkKeyDataPtrStruct< T_KEY, T_DATA > &in_val)
Definition: AkKeyDef.h:89
void FreeData()
Definition: AkKeyDef.h:79
T_KEY key
Definition: AkKeyDef.h:36
AkKeyDataPtrStruct()
Definition: AkKeyDef.h:57
#define AkForceInline
Force inlining.
Definition: AkTypes.h:63
T_KEY key
Definition: AkKeyDef.h:60
T_DATA * pData
Definition: AkKeyDef.h:61
bool operator==(const MapStruct &in_Op) const
Definition: AkKeyDef.h:38
#define NULL
Definition: AkTypes.h:49
#define AkPlacementNew(_memory)
Definition: AkObject.h:53
bool AllocData()
Definition: AkKeyDef.h:67
Definition: AkKeyDef.h:34
void Transfer(MapStruct< T_KEY, T_ITEM > &in_rSource)
Definition: AkKeyDef.h:43
T_ITEM item
Definition: AkKeyDef.h:37

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