Uranus  1.0.1.0
Uranus is a GameEngine written in C++
Loading...
Searching...
No Matches
tson::IDecompressor< TIn, TOut > Class Template Referenceabstract

Public Member Functions

virtual ~IDecompressor ()=default
 
virtual TOut decompress (const TIn &input)=0
 
virtual TOut decompress (const void *data, size_t size)=0
 
virtual TOut decompressFile (const fs::path &path)=0
 
virtual const std::string & name () const =0
 

Constructor & Destructor Documentation

◆ ~IDecompressor()

template<class TIn , class TOut >
virtual tson::IDecompressor< TIn, TOut >::~IDecompressor ( )
virtualdefault

Pure virtual class needs virtual destructor so derived classes can call their own destructors

Member Function Documentation

◆ decompress() [1/2]

template<class TIn , class TOut >
virtual TOut tson::IDecompressor< TIn, TOut >::decompress ( const TIn &  input)
pure virtual

Used primarily for Tiled related decompression.

Parameters
inputInput data
Returns
Decompressed data

Implemented in tson::Base64Decompressor.

◆ decompress() [2/2]

template<class TIn , class TOut >
virtual TOut tson::IDecompressor< TIn, TOut >::decompress ( const void *  data,
size_t  size 
)
pure virtual

Used for whole file decompression. Not related to Tiled

Parameters
path
Returns

Implemented in tson::Base64Decompressor.

◆ decompressFile()

template<class TIn , class TOut >
virtual TOut tson::IDecompressor< TIn, TOut >::decompressFile ( const fs::path &  path)
pure virtual

Used for whole file decompression. Not related to Tiled

Parameters
path
Returns

Implemented in tson::Base64Decompressor.

◆ name()

template<class TIn , class TOut >
virtual const std::string & tson::IDecompressor< TIn, TOut >::name ( ) const
pure virtual

If the name matches with 'compression' or 'encoding' the decompress() function will be called automatically for the actual Layer. Encoding-related matching is handled first!

Known values:

compression: zlib, gzip, zstd (since Tiled 1.3) or empty (default) (tilelayer only). encoding: csv (default) or base64 (tilelayer only).

Returns

Implemented in tson::Base64Decompressor.


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