Version

menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.8.8601 ). 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 2023.1.8
AkArray.h
void EraseSwap(unsigned int in_uIndex)
Definition: AkArray.h:502
static AkForceInline void TransferMem(void *&io_pDest, AkArrayAllocatorNoAlign< T_MEMID > in_srcAlloc, void *in_pSrc)
Definition: AkArray.h:54
AkForceInline void TransferMem(void *&io_pDest, AkHybridAllocator< uBufferSizeBytes, uAlignmentSize, T_MEMID > &in_srcAlloc, void *in_pSrc)
Definition: AkArray.h:123
AkUInt32 operator-(Iterator const &rhs) const
Definition: AkArray.h:294
AkForceInline void * Alloc(size_t in_uSize)
Definition: AkArray.h:63
AkForceInline void Free(void *in_pAddress)
Definition: AkArray.h:73
Iterator & operator++()
++ operator</div>
Definition: AkArray.h:301
static const AkUInt32 _uBufferSizeBytes
Definition: AkArray.h:92
AkForceInline void AkMemMove(void *pDest, const void *pSrc, AkUInt32 uSize)
~AkArray()
Destructor.
Definition: AkArray.h:269
@ AK_Fail
The operation failed.
Definition: AkTypes.h:134
bool IsGrowingAllowed() const
Definition: AkArray.h:509
AkForceInline void * ReAlloc(void *in_pCurrent, size_t in_uOldSize, size_t in_uNewSize)
Definition: AkArray.h:101
AKRESULT Copy(const AkArray< T, ARG_T, TAlloc, TGrowBy, TMovePolicy > &in_rSource)
Definition: AkArray.h:865
Iterator FindEx(ARG_T in_Item) const
Returns the iterator th the specified item, will be End() if the item is not found.
Definition: AkArray.h:360
void RemoveAll()
Removes all items in the array.
Definition: AkArray.h:673
#define AkFree(_pool, _pvmem)
Definition: AkObject.h:82
AKSOUNDENGINE_API void Free(AkMemPoolId in_poolId, void *in_pMemAddress)
AK_ALIGN(char m_buffer[uBufferSizeBytes], uAlignmentSize)
T & Last()
Returns a reference to the last item in the array.
Definition: AkArray.h:630
AKRESULT
Standard function call result.
Definition: AkTypes.h:131
AkForceInline void * ReAlloc(void *in_pCurrent, size_t in_uOldSize, size_t in_uNewSize)
Definition: AkArray.h:68
AKRESULT RemoveSwap(ARG_T in_rItem)
Definition: AkArray.h:660
AkArrayAllocatorAlignedSimd< AkMemID_Processing > ArrayPoolLEngineDefaultAlignedSimd
Definition: AkArray.h:213
AkForceInline void Free(void *in_pAddress)
Definition: AkArray.h:117
static AkUInt32 GrowBy(AkUInt32 in_CurrentArraySize)
Definition: AkArray.h:231
AkForceInline T * Exists(ARG_T in_Item) const
Returns a pointer to the specified item in the list if it exists, 0 if not found.
Definition: AkArray.h:584
Specific implementation of array.
Definition: AkArray.h:258
#define AkAlloc(_pool, _size)
Definition: AkObject.h:75
#define NULL
Definition: AkTypes.h:46
static AkForceInline bool IsTrivial()
Definition: AkArray.h:173
T * pItem
Pointer to the item in the array.
Definition: AkArray.h:282
@ AK_Success
The operation was successful.
Definition: AkTypes.h:133
bool GrowArray(AkUInt32 in_uGrowBy)
Resize the array.
Definition: AkArray.h:779
T * operator->() const
Definition: AkArray.h:323
AkArrayAllocatorNoAlign< AkMemID_Profiler > ArrayPoolProfiler
Definition: AkArray.h:212
AkArrayAllocatorNoAlign< AkMemID_Processing > ArrayPoolLEngineDefault
Definition: AkArray.h:211
AkForceInline void TransferMem(void *&io_pDest, AkArrayAllocatorAlignedSimd< T_MEMID > in_srcAlloc, void *in_pSrc)
Definition: AkArray.h:78
bool operator==(const Iterator &in_rOp) const
== operator</div>
Definition: AkArray.h:330
#define AkPlacementNew(_memory)
Definition: AkObject.h:49
void RemoveLast()
Removes the last item from the array.
Definition: AkArray.h:638
@ AK_InvalidParameter
Something is not within bounds, check the documentation of the function returning this code.
Definition: AkTypes.h:149
static AkForceInline void * Alloc(size_t in_uSize)
Definition: AkArray.h:39
AkUInt32 m_uLength
number of items in the array.
Definition: AkArray.h:881
bool Resize(AkUInt32 in_uiSize)
Resize the array to the specified size.
Definition: AkArray.h:822
AkArray()
Constructor.
Definition: AkArray.h:261
AkForceInline T * AddLast(ARG_T in_rItem)
Add an item in the array, and fills it with the provided item.
Definition: AkArray.h:621
Iterator.
Definition: AkArray.h:281
#define AKASSERT(Condition)
Definition: AkAssert.h:67
static AkUInt32 GrowBy(AkUInt32)
Definition: AkArray.h:222
static AkForceInline void * ReAlloc(void *in_pCurrent, size_t in_uOldSize, size_t in_uNewSize)
Definition: AkArray.h:44
AKRESULT ReserveExtra(AkUInt32 in_ulReserve)
Definition: AkArray.h:546
AkForceInline void AkMemCpy(void *pDest, const void *pSrc, AkUInt32 uSize)
Platform Independent Helper for memcpy/memmove/memset.
Iterator End() const
Returns the iterator to the end of the array.
Definition: AkArray.h:352
AkUInt32 Reserved() const
Definition: AkArray.h:551
Iterator Insert(Iterator &in_rIter)
Definition: AkArray.h:691
AkForceInline void * Alloc(size_t in_uSize)
Definition: AkArray.h:94
#define AK_SIMD_ALIGNMENT
Platform-specific alignment requirement for SIMD data.
Definition: AkTypes.h:52
void Transfer(AkArray< T, ARG_T, TAlloc, TGrowBy, TMovePolicy > &in_rSource)
Definition: AkArray.h:852
Iterator Erase(Iterator &in_rIter)
Erase the specified iterator from the array.
Definition: AkArray.h:403
static AkForceInline void Move(T &in_Dest, T &in_Src)
Definition: AkArray.h:198
#define AkMalign(_pool, _size, _align)
Definition: AkObject.h:76
AkUInt32 m_ulReserved
how many we can have at most (currently allocated).
Definition: AkArray.h:882
Iterator Begin() const
Returns the iterator to the first item of the array, will be End() if the array is empty.
Definition: AkArray.h:344
AkForceInline AkUInt32 Length() const
Returns the numbers of items in the array.
Definition: AkArray.h:566
static AkForceInline bool IsTrivial()
Definition: AkArray.h:203
#define AkRealloc(_pool, _pvmem, _size)
Definition: AkObject.h:78
AkArrayAllocatorNoAlign< AkMemID_Object > ArrayPoolDefault
Definition: AkArray.h:210
AKRESULT Remove(ARG_T in_rItem)
Removes the specified item if found in the array.
Definition: AkArray.h:646
void Erase(unsigned int in_uIndex)
Erase the item at the specified index.
Definition: AkArray.h:443
bool operator!=(const Iterator &in_rOp) const
!= operator</div>
Definition: AkArray.h:336
bool GrowArray()
Definition: AkArray.h:772
AkForceInline T * AddLast()
Definition: AkArray.h:592
static AkForceInline void Free(void *in_pAddress)
Definition: AkArray.h:49
uint32_t AkUInt32
Unsigned 32-bit integer.
void Term()
Term the array. Must be called before destroying the object.
Definition: AkArray.h:554
static AkForceInline bool IsTrivial()
Definition: AkArray.h:158
@ AK_InsufficientMemory
Memory error.
Definition: AkTypes.h:161
static AkUInt32 GrowBy(AkUInt32 in_CurrentArraySize)
Definition: AkArray.h:244
static AkUInt32 GrowBy(AkUInt32)
Definition: AkArray.h:217
AkForceInline bool IsEmpty() const
Returns true if the number items in the array is 0, false otherwise.
Definition: AkArray.h:578
static AkForceInline void Move(T &in_Dest, T &in_Src)
Definition: AkArray.h:150
#define AkForceInline
Definition: AkTypes.h:63
AkForceInline T * Data() const
Returns a pointer to the first item in the array.
Definition: AkArray.h:572
T * Insert(unsigned int in_uIndex)
Definition: AkArray.h:711
Iterator & operator--()
– operator</div>
Definition: AkArray.h:309
Iterator EraseSwap(Iterator &in_rIter)
Definition: AkArray.h:481
AkForceInline T & operator[](unsigned int uiIndex) const
Operator [], return a reference to the specified index.
Definition: AkArray.h:681
#define AkReallocAligned(_pool, _pvmem, _size, _align)
Definition: AkObject.h:79
AKRESULT Reserve(AkUInt32 in_ulReserve)
Definition: AkArray.h:529
Iterator operator+(AkUInt32 inc) const
Definition: AkArray.h:285
static AkForceInline void Move(T &&io_Dest, T &&io_Src)
Definition: AkArray.h:168
Iterator BinarySearch(ARG_T in_Item) const
Definition: AkArray.h:375
T * m_pItems
pointer to the beginning of the array.
Definition: AkArray.h:880
static AkForceInline void Move(T &&io_Dest, T &&io_Src)
Definition: AkArray.h:183
static AkForceInline bool IsTrivial()
Definition: AkArray.h:188

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