AkInstrument.h

Wwise SDK 2024.1.3

#include <AK/SoundEngine/Common/AkCommonDefs.h>
#include <AK/Tools/Common/AkAssert.h>

Namespaces
namespace	AK
	Definition of data structures for AkAudioObject.

	AK::Instrument

Macros
#define	AK_INSTRUMENT_BEGIN(_plugin_id_, _zone_name_) (AK::Instrument::g_fnPushTimer(_plugin_id_, _zone_name_))

#define	AK_INSTRUMENT_END(__token__) (AK::Instrument::g_fnPopTimer(__token__))

#define	AK_INSTRUMENT_MARKER(_plugin_id_, _marker_name_) (AK::Instrument::g_fnPostMarker(_plugin_id_, _marker_name_))

#define	AK_INSTRUMENT_MARKER_PROFILINGID(_profilingid_) (AK::Instrument::g_fnPostMarker(AKMAKECLASSID( AkPluginTypeNone, AKCOMPANYID_AUDIOKINETIC, _profilingid_ ), nullptr))

#define	AK_INSTRUMENT_METAMARKER(_plugin_id_, _metadata_) (AK::Instrument::g_fnPostMetaMarker(_plugin_id_, _metadata_))

#define	AK_INSTRUMENT_CONCAT_INNER(_base_, _counter_) _base_ ## _counter_

#define	AK_INSTRUMENT_CONCAT(_base_, _counter_) AK_INSTRUMENT_CONCAT_INNER(_base_, _counter_)

#define	AK_INSTRUMENT_SCOPE(_zone_name_) AK::Instrument::Scope AK_INSTRUMENT_CONCAT(_akInstrumentScope_, __LINE__)(0, _zone_name_)

#define	AK_INSTRUMENT_SCOPE_ID(_plugin_id_, _zone_name_) AK::Instrument::Scope AK_INSTRUMENT_CONCAT(_akInstrumentScope_, __LINE__)(_plugin_id_, _zone_name_)

#define	AK_INSTRUMENT_SCOPE_PROFILINGID(_profilingid_) AK::Instrument::Scope AK_INSTRUMENT_CONCAT(_akInstrumentScope_, __LINE__)(AKMAKECLASSID( AkPluginTypeNone, AKCOMPANYID_AUDIOKINETIC, _profilingid_ ), nullptr)

#define	AK_INSTRUMENT_THREAD_START(_thread_name_)

#define	AK_INSTRUMENT_BEGIN_C(_plugin_id_, _color_, _zone_name_) AK_INSTRUMENT_BEGIN(_plugin_id_, _zone_name_)

Typedefs
typedef void (	AK::Instrument::PushTimerFunc) (AkPluginID in_uPluginID, const char *in_pszZoneName)

typedef void(*	AK::Instrument::PopTimerFunc) (void *in_pToken)

typedef void(*	AK::Instrument::PostMarkerFunc) (AkPluginID in_uPluginID, const char *in_pszMarkerName)

typedef void(*	AK::Instrument::PostMetaMarkerFunc) (AkPluginID in_uPluginID, AkUInt32 in_uMetadata)

Variables
PushTimerFunc	AK::Instrument::g_fnPushTimer

PopTimerFunc	AK::Instrument::g_fnPopTimer

PostMarkerFunc	AK::Instrument::g_fnPostMarker

PostMetaMarkerFunc	AK::Instrument::g_fnPostMetaMarker

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Get started with Wwise

Wwise SDK