Version
menu_open
link
Wwise SDK 2022.1.8
AkReflectGameData.h
Go to the documentation of this file.
1 /*******************************************************************************
2 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
3 released in source code form as part of the SDK installer package.
4 
5 Commercial License Usage
6 
7 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
8 may use this file in accordance with the end user license agreement provided
9 with the software or, alternatively, in accordance with the terms contained in a
10 written agreement between you and Audiokinetic Inc.
11 
12 Apache License Usage
13 
14 Alternatively, this file may be used under the Apache License, Version 2.0 (the
15 "Apache License"); you may not use this file except in compliance with the
16 Apache License. You may obtain a copy of the Apache License at
17 http://www.apache.org/licenses/LICENSE-2.0.
18 
19 Unless required by applicable law or agreed to in writing, software distributed
20 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
21 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
22 the specific language governing permissions and limitations under the License.
23 
24  Copyright (c) 2023 Audiokinetic Inc.
25 *******************************************************************************/
26 
27 #ifndef _AK_REFLECT_GAMEDATA_H_
28 #define _AK_REFLECT_GAMEDATA_H_
29 
30 #include <AK/SoundEngine/Common/AkTypes.h>
31 
32 #define AK_MAX_NUM_TEXTURE 4
33 
34 /// Data used to describe one image source in Reflect.
35 struct AkImageSourceName
36 {
37  AkImageSourceName()
38  : uNumChar(0)
39  , pName(NULL)
40  {
41  }
42 
43  void SetName(const char * in_pName)
44  {
45  pName = in_pName;
46  if (pName)
47  {
48  uNumChar = (AkUInt32)strlen(in_pName);
49  }
50  else
51  {
52  uNumChar = 0;
53  }
54  }
55 
56  AkUInt32 uNumChar; ///< Number of characters in image source name.
57  const char * pName; ///< Optional image source name. Appears in Reflect's editor when profiling.
58 };
59 
60 struct AkImageSourceTexture
61 {
62  AkImageSourceTexture()
63  : uNumTexture(1)
64  {
65  arTextureID[0] = AK_INVALID_UNIQUE_ID;
66  }
67 
68  AkUInt32 uNumTexture; ///< Number of valid textures in the texture array.
69  AkUniqueID arTextureID[AK_MAX_NUM_TEXTURE]; ///< Unique IDs of the Acoustics Texture ShareSets used to filter this image source.
70 };
71 
72 struct AkImageSourceParams
73 {
74  AkImageSourceParams()
75  : fDistanceScalingFactor(1.f)
76  , fLevel(1.f)
77  , fDiffraction(0.f)
78  , uDiffractionEmitterSide(0)
79  , uDiffractionListenerSide(0)
80  {
81  sourcePosition.X = 0.f;
82  sourcePosition.Y = 0.f;
83  sourcePosition.Z = 0.f;
84  }
85 
86  AkImageSourceParams(AkVector64 in_sourcePosition, AkReal32 in_fDistanceScalingFactor, AkReal32 in_fLevel)
87  : sourcePosition(in_sourcePosition)
88  , fDistanceScalingFactor(in_fDistanceScalingFactor)
89  , fLevel(in_fLevel)
90  , fDiffraction(0.f)
91  , uDiffractionEmitterSide(0)
92  , uDiffractionListenerSide(0)
93  {
94  }
95 
96  AkVector64 sourcePosition; ///< Image source position, relative to the world.
97  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.
98  AkReal32 fLevel; ///< Game-controlled level for this source, linear.
99  AkReal32 fDiffraction; ///< Diffraction amount, normalized to the range [0,1].
100  AkUInt8 uDiffractionEmitterSide; ///< If there is a shadow zone diffraction just after the emitter in the reflection path, indicates the number of diffraction edges, otherwise 0 if no diffraction.
101  AkUInt8 uDiffractionListenerSide; ///< If there is a shadow zone diffraction before reaching the listener in the reflection path, indicates the number of diffraction edges, otherwise 0 if no diffraction.
102 };
103 
104 struct AkReflectImageSource
105 {
106  AkReflectImageSource()
107  : uID((AkImageSourceID)-1)
108  , params()
109  , texture()
110  , name()
111  {}
112 
113  AkReflectImageSource(AkImageSourceID in_uID, AkVector64 in_sourcePosition, AkReal32 in_fDistanceScalingFactor, AkReal32 in_fLevel)
114  : uID(in_uID)
115  , params(in_sourcePosition, in_fDistanceScalingFactor, in_fLevel)
116  , texture()
117  , name()
118  {
119  }
120 
121  void SetName(const char * in_pName)
122  {
123  name.SetName(in_pName);
124  }
125 
126  AkImageSourceID uID; ///< Image source ID (for matching delay lines across frames)
127  AkImageSourceParams params;
128  AkImageSourceTexture texture;
129  AkImageSourceName name;
130 };
131 
132 /// Data structure sent by the game to an instance of the Reflect plug-in.
133 struct AkReflectGameData
134 {
135  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.
136  AkUInt32 uNumImageSources; ///< Number of image sources passed in the variable array, below.
137  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.
138 
139  /// Default constructor.
140  AkReflectGameData()
141  : listenerID( AK_INVALID_GAME_OBJECT )
142  , uNumImageSources(0)
143  {}
144 
145  /// Helper function for computing the size required to allocate the AkReflectGameData structure.
146  static AkUInt32 GetSize(AkUInt32 in_uNumSources)
147  {
148  return (in_uNumSources > 0) ? sizeof(AkReflectGameData) + (in_uNumSources - 1) * sizeof(AkReflectImageSource) : sizeof(AkReflectGameData);
149  }
150 };
151 #endif // _AK_REFLECT_GAMEDATA_H_
AkImageSourceName::uNumChar
AkUInt32 uNumChar
Number of characters in image source name.
Definition: AkReflectGameData.h:56
AkReflectImageSource::AkReflectImageSource
AkReflectImageSource(AkImageSourceID in_uID, AkVector64 in_sourcePosition, AkReal32 in_fDistanceScalingFactor, AkReal32 in_fLevel)
Definition: AkReflectGameData.h:113
AK_MAX_NUM_TEXTURE
#define AK_MAX_NUM_TEXTURE
Definition: AkReflectGameData.h:32
AkReflectGameData::arSources
AkReflectImageSource arSources[1]
Variable array of image sources. You should allocate storage for the structure by calling AkReflectGa...
Definition: AkReflectGameData.h:137
AkReflectImageSource::texture
AkImageSourceTexture texture
Definition: AkReflectGameData.h:128
AkImageSourceName
Data used to describe one image source in Reflect.
Definition: AkReflectGameData.h:36
AkGameObjectID
AkUInt64 AkGameObjectID
Game object ID.
Definition: AkTypes.h:128
AkImageSourceTexture::uNumTexture
AkUInt32 uNumTexture
Number of valid textures in the texture array.
Definition: AkReflectGameData.h:68
AkImageSourceParams::fDiffraction
AkReal32 fDiffraction
Diffraction amount, normalized to the range [0,1].
Definition: AkReflectGameData.h:99
AkImageSourceParams::fLevel
AkReal32 fLevel
Game-controlled level for this source, linear.
Definition: AkReflectGameData.h:98
AkImageSourceID
AkUInt32 AkImageSourceID
Image Source ID.
Definition: AkTypes.h:152
AkImageSourceParams::fDistanceScalingFactor
AkReal32 fDistanceScalingFactor
Image source distance scaling. This number effectively scales the sourcePosition vector with respect ...
Definition: AkReflectGameData.h:97
AkUInt8
uint8_t AkUInt8
Unsigned 8-bit integer.
Definition: AkNumeralTypes.h:36
AkReflectGameData::uNumImageSources
AkUInt32 uNumImageSources
Number of image sources passed in the variable array, below.
Definition: AkReflectGameData.h:136
AkReflectImageSource::SetName
void SetName(const char *in_pName)
Definition: AkReflectGameData.h:121
NULL
#define NULL
Definition: AkTypes.h:46
AkReal32
float AkReal32
32-bit floating point
Definition: AkNumeralTypes.h:46
AkUniqueID
AkUInt32 AkUniqueID
Unique 32-bit ID.
Definition: AkTypes.h:120
AkReflectGameData::GetSize
static AkUInt32 GetSize(AkUInt32 in_uNumSources)
Helper function for computing the size required to allocate the AkReflectGameData structure.
Definition: AkReflectGameData.h:146
AkReflectGameData::listenerID
AkGameObjectID listenerID
ID of the listener used to compute spatialization and distance evaluation from within the targeted Re...
Definition: AkReflectGameData.h:135
AkImageSourceParams::uDiffractionListenerSide
AkUInt8 uDiffractionListenerSide
If there is a shadow zone diffraction before reaching the listener in the reflection path,...
Definition: AkReflectGameData.h:101
AkReflectImageSource::uID
AkImageSourceID uID
Image source ID (for matching delay lines across frames)
Definition: AkReflectGameData.h:126
AkReflectGameData
Data structure sent by the game to an instance of the Reflect plug-in.
Definition: AkReflectGameData.h:134
AkReflectGameData::AkReflectGameData
AkReflectGameData()
Default constructor.
Definition: AkReflectGameData.h:140
AK_INVALID_UNIQUE_ID
static const AkUniqueID AK_INVALID_UNIQUE_ID
Invalid unique 32-bit ID.
Definition: AkTypes.h:163
AkImageSourceParams::AkImageSourceParams
AkImageSourceParams(AkVector64 in_sourcePosition, AkReal32 in_fDistanceScalingFactor, AkReal32 in_fLevel)
Definition: AkReflectGameData.h:86
AkImageSourceName::pName
const char * pName
Optional image source name. Appears in Reflect's editor when profiling.
Definition: AkReflectGameData.h:57
AkVector64::Y
AkReal64 Y
Y Position.
Definition: AkTypes.h:419
AkReflectImageSource::name
AkImageSourceName name
Definition: AkReflectGameData.h:129
AK_INVALID_GAME_OBJECT
static const AkGameObjectID AK_INVALID_GAME_OBJECT
Invalid game object (may also mean all game objects)
Definition: AkTypes.h:162
AkVector64
3D 64-bit vector. Intended as storage for world positions of sounds and objects, benefiting from 64-b...
Definition: AkTypes.h:390
AkUInt32
uint32_t AkUInt32
Unsigned 32-bit integer.
Definition: AkNumeralTypes.h:38
AkImageSourceParams::sourcePosition
AkVector64 sourcePosition
Image source position, relative to the world.
Definition: AkReflectGameData.h:96
AkImageSourceName::SetName
void SetName(const char *in_pName)
Definition: AkReflectGameData.h:43
AkReflectImageSource::params
AkImageSourceParams params
Definition: AkReflectGameData.h:127
AkVector64::Z
AkReal64 Z
Z Position.
Definition: AkTypes.h:420
AkImageSourceTexture::arTextureID
AkUniqueID arTextureID[AK_MAX_NUM_TEXTURE]
Unique IDs of the Acoustics Texture ShareSets used to filter this image source.
Definition: AkReflectGameData.h:69
AkVector64::X
AkReal64 X
X Position.
Definition: AkTypes.h:418
AkImageSourceParams::uDiffractionEmitterSide
AkUInt8 uDiffractionEmitterSide
If there is a shadow zone diffraction just after the emitter in the reflection path,...
Definition: AkReflectGameData.h:100

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