Version
menu

◆ AK_CommandBuffer_Add()

AKSOUNDENGINE_API void* AK_CommandBuffer_Add ( void *  in_buffer,
enum AkCommand  in_cmd_id 
)

Reserve space for a command in the command buffer When this function returns a non-null pointer, the space reserved is zero'ed out. It is the responsibility of the caller to write the correct payload data in the command's reserved space.

The buffer must be initialized prior to calling this function, either using AK_CommandBuffer_Create or AK_CommandBuffer_Init. Passing an un-initialized buffer results in undefined behavior.

Parameters
[in,out]in_bufferPointer to command buffer
[in]in_cmd_idID of command (should be one of the values listed in AkCommand enum)
Returns
Pointer to the corresponding command payload, or NULL if not enough space left in the buffer
See also
AkCommand

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