Version
menu

Wwise SDK 2025.1.4
AkCmd_SA_SetGeometryInstance Struct Reference

#include AkCommandTypes.h>

Public Attributes

AkGeometryInstanceID geometryInstanceID
 Unique geometry set instance ID, chosen by client. More...
 
struct AkGeometryInstanceParams params
 Geometry instance parameters to set. More...
 

Detailed Description

Add or update a geometry instance from the SpatialAudio module for geometric reflection and diffraction processing. A geometry instance is a unique instance of a geometry set with a specified transform (position, rotation and scale). It is necessary to create at least one geometry instance for each geometry set that is to be used for diffraction and reflection simulation. The ID (geometryInstanceID) must be unique amongst all geometry instances, including geometry instances referencing different geometry sets. The ID is chosen by the client in a manner similar to AkGameObjectID's. To update the transform of an existing geometry instance, call SetGeometryInstance again, passing the same AkGeometryInstanceID, with the updated transform.

This command can fail for the following reasons:

  • AK_InvalidParameter: geometryInstanceID or params.GeometrySetID are not valid IDs or params.PositionAndOrientation is not a valid transform.
  • AK_IDNotFound: The GeometrySetID does not refer to a registered geometry set.
  • AK_InsufficientMemory: Not enough memory to complete the operation.
See also

Definition at line 1488 of file AkCommandTypes.h.


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