Wwise SDK 2021.1.14
_plugin_links_8h_source
Version
menu_open
link
PluginLinks.h
Go to the documentation of this file.
29 * \brief Wwise Authoring Plug-ins - Provides links to the related backend and frontend instances.
40 * Useful for the Frontend (GUI) when a special function must be called to get a value, or update elements.
52 /// Base host-provided instance to retrieve the related backend instance, as shown in the frontend.
62 * \aknote The returned pointer might be modified in the frontend lifetime. For example, a plug-in that would undo
63 * and redo a plug-in creation might return a different value. As such, you should not store the backend
89 /// Base host-provided instance to retrieve the related frontend instances related to the current backend.
99 * \aknote The returned array is a temporary TLS pointer that is meant to be retrieved and processed immediately to
114 #define AK_WWISE_PLUGIN_LINK_BACKEND_CTOR(/* ak_wwise_plugin_info* */ in_pluginInfo, /* void* */ in_data) \
116 .m_baseInterface = AK_WWISE_PLUGIN_BASE_INTERFACE_CTOR(AK_WWISE_PLUGIN_LINK_BACKEND_ID(), in_pluginInfo, in_data) \
121 #define AK_WWISE_PLUGIN_LINK_FRONTEND_CTOR(/* ak_wwise_plugin_info* */ in_pluginInfo, /* void* */ in_data) \
123 .m_baseInterface = AK_WWISE_PLUGIN_BASE_INTERFACE_CTOR(AK_WWISE_PLUGIN_LINK_FRONTEND_ID(), in_pluginInfo, in_data) \
151 };
161 };
166 * \aknote The returned pointer might be modified in the frontend lifetime. For example, a plug-in that would undo
167 * and redo a plug-in creation might return a different value. As such, you should not store the backend
178 * \brief Retrieves a link to the plug-in's backend instance, casted as your C++ Backend class type.
180 * \aknote The returned pointer might be modified in the frontend lifetime. For example, a plug-in that would undo
181 * and redo a plug-in creation might return a different value. As such, you should not store the backend
184 * \tparam Backend Expected type of the backend instance. An unexpected type yields to an undefined result.
210 };
220 };
225 * \aknote The returned array is a temporary TLS pointer that is meant to be retrieved and processed immediately to
239 * \aknote The frontend instances passed to the function are temporary TLS pointers that are meant to be retrieved
242 * \tparam Frontend Expected type of the frontend instances (optional). If no explicit type is provided, the caller
243 * needs to manually perform the cast to the expected frontend instance type. If an explicit type is
244 * provided, the frontend instances will automatically be casted to the provided type and then forwarded
ak_wwise_plugin_frontend_instance **(* GetArray)(const ak_wwise_plugin_link_frontend_instance_v1 *in_this, int *out_count)
Retrieves an array of the plug-in's frontend instances.
Definition: PluginLinks.h:106
V1::LinkBackend LinkBackend
Latest version of the C++ LinkBackend interface.
Definition: PluginLinks.h:275
ak_wwise_plugin_link_frontend_v1 CLinkFrontend
Definition: PluginLinks.h:133
static GluedInterface * g_cinterface
The unique instance of the CInterface interface. Defined at nullptr first, overridden by the Host onc...
Definition: PluginInfoGenerator.h:90
ak_wwise_plugin_link_backend_v1()
Definition: PluginLinks.h:54
decltype(BaseInterface::m_version) InterfaceVersion
PluginInfoGenerator: Type for the m_version value in BaseInterface.
Definition: PluginInfoGenerator.h:51
ak_wwise_plugin_link_frontend_v1()
Definition: PluginLinks.h:91
Base host-provided instance to retrieve the related backend instance, as shown in the frontend.
Definition: PluginDef.h:766
Wwise Authoring Plug-ins - C++ class helper to automatically determine the plug-in interfaces used in...
PluginInfoGenerator: Associates an existing C Interface with a variable that can be used....
Definition: PluginInfoGenerator.h:105
@ k_interfaceVersion
The interface version, as requested by this plug-in.
Definition: PluginLinks.h:219
@ k_interfaceVersion
The interface version, as requested by this plug-in.
Definition: PluginLinks.h:160
RequestedHostInterface< LinkFrontend > RequestLinkFrontend
Definition: PluginLinks.h:268
std::underlying_type< InterfaceType >::type InterfaceTypeValue
PluginInfoGenerator: Underlying storage type for the m_interface value in BaseInterface.
Definition: PluginInfoGenerator.h:50
Backend * As()
Retrieves a link to the plug-in's backend instance, casted as your C++ Backend class type.
Definition: PluginLinks.h:188
ak_wwise_plugin_backend_instance *(* Get)(const ak_wwise_plugin_link_backend_instance_v1 *in_this)
Retrieves a link to the plug-in's backend instance.
Definition: PluginLinks.h:69
ak_wwise_plugin_link_backend_v1 CLinkBackend
Definition: PluginLinks.h:132
AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_VERSION(AudioPlugin)
Host API to retrieve a link to the plug-in's frontend interfaces.
Definition: PluginLinks.h:83
Host API to retrieve a link to the plug-in's backend instance.
Definition: PluginLinks.h:46
Base host-provided instance to retrieve the related frontend instances related to the current backend...
Definition: PluginDef.h:776
Interface description and base class for every Wwise Authoring plug-in interface.
Definition: PluginBaseInterface.h:117
ak_wwise_plugin_link_frontend_instance_v1 Instance
Base host-provided instance to retrieve the related frontend instances related to the current backend...
Definition: PluginLinks.h:90
Host API to retrieve a link to the plug-in's backend instance.
Definition: PluginLinks.h:137
ak_wwise_plugin_frontend_instance ** GetArray(int *out_count) const
Retrieves an array of the plug-in's frontend instances.
Definition: PluginLinks.h:231
ak_wwise_plugin_backend_instance * Get() const
Retrieves a link to the plug-in's backend instance.
Definition: PluginLinks.h:172
V1::LinkFrontend LinkFrontend
Latest version of the C++ LinkFrontend interface.
Definition: PluginLinks.h:282
void ForEach(Functor in_operation) const
Applies a function on each plug-in's frontend instances.
Definition: PluginLinks.h:249
#define AK_WWISE_PLUGIN_SPECIALIZE_HOST_INTERFACE(in_name, in_varname,...)
PluginInfoGenerator: Creates a C++ host specialization for interface class specified in in_name,...
Definition: PluginInfoGenerator.h:238
Host API to retrieve a link to the plug-in's frontend interfaces.
Definition: PluginLinks.h:196
ak_wwise_plugin_link_backend_instance_v1 Instance
Base host-provided instance to retrieve the related backend instance, as shown in the frontend.
Definition: PluginLinks.h:53
RequestedHostInterface< LinkBackend > RequestLinkBackend
Definition: PluginLinks.h:267
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_LINK_FRONTEND
2021.1 Link to the frontend plug-ins. ak_wwise_plugin_link_frontend_v1
Definition: PluginBaseInterface.h:87
AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_CLASS(AudioPlugin)
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_LINK_BACKEND
2021.1 Link to the backend plug-in. ak_wwise_plugin_link_backend_v1
Definition: PluginBaseInterface.h:86
Definition: AudioPlugin.h:112
Was this page helpful?
Need Support?
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageTell 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