Struct SubBlockInfo

Contents

Struct SubBlockInfo#

Defined in File libCZI.h

Inheritance Relationships#

Derived Type#

public libCZI::DirectorySubBlockInfo (Struct DirectorySubBlockInfo)

Struct Documentation#

struct SubBlockInfo#

Information about a sub-block.

Subclassed by libCZI::DirectorySubBlockInfo

Public Functions

inline double GetZoom() const#

Calculate a zoom-factor from the physical- and logical size.

Remark

This calculation not really well-defined.

Returns:: The zoom factor.

inline CompressionMode GetCompressionMode() const#

Gets compression mode enumeration. Note that unknown compression-mode identifiers (unknown to libCZI) are mapped to CompressionMode::Invalid.

Returns:: The compression mode enumeration.

inline bool IsMindexValid() const#

Query if the M-index is valid.

Returns:: True if the M-index is valid, false if not.

Public Members

std::int32_t compressionModeRaw#: The (raw) compression mode identification of the sub-block. This value is not interpreted, use “GetCompressionMode” to have it converted to the CompressionMode-enumeration. Note that unknown compression-mode identifiers (unknown to libCZI) are mapped to CompressionMode::Invalid.

PixelType pixelType#: The pixel type of the sub-block.

libCZI::CDimCoordinate coordinate#: The coordinate of the sub-block.

libCZI::IntRect logicalRect#: The rectangle where the bitmap (in this sub-block) is located.

libCZI::IntSize physicalSize#: The physical size of the bitmap (which may be different to the size of logicalRect).

int mIndex#: The M-index of the sub-block (if available). If not available, it has the value std::numeric_limits<int>::max() or std::numeric_limits<int>::min().

SubBlockPyramidType pyramidType#: This field indicates the “pyramid-type” of the sub-block. The significance and importance of this field is unclear, and is considered legacy. It is recommended to ignore this field.