Wwise SDK 2018.1.11
_ak_reflect_game_data_8h_source
Version
menu_open
link
AkReflectGameData.h
Go to the documentation of this file.
58 const char * pName; ///< Optional image source name. Appears in Wwise Reflect's editor when profiling.
70 AkUniqueID arTextureID[AK_MAX_NUM_TEXTURE]; ///< Unique IDs of the Acoustics Texture ShareSets used to filter this image source.
85 AkImageSourceParams(AkVector in_sourcePosition, AkReal32 in_fDistanceScalingFactor, AkReal32 in_fLevel)
94 AkReal32 fDistanceScalingFactor; ///< Image source distance scaling. This number effectively scales the sourcePosition vector with respect to the listener and, consequently, scales distance and preserves orientation.
97 bool bDiffractedEmitterSide; ///< Indicates if there is a shadow zone diffraction just after the emitter in the reflection path.
98 bool bDiffractedListenerSide; ///< Indicates if there is a shadow zone diffraction before reaching the listener in the reflection path.
110 AkReflectImageSource(AkImageSourceID in_uID, AkVector in_sourcePosition, AkReal32 in_fDistanceScalingFactor, AkReal32 in_fLevel)
132 AkGameObjectID listenerID; ///< ID of the listener used to compute spatialization and distance evaluation from within the targeted Reflect plug-in instance. It needs to be one of the listeners that are listening to the game object associated with the targeted plug-in instance. See AK::SoundEngine::SetListeners and AK::SoundEngine::SetGameObjectAuxSendValues.
134 AkReflectImageSource arSources[1]; ///< Variable array of image sources. You should allocate storage for the structure by calling AkReflectGameData::GetSize() with the desired number of sources.
142 /// Helper function for computing the size required to allocate the AkReflectGameData structure.
145 return (in_uNumSources > 0) ? sizeof(AkReflectGameData) + (in_uNumSources - 1) * sizeof(AkReflectImageSource) : sizeof(AkReflectGameData);
AkUniqueID arTextureID[AK_MAX_NUM_TEXTURE]
Unique IDs of the Acoustics Texture ShareSets used to filter this image source.
Definition: AkReflectGameData.h:70
AkReflectImageSource(AkImageSourceID in_uID, AkVector in_sourcePosition, AkReal32 in_fDistanceScalingFactor, AkReal32 in_fLevel)
Definition: AkReflectGameData.h:110
Data structure sent by the game to an instance of the Wwise Reflect plug-in.
Definition: AkReflectGameData.h:130
AkReflectImageSource()
Definition: AkReflectGameData.h:103
AkReal32 fDiffraction
Diffraction amount, normalized to the range [0,1].
Definition: AkReflectGameData.h:96
Definition: AkReflectGameData.h:73
AkImageSourceTexture()
Definition: AkReflectGameData.h:63
AkUInt32 uNumTexture
Number of valid textures in the texture array.
Definition: AkReflectGameData.h:69
const char * pName
Optional image source name. Appears in Wwise Reflect's editor when profiling.
Definition: AkReflectGameData.h:58
void SetName(const char *in_pName)
Definition: AkReflectGameData.h:118
Definition: AkReflectGameData.h:101
bool bDiffractedListenerSide
Indicates if there is a shadow zone diffraction before reaching the listener in the reflection path.
Definition: AkReflectGameData.h:98
AkImageSourceID uID
Image source ID (for matching delay lines across frames)
Definition: AkReflectGameData.h:123
AkGameObjectID listenerID
ID of the listener used to compute spatialization and distance evaluation from within the targeted Re...
Definition: AkReflectGameData.h:132
Data used to describe one image source in Wwise Reflect.
Definition: AkReflectGameData.h:36
static const AkGameObjectID AK_INVALID_GAME_OBJECT
Invalid game object (may also mean all game objects)
Definition: AkTypes.h:98
AkReflectImageSource arSources[1]
Variable array of image sources. You should allocate storage for the structure by calling AkReflectGa...
Definition: AkReflectGameData.h:134
static AkUInt32 GetSize(AkUInt32 in_uNumSources)
Helper function for computing the size required to allocate the AkReflectGameData structure.
Definition: AkReflectGameData.h:143
AkReal32 fDistanceScalingFactor
Image source distance scaling. This number effectively scales the sourcePosition vector with respect ...
Definition: AkReflectGameData.h:94
AkVector sourcePosition
Image source position, relative to the world.
Definition: AkReflectGameData.h:93
AkImageSourceParams(AkVector in_sourcePosition, AkReal32 in_fDistanceScalingFactor, AkReal32 in_fLevel)
Definition: AkReflectGameData.h:85
AkUInt32 uNumImageSources
Number of image sources passed in the variable array, below.
Definition: AkReflectGameData.h:133
bool bDiffractedEmitterSide
Indicates if there is a shadow zone diffraction just after the emitter in the reflection path.
Definition: AkReflectGameData.h:97
Definition: AkReflectGameData.h:61
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