ImageBufferDescription Class Reference

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

Inherited by ChunkImageBufferDescription.

Public Member Functions
	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
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.

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

Constructor & Destructor Documentation

ImageBufferDescription() [1/2]

ImageBufferDescription	(	Size2D	size,
		ColorModel	colorModel,
		DataType	dataType
	)

Creates a default 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.

ImageBufferDescription() [2/2]

ImageBufferDescription	(	Size2D	size,
		PfncFormat	pixelFormat
	)

Creates a default image buffer description.

Parameters

size	Width and height in pixels.
pixelFormat	GenICam PFNC format value.

Property Documentation

LinePadding

int LinePadding

getset

Gets or sets the line padding.

Line padding is a contiguous block at the end of each line that holds no meaningful data. This is normally used to align lines.

Line padding in bytes.

Offset

Point2D Offset

getset

Gets or sets the image's offset on the sensor.

The server always sends an image with the given Size. The offset is only for information.

Size

Size2D Size

getset

Gets or sets the image size.

Unit is pixels.