Wwise SDK 2022.1.4
_ak_spatial_audio_types_8h_source
Version
menu_open
link
Wwise SDK 2022.1.4
|
AkSpatialAudioTypes.h
Go to the documentation of this file.
68 typedef AkArrayAllocatorAlignedSimd<AkMemID_SpatialAudioGeometry> ArrayPoolSpatialAudioGeometrySIMD;
74 typedef AkString<ArrayPoolSpatialAudio, wchar_t> WString; ///< Wide string type for use in Wwise Spatial Audio
75 typedef AkString<ArrayPoolSpatialAudio, AkOSChar> OsString; ///< OS string type for use in Wwise Spatial Audio
76 typedef AkString<ArrayPoolSpatialAudio, char> String; ///< String type for use in Wwise Spatial Audio
124 /// Spatial Audio Room ID type. This ID type exists in the same ID-space as game object ID's. The client is responsible for not choosing room ID's
125 /// that conflict with registered game objects' ID's. Internally, the spatial audio rooms and portals API manages registration and un-registration of game objects that
126 /// represent rooms using AkRoomID's provided by the client; AkRoomID's are converted to AkGameObjectID's by calling AsGameObjectID().
142 AkGameObjectID AsGameObjectID() const { return IsValid() ? (AkGameObjectID)id : OutdoorsGameObjID; }
154 /// A game object ID that is in the reserved range, used for 'outdoor' rooms, i.e. when not in a room.
155 /// \akwarning This AkGameObjectID is the underlying game object ID of the outdoor room, and should not be confused with the actual outdoor room's ID, AK::SpatialAudio::kOutdoorRoomID.\endakwarning
163 /// The outdoor room ID. This room is created automatically and is typically used for outdoors, i.e. when not in a room.
168 ///< Unique ID for portals. This ID type exists in the same ID-space as game object ID's. The client is responsible for not choosing portal ID's
169 /// that conflict with registered game objects' ID's. Internally, the spatial audio rooms and portals API manages registration and un-registration of game objects that
170 /// represent portals using AkPortalID's provided by the client; AkPortalID's are convertied to AkGameObjectID's by calling AsGameObjectID().
bool operator>(AkSpatialAudioID rhs) const
Definition: AkSpatialAudioTypes.h:109
Definition: AkArray.h:62
const AkUInt32 kDefaultDiffractionMaxPaths
Definition: AkSpatialAudioTypes.h:53
AkArrayAllocatorAlignedSimd< AkMemID_SpatialAudio > ArrayPoolSpatialAudioSIMD
Definition: AkSpatialAudioTypes.h:62
AkArrayAllocatorNoAlign< AkMemID_SpatialAudioPaths > ArrayPoolSpatialAudioPaths
Definition: AkSpatialAudioTypes.h:64
static AkRoomID FromGameObjectID(AkGameObjectID in_fromGameObject)
Conversion function used to convert to AkGameObjectIDs to AkRoomID.
Definition: AkSpatialAudioTypes.h:145
AkArrayAllocatorAlignedSimd< AkMemID_SpatialAudioGeometry > ArrayPoolSpatialAudioGeometrySIMD
Definition: AkSpatialAudioTypes.h:68
AkDbString< ArrayPoolSpatialAudio, char, CAkLock > DbString
Instanced string type.
Definition: AkSpatialAudioTypes.h:77
bool operator==(AkSpatialAudioID rhs) const
Definition: AkSpatialAudioTypes.h:106
bool operator!=(AkSpatialAudioID rhs) const
Definition: AkSpatialAudioTypes.h:107
AkString< ArrayPoolSpatialAudio, AkOSChar > OsString
OS string type for use in Wwise Spatial Audio.
Definition: AkSpatialAudioTypes.h:75
Definition: AkString.h:66
AkSpatialAudioID(const void *ptr)
Conversion from a pointer to a AkSpatialAudioID.
Definition: AkSpatialAudioTypes.h:104
AkString< ArrayPoolSpatialAudio, char > String
String type for use in Wwise Spatial Audio.
Definition: AkSpatialAudioTypes.h:76
AkGameObjectID AsGameObjectID() const
Conversion function used to convert AkRoomID's to AkGameObjectIDs.
Definition: AkSpatialAudioTypes.h:142
bool operator>=(AkSpatialAudioID rhs) const
Definition: AkSpatialAudioTypes.h:111
AkGameObjectID AsGameObjectID() const
Conversion function used internally to convert from a AkSpatialAudioID to a AkGameObjectID.
Definition: AkSpatialAudioTypes.h:117
Base type for ID's used by Wwise spatial audio.
Definition: AkSpatialAudioTypes.h:96
constexpr AkSpatialAudioID()
Default constructor. Creates an invalid ID.
Definition: AkSpatialAudioTypes.h:98
bool operator<(AkSpatialAudioID rhs) const
Definition: AkSpatialAudioTypes.h:108
constexpr AkRoomID kOutdoorRoomID
The outdoor room ID. This room is created automatically and is typically used for outdoors,...
Definition: AkSpatialAudioTypes.h:164
constexpr AkRoomID()
Default constructor. Creates an invalid ID.
Definition: AkSpatialAudioTypes.h:133
AkRoomID(const void *ptr)
Conversion from a pointer to a AkRoomID.
Definition: AkSpatialAudioTypes.h:139
bool operator<=(AkSpatialAudioID rhs) const
Definition: AkSpatialAudioTypes.h:110
Definition: AkSpatialAudioTypes.h:131
AkArrayAllocatorNoAlign< AkMemID_SpatialAudio > ArrayPoolSpatialAudio
Definition: AkSpatialAudioTypes.h:61
AkArrayAllocatorAlignedSimd< AkMemID_SpatialAudioPaths > ArrayPoolSpatialAudioPathsSIMD
Definition: AkSpatialAudioTypes.h:65
const AkUInt32 kDefaultDiffractionMaxEdges
Definition: AkSpatialAudioTypes.h:52
const AkUInt32 kPortalToPortalDiffractionMaxPaths
Definition: AkSpatialAudioTypes.h:59
Definition: AkArray.h:38
Definition: AkString.h:277
AkString< ArrayPoolSpatialAudio, wchar_t > WString
Wide string type for use in Wwise Spatial Audio.
Definition: AkSpatialAudioTypes.h:74
AkArrayAllocatorNoAlign< AkMemID_SpatialAudioGeometry > ArrayPoolSpatialAudioGeometry
Definition: AkSpatialAudioTypes.h:67
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