Version

menu_open
Wwise SDK 2023.1.2
ak_wwise_plugin_property_display_name_v1 Struct Reference

Backend API to specify display names for properties. More...

#include <PropertyDisplayName.h>

Inheritance diagram for ak_wwise_plugin_property_display_name_v1:
ak_wwise_plugin_interface_ptr AK.Wwise::Plugin::V1::PropertyDisplayName::Interface

Public Types

using Instance = ak_wwise_plugin_property_display_name_instance_v1
 Base instance type for providing display names to properties. More...
 

Public Member Functions

 ak_wwise_plugin_property_display_name_v1 ()
 
- Public Member Functions inherited from ak_wwise_plugin_interface_ptr
constexpr ak_wwise_plugin_base_interface (decltype(m_interface) in_interface, decltype(m_version) in_version)
 
constexpr ak_wwise_plugin_base_interface ()
 
constexpr ak_wwise_plugin_base_interface (std::underlying_type< decltype(m_interface)>::type in_interface, decltype(m_version) in_version)
 

Public Attributes

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. More...
 
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. More...
 
- Public Attributes inherited from ak_wwise_plugin_interface_ptr
ak_wwise_plugin_interface_type m_interface: 32
 Interface type (see ak_wwise_plugin_interface_type) More...
 
uint32_t m_version: 32
 Version of the interface. More...
 

Detailed Description

Backend API to specify display names for properties.

Note: It is preferrable to specify names directly in the XML. This interface can be useful when implementing properties that have different meanings dependending on the state of other properties.

Definition at line 42 of file PropertyDisplayName.h.


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