Table of Contents

AkRoomID Struct Reference

Inheritance diagram for AkRoomID:
AkSpatialAudioID

List of all members.

Public Member Functions

  AkRoomID ()
  Default constructor. Creates an invalid ID.
  AkRoomID (AkUInt64 _id)
  Construct from a 64-bit int.
  AkRoomID (const void *ptr)
  Conversion from a pointer to a AkRoomID.
AkGameObjectID  AsGameObjectID () const
  Conversion function used internally to convert AkRoomID's to AkGameObjectIDs.

Static Public Attributes

static const AkGameObjectID  OutdoorsGameObjID = (AkGameObjectID)-4
  A game object ID that is in the reserved range, used for 'outdoor' rooms, ie when not in a room.

Detailed Description

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 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 represent rooms using AkRoomID's provided by the client; AkRoomID's are convertied to AkGameObjectID's by calling AsGameObjectID().

See also:

Definition at line 120 of file AkSpatialAudioTypes.h.


The documentation for this struct was generated from the following file: