Decompressor

Inheritance:

Methods of Decompressor:

decompress
bool Decompressor::decompress(Filename const &source_file);

Description: Performs a foreground decompression of the named file; does not return until the decompression is complete.
Description: Does an in-memory decompression of the indicated Ramfile. The decompressed contents are written back into the same Ramfile on completion.

getProgress
float Decompressor::get_progress(void) const;

Description: Returns the ratio through the decompression step in the background.

initiate
int Decompressor::initiate(Filename const &source_file);

Description: Begins a background decompression of the named file (whose filename must end in ".pz") to a new file without the .pz extension. The source file is removed after successful completion.
Description: Begins a background decompression from the named source file to the named destination file. The source file is removed after successful completion.

run
int Decompressor::run(void);

Description: Called each frame to do the next bit of work in the background task. Returns EU_ok if a chunk is completed but there is more to go, or EU_success when we're all done. Any other return value indicates an error.