Version

menu_open
Wwise SDK 2023.1.4
AkBankReadHelpers.h File Reference
#include <AK/Tools/Common/AkPlatformFuncs.h>
#include <type_traits>

Go to the source code of this file.

Namespaces

namespace  AK
 Audiokinetic namespace.
 

Macros

#define READBANKDATA(_Type, _Ptr, _Size)    AK::ReadBankData<_Type>( _Ptr )
 Read and return bank data of a given type, incrementing running pointer and decrementing block size for debug tracking purposes. More...
 
#define READVARIABLESIZEBANKDATA(_Type, _Ptr, _Size)    AK::ReadVariableSizeBankData<_Type>( _Ptr )
 
#define READBANKSTRING(_Ptr, _Size, _out_StringSize)    AK::ReadBankStringUtf8( _Ptr, _out_StringSize )
 
#define SKIPBANKDATA(_Type, _Ptr, _Size)    ( _Ptr ) += sizeof( _Type )
 Skip over some bank data of a given type, incrementing running pointer and decrementing block size for debug tracking purposes. More...
 
#define SKIPBANKBYTES(_NumBytes, _Ptr, _Size)    ( _Ptr ) += _NumBytes;
 Skip over some bank data by a given size in bytes, incrementing running pointer and decrementing block size for debug tracking purposes. More...
 
#define COPYBANKSTRING_CHAR(_Ptr, _Size, _OutPtr, _MaxPtrSize)
 Read and copy to a null-terminated UTF-8 string conversion from string stored in bank. More...
 
#define COPYBANKSTRING_OSCHAR(_Ptr, _Size, _OutPtr, _MaxPtrSize)
 Read and copy to a null-terminated OSChar string conversion from string stored in bank. More...
 
#define COPYBANKSTRING_WCHAR(_Ptr, _Size, OutPtr, _MaxPtrSize)
 Read and copy to a null-terminated wchar_t string conversion from string stored in bank. More...
 
#define GETBANKDATABIT(_Data, _Shift)    (((_Data) >> (_Shift)) & 0x1)
 
#define CHECKBANKDATASIZE(_DATASIZE_, _ERESULT_)
 Helper macro to determine whether the full content of a block of memory was properly parsed. More...
 

Functions

template<typename T , typename std::enable_if< std::is_fundamental< T >::value||std::is_enum< T >::value, bool >::type = true>
AK::ReadUnaligned (const AkUInt8 *in_pVal)
 
template<typename T , typename std::enable_if< std::is_fundamental< T >::value||std::is_enum< T >::value, bool >::type = true>
void AK::WriteUnaligned (AkUInt8 *out_pVal, const T in_val)
 
template<typename T , typename std::enable_if< std::is_class< T >::value, bool >::type = true>
void AK::WriteUnaligned (AkUInt8 *out_pVal, const T &in_val)
 
template<typename T >
AK::ReadBankData (AkUInt8 *&in_rptr)
 Read data from bank and advance pointer. More...
 
template<typename T >
AK::ReadVariableSizeBankData (AkUInt8 *&in_rptr)
 
char * AK::ReadBankStringUtf8 (AkUInt8 *&in_rptr, AkUInt32 &out_uStringSize)
 

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