RingBuffer Control 15.0
Properties

Variables

__int3264 Image
 This determines the image object that has been assigned to the Common Vision RingBuffer Control.

The image must support at least the IRingBuffer interface. More...
 
LockMode LockMode
 Gets and sets the lockmode to be used. More...
 
long MaxNumBuffers
 Returns the maximum number of buffers that can be allocated by the driver. More...
 
long NumBuffers
 Used to retrieve or set the number of buffers used in the ringbuffer.

Setting this property may take some time as the buffers have to be allocated and initialized with zeros. More...
 

Detailed Description

Variable Documentation

◆ Image

__int3264 Image

This determines the image object that has been assigned to the Common Vision RingBuffer Control.

The image must support at least the IRingBuffer interface.

Parameters
[in,out]ImageHandle of the image object.
Returns
Image object handle.
Examples:
Delphi - Delphi RingBuffer Example
Visual Basic - VB RingBuffer Example 1 and VB RingBuffer Example 2
Visual C++ - VC RingBuffer Example

◆ LockMode

Gets and sets the lockmode to be used.

Attention
You have to stop any acquisition before changing this property.
Parameters
[in,out]LockModeSets the lockmode (for more details see: LockMode).
Returns
Current lock mode.
Related Topics:
Unlock Method
Examples:
Delphi - Delphi RingBuffer Example
Visual Basic - VB RingBuffer Example 1 and VB RingBuffer Example 2
Visual C++ - VC RingBuffer Example

◆ MaxNumBuffers

long MaxNumBuffers

Returns the maximum number of buffers that can be allocated by the driver.

Attention
The function may not be implemented by any driver.
Parameters
[out]MaxNumBuffersGets the maximum number of buffers.
Returns
Maximum number of buffers.
Related Topics:
NumBuffers Property
Examples:
Delphi - Delphi RingBuffer Example
Visual Basic - VB RingBuffer Example 1 and VB RingBuffer Example 2
Visual C++ - VC RingBuffer Example

◆ NumBuffers

long NumBuffers

Used to retrieve or set the number of buffers used in the ringbuffer.

Setting this property may take some time as the buffers have to be allocated and initialized with zeros.

Attention
The Ringbuffer control creates a new image object from that call and this new image has to be set in other program parts (i.e. via the ImageUpdated event of the RingBuffer Control).
Parameters
[in,out]NumBuffersNumber of buffers being used.
Returns
Retieve the number of buffers.
Related Topics:
MaxNumBuffers Property
Examples:
Delphi - Delphi RingBuffer Example
Visual Basic - VB RingBuffer Example 1 and VB RingBuffer Example 2
Visual C++ - VC RingBuffer Example