Wwise SDK 2022.1.4
_plugin_container_8h_source
Version
menu_open
link
PluginContainer.h
Go to the documentation of this file.
28 * \brief Wwise Authoring Plug-ins - Root interface allowing a logical unit (variable, library) to contain more than one interface.
37 * \brief Root interface allowing a logical unit (variable, library) to contain more than one interface.
39 * The container is a required element to define the base of a logical unit. It contains basic information on the
40 * build being used by the enclosed plug-ins. This allows the host to quickly determine if it should pursue
41 * loading this container or not, and might need to apply patches to fix interface variations appearing
44 * The container being versioned means this format could eventually change, but the goal was to make it generic
45 * enough to keep it stable. It's easier to add up plug-ins to extend the format than to modify it.
58 struct ak_wwise_plugin_info* m_pluginInfos; ///< A chained list of all the plug-ins embedded in this container
66 constexpr inline static uint64_t SdkVersionSubminorMultiplier() { return SdkVersionBuildMultiplier() * (SdkVersionBuildMax() + 1); }
68 constexpr inline static uint64_t SdkVersionMinorMultiplier() { return SdkVersionSubminorMultiplier() * (SdkVersionSubminorMax() + 1); }
70 constexpr inline static uint64_t SdkVersionMajorMultiplier() { return SdkVersionMinorMultiplier() * (SdkVersionMinorMax() + 1); }
74 constexpr inline uint32_t MajorSdkVersion() const { return (uint32_t)(m_wwiseSdkVersion / SdkVersionMajorMultiplier()); }
76 constexpr inline uint32_t MinorSdkVersion() const { return (uint32_t)((m_wwiseSdkVersion % (SdkVersionMinorMultiplier() * (SdkVersionMinorMax() + 1))) / SdkVersionMinorMultiplier()); }
78 constexpr inline uint32_t SubminorSdkVersion() const { return (uint32_t)((m_wwiseSdkVersion % (SdkVersionSubminorMultiplier() * (SdkVersionSubminorMax() + 1))) / SdkVersionSubminorMultiplier()); }
80 constexpr inline uint32_t BuildSdkVersion() const { return (uint32_t)((m_wwiseSdkVersion % (SdkVersionBuildMultiplier() * (SdkVersionBuildMax() + 1)))); }
84 m_wwiseSdkVersion((uint64_t)AK_WWISESDK_VERSION_MAJOR * SdkVersionMajorMultiplier() + (uint64_t)AK_WWISESDK_VERSION_MINOR * SdkVersionMinorMultiplier() + (uint64_t)AK_WWISESDK_VERSION_SUBMINOR * SdkVersionSubminorMultiplier() + (uint64_t)AK_WWISESDK_VERSION_BUILD * SdkVersionBuildMultiplier()),
89 m_wwiseSdkVersion((uint64_t)AK_WWISESDK_VERSION_MAJOR * SdkVersionMajorMultiplier() + (uint64_t)AK_WWISESDK_VERSION_MINOR * SdkVersionMinorMultiplier() + (uint64_t)AK_WWISESDK_VERSION_SUBMINOR * SdkVersionSubminorMultiplier() + (uint64_t)AK_WWISESDK_VERSION_BUILD * SdkVersionBuildMultiplier()),
constexpr static uint64_t SdkVersionMajorMax()
Definition: PluginContainer.h:71
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_PLUGIN_CONTAINER
2021.1 Plug-in container plug-in. Contains all the other plug-ins. ak_wwise_plugin_container
Definition: PluginBaseInterface.h:53
constexpr static uint64_t SdkVersionMajorMultiplier()
Definition: PluginContainer.h:70
constexpr uint32_t SubminorSdkVersion() const
(C++) Patch / Subminor SDK version (ex. 0)
Definition: PluginContainer.h:78
ak_wwise_plugin_container(ak_wwise_plugin_info *in_pluginInfos)
Definition: PluginContainer.h:87
struct ak_wwise_plugin_info * m_pluginInfos
A chained list of all the plug-ins embedded in this container.
Definition: PluginContainer.h:58
Root interface allowing a logical unit (variable, library) to contain more than one interface.
Definition: PluginContainer.h:51
constexpr static uint64_t SdkVersionMinorMultiplier()
Definition: PluginContainer.h:68
#define AK_WWISESDK_VERSION_SUBMINOR
Wwise SDK sub-minor version.
Definition: AkWwiseSDKVersion.h:46
constexpr static uint64_t SdkVersionSubminorMultiplier()
Definition: PluginContainer.h:66
constexpr static uint64_t SdkVersionBuildMax()
Definition: PluginContainer.h:65
constexpr uint32_t MajorSdkVersion() const
(C++) Major SDK version (ex. 2020)
Definition: PluginContainer.h:74
uint64_t m_wwiseSdkVersion
Wwise Authoring version included with this SDK.
Definition: PluginContainer.h:56
constexpr uint32_t MinorSdkVersion() const
(C++) Minor SDK version (ex. 1)
Definition: PluginContainer.h:76
Interface description and base class for every Wwise Authoring plug-in interface.
Definition: PluginBaseInterface.h:120
constexpr static uint64_t SdkVersionBuildMultiplier()
Definition: PluginContainer.h:64
constexpr static uint64_t SdkVersionMinorMax()
Definition: PluginContainer.h:69
Definition: PluginInfo.h:38
constexpr static uint64_t SdkVersionSubminorMax()
Definition: PluginContainer.h:67
ak_wwise_plugin_container()
Definition: PluginContainer.h:82
constexpr uint32_t BuildSdkVersion() const
(C++) Build number (ex. 9404)
Definition: PluginContainer.h:80
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