ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

Common::BitStream Class Reference

A bit stream. More...

#include <bitstream.h>

Inheritance diagram for Common::BitStream:

List of all members.

Public Member Functions

virtual ~BitStream ()
virtual uint32 pos () const =0
 Return the stream position in bits.
virtual uint32 size () const =0
 Return the stream size in bits.
virtual bool eos () const =0
 Has the end of the stream been reached?
virtual void rewind ()=0
 Rewind the bit stream back to the start.
virtual void skip (uint32 n)=0
 Skip the specified amount of bits.
virtual void align ()=0
 Skip the bits to closest data value border.
virtual uint32 getBit ()=0
 Read a bit from the bit stream.
virtual uint32 getBits (uint8 n)=0
 Read a multi-bit value from the bit stream.
virtual uint32 peekBit ()=0
 Read a bit from the bit stream, without changing the stream's position.
virtual uint32 peekBits (uint8 n)=0
 Read a multi-bit value from the bit stream, without changing the stream's position.
virtual void addBit (uint32 &x, uint32 n)=0
 Add a bit to the value x, making it an n+1-bit value.

Protected Member Functions

 BitStream ()

Detailed Description

A bit stream.

Definition at line 36 of file bitstream.h.


Constructor & Destructor Documentation

virtual Common::BitStream::~BitStream (  )  [inline, virtual]

Definition at line 38 of file bitstream.h.

Common::BitStream::BitStream (  )  [inline, protected]

Definition at line 75 of file bitstream.h.


Member Function Documentation

virtual void Common::BitStream::addBit ( uint32 x,
uint32  n 
) [pure virtual]

Add a bit to the value x, making it an n+1-bit value.

Implemented in Common::BitStreamImpl< valueBits, isLE, isMSB2LSB >.

virtual void Common::BitStream::align (  )  [pure virtual]

Skip the bits to closest data value border.

Implemented in Common::BitStreamImpl< valueBits, isLE, isMSB2LSB >.

virtual bool Common::BitStream::eos (  )  const [pure virtual]

Has the end of the stream been reached?

Implemented in Common::BitStreamImpl< valueBits, isLE, isMSB2LSB >.

virtual uint32 Common::BitStream::getBit (  )  [pure virtual]

Read a bit from the bit stream.

Implemented in Common::BitStreamImpl< valueBits, isLE, isMSB2LSB >.

virtual uint32 Common::BitStream::getBits ( uint8  n  )  [pure virtual]

Read a multi-bit value from the bit stream.

Implemented in Common::BitStreamImpl< valueBits, isLE, isMSB2LSB >.

virtual uint32 Common::BitStream::peekBit (  )  [pure virtual]

Read a bit from the bit stream, without changing the stream's position.

Implemented in Common::BitStreamImpl< valueBits, isLE, isMSB2LSB >.

virtual uint32 Common::BitStream::peekBits ( uint8  n  )  [pure virtual]

Read a multi-bit value from the bit stream, without changing the stream's position.

Implemented in Common::BitStreamImpl< valueBits, isLE, isMSB2LSB >.

virtual uint32 Common::BitStream::pos (  )  const [pure virtual]

Return the stream position in bits.

Implemented in Common::BitStreamImpl< valueBits, isLE, isMSB2LSB >.

virtual void Common::BitStream::rewind (  )  [pure virtual]

Rewind the bit stream back to the start.

Implemented in Common::BitStreamImpl< valueBits, isLE, isMSB2LSB >.

virtual uint32 Common::BitStream::size (  )  const [pure virtual]

Return the stream size in bits.

Implemented in Common::BitStreamImpl< valueBits, isLE, isMSB2LSB >.

virtual void Common::BitStream::skip ( uint32  n  )  [pure virtual]

Skip the specified amount of bits.

Implemented in Common::BitStreamImpl< valueBits, isLE, isMSB2LSB >.


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


Generated on Sat Sep 2 2017 05:01:23 for ResidualVM by doxygen 1.7.1
curved edge   curved edge