Version

menu_open

include/AK/Tools/Common/AkBankReadHelpers.h File Reference

Go to the source code of this file.

Defines

#define  READBANKDATA(_Type, _Ptr, _Size)   ReadBankData<_Type>( _Ptr )
  Read and return bank data of a given type, incrementing running pointer and decrementing block size for debug tracking purposes.
#define  READVARIABLESIZEBANKDATA(_Type, _Ptr, _Size)   ReadVariableSizeBankData<_Type>( _Ptr )
#define  READBANKSTRING_UTF8(_Ptr, _Size, _out_StringSize)   ReadBankStringUtf8( _Ptr, _out_StringSize )
#define  READBANKSTRING(_Ptr, _Size, _out_StringSize)   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.
#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.
#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.

Functions

template<typename T >
ReadBankData (AkUInt8 *&in_rptr)
  Read data from bank and advance pointer.
template<typename T >
ReadVariableSizeBankData (AkUInt8 *&in_rptr)
char *  ReadBankStringUtf8 (AkUInt8 *&in_rptr, AkUInt32 &out_uStringSize)
template<typename T >
ReadUnaligned (const AkUInt8 *in_rptr, AkUInt32 in_bytesToSkip=0)
  Read unaligned memory, const version.

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