Visualization Library 2.0.0-b5

A lightweight C++ OpenGL middleware for 2D/3D graphics

VL     Star     Watch     Fork     Issue

[Download] [Tutorials] [All Classes] [Grouped Classes]
Public Member Functions | Protected Member Functions | List of all members
DotZLib.Deflater Class Reference

Implements a data compressor, using the deflate algorithm in the ZLib dll More...

+ Inheritance diagram for DotZLib.Deflater:

Public Member Functions

 Deflater (CompressLevel level)
 Constructs an new instance of the Deflater More...
 
override void Add (byte[] data, int offset, int count)
 Adds more data to the codec to be processed. More...
 
override void Finish ()
 Finishes up any pending data that needs to be processed and handled. More...
 
- Public Member Functions inherited from DotZLib.CodecBase
 CodecBase ()
 Initializes a new instance of the CodeBase class. More...
 
void Add (byte[] data)
 Adds more data to the codec to be processed. More...
 
void Dispose ()
 Releases any unmanaged resources and calls the CleanUp() method of the derived class More...
 

Protected Member Functions

override void CleanUp ()
 Closes the internal zlib deflate stream More...
 
- Protected Member Functions inherited from DotZLib.CodecBase
void OnDataAvailable ()
 Fires the DataAvailable event More...
 
void copyInput (byte[] data, int startIndex, int count)
 Copies a number of bytes to the internal codec buffer - ready for proccesing More...
 
void resetOutput ()
 Resets the internal output buffers to a known state - ready for processing More...
 
void setChecksum (uint newSum)
 Updates the running checksum property More...
 

Additional Inherited Members

- Protected Attributes inherited from DotZLib.CodecBase
bool _isDisposed = false
 True if the object instance has been disposed, false otherwise More...
 
const int kBufferSize = 16384
 The size of the internal buffers More...
 
- Properties inherited from DotZLib.CodecBase
uint Checksum [get]
 Gets the checksum of the data that has been added so far More...
 
- Properties inherited from DotZLib.Codec
uint Checksum [get]
 Gets the checksum of the data that has been added so far More...
 
- Events inherited from DotZLib.CodecBase
DataAvailableHandler DataAvailable
 Occurs when more processed data are available. More...
 
- Events inherited from DotZLib.Codec
DataAvailableHandler DataAvailable
 Occurs when more processed data are available. More...
 

Detailed Description

Implements a data compressor, using the deflate algorithm in the ZLib dll

Definition at line 18 of file Deflater.cs.

Constructor & Destructor Documentation

◆ Deflater()

DotZLib.Deflater.Deflater ( CompressLevel  level)
inline

Constructs an new instance of the Deflater

Parameters
levelThe compression level to use for this Deflater

Definition at line 38 of file Deflater.cs.

References DotZLib.CodecBase.resetOutput(), and DotZLib.Info.Version.

Member Function Documentation

◆ Add()

override void DotZLib.Deflater.Add ( byte []  data,
int  offset,
int  count 
)
inlinevirtual

Adds more data to the codec to be processed.

Parameters
dataByte array containing the data to be added to the codec
offsetThe index of the first byte to add from data
countThe number of bytes to add

Adding data may, or may not, raise the DataAvailable event

Implements DotZLib.CodecBase.

Definition at line 54 of file Deflater.cs.

References DotZLib.CodecBase.copyInput(), int, DotZLib.CodecBase.kBufferSize, DotZLib.CodecBase.OnDataAvailable(), and DotZLib.CodecBase.setChecksum().

◆ CleanUp()

override void DotZLib.Deflater.CleanUp ( )
inlineprotectedvirtual

Closes the internal zlib deflate stream

Implements DotZLib.CodecBase.

Definition at line 103 of file Deflater.cs.

◆ Finish()

override void DotZLib.Deflater.Finish ( )
inlinevirtual

Finishes up any pending data that needs to be processed and handled.

Implements DotZLib.CodecBase.

Definition at line 86 of file Deflater.cs.

References DotZLib.CodecBase.OnDataAvailable(), DotZLib.CodecBase.resetOutput(), and DotZLib.CodecBase.setChecksum().


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