Wwise SDK 2018.1.11
_ak_spatial_audio_types_8h_source
Version
menu_open
link
Wwise SDK 2018.1.11
|
AkSpatialAudioTypes.h
Go to the documentation of this file.
65 typedef AkString<ArrayPoolSpatialAudio, wchar_t> WString; ///< Wide string type for use in Wwise Spatial Audio
66 typedef AkString<ArrayPoolSpatialAudio, AkOSChar> OsString; ///< OS string type for use in Wwise Spatial Audio
67 typedef AkString<ArrayPoolSpatialAudio, char> String; ///< String type for use in Wwise Spatial Audio
114 /// 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
115 /// 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
116 /// represent rooms using AkRoomID's provided by the client; AkRoomID's are convertied to AkGameObjectID's by calling AsGameObjectID().
122 /// A game object ID that is in the reserved range, used for 'outdoor' rooms, ie when not in a room.
135 AkGameObjectID AsGameObjectID() const { return IsValid() ? (AkGameObjectID)id : OutdoorsGameObjID; }
138 ///< 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
139 /// 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
140 /// represent portals using AkPortalID's provided by the client; AkPortalID's are convertied to AkGameObjectID's by calling AsGameObjectID().
static const AkGameObjectID OutdoorsGameObjID
A game object ID that is in the reserved range, used for 'outdoor' rooms, ie when not in a room.
Definition: AkSpatialAudioTypes.h:123
AkString< ArrayPoolSpatialAudio, char > String
String type for use in Wwise Spatial Audio.
Definition: AkSpatialAudioTypes.h:67
AkGameObjectID AsGameObjectID() const
Conversion function used internally to convert from a AkSpatialAudioID to a AkGameObjectID.
Definition: AkSpatialAudioTypes.h:107
bool operator !=(AkSpatialAudioID rhs) const
Definition: AkSpatialAudioTypes.h:97
AkString< ArrayPoolSpatialAudio, AkOSChar > OsString
OS string type for use in Wwise Spatial Audio.
Definition: AkSpatialAudioTypes.h:66
AK_DEFINE_ARRAY_POOL(_ArrayPoolSpatialAudio, g_SpatialAudioPoolId)
bool operator==(AkSpatialAudioID rhs) const
Definition: AkSpatialAudioTypes.h:96
Definition: AkString.h:60
AkSpatialAudioID(const void *ptr)
Conversion from a pointer to a AkSpatialAudioID.
Definition: AkSpatialAudioTypes.h:94
bool operator >=(AkSpatialAudioID rhs) const
Definition: AkSpatialAudioTypes.h:101
AkDbString< ArrayPoolSpatialAudio, char, CAkLock > DbString
Instanced string type.
Definition: AkSpatialAudioTypes.h:68
AkString< ArrayPoolSpatialAudio, wchar_t > WString
Wide string type for use in Wwise Spatial Audio.
Definition: AkSpatialAudioTypes.h:65
AkGameObjectID AsGameObjectID() const
Conversion function used internally to convert AkRoomID's to AkGameObjectIDs.
Definition: AkSpatialAudioTypes.h:135
bool operator >(AkSpatialAudioID rhs) const
Definition: AkSpatialAudioTypes.h:99
Definition: AkString.h:263
Definition: AkArray.h:48
bool operator<(AkSpatialAudioID rhs) const
Definition: AkSpatialAudioTypes.h:98
AkRoomID(const void *ptr)
Conversion from a pointer to a AkRoomID.
Definition: AkSpatialAudioTypes.h:132
Base type for ID's used by Wwise spatial audio.
Definition: AkSpatialAudioTypes.h:85
AkMemPoolId g_SpatialAudioPoolId
AkArrayAllocatorNoAlign< _ArrayPoolSpatialAudio > ArrayPoolSpatialAudio
Definition: AkSpatialAudioTypes.h:58
Definition: AkSpatialAudioTypes.h:120
bool operator<=(AkSpatialAudioID rhs) const
Definition: AkSpatialAudioTypes.h:100
AkArrayAllocatorAlignedSimd< _ArrayPoolSpatialAudio > ArrayPoolSpatialAudioSIMD
Definition: AkSpatialAudioTypes.h:59
Definition: AkArray.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