Information about a subblock. More...

#include <libCZI_Write.h>

Inheritance diagram for libCZI::AddSubBlockInfoBase:

Public Member Functions
	AddSubBlockInfoBase ()
	Default constructor.

virtual void	Clear ()
	Clears this object to its blank/initial state.

void	SetCompressionMode (libCZI::CompressionMode m)

libCZI::CompressionMode	GetCompressionMode () const

Public Attributes
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 x-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

std::int32_t	compressionModeRaw

Detailed Description

Information about a subblock.

Member Function Documentation

◆ Clear()

void libCZI::AddSubBlockInfoBase::Clear ( )

inlinevirtual

Clears this object to its blank/initial state.

Reimplemented in libCZI::AddSubBlockInfo, libCZI::AddSubBlockInfoMemPtr, libCZI::AddSubBlockInfoStridedBitmap, and libCZI::AddSubBlockInfoLinewiseBitmap.

◆ GetCompressionMode()

libCZI::CompressionMode libCZI::AddSubBlockInfoBase::GetCompressionMode ( ) const

inline

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

Returns: The compression mode.

◆ SetCompressionMode()

void libCZI::AddSubBlockInfoBase::SetCompressionMode ( libCZI::CompressionMode m )

inline

Sets compression mode (specifying a compression enumeration).

Parameters

m	The compression enumeration.

Member Data Documentation

◆ compressionModeRaw

std::int32_t libCZI::AddSubBlockInfoBase::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.

◆ pyramid_type

libCZI::SubBlockPyramidType libCZI::AddSubBlockInfoBase::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).

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

libCZI/libCZI_Write.h

Public Member Functions

Public Attributes