Struct AccessorOptionsInterop

Struct AccessorOptionsInterop#

Struct Documentation#

struct AccessorOptionsInterop#

This structure is used to pass the accessor options to libCZIAPI.

Public Members

float back_ground_color_r#

The red component of the background 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 an 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.

float back_ground_color_g#

The green component of the background 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 an 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.

float back_ground_color_b#

The blue component of the background 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 an 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.

bool sort_by_m#

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.

bool use_visibility_check_optimization#

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.

const char *additional_parameters#

Additional parameters for the accessor in JSON format.

This field allows passing extended configuration options that are not covered by the standard structure members. The value should be a valid JSON string with an object as the root element.

Currently supported parameters:

  • ”mask_aware” (boolean): When true, enables mask-aware composition where subblock mask data (if available) is used during tile composition to selectively copy pixels. Only pixels where the corresponding mask bit is set will be rendered.

Example JSON: 

{
    "mask_aware": true
}

If this field is nullptr, empty, or contains invalid JSON, default values are used for all extended parameters. Unknown parameters are silently ignored.

Contents