OpenTTD
Public Member Functions | Data Fields
ZlibLoadFilter Struct Reference

Filter using Zlib compression. More...

Inheritance diagram for ZlibLoadFilter:
LoadFilter

Public Member Functions

 ZlibLoadFilter (LoadFilter *chain)
 Initialise this filter.
 ~ZlibLoadFilter ()
 Clean everything up.
size_t Read (byte *buf, size_t size)
 Read a given number of bytes from the savegame.
- Public Member Functions inherited from LoadFilter
 LoadFilter (LoadFilter *chain)
 Initialise this filter.
virtual ~LoadFilter ()
 Make sure the writers are properly closed.
virtual void Reset ()
 Reset this filter to read from the beginning of the file.

Data Fields

z_stream z
 Stream state we are reading from.
byte fread_buf [MEMORY_CHUNK_SIZE]
 Buffer for reading from the file.
- Data Fields inherited from LoadFilter
LoadFilterchain
 Chained to the (savegame) filters.

Detailed Description

Filter using Zlib compression.

Definition at line 2099 of file saveload.cpp.

Constructor & Destructor Documentation

ZlibLoadFilter::ZlibLoadFilter ( LoadFilter chain)
inline

Initialise this filter.

Parameters
chainThe next filter in this chain.

Definition at line 2107 of file saveload.cpp.

References SlError(), and z.

ZlibLoadFilter::~ZlibLoadFilter ( )
inline

Clean everything up.

Definition at line 2114 of file saveload.cpp.

References z.

Member Function Documentation

size_t ZlibLoadFilter::Read ( byte *  buf,
size_t  len 
)
inlinevirtual

Read a given number of bytes from the savegame.

Parameters
bufThe bytes to read.
lenThe number of bytes to read.
Returns
The number of actually read bytes.

Implements LoadFilter.

Definition at line 2119 of file saveload.cpp.

References LoadFilter::chain, fread_buf, LoadFilter::Read(), SlError(), and z.


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