xoreos  0.0.5
Public Member Functions | Protected Member Functions | List of all members
Common::BitStreamWriter Class Referenceabstract

A bit stream writer. More...

#include <bitstreamwriter.h>

Inheritance diagram for Common::BitStreamWriter:
Inheritance graph
[legend]

Public Member Functions

virtual ~BitStreamWriter ()
 
virtual void putBit (bool bit)=0
 Write a bit to the bit stream. More...
 
virtual void putBits (uint32 bits, size_t n)=0
 Write a multi-bit value to the bit stream. More...
 
virtual void flush ()=0
 Flush the stream, forcing all cached bits to the written. More...
 

Protected Member Functions

 BitStreamWriter ()
 

Detailed Description

A bit stream writer.

Definition at line 40 of file bitstreamwriter.h.

Constructor & Destructor Documentation

◆ ~BitStreamWriter()

virtual Common::BitStreamWriter::~BitStreamWriter ( )
inlinevirtual

Definition at line 42 of file bitstreamwriter.h.

◆ BitStreamWriter()

Common::BitStreamWriter::BitStreamWriter ( )
inlineprotected

Definition at line 55 of file bitstreamwriter.h.

Member Function Documentation

◆ flush()

virtual void Common::BitStreamWriter::flush ( )
pure virtual

Flush the stream, forcing all cached bits to the written.

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

◆ putBit()

virtual void Common::BitStreamWriter::putBit ( bool  bit)
pure virtual

Write a bit to the bit stream.

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

Referenced by Sound::CodebookLibrary::copy(), and Sound::CodebookLibrary::rebuild().

Here is the caller graph for this function:

◆ putBits()

virtual void Common::BitStreamWriter::putBits ( uint32  bits,
size_t  n 
)
pure virtual

Write a multi-bit value to the bit stream.

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

Referenced by Sound::CodebookLibrary::copy(), Sound::putVorbisHeader(), Sound::putVorbisString(), and Sound::CodebookLibrary::rebuild().

Here is the caller graph for this function:

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