Kanzi  3.9.9
Kanzi Engine C++ API
kanzi::ApplicationProperties::ImageLoadParameters Struct Reference

Parameters that Kanzi passes to third-party image libraries when loading image files. More...

#include <kanzi/core.ui/application/application_properties.hpp>

Public Attributes

size_t libJPEGMaxMemory
 Sets the maximum amount of memory in bytes to allocate for a JPEG object in libjpeg. More...
 
optional< uint32_t > libPNGChunkCacheMax
 Sets the maximum number of ancillary chunks in libpng. More...
 
optional< uint32_t > libPNGChunkMallocMax
 Sets the maximum amount of memory in bytes to allocate for a chunk in libpng. More...
 

Detailed Description

Parameters that Kanzi passes to third-party image libraries when loading image files.

Since
Kanzi 3.9.3

Member Data Documentation

size_t kanzi::ApplicationProperties::ImageLoadParameters::libJPEGMaxMemory

Sets the maximum amount of memory in bytes to allocate for a JPEG object in libjpeg.

This parameter corresponds to the libjpeg parameter jpeg_memory_mgr::max_memory_to_use. Note that this limit affects only the space used for virtual-array buffers and is not a guaranteed maximum but merely advisory.

The default value 0 sets no limit on the amount of memory to allocate.

optional<uint32_t> kanzi::ApplicationProperties::ImageLoadParameters::libPNGChunkCacheMax

Sets the maximum number of ancillary chunks in libpng.

This parameter corresponds to the libpng function png_set_chunk_cache_max().

The PNG specification does not limit the number of ancillary chunks allowed in a PNG datastream. By default libpng imposes a limit of a total of 1000 sPLT, tEXt, iTXt, zTXt, and unknown chunks to be stored.

If you do not set this optional parameter, Kanzi keeps the libpng defaults. To not limit the number of ancillary chunks, set this parameter to 0x7fffffffL.

optional<uint32_t> kanzi::ApplicationProperties::ImageLoadParameters::libPNGChunkMallocMax

Sets the maximum amount of memory in bytes to allocate for a chunk in libpng.

This parameter corresponds to the libpng function png_set_chunk_malloc_max().

By default libpng imposes a limit of 8 MB (8,000,000 bytes) on the amount of memory that a chunk other than IDAT can occupy, originally or when decompressed.

If you do not set this optional parameter, Kanzi keeps the libpng defaults.


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