ScummVM API documentation
Common::ReadStreamEndian Class Reference

#include <stream.h>

Inheritance diagram for Common::ReadStreamEndian:
Common::ReadStream Common::Stream Common::SeekableReadStreamEndian Tinsel::TinselFile Common::MemoryReadStreamEndian Common::SeekableReadStreamEndianWrapper Saga::ByteArrayReadStreamEndian

Public Member Functions

 ReadStreamEndian (bool bigEndian)
 
bool isBE () const
 
uint16 readUint16 ()
 
uint32 readUint32 ()
 
uint64 readUint64 ()
 
FORCEINLINE int16 readSint16 ()
 
FORCEINLINE int32 readSint32 ()
 
FORCEINLINE int64 readSint64 ()
 
FORCEINLINE float readFloat ()
 
FORCEINLINE double readDouble ()
 
- Public Member Functions inherited from Common::ReadStream
virtual bool eos () const =0
 
virtual uint32 read (void *dataPtr, uint32 dataSize)=0
 
byte readByte ()
 
FORCEINLINE int8 readSByte ()
 
uint16 readUint16LE ()
 
uint32 readUint32LE ()
 
uint64 readUint64LE ()
 
uint16 readUint16BE ()
 
uint32 readUint32BE ()
 
uint64 readUint64BE ()
 
FORCEINLINE int16 readSint16LE ()
 
FORCEINLINE int32 readSint32LE ()
 
FORCEINLINE int64 readSint64LE ()
 
FORCEINLINE int16 readSint16BE ()
 
FORCEINLINE int32 readSint32BE ()
 
FORCEINLINE int64 readSint64BE ()
 
FORCEINLINE float readFloatLE ()
 
FORCEINLINE float readFloatBE ()
 
FORCEINLINE double readDoubleLE ()
 
FORCEINLINE double readDoubleBE ()
 
template<class TDataFormat , class... T>
bool readMultiple (const TDataFormat &dataFormat, T &...values)
 
template<class... T>
bool readMultipleEndian (bool isLittle, T &...values)
 
template<class... T>
bool readMultipleLE (T &...values)
 
template<class... T>
bool readMultipleBE (T &...values)
 
SeekableReadStreamreadStream (uint32 dataSize)
 
String readString (char terminator=0, size_t len=String::npos)
 
Common::String readPascalString (bool transformCR=true)
 
- Public Member Functions inherited from Common::Stream
virtual bool err () const
 
virtual void clearErr ()
 

Detailed Description

ReadStream mixin subclass that adds non-endian read methods whose endianness is set during the stream creation.

Constructor & Destructor Documentation

◆ ReadStreamEndian()

Common::ReadStreamEndian::ReadStreamEndian ( bool  bigEndian)
inline

Set the endianness of the read stream.

Parameters
bigEndianIf true, create a big endian stream. If false, create a little endian stream.

Member Function Documentation

◆ isBE()

bool Common::ReadStreamEndian::isBE ( ) const
inline

Return true if data is encoded in big endian order.

◆ readUint16()

uint16 Common::ReadStreamEndian::readUint16 ( )
inline

Read an unsigned 16-bit word using the stream endianness and return it in native endianness.

◆ readUint32()

uint32 Common::ReadStreamEndian::readUint32 ( )
inline

Read an unsigned 32-bit word using the stream endianness and return it in native endianness.

◆ readUint64()

uint64 Common::ReadStreamEndian::readUint64 ( )
inline

Read an unsigned 64-bit word using the stream endianness and return it in native endianness.

◆ readSint16()

FORCEINLINE int16 Common::ReadStreamEndian::readSint16 ( )
inline

Read a signed 16-bit word using the stream endianness and return it in native endianness.

◆ readSint32()

FORCEINLINE int32 Common::ReadStreamEndian::readSint32 ( )
inline

Read a signed 32-bit word using the stream endianness and return it in native endianness.

◆ readSint64()

FORCEINLINE int64 Common::ReadStreamEndian::readSint64 ( )
inline

Read a signed 64-bit word using the stream endianness and return it in native endianness.

◆ readFloat()

FORCEINLINE float Common::ReadStreamEndian::readFloat ( )
inline

Read a 32-bit floating point value using the stream endianness and return it in native endianness.

◆ readDouble()

FORCEINLINE double Common::ReadStreamEndian::readDouble ( )
inline

Read a 64-bit floating point value using the stream endianness and return it in native endianness.


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