Version
menu_open
Wwise SDK 2024.1.1
PluginHelpers.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 /**
28  * \brief Wwise Authoring Plug-ins - Helper tools, potentially defined elsewhere.
29  * \file AK/Wwise/Plugin/PluginHelpers.h
30  */
31 
32 #pragma once
33 
34 #include "../../AkPlatforms.h"
35 #include "../../AkWwiseSDKVersion.h"
36 
37 #include <memory.h>
38 #include <stdbool.h> // for bool type
39 #include <stdint.h> // for integer types (uint32_t, ...)
40 
41 // These definitions are used throughout the Wwise plug-in system
42 #ifdef AK_WIN
43  #include <guiddef.h>
44  #include <cguid.h>
45  #define AK_DEFINE_GUID_NULL
46 #else
47  #ifndef GUID_DEFINED
48  #define GUID_DEFINED
49  // Adapted from Windows API, to have exactly the same definition. C-compatible.
50  #pragma pack(push,8)
51  typedef struct _GUID {
52  uint32_t Data1;
53  uint16_t Data2;
54  uint16_t Data3;
55  uint8_t Data4[8];
56  } GUID;
57  #pragma pack(pop)
58  #endif // GUID_DEFINED
59 
60  #ifndef GUID_HELPERS_DEFINED
61  #define GUID_HELPERS_DEFINED
62  extern const __attribute__((weak)) GUID GUID_NULL = { 0 };
63 
64  #ifdef __cplusplus
65  inline bool operator==(const GUID& lhs, const GUID& rhs)
66  {
67  return memcmp(&lhs, &rhs, sizeof(GUID)) == 0;
68  }
69 
70  inline bool operator!=(const GUID& lhs, const GUID& rhs)
71  {
72  return !(lhs == rhs);
73  }
74  #endif // __cplusplus
75  #endif // GUID_HELPERS_DEFINED
76 #endif // AK_WIN
77 
78 #ifndef MKBOOL
79  #define MKBOOL(cond) ((cond) ? true : false)
80 #endif

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