ChunkImageBufferDescription Class Reference

Describes a GenICam Pixel Format Naming Convention (PFNC) compatible image memory buffer with possibly additional data. More...

Inherits ImageBufferDescription.

Public Member Functions
	ChunkImageBufferDescription (Size2D size, ColorModel colorModel, DataType dataType, int totalPayloadSize)
	Creates a default chunk image buffer description. More...
	ChunkImageBufferDescription (Size2D size, PfncFormat pixelFormat, int totalPayloadSize)
	Creates a default chunk image buffer description. More...
Public Member Functions inherited from ImageBufferDescription
	ImageBufferDescription (Size2D size, ColorModel colorModel, DataType dataType)
	Creates a default image buffer description. More...
	ImageBufferDescription (Size2D size, PfncFormat pixelFormat)
	Creates a default image buffer description. More...

Properties
int	TotalPayloadSize [get, set]
	Valid payload size over all chunks including the image chunk. More...
int	LayoutId [get, set]
	Gets or sets the layout identifier for the chunks. More...
Properties inherited from ImageBufferDescription
PfncFormat	PixelFormat [get, set]
	Gets or sets the image pixel format value.
Size2D	Size [get, set]
	Gets or sets the image size. More...
Point2D	Offset [get, set]
	Gets or sets the image's offset on the sensor. More...
int	LinePadding [get, set]
	Gets or sets the line padding. More...

Detailed Description

Describes a GenICam Pixel Format Naming Convention (PFNC) compatible image memory buffer with possibly additional data.

This buffer needn't be CVB Image compatible. You can use all PFNC values even packed ones.

Constructor & Destructor Documentation

ChunkImageBufferDescription() [1/2]

ChunkImageBufferDescription	(	Size2D	size,
		ColorModel	colorModel,
		DataType	dataType,
		int	totalPayloadSize
	)

Creates a default chunk image buffer description.

Tries to map the given colorModel and dataType to a PfncFormat.

Parameters

size	Width and height in pixels.
colorModel	Color model of the image to send.
dataType	CVB data type of the image to send.
totalPayloadSize	Size of the valid payload over all chunks (including the image).

ChunkImageBufferDescription() [2/2]

ChunkImageBufferDescription	(	Size2D	size,
		PfncFormat	pixelFormat,
		int	totalPayloadSize
	)

Creates a default chunk image buffer description.

Parameters

size	Width and height in pixels.
pixelFormat	GenICam PFNC format value.
totalPayloadSize	Size of the valid payload over all chunks (including the image).

Property Documentation

LayoutId

int LayoutId

getset

Gets or sets the layout identifier for the chunks.

Change the identifier if the layout/size of the chunks you send changes. This is to reduce parse time on the client side. An easy way to define such an identifier is to use a bit field for all supported chunks.

A value of 0 means that the layout mechanism is not used and the client must parse the chunk layout for each buffer.

Positive or 0 identifier.

TotalPayloadSize

int TotalPayloadSize

getset

Valid payload size over all chunks including the image chunk.

Size in bytes.