OpenTTD
Public Member Functions | Data Fields
LZMASaveFilter Struct Reference

Filter using LZMA compression. More...

Inheritance diagram for LZMASaveFilter:
SaveFilter

Public Member Functions

 LZMASaveFilter (SaveFilter *chain, byte compression_level)
 Initialise this filter. More...
 
 ~LZMASaveFilter ()
 Clean up what we allocated. More...
 
void WriteLoop (byte *p, size_t len, lzma_action action)
 Helper loop for writing the data. More...
 
void Write (byte *buf, size_t size)
 Write a given number of bytes into the savegame. More...
 
void Finish ()
 Prepare everything to finish writing the savegame.
 
- Public Member Functions inherited from SaveFilter
 SaveFilter (SaveFilter *chain)
 Initialise this filter. More...
 
virtual ~SaveFilter ()
 Make sure the writers are properly closed. More...
 

Data Fields

lzma_stream lzma
 Stream state that we are writing to.
 
- Data Fields inherited from SaveFilter
SaveFilterchain
 Chained to the (savegame) filters. More...
 

Detailed Description

Filter using LZMA compression.

Definition at line 2280 of file saveload.cpp.

Constructor & Destructor Documentation

◆ LZMASaveFilter()

LZMASaveFilter::LZMASaveFilter ( SaveFilter chain,
byte  compression_level 
)
inline

Initialise this filter.

Parameters
chainThe next filter in this chain.
compression_levelThe requested level of compression.

Definition at line 2288 of file saveload.cpp.

References SlError().

◆ ~LZMASaveFilter()

LZMASaveFilter::~LZMASaveFilter ( )
inline

Clean up what we allocated.

Definition at line 2294 of file saveload.cpp.

Member Function Documentation

◆ Write()

void LZMASaveFilter::Write ( byte *  buf,
size_t  len 
)
inlinevirtual

Write a given number of bytes into the savegame.

Parameters
bufThe bytes to write.
lenThe number of bytes to write.

Implements SaveFilter.

Definition at line 2326 of file saveload.cpp.

◆ WriteLoop()

void LZMASaveFilter::WriteLoop ( byte *  p,
size_t  len,
lzma_action  action 
)
inline

Helper loop for writing the data.

Parameters
pThe bytes to write.
lenAmount of bytes to write.
actionAction for lzma_code.

Definition at line 2305 of file saveload.cpp.

References ReadBuffer::buf, MEMORY_CHUNK_SIZE, and SlError().


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