Version

menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2022.1.17.8543 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
Wwise SDK 2022.1.17
AkObjectPool.h
Audiokinetic namespace.
static constexpr SizeType kInvalidIndex
Definition: AkObjectPool.h:63
static constexpr void Unlock()
Definition: AkObjectPool.h:48
AKSOUNDENGINE_API void Free(AkMemPoolId in_poolId, void *in_pMemAddress)
AKRESULT
Standard function call result.
Definition: AkTypes.h:199
AK_NODISCARD ValueType * AllocateZeroFilled()
Initialize memory before returning.
Definition: AkObjectPool.h:149
ObjectPool()=default
AK_NODISCARD bool IsFull() const
Definition: AkObjectPool.h:129
AKRESULT Init(SizeType count)
Definition: AkObjectPool.h:84
@ AK_Success
The operation was successful.
Definition: AkTypes.h:201
ObjectPool(ObjectPool &&)=delete
@ AK_InvalidParameter
Something is not within bounds, check the documentation of the function returning this code.
Definition: AkTypes.h:217
AK_NODISCARD bool IsEmpty() const
Definition: AkObjectPool.h:130
uint8_t data[sizeof(ValueType)]
Definition: AkObjectPool.h:69
friend struct UnitTest::ObjectPoolHelper
Definition: AkObjectPool.h:206
#define AKASSERT(Condition)
Definition: AkAssert.h:67
AK_NODISCARD ValueType * Allocate()
Definition: AkObjectPool.h:135
AKRESULT Deallocate(ValueType *data)
Definition: AkObjectPool.h:164
AK_NODISCARD SizeType Size() const
Definition: AkObjectPool.h:126
ObjectPool(const ObjectPool &)=delete
AkForceInline void AkMemSet(void *pDest, AkInt32 iVal, AkUInt32 uSize)
Platform Independent Helper.
AK_NODISCARD SizeType Capacity() const
Definition: AkObjectPool.h:127
ObjectPool & operator=(const ObjectPool &)=delete
ObjectPool & operator=(ObjectPool &&)=delete
An object pool of N reusable objects with one allocation.
Definition: AkObjectPool.h:59
uint32_t AkUInt32
Unsigned 32-bit integer.
#define AK_NODISCARD
Definition: AkTypes.h:101
AkUInt32 SizeType
Definition: AkObjectPool.h:62
static constexpr void Lock()
Definition: AkObjectPool.h:47
@ AK_InsufficientMemory
Memory error.
Definition: AkTypes.h:229
const ValueType & Data() const
Definition: AkObjectPool.h:68

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