Version
menu_open
Wwise SDK 2023.1.4
PluginInterfaceArrayItem.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 - A single instantiatable plug-in interface.
29  * \file AK/Wwise/Plugin/PluginInterfaceArrayItem.h
30  */
31 
32 #pragma once
33 
34 #include "PluginBaseInterface.h"
35 
36 /**
37  * \brief A single instantiatable plug-in interface.
38  *
39  * The goal of the ak_wwise_plugin_interface_array_item is to provide both the static m_interface, as well as the
40  * dynamic m_instance
41  *
42  */
44 {
45  /**
46  * \brief The interface. Should be identical for every instance of this DLL.
47  *
48  * Filled in the static array by plug-in. Requests statically filled or nulled before Instantiate by host.
49  */
50  ak_wwise_plugin_interface_ptr m_interface;
51 
52  /**
53  * \brief That particular instance.
54  *
55  * Filled before Instantiate by host, or by Instantiate by plug-in.
56  */
57  ak_wwise_plugin_instance_ptr m_instance;
58 
59 #ifdef __cplusplus
60  constexpr inline ak_wwise_plugin_interface_array_item(ak_wwise_plugin_interface_ptr in_interface = nullptr, ak_wwise_plugin_instance_ptr in_instance = nullptr) :
61  m_interface(in_interface),
62  m_instance(in_instance)
63  {
64  }
65 #endif
66 };
67 
68 #define AK_WWISE_PLUGIN_INTERFACE_ARRAY_ITEM_CTOR() \
69 { \
70  .m_interface = 0, \
71  .m_instance = 0 \
72 }
73 #define AK_WWISE_PLUGIN_INTERFACE_ARRAY_ITEM_CTOR_INTERFACE(/* ak_wwise_plugin_interface_ptr */ in_interface) \
74 { \
75  .m_interface = in_interface, \
76  .m_instance = 0 \
77 }
78 #define AK_WWISE_PLUGIN_INTERFACE_ARRAY_ITEM_CTOR_INSTANCE(/* ak_wwise_plugin_interface_ptr */ in_interface, /* ak_wwise_plugin_instance_ptr */ in_instance) \
79 { \
80  .m_interface = in_interface, \
81  .m_instance = (void*)in_instance \
82 }
constexpr ak_wwise_plugin_interface_array_item(ak_wwise_plugin_interface_ptr in_interface=nullptr, ak_wwise_plugin_instance_ptr in_instance=nullptr)
Wwise Authoring Plug-ins - Standardized header for all the plug-in interfaces.
A single instantiatable plug-in interface.
ak_wwise_plugin_instance_ptr m_instance
That particular instance.
ak_wwise_plugin_interface_ptr m_interface
The interface. Should be identical for every instance of this DLL.

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