ImFusion C++ SDK 4.5.0
ImFusion::ImFusionFile::CompressionSettings Struct Reference

#include <ImFusion/Base/ImFusionFile.h>

Compression settings for nested ImFusionFile save operations. More...

Detailed Description

Compression settings for nested ImFusionFile save operations.

Used to pass compression configuration to plugins that save nested data. Different datasets inside the same ImFusionFile can have very different size, structure, and compressibility, so a single global compression choice may be suboptimal. This struct allow defining compression settings for heterogeneous content where a one-mode-fits-all compression approach can either bloat storage/transfer or slow down save/load unnecessarily.

Public Member Functions

CompressionMode compressionFor (const Data &data, CompressionMode fallback) const
 Get compression for a specific Data item.

Public Attributes

std::optional< CompressionModedefaultCompression
 Default compression mode (nullopt = inherit from ImFusionFile).
CompressionOverride compressionOverride
 Per-data compression override by name.

Member Function Documentation

◆ compressionFor()

CompressionMode ImFusion::ImFusionFile::CompressionSettings::compressionFor ( const Data & data,
CompressionMode fallback ) const
inline

Get compression for a specific Data item.

Checks compressionOverride for data name, then "<ALL>" wildcard, then defaultCompression.

Parameters
fallbackCompression mode to use if neither override nor default is set

The documentation for this struct was generated from the following file:
  • ImFusion/Base/ImFusionFile.h
Search Tab / S to search, Esc to close