Version
menu_open
Wwise SDK 2023.1.4
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 #ifndef GUID_DEFINED // Adapted from Windows API, to have exactly the same definition. C-compatible.
43 #define GUID_DEFINED
44 #pragma pack(push,8)
45 typedef struct _GUID {
46  uint32_t Data1;
47  uint16_t Data2;
48  uint16_t Data3;
49  uint8_t Data4[8];
50 } GUID;
51 #pragma pack(pop)
52 #endif
53 
54 #ifndef AK_WIN
55 #ifndef GUID_HELPERS_DEFINED
56 #define GUID_HELPERS_DEFINED
57 extern const __attribute__((weak)) GUID GUID_NULL = { 0 };
58 
59 inline bool operator==(const GUID& lhs, const GUID& rhs)
60 {
61  return memcmp(&lhs, &rhs, sizeof(GUID)) == 0;
62 }
63 
64 inline bool operator!=(const GUID& lhs, const GUID& rhs)
65 {
66  return !(lhs == rhs);
67 }
68 #endif
69 #else
70 #define AK_DEFINE_GUID_NULL
71 #endif
72 
73 #ifndef MKBOOL
74 #define MKBOOL(cond) ((cond) ? true : false)
75 #endif
uint32_t Data1
Definition: PluginHelpers.h:46
uint16_t Data2
Definition: PluginHelpers.h:47
uint16_t Data3
Definition: PluginHelpers.h:48

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