Struct AddSubBlockInfoBase

Struct AddSubBlockInfoBase#

Inheritance Relationships#

Derived Types#

Struct Documentation#

struct AddSubBlockInfoBase#

Information about a subblock.

Subclassed by libCZI::AddSubBlockInfo, libCZI::AddSubBlockInfoLinewiseBitmap, libCZI::AddSubBlockInfoMemPtr, libCZI::AddSubBlockInfoStridedBitmap

Public Functions

inline AddSubBlockInfoBase()#

Default constructor.

virtual ~AddSubBlockInfoBase() = default#
inline virtual void Clear()#

Clears this object to its blank/initial state.

inline void SetCompressionMode(libCZI::CompressionMode m)#

Sets compression mode (specifying a compression enumeration).

Parameters:

m – The compression enumeration.

inline libCZI::CompressionMode GetCompressionMode() const#

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

Returns:

The compression mode.

Public Members

libCZI::CDimCoordinate coordinate#

The subblock’s coordinate.

bool mIndexValid#

Whether the field ‘mIndex’ is valid;.

int mIndex#

The M-index of the subblock.

int x#

The x-coordinate of the subblock.

int y#

The y-coordinate of the subblock.

int logicalWidth#

The logical with of the subblock (in pixels).

int logicalHeight#

The logical height of the subblock (in pixels).

int physicalWidth#

The physical with of the subblock (in pixels).

int physicalHeight#

The physical height of the subblock (in pixels).

libCZI::PixelType PixelType#

The pixel type of the subblock.

libCZI::SubBlockPyramidType pyramid_type#

The pyramid type of the subblock. The significance of this field is unclear (and considered legacy). It is recommended to have this field set to ‘SubBlockPyramidType::None’ (which is the value set as default).

std::int32_t compressionModeRaw#

The compression-mode (applying to the subblock-data). If using a compressed format, the data passed in must be already compressed - the writer does not perform the compression. The value specified here is the “raw value”, use “GetCompressionMode()” or “Utils::CompressionModeFromRawCompressionIdentifier” in order to identify well-known compression modes.

Contents