Options for controlling the composition operation. More...

#include <libCZI_Compositor.h>

Public Member Functions
void	Clear ()
	Clears this object to its blank state.

Public Attributes
RgbFloatColor	backGroundColor

bool	sortByM

bool	useVisibilityCheckOptimization

bool	drawTileBorder

std::shared_ptr< libCZI::IIndexSet >	sceneFilter
	If specified, only subblocks with a scene-index contained in the set will be considered.

std::shared_ptr< libCZI::ISubBlockCacheOperation >	subBlockCache

bool	onlyUseSubBlockCacheForCompressedData

Detailed Description

Options for controlling the composition operation.

Member Data Documentation

◆ backGroundColor

RgbFloatColor libCZI::ISingleChannelTileAccessor::Options::backGroundColor

The back ground color. If the destination bitmap is a grayscale-type, then the mean from R, G and B is calculated and multiplied with the maximum pixel value (of the specific pixeltype). If it is a RGB-color type, then R, G and B are separately multiplied with the maximum pixel value. If any of R, G or B is NaN, then the background is not cleared.

◆ drawTileBorder

bool libCZI::ISingleChannelTileAccessor::Options::drawTileBorder

If true, then a one-pixel wide boundary will be drawn around each tile (in black color).

◆ onlyUseSubBlockCacheForCompressedData

bool libCZI::ISingleChannelTileAccessor::Options::onlyUseSubBlockCacheForCompressedData

If true, then only bitmaps from sub-blocks with compressed data are added to the cache. For uncompressed data, the time for reading the bitmap can be negligible, so the benefit of caching might not outweigh the increased memory usage.

◆ sortByM

bool libCZI::ISingleChannelTileAccessor::Options::sortByM

If true, then the tiles are sorted by their M-index (tile with highest M-index will be 'on top'). Otherwise the Z-order is arbitrary.

◆ subBlockCache

std::shared_ptr<libCZI::ISubBlockCacheOperation> libCZI::ISingleChannelTileAccessor::Options::subBlockCache

If specified, then the sub-block cache is used. This can speed up the operation considerably. Bitmaps that are read by the accessor are added to the cache. If a bitmap is needed which is already in the cache, then the bitmap from the cache is used instead of reading the sub-block from the file.

◆ useVisibilityCheckOptimization

bool libCZI::ISingleChannelTileAccessor::Options::useVisibilityCheckOptimization

If true, then the tile-visibility-check-optimization is used. When doing the multi-tile composition, all relevant tiles are checked whether they are visible in the destination bitmap. If a tile is not visible, then the corresponding sub-block is not read. This can speed up the operation considerably. The result is the same as without this optimization - i.e. there should be no reason to turn it off besides potential bugs.

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

libCZI/libCZI_Compositor.h

Public Member Functions

Public Attributes