Unigine.LandscapeMapFileCompression Class

LandscapeMapFileCompression Class

Properties

bool IsCompressing#

bool IsDecompressing#

int Progress#

Landscape.COMPRESSOR_TYPE HeightCompressor#

Landscape.COMPRESSOR_TYPE AlbedoCompressor#

Landscape.COMPRESSOR_TYPE OpacityHeightCompressor#

bool EnabledAlbedoTextureCompression#

bool EnabledOpacityHeightTextureCompression#

UGUID GUID#

string CacheDirectory#

Members

---

LandscapeMapFileCompression ( ) #

Constructor.

bool Compress ( bool is_safe ) #

Starts the landscape map file compression process.

Arguments

• bool is_safe - true to make the Engine automatically call filesClose()/fileOpen() methods when performing operations (before modifying an .lmap file the Engine should release files via filesClose(), while after modification fileOpen() should be called), false — to call filesClose()/fileOpen() methods manually.

  The Landscape class has two overloads for the filesClose() method:

  • filesClose() — to be called in case of moving an .lmap file (no data reloading is performed as the file itself was not modified — saves time on reloading data)
  • filesClose(reload_files) — to be called in case of deleting or modifying an .lmap file.
  Notice

  When is_safe = true the Engine shall always call filesClose(reload_files) with complete data reloading.

Return value

true if the compression operation is successful; otherwise, false.

bool Decompress ( bool is_safe ) #

Starts the landscape map file decompression process.

Arguments

• bool is_safe - true to make the Engine automatically call filesClose()/fileOpen() methods when performing operations (before modifying an .lmap file the Engine should release files via filesClose(), while after modification fileOpen() should be called), false — to call filesClose()/fileOpen() methods manually.

  The Landscape class has two overloads for the filesClose() method:

  • filesClose() — to be called in case of moving an .lmap file (no data reloading is performed as the file itself was not modified — saves time on reloading data)
  • filesClose(reload_files) — to be called in case of deleting or modifying an .lmap file.
  Notice

  When is_safe = true the Engine shall always call filesClose(reload_files) with complete data reloading.

Return value

true if the decompression operation is successful; otherwise, false.

void Stop ( ) #

Stops the landscape map file compression/decompression process.

void SetMaskCompressor ( int mask, Landscape.COMPRESSOR_TYPE compressor_type ) #

Sets the type of the compressor used for the specified mask.

Arguments

• int mask - Mask number.
• Landscape.COMPRESSOR_TYPE compressor_type - Compressor type:
  • 0 – None
  • 1 – Our Method
  • 2 – LZ4
  • 3 – Zlib

void SetMaskOpacityCompressor ( int mask, Landscape.COMPRESSOR_TYPE compressor_type ) #

Sets the type of the compressor used for the opacity data of the specified mask.

Arguments

• int mask - Mask number.
• Landscape.COMPRESSOR_TYPE compressor_type - Compressor type:
  • 0 – None
  • 1 – Our Method
  • 2 – LZ4
  • 3 – Zlib

void SetCompressorAll ( Landscape.COMPRESSOR_TYPE compressor_type ) #

Sets the type of the compressor used to compress all data.

Arguments

• Landscape.COMPRESSOR_TYPE compressor_type - Compressor type:
  • 0 – None
  • 1 – Our Method
  • 2 – LZ4
  • 3 – Zlib

int GetMaskCompressor ( int mask ) #

Returns the current type of the compressor used for the specified mask.

Arguments

• int mask - Mask number.

Return value

Compressor type:

• 0 – None
• 1 – Our Method
• 2 – LZ4
• 3 – Zlib

int GetMaskOpacityCompressor ( int mask ) #

Returns the current type of the compressor used for the opacity data of the specified mask.

Arguments

• int mask - Mask number.

Return value

Compressor type:

• 0 – None
• 1 – Our Method
• 2 – LZ4
• 3 – Zlib

void SetEnabledMaskTextureCompression ( int mask, bool enable ) #

Enables or disables compression of the specified mask texture.

Arguments

• int mask - Mask number.
• bool enable - true to enable the mask texture compression; otherwise, false.

void SetEnabledMaskOpacityTextureCompression ( int mask, bool enable ) #

Enables or disables compression of the specified mask opacity texture.

Arguments

• int mask - Mask number.
• bool enable - true to enable the compression of the mask opacity texture; otherwise, false.

bool IsEnabledMaskTextureCompression ( int mask ) #

Returns a value undicating if the mask texture compression is enabled.

Arguments

• int mask - Mask number.

Return value

true if the mask texture compression is enabled; otherwise, false.

bool IsEnabledMaskOpacityTextureCompression ( int mask ) #

Returns the value indicating if the compression of the mask opacity texture is enabled.

Arguments

• int mask - Mask number.

Return value

true if the mask opacity texture compression is enabled; otherwise, false.