libCZI::AddSubBlockInfoLinewiseBitmap Struct Reference

#include <libCZI_Write.h>

Inheritance diagram for libCZI::AddSubBlockInfoLinewiseBitmap:

Public Member Functions
	AddSubBlockInfoLinewiseBitmap ()
	Default constructor.
void	Clear () override
	Clears this object to its blank/initial state.
Public Member Functions inherited from libCZI::AddSubBlockInfoBase
	AddSubBlockInfoBase ()
	Default constructor.
void	SetCompressionMode (libCZI::CompressionMode m)
libCZI::CompressionMode	GetCompressionMode () const

Public Attributes
std::function< const void *(int line)>	getBitmapLine
const void *	ptrSbBlkMetadata
	Pointer to the subblock-metadata.
std::uint32_t	sbBlkMetadataSize
	The size of the subblock-metadata in bytes. If this is 0, then ptrSbBlkMetadata is not used (and no sub-block-metadata written).
const void *	ptrSbBlkAttachment
	Pointer to the subblock-attachment.
std::uint32_t	sbBlkAttachmentSize
	The size of the subblock-attachment in bytes. If this is 0, then ptrSbBlkMetadata is not used (and no sub-block-metadata written).
Public Attributes inherited from libCZI::AddSubBlockInfoBase
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

This struct defines the data to be added to the subblock segment. This variant uses a callback-function in order to supply the writer with the bitmap-data, which will be called for every line of the bitmap.

Member Function Documentation

Clear()

void libCZI::AddSubBlockInfoLinewiseBitmap::Clear ( )

inlineoverridevirtual

Clears this object to its blank/initial state.

Reimplemented from libCZI::AddSubBlockInfoBase.

Member Data Documentation

getBitmapLine

std::function<const void* (int line)> libCZI::AddSubBlockInfoLinewiseBitmap::getBitmapLine

This functor will be called for every line, ie. the parameter line will count from 0 to physicalHeight-1. The pointer returned by this function must be valid until the next call into the functor (or returning from the 'SyncAddSubBlock' method).

---

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

• libCZI/libCZI_Write.h