Wwise SDK 2021.1.14
バージョン
menu_open
link
PropertyDisplayName.h
Go to the documentation of this file.
40 * \aknote It is preferrable to specify names directly in the XML. This interface can be useful when implementing
41 * properties that have different meanings dependending on the state of other properties. \endaknote
77 * \param[in] in_unCharCount The maximum number of char in the buffer, including the terminating null.
102 * \aknote This function used to be deprecated, but is actually useful in case of dynamic naming.
112 * \param[in] in_unCharCount The maximum number of char in the buffer, including the terminating null.
127 #define AK_WWISE_PLUGIN_PROPERTY_DISPLAY_NAME_V1_CTOR(/* ak_wwise_plugin_info* */ in_pluginInfo, /* void* */ in_data) \
129 .m_baseInterface = AK_WWISE_PLUGIN_BASE_INTERFACE_CTOR(AK_WWISE_PLUGIN_PROPERTY_DISPLAY_NAME_V1_ID(), in_pluginInfo, in_data) \
150 };
160 };
217 * This function should write the user-friendly name of the specified property to the char buffer
220 * \aknote This function used to be deprecated, but is actually useful in case of dynamic naming.
229 * \param[in] in_unCharCount The maximum number of char in the buffer, including the terminating null.
253 * \aknote This function used to be deprecated, but is actually useful in case of dynamic naming.
virtual ~PropertyDisplayName()
Definition: PropertyDisplayName.h:212
virtual bool DisplayNamesForPropValues(const char *in_pszPropertyName, char *out_pszValuesName, uint32_t in_unCharCount) const
Get the user-friendly names of possible values for the specified property.
Definition: PropertyDisplayName.h:268
ak_wwise_plugin_property_display_name_v1 CPropertyDisplayName
Definition: PropertyDisplayName.h:137
CPropertyDisplayName::Instance * GetInstancePointer()
Definition: PropertyDisplayName.h:200
PropertyDisplayName()
Definition: PropertyDisplayName.h:207
decltype(BaseInterface::m_version) InterfaceVersion
PluginInfoGenerator: Type for the m_version value in BaseInterface.
Definition: PluginInfoGenerator.h:51
bool(* DisplayNamesForPropValues)(const struct ak_wwise_plugin_property_display_name_instance_v1 *in_this, const char *in_pszPropertyName, char *out_pszValuesName, uint32_t in_unCharCount)
Get the user-friendly names of possible values for the specified property.
Definition: PropertyDisplayName.h:118
Wwise Authoring Plug-ins - C++ class helper to automatically determine the plug-in interfaces used in...
@ k_interfaceType
The interface type, as provided by this plug-in.
Definition: PropertyDisplayName.h:149
The C interface, fulfilled by your plug-in.
Definition: PropertyDisplayName.h:166
Base instance type for providing display names to properties through ak_wwise_plugin_property_display...
Definition: PluginDef.h:722
InterfacePtr GetInterfacePointer()
Definition: PropertyDisplayName.h:196
const CPropertyDisplayName::Instance * GetInstancePointer() const
Definition: PropertyDisplayName.h:203
std::underlying_type< InterfaceType >::type InterfaceTypeValue
PluginInfoGenerator: Underlying storage type for the m_interface value in BaseInterface.
Definition: PluginInfoGenerator.h:50
@ k_interfaceVersion
The interface version, as provided by this plug-in.
Definition: PropertyDisplayName.h:159
AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_VERSION(AudioPlugin)
Interface()
Definition: PropertyDisplayName.h:168
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_PROPERTY_DISPLAY_NAME
2021.1 Property display name overrides. ak_wwise_plugin_property_display_name_v1
Definition: PluginBaseInterface.h:69
Backend API to specify display names for properties.
Definition: PropertyDisplayName.h:47
virtual bool DisplayNameForProp(const char *in_pszPropertyName, char *out_pszDisplayName, uint32_t in_unCharCount) const
Gets the user-friendly name of the specified property.
Definition: PropertyDisplayName.h:232
Interface description and base class for every Wwise Authoring plug-in interface.
Definition: PluginBaseInterface.h:117
V1::PropertyDisplayName PropertyDisplayName
Latest version of the C++ PropertyDisplayName interface.
Definition: PropertyDisplayName.h:279
bool(* DisplayNameForProp)(const struct ak_wwise_plugin_property_display_name_instance_v1 *in_this, const char *in_pszPropertyName, char *out_pszDisplayName, uint32_t in_unCharCount)
Gets the user-friendly name of the specified property.
Definition: PropertyDisplayName.h:80
ak_wwise_plugin_property_display_name_v1()
Definition: PropertyDisplayName.h:56
AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_CLASS(AudioPlugin)
Definition: AudioPlugin.h:112