libCZI
Reading CZI documents made easy
libCZI::ISingleChannelTileAccessor::Options Struct Reference

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 drawTileBorder
 
std::shared_ptr< libCZI::IIndexSetsceneFilter
 If specified, only subblocks with a scene-index contained in the set will be considered.
 

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).

◆ 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.


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