Version
menu_open
Wwise SDK 2024.1.0
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) 2024 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  , fOcclusion(0.f)
79  , uDiffractionEmitterSide(0)
80  , uDiffractionListenerSide(0)
81  {
82  sourcePosition.X = 0.f;
83  sourcePosition.Y = 0.f;
84  sourcePosition.Z = 0.f;
85  }
86 
87  AkImageSourceParams(AkVector64 in_sourcePosition, AkReal32 in_fDistanceScalingFactor, AkReal32 in_fLevel)
88  : sourcePosition(in_sourcePosition)
89  , fDistanceScalingFactor(in_fDistanceScalingFactor)
90  , fLevel(in_fLevel)
91  , fDiffraction(0.f)
92  , fOcclusion(0.f)
93  , uDiffractionEmitterSide(0)
94  , uDiffractionListenerSide(0)
95  {
96  }
97 
98  AkVector64 sourcePosition; ///< Image source position, relative to the world.
99  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.
100  AkReal32 fLevel; ///< Game-controlled level for this source, linear.
101  AkReal32 fDiffraction; ///< Diffraction amount, normalized to the range [0,1].
102  AkReal32 fOcclusion; ///< Portal occlusion amount, in the range [0,1].
103  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.
104  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.
105 };
106 
107 struct AkReflectImageSource
108 {
109  AkReflectImageSource()
110  : uID((AkImageSourceID)-1)
111  , params()
112  , texture()
113  , name()
114  {}
115 
116  AkReflectImageSource(AkImageSourceID in_uID, AkVector64 in_sourcePosition, AkReal32 in_fDistanceScalingFactor, AkReal32 in_fLevel)
117  : uID(in_uID)
118  , params(in_sourcePosition, in_fDistanceScalingFactor, in_fLevel)
119  , texture()
120  , name()
121  {
122  }
123 
124  void SetName(const char * in_pName)
125  {
126  name.SetName(in_pName);
127  }
128 
129  AkImageSourceID uID; ///< Image source ID (for matching delay lines across frames)
130  AkImageSourceParams params; ///< Image source properties
131  AkImageSourceTexture texture; ///< Image source's acoustic textures. Note that changing any of these textures across frames for a given image source, identified by uID, may result in a discontinuity in the audio signal.
132  AkImageSourceName name; ///< Image source name, for profiling.
133 };
134 
135 /// Data structure sent by the game to an instance of the Reflect plug-in.
136 struct AkReflectGameData
137 {
138  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.
139  AkUInt32 uNumImageSources; ///< Number of image sources passed in the variable array, below.
140  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.
141 
142  /// Default constructor.
143  AkReflectGameData()
144  : listenerID( AK_INVALID_GAME_OBJECT )
145  , uNumImageSources(0)
146  {}
147 
148  /// Helper function for computing the size required to allocate the AkReflectGameData structure.
149  static AkUInt32 GetSize(AkUInt32 in_uNumSources)
150  {
151  return (in_uNumSources > 0) ? sizeof(AkReflectGameData) + (in_uNumSources - 1) * sizeof(AkReflectImageSource) : sizeof(AkReflectGameData);
152  }
153 };
154 #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:116
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:140
AkReflectImageSource::texture
AkImageSourceTexture texture
Image source's acoustic textures. Note that changing any of these textures across frames for a given ...
Definition: AkReflectGameData.h:131
AkImageSourceName
Data used to describe one image source in Reflect.
Definition: AkReflectGameData.h:36
AkImageSourceParams::fOcclusion
AkReal32 fOcclusion
Portal occlusion amount, in the range [0,1].
Definition: AkReflectGameData.h:102
AkGameObjectID
AkUInt64 AkGameObjectID
Game object ID.
Definition: AkTypes.h:60
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:101
AkImageSourceParams::fLevel
AkReal32 fLevel
Game-controlled level for this source, linear.
Definition: AkReflectGameData.h:100
AkImageSourceID
AkUInt32 AkImageSourceID
Image Source ID.
Definition: AkTypes.h:84
AkImageSourceParams::fDistanceScalingFactor
AkReal32 fDistanceScalingFactor
Image source distance scaling. This number effectively scales the sourcePosition vector with respect ...
Definition: AkReflectGameData.h:99
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:139
AkReflectImageSource::SetName
void SetName(const char *in_pName)
Definition: AkReflectGameData.h:124
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:52
AkReflectGameData::GetSize
static AkUInt32 GetSize(AkUInt32 in_uNumSources)
Helper function for computing the size required to allocate the AkReflectGameData structure.
Definition: AkReflectGameData.h:149
AkReflectGameData::listenerID
AkGameObjectID listenerID
ID of the listener used to compute spatialization and distance evaluation from within the targeted Re...
Definition: AkReflectGameData.h:138
AkImageSourceParams::uDiffractionListenerSide
AkUInt8 uDiffractionListenerSide
If there is a shadow zone diffraction before reaching the listener in the reflection path,...
Definition: AkReflectGameData.h:104
AkReflectImageSource::uID
AkImageSourceID uID
Image source ID (for matching delay lines across frames)
Definition: AkReflectGameData.h:129
AkReflectGameData
Data structure sent by the game to an instance of the Reflect plug-in.
Definition: AkReflectGameData.h:137
AkReflectGameData::AkReflectGameData
AkReflectGameData()
Default constructor.
Definition: AkReflectGameData.h:143
AK_INVALID_UNIQUE_ID
static const AkUniqueID AK_INVALID_UNIQUE_ID
Invalid unique 32-bit ID.
Definition: AkTypes.h:97
AkImageSourceParams::AkImageSourceParams
AkImageSourceParams(AkVector64 in_sourcePosition, AkReal32 in_fDistanceScalingFactor, AkReal32 in_fLevel)
Definition: AkReflectGameData.h:87
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:363
AkReflectImageSource::name
AkImageSourceName name
Image source name, for profiling.
Definition: AkReflectGameData.h:132
AK_INVALID_GAME_OBJECT
static const AkGameObjectID AK_INVALID_GAME_OBJECT
Invalid game object (may also mean all game objects)
Definition: AkTypes.h:96
AkVector64
3D 64-bit vector. Intended as storage for world positions of sounds and objects, benefiting from 64-b...
Definition: AkTypes.h:334
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:98
AkImageSourceName::SetName
void SetName(const char *in_pName)
Definition: AkReflectGameData.h:43
AkReflectImageSource::params
AkImageSourceParams params
Image source properties.
Definition: AkReflectGameData.h:130
AkVector64::Z
AkReal64 Z
Z Position.
Definition: AkTypes.h:364
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:362
AkImageSourceParams::uDiffractionEmitterSide
AkUInt8 uDiffractionEmitterSide
If there is a shadow zone diffraction just after the emitter in the reflection path,...
Definition: AkReflectGameData.h:103

Cette page a-t-elle été utile ?

Besoin d'aide ?

Des questions ? Des problèmes ? Besoin de plus d'informations ? Contactez-nous, nous pouvons vous aider !

Visitez notre page d'Aide

Décrivez-nous de votre projet. Nous sommes là pour vous aider.

Enregistrez votre projet et nous vous aiderons à démarrer sans aucune obligation !

Partir du bon pied avec Wwise