Table of Contents

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

Go to the source code of this file.

Namespaces

namespace   AK
 

Audiokinetic namespace.


Defines

#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.
#define  READVARIABLESIZEBANKDATA(_Type, _Ptr, _Size)   AK::ReadVariableSizeBankData<_Type>( _Ptr )
#define  READBANKSTRING_UTF8(_Ptr, _Size, _out_StringSize)   AK::ReadBankStringUtf8( _Ptr, _out_StringSize )
#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.
#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 >
AK::ReadUnaligned (const AkUInt8 *in_pVal)
template<typename T >
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.
template<typename T >
AK::ReadVariableSizeBankData (AkUInt8 *&in_rptr)
char *  AK::ReadBankStringUtf8 (AkUInt8 *&in_rptr, AkUInt32 &out_uStringSize)