Wwise SDK 2019.1.11
_ak_mixer_input_map_8h_source
Version
menu_open
link
Wwise SDK 2019.1.11
|
AkMixerInputMap.h
38 /// The inputs are identified by their context AK::IAkMixerInputContext. The type of data attached to it is the template argument USER_DATA.
47 /// m_mapInputs.AddInput( in_pInput ); // AK::IAkMixerInputContext * in_pInput passed to OnInputConnected()
50 /// MyStruct * pInput = m_mapInputs.Exists( in_pInputContext ); // AK::IAkMixerInputContext * in_pInputContext passed to ConsumeInput()
66 USER_DATA * pUserData; /// User data. Here we have a buffer. Other relevant info would be the game object position and input parameters of the previous frame.
78 AkForceInline void Init( AK::IAkPluginMemAlloc * in_pAllocator ) { m_pAllocator = in_pAllocator; }
80 AkForceInline void * Alloc( size_t in_uSize ) { AKASSERT( m_pAllocator || !"Allocator not set. Did you forget to call AkMixerInputMap::Init()?" ); return AK_PLUGIN_ALLOC( m_pAllocator, in_uSize ); }
92 AkForceInline void Free( void * in_pAddress ) { AKASSERT( m_pAllocator || !"Allocator not set. Did you forget to call AkMixerInputMap::Init()?" ); AK_PLUGIN_FREE( m_pAllocator, in_pAddress ); }
98 /// AkMixerInputMap: Map of inputs (identified with AK::IAkMixerInputContext *) to user-defined blocks of data.
100 class AkMixerInputMap : public AkArray<AkInputMapSlot<USER_DATA>, const AkInputMapSlot<USER_DATA>&, AkPluginArrayAllocator, 1>
103 typedef AkArray<AkInputMapSlot<USER_DATA>, const AkInputMapSlot<USER_DATA>&, AkPluginArrayAllocator, 1> BaseClass;
108 typename AkArray<AkInputMapSlot<USER_DATA>, const AkInputMapSlot<USER_DATA>&, AkPluginArrayAllocator, 1>::Iterator it = FindEx( in_pInput );
115 typename AkArray<AkInputMapSlot<USER_DATA>, const AkInputMapSlot<USER_DATA>&, AkPluginArrayAllocator, 1>::Iterator it = FindEx( in_pInput );
120 AkInputMapSlot<USER_DATA> * pSlot = AkArray<AkInputMapSlot<USER_DATA>, const AkInputMapSlot<USER_DATA>&, AkPluginArrayAllocator, 1>::AddLast();
138 typename AkArray<AkInputMapSlot<USER_DATA>, const AkInputMapSlot<USER_DATA>&, AkPluginArrayAllocator, 1>::Iterator it = FindEx( in_pInput );
162 typename AkArray<AkInputMapSlot<USER_DATA>, const AkInputMapSlot<USER_DATA>&, AkPluginArrayAllocator, 1>::Iterator FindEx( AK::IAkMixerInputContext * in_pInput ) const
172 for ( typename AkArray<AkInputMapSlot<USER_DATA>, const AkInputMapSlot<USER_DATA>&, AkPluginArrayAllocator, 1>::Iterator it = BaseClass::Begin(), itEnd = BaseClass::End(); it != itEnd; ++it )
AkForceInline void * Alloc(size_t in_uSize)
Definition: AkMixerInputMap.h:80
AkForceInline AK::IAkPluginMemAlloc * GetAllocator()
Definition: AkMixerInputMap.h:93
Interface to retrieve information about an input of a mixer.
Definition: IAkPlugin.h:746
bool RemoveInput(AK::IAkMixerInputContext *in_pInput)
Removes an input and destroys its associated user data.
Definition: AkMixerInputMap.h:136
AkForceInline void * ReAlloc(void *in_pCurrent, size_t in_uOldSize, size_t in_uNewSize)
Definition: AkMixerInputMap.h:81
USER_DATA * Exists(AK::IAkMixerInputContext *in_pInput)
Returns the user data associated with given input context. Returns NULL if none found.
Definition: AkMixerInputMap.h:106
USER_DATA * AddInput(AK::IAkMixerInputContext *in_pInput)
Adds an input with new user data.
Definition: AkMixerInputMap.h:113
AkForceInline void Init(AK::IAkPluginMemAlloc *in_pAllocator)
Definition: AkMixerInputMap.h:78
Definition: IAkPluginMemAlloc.h:46
AkArray< AkInputMapSlot< USER_DATA >, const AkInputMapSlot< USER_DATA > &, AkPluginArrayAllocator, 1 >::Iterator FindEx(AK::IAkMixerInputContext *in_pInput) const
Finds an item in the array.
Definition: AkMixerInputMap.h:162
AkForceInline void AkMemCpy(void *pDest, const void *pSrc, AkUInt32 uSize)
Platform Independent Helper.
Definition: AkPlatformFuncs.h:330
AkForceInline AkPluginArrayAllocator()
Definition: AkMixerInputMap.h:77
bool operator==(const AkInputMapSlot &in_Op) const
Definition: AkMixerInputMap.h:69
Definition: AkMixerInputMap.h:75
AkForceInline AkInputMapSlot< USER_DATA > * AddLast()
Definition: AkArray.h:448
AkArray< AkInputMapSlot< USER_DATA >, const AkInputMapSlot< USER_DATA > &, AkPluginArrayAllocator, 1 > BaseClass
Definition: AkMixerInputMap.h:103
AkMixerInputMap: Map of inputs (identified with AK::IAkMixerInputContext *) to user-defined blocks of...
Definition: AkMixerInputMap.h:101
AkForceInline void Free(void *in_pAddress)
Definition: AkMixerInputMap.h:92
AkInputMapSlot()
User data. Here we have a buffer. Other relevant info would be the game object position and input par...
Definition: AkMixerInputMap.h:68
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