Open 3D Engine GridMate API Reference  2205.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
GridMate::ReadBuffer Class Reference

#include <Buffer.h>

Public Member Functions

 ReadBuffer (EndianType endianType, const char *data=nullptr, PackedSize size=0, PackedSize offset=0)
 
 ReadBuffer (const ReadBuffer &rhs)
 
AZ_FORCE_INLINE bool IsEmptyIgnoreTrailingBits () const
 
AZ_FORCE_INLINE bool IsEmpty () const
 
AZ_FORCE_INLINE PackedSize Left () const
 
AZ_FORCE_INLINE PackedSize Read () const
 
AZ_FORCE_INLINE PackedSize Size () const
 
const AZ_FORCE_INLINE char * Get () const
 
const AZ_FORCE_INLINE char * GetCurrent () const
 
AZ_FORCE_INLINE bool IsOverrun () const
 
AZ_FORCE_INLINE bool IsValid () const
 
AZ_FORCE_INLINE EndianType GetEndianType () const
 
AZ_FORCE_INLINE void SetEndianType (EndianType endianType)
 
template<typename Type >
AZ_FORCE_INLINE bool Read (Type &pod)
 
template<typename Type , typename MarshalerType >
AZ_FORCE_INLINE bool Read (Type &pod, MarshalerType &&marshaler)
 
bool ReadRaw (void *data, PackedSize dataSize)
 
bool ReadRawBit (bool &data)
 
bool Skip (PackedSize bytes)
 
ReadBuffer ReadInnerBuffer (PackedSize size)
 

Detailed Description

Generic read buffer.

Constructor & Destructor Documentation

◆ ReadBuffer()

GridMate::ReadBuffer::ReadBuffer ( EndianType  endianType,
const char *  data = nullptr,
PackedSize  size = 0,
PackedSize  offset = 0 
)

@endianType Endian type of the buffer @data the starting byte of the buffer, note the actual start might begin in the middle of the byte somewhere @size the length of the buffer, note the buffer might be in bytes and a non-8 number of bits @offset the start of the buffer, usually, it is either zero bytes from @data or some non-zero number of bits from @data


The documentation for this class was generated from the following file: