Enum CompressionParameterKey

• Defined in File libCZI_compress.h

Enum Documentation

enum class libCZI::CompressionParameterKey

Values that represent well-known keys for the compression-parameters property bag. Note that the property-bag API is modeled with an int as key, which is by intention in order to allow for private keys.

Values:

enumerator ZSTD_RAWCOMPRESSIONLEVEL

This gives the “raw” zstd compression level aka “ExplicitLevel” (type: int32). If value is out-of-range, it will be clipped. This parameter is used with “zstd0” and “zstd1” compression schemes.

enumerator ZSTD_PREPROCESS_DOLOHIBYTEPACKING

Whether to do the “lo-hi-byte-packing” preprocessing (type: boolean). This parameter is used with the “zstd1” compression scheme only.

enumerator JXRLIB_QUALITY

The quality parameter for the jxrlib encoder (type: uint32). The range is from 0 to 1000, where 1000 gives the best quality (i.e. loss-less compression). This parameter is used with the “jxrlib” compression scheme only. If value is out-of-range, it will be clipped.

enumerator CHUNKEDCOMPRESSION_MAXCHUNKSIZE

The maximum chunk size (in bytes) to be used for chunked compression (type: uint32). This parameter is used with the “chunked” compression scheme only.

enumerator CHUNKEDCOMPRESSION_CODEC

The codec to be used for chunked compression (type: int32, where the value is interpreted as a ChunkedCompressionHeaderHelper::Codec enum value). This parameter is used with the “chunked” compression scheme only.

enumerator CHUNKEDCOMPRESSION_RAWCOMPRESSIONLEVEL_ZSTD

The “raw” zstd compression level aka “ExplicitLevel” (type: int32) to be used for chunked compression. If value is out-of-range, it will be clipped. This parameter is used with the “chunked” compression scheme only, and only if the codec for chunked compression is set to zstd.

enumerator CHUNKEDCOMPRESSION_DOLOHIBYTEUNPACKING

Whether to do the “lo-hi-byte-unpacking” preprocessing (type: boolean) for chunked compression.