MultiCam Boards Documentation > MultiCam Documentation > MultiCam Reference > Channel Class > Cluster Category > Expert Level (Cluster) > BufferPitch

BufferPitch

Description

Type

Integer Collection

Description

Size required to contain one line of the plane

"Set" effect

Sets the line pitch

"Get" effect

Returns the current line pitch

Classification

Class

Channel

Category

Cluster

Level

Expert

Identifiers

String

BufferPitch

C, C++

MC_BufferPitch

.NET

MC.BufferPitch

Numerical

3336

MultiCam creates the surfaces and automatically allocates the memory buffers, if not done by the application. The following channel parameters configure the automatic allocation: BufferSize, BufferPitch, ImagePlaneCount and SurfaceCount. MultiCam decides the adequate number of surfaces for the selected acquisition mode.

This parameter is expressed as a number of bytes.

Getting this parameter gives the minimum size (in bytes) required to contain one line of the plane produced by the channel.

Setting this parameter defines the desired line pitch. If allowed, this value will be used in the computation of other Cluster category parameters.

The minimum value is reported by parameter MinBufferPitch.

The dimension of this collection parameter is specified by ImagePlaneCount. The assignment of the planes is returned by SurfacePlaneName. For a complete description of color formats, see MultiCam Storage Formats.

Value range

[4:32768]