Version
menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2024.1.1.8691 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
Wwise SDK 2024.1.1
List of all members | Public Member Functions | Public Attributes
AkInputMapSlot< KEY, USER_DATA > Struct Template Reference

Structure of an entry in the AkMixerInputMap map. More...

#include <AkMixerInputMap.h>

Public Member Functions

 AkInputMapSlot ()
 User data. Here we have a buffer. Other relevant info would be the game object position and input parameters of the previous frame. More...
 
bool operator== (const AkInputMapSlot &in_Op) const
 

Public Attributes

KEY key
 
USER_DATA * pUserData
 Key. More...
 

Detailed Description

template<class KEY, class USER_DATA>
struct AkInputMapSlot< KEY, USER_DATA >

Structure of an entry in the AkMixerInputMap map.

Collection class to manage inputs in mixer plugins. The inputs are identified by their context. The type of data attached to it is the template argument USER_DATA. The collection performs allocation/deallocation of user data via AK_PLUGIN_NEW/DELETE(). Usage

// Init AkMixerInputMap<void*, MyStruct> m_mapInputs; m_mapInputs.Init( in_pAllocator ); // in_pAllocator passed at plugin init.

// Add an input. m_mapInputs.AddInput( in_pInput ); // void * in_pInput

// Find an input MyStruct * pInput = m_mapInputs.Exists( in_pInputContext ); // void * in_pInputContext passed to ConsumeInput()

// Iterate through inputs. AkMixerInputMap<MyStruct>::Iterator it = m_mapInputs.End(); while ( it != m_mapInputs.End() ) { MyStruct * pInput = (*it).pUserData; ... ++it; }

Definition at line 62 of file AkMixerInputMap.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