CVB++ 14.0
ImageBufferDescription Class Reference

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

#include <cvb/image_buffer_description.hpp>

Inherited by ChunkImageBufferDescription.

Public Member Functions

 ImageBufferDescription (Size2D< int > size, ColorModel colorModel, DataType dataType)
 Creates a default image buffer description. More...
 
 ImageBufferDescription (Size2D< int > size, PfncFormat pixelFormat)
 Creates a default image buffer description. More...
 
PfncFormat PixelFormat () const noexcept
 Gets the image pixel format value.
 
void SetPixelFormat (const PfncFormat &pixelFormat)
 Sets the image pixel format value.
 
Size2D< int > Size () const noexcept
 Gets the image size.
 
void SetSize (const Size2D< int > &size)
 Sets the image size.
 
Point2D< int > Offset () const noexcept
 Get the image's offset on the sensor. More...
 
void SetOffset (Point2D< int > point)
 Set the image's offset on the sensor. More...
 
int LinePadding () const noexcept
 Gets the line padding. More...
 
void SetLinePadding (int padding)
 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< int >  size,
ColorModel  colorModel,
DataType  dataType 
)
inline

Creates a default image buffer description.

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

Parameters
sizeWidth and height in pixels.
colorModelColor model of the image to send.
dataTypeCVB data type of the image to send.

◆ ImageBufferDescription() [2/2]

ImageBufferDescription ( Size2D< int >  size,
PfncFormat  pixelFormat 
)
inline

Creates a default image buffer description.

Parameters
sizeWidth and height in pixels.
pixelFormatGenICam PFNC format value.

Member Function Documentation

◆ LinePadding()

int LinePadding ( ) const
inlinenoexcept

Gets 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< int > Offset ( ) const
inlinenoexcept

Get the image's offset on the sensor.

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

◆ SetLinePadding()

void SetLinePadding ( int  padding)
inline

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.

◆ SetOffset()

void SetOffset ( Point2D< int >  point)
inline

Set the image's offset on the sensor.

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