Wwise SDK
_plugin_links_8h_source
バージョン
menu_open
link
PluginLinks.h
[詳解]
28 * \brief Wwise Authoring Plug-ins - Provides links to the related backend and frontend instances.
39 * Useful for the Frontend (GUI) when a special function must be called to get a value, or update elements.
51 /// Base host-provided instance to retrieve the related backend instance, as shown in the frontend.
61 * \aknote The returned pointer might be modified in the frontend lifetime. For example, a plug-in that would undo
62 * and redo a plug-in creation might return a different value. As such, you should not store the backend
88 /// Base host-provided instance to retrieve the related frontend instances related to the current backend.
98 * \aknote The returned array is a temporary TLS pointer that is meant to be retrieved and processed immediately to
113 #define AK_WWISE_PLUGIN_LINK_BACKEND_CTOR(/* ak_wwise_plugin_info* */ in_pluginInfo, /* void* */ in_data) \
115 .m_baseInterface = AK_WWISE_PLUGIN_BASE_INTERFACE_CTOR(AK_WWISE_PLUGIN_LINK_BACKEND_ID(), in_pluginInfo, in_data) \
120 #define AK_WWISE_PLUGIN_LINK_FRONTEND_CTOR(/* ak_wwise_plugin_info* */ in_pluginInfo, /* void* */ in_data) \
122 .m_baseInterface = AK_WWISE_PLUGIN_BASE_INTERFACE_CTOR(AK_WWISE_PLUGIN_LINK_FRONTEND_ID(), in_pluginInfo, in_data) \
150 };
160 };
165 * \aknote The returned pointer might be modified in the frontend lifetime. For example, a plug-in that would undo
166 * and redo a plug-in creation might return a different value. As such, you should not store the backend
177 * \brief Retrieves a link to the plug-in's backend instance, casted as your C++ Backend class type.
179 * \aknote The returned pointer might be modified in the frontend lifetime. For example, a plug-in that would undo
180 * and redo a plug-in creation might return a different value. As such, you should not store the backend
183 * \tparam Backend Expected type of the backend instance. An unexpected type yields to an undefined result.
209 };
219 };
224 * \aknote The returned array is a temporary TLS pointer that is meant to be retrieved and processed immediately to
238 * \aknote The frontend instances passed to the function are temporary TLS pointers that are meant to be retrieved
241 * \tparam Frontend Expected type of the frontend instances (optional). If no explicit type is provided, the caller
242 * needs to manually perform the cast to the expected frontend instance type. If an explicit type is
243 * 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:105
V1::LinkBackend LinkBackend
Latest version of the C++ LinkBackend interface.
Definition: PluginLinks.h:274
ak_wwise_plugin_link_frontend_v1 CLinkFrontend
Definition: PluginLinks.h:132
static GluedInterface * g_cinterface
The unique instance of the CInterface interface. Defined at nullptr first, overridden by the Host onc...
Definition: PluginInfoGenerator.h:89
ak_wwise_plugin_link_backend_v1()
Definition: PluginLinks.h:53
decltype(BaseInterface::m_version) InterfaceVersion
PluginInfoGenerator: Type for the m_version value in BaseInterface
Definition: PluginInfoGenerator.h:50
ak_wwise_plugin_link_frontend_v1()
Definition: PluginLinks.h:90
Base host-provided instance to retrieve the related backend instance, as shown in the frontend.
Definition: PluginDef.h:782
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:104
@ k_interfaceVersion
The interface version, as requested by this plug-in.
Definition: PluginLinks.h:218
@ k_interfaceVersion
The interface version, as requested by this plug-in.
Definition: PluginLinks.h:159
RequestedHostInterface< LinkFrontend > RequestLinkFrontend
Definition: PluginLinks.h:267
std::underlying_type< InterfaceType >::type InterfaceTypeValue
PluginInfoGenerator: Underlying storage type for the m_interface value in BaseInterface
Definition: PluginInfoGenerator.h:49
Backend * As()
Retrieves a link to the plug-in's backend instance, casted as your C++ Backend class type.
Definition: PluginLinks.h:187
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:68
ak_wwise_plugin_link_backend_v1 CLinkBackend
Definition: PluginLinks.h:131
AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_VERSION(AudioPlugin)
Host API to retrieve a link to the plug-in's frontend interfaces.
Definition: PluginLinks.h:82
Host API to retrieve a link to the plug-in's backend instance.
Definition: PluginLinks.h:45
Base host-provided instance to retrieve the related frontend instances related to the current backend...
Definition: PluginDef.h:792
Interface description and base class for every Wwise Authoring plug-in interface.
Definition: PluginBaseInterface.h:120
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:89
Host API to retrieve a link to the plug-in's backend instance.
Definition: PluginLinks.h:136
ak_wwise_plugin_frontend_instance ** GetArray(int *out_count) const
Retrieves an array of the plug-in's frontend instances.
Definition: PluginLinks.h:230
ak_wwise_plugin_backend_instance * Get() const
Retrieves a link to the plug-in's backend instance.
Definition: PluginLinks.h:171
V1::LinkFrontend LinkFrontend
Latest version of the C++ LinkFrontend interface.
Definition: PluginLinks.h:281
void ForEach(Functor in_operation) const
Applies a function on each plug-in's frontend instances.
Definition: PluginLinks.h:248
#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:237
Host API to retrieve a link to the plug-in's frontend interfaces.
Definition: PluginLinks.h:195
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:52
RequestedHostInterface< LinkBackend > RequestLinkBackend
Definition: PluginLinks.h:266
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_LINK_FRONTEND
2021.1 Link to the frontend plug-ins. ak_wwise_plugin_link_frontend_v1
Definition: PluginBaseInterface.h:86
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:85
Definition: AudioPlugin.h:111