idCompressor Class Reference

#include <Compressor.h>

Inheritance diagram for idCompressor:

Public Member Functions
virtual void	Init (idFile *f, bool compress, int wordLength)=0
virtual void	FinishCompress (void)=0
virtual float	GetCompressionRatio (void) const =0
virtual const char *	GetName (void)=0
virtual const char *	GetFullPath (void)=0
virtual int	Read (void *outData, int outLength)=0
virtual int	Write (const void *inData, int inLength)=0
virtual int	Length (void)=0
virtual ID_TIME_T	Timestamp (void)=0
virtual int	Tell (void)=0
virtual void	ForceFlush (void)=0
virtual void	Flush (void)=0
virtual int	Seek (long offset, fsOrigin_t origin)=0
Public Member Functions inherited from idFile
virtual	~idFile (void)
virtual void	Rewind (void)
virtual int	Printf (const char *fmt,...) id_attribute((format(printf
virtual int virtual int	VPrintf (const char *fmt, va_list arg)
virtual int	WriteFloatString (const char *fmt,...) id_attribute((format(printf
virtual int virtual int	ReadInt (int &value)
virtual int	ReadUnsignedInt (unsigned int &value)
virtual int	ReadShort (short &value)
virtual int	ReadUnsignedShort (unsigned short &value)
virtual int	ReadChar (char &value)
virtual int	ReadUnsignedChar (unsigned char &value)
virtual int	ReadFloat (float &value)
virtual int	ReadBool (bool &value)
virtual int	ReadString (idStr &string)
virtual int	ReadVec2 (idVec2 &vec)
virtual int	ReadVec3 (idVec3 &vec)
virtual int	ReadVec4 (idVec4 &vec)
virtual int	ReadVec6 (idVec6 &vec)
virtual int	ReadMat3 (idMat3 &mat)
virtual int	WriteInt (const int value)
virtual int	WriteUnsignedInt (const unsigned int value)
virtual int	WriteShort (const short value)
virtual int	WriteUnsignedShort (unsigned short value)
virtual int	WriteChar (const char value)
virtual int	WriteUnsignedChar (const unsigned char value)
virtual int	WriteFloat (const float value)
virtual int	WriteBool (const bool value)
virtual int	WriteString (const char *string)
virtual int	WriteVec2 (const idVec2 &vec)
virtual int	WriteVec3 (const idVec3 &vec)
virtual int	WriteVec4 (const idVec4 &vec)
virtual int	WriteVec6 (const idVec6 &vec)
virtual int	WriteMat3 (const idMat3 &mat)

Static Public Member Functions
static idCompressor *	AllocNoCompression (void)
static idCompressor *	AllocBitStream (void)
static idCompressor *	AllocRunLength (void)
static idCompressor *	AllocRunLength_ZeroBased (void)
static idCompressor *	AllocHuffman (void)
static idCompressor *	AllocArithmetic (void)
static idCompressor *	AllocLZSS (void)
static idCompressor *	AllocLZSS_WordAligned (void)
static idCompressor *	AllocLZW (void)

Detailed Description

Definition at line 42 of file Compressor.h.

Member Function Documentation

idCompressor * idCompressor::AllocArithmetic ( void  )

static

Definition at line 2547 of file Compressor.cpp.

idCompressor * idCompressor::AllocBitStream ( void  )

static

Definition at line 2511 of file Compressor.cpp.

idCompressor * idCompressor::AllocHuffman ( void  )

static

Definition at line 2538 of file Compressor.cpp.

idCompressor * idCompressor::AllocLZSS ( void  )

static

Definition at line 2556 of file Compressor.cpp.

idCompressor * idCompressor::AllocLZSS_WordAligned ( void  )

static

Definition at line 2565 of file Compressor.cpp.

idCompressor * idCompressor::AllocLZW ( void  )

static

Definition at line 2574 of file Compressor.cpp.

idCompressor * idCompressor::AllocNoCompression ( void  )

static

Definition at line 2502 of file Compressor.cpp.

idCompressor * idCompressor::AllocRunLength ( void  )

static

Definition at line 2520 of file Compressor.cpp.

idCompressor * idCompressor::AllocRunLength_ZeroBased ( void  )

static

Definition at line 2529 of file Compressor.cpp.

virtual void idCompressor::FinishCompress ( void  )

pure virtual

Implemented in idCompressor_LZW, idCompressor_LZSS, idCompressor_Arithmetic, idCompressor_Huffman, idCompressor_BitStream, and idCompressor_None.

virtual void idCompressor::Flush ( void  )

pure virtual

Reimplemented from idFile.

Implemented in idCompressor_None.

virtual void idCompressor::ForceFlush ( void  )

pure virtual

Reimplemented from idFile.

Implemented in idCompressor_None.

virtual float idCompressor::GetCompressionRatio ( void  ) const

pure virtual

Implemented in idCompressor_Huffman, idCompressor_BitStream, and idCompressor_None.

virtual const char* idCompressor::GetFullPath ( void  )

pure virtual

Reimplemented from idFile.

Implemented in idCompressor_None.

virtual const char* idCompressor::GetName ( void  )

pure virtual

Reimplemented from idFile.

Implemented in idCompressor_None.

virtual void idCompressor::Init ( idFile *  f, bool  compress, int  wordLength  )

pure virtual

Implemented in idCompressor_LZW, idCompressor_LZSS_WordAligned, idCompressor_LZSS, idCompressor_Arithmetic, idCompressor_Huffman, idCompressor_RunLength, idCompressor_BitStream, and idCompressor_None.

virtual int idCompressor::Length ( void  )

pure virtual

Reimplemented from idFile.

Implemented in idCompressor_None.

virtual int idCompressor::Read ( void *  outData, int  outLength  )

pure virtual

Reimplemented from idFile.

Implemented in idCompressor_LZW, idCompressor_LZSS, idCompressor_Arithmetic, idCompressor_Huffman, idCompressor_RunLength_ZeroBased, idCompressor_RunLength, idCompressor_BitStream, and idCompressor_None.

virtual int idCompressor::Seek ( long  offset, fsOrigin_t  origin  )

pure virtual

Reimplemented from idFile.

Implemented in idCompressor_None.

virtual int idCompressor::Tell ( void  )

pure virtual

Reimplemented from idFile.

Implemented in idCompressor_None.

virtual ID_TIME_T idCompressor::Timestamp ( void  )

pure virtual

Reimplemented from idFile.

Implemented in idCompressor_None.

virtual int idCompressor::Write ( const void *  inData, int  inLength  )

pure virtual

Reimplemented from idFile.

Implemented in idCompressor_LZW, idCompressor_LZSS, idCompressor_Arithmetic, idCompressor_Huffman, idCompressor_RunLength_ZeroBased, idCompressor_RunLength, idCompressor_BitStream, and idCompressor_None.

---

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

• neo/framework/Compressor.h
• neo/framework/Compressor.cpp