RingBuffer Control 15.0
Functions
Methods

Functions

void AboutBox ()
 Displays the About box of the Common Vision RingBuffer Control. More...
 
__int3264 GetBufferImage (long BufferIndex)
 Returns an image representing a buffer at a given index.

As the buffer are acquired in a sequence you may have to get the index based on the sequence number using the GetBufferSequence method. More...
 
long GetBufferSequence (long SequenceNumber)
 Returns the buffer index for a given sequence number.

As the ringbuffer is filled automatically the index of a buffer does not necessarily correspond to the timewise sequence in which the images have been captured. E.g. the SequenceNumber 0 returns the index of the last acquired buffer. SequenceNumber NumBuffers-1 returns the 'oldest' image in the ringbuffer.
More...
 
double GetTag (long BufferIndex)
 Returns a tag of a buffer at a given index.

A tag represents some optional and additional information that is tagged to the image such as a configuration information for this specific image on Silicon Software frame grabber. As the buffer are acquired in a sequence you may have to get the index based on the sequence number using the GetBufferSequence method. Tags may not be supported by every image acquisition device driver. More...
 
double GetTimestamp (long BufferIndex)
 Returns a timestamp of a buffer at a given index.

As the buffers are acquired in a sequence you may have to get the index based on the sequence number using the GetBufferSequence method. More...
 
boolean IsLocked (long BufferIndex)
 Checks whether a buffer is locked or not. More...
 
boolean Unlock (long BufferIndex)
 Unlocks the buffer at the given index.

You have to unlock the buffers of the ringbuffer if you use the LOCKMODE_ON mode (see LockMode). More...
 

Detailed Description

Function Documentation

◆ AboutBox()

void AboutBox ( )

Displays the About box of the Common Vision RingBuffer Control.

◆ GetBufferImage()

__int3264 GetBufferImage ( long  BufferIndex)

Returns an image representing a buffer at a given index.

As the buffer are acquired in a sequence you may have to get the index based on the sequence number using the GetBufferSequence method.

Parameters
[in]BufferIndexThe index of the buffer you want to access.
Returns
Image representing the buffer at the given index.
Related Topics:
GetTag Method
GetTimestamp Method
GetBufferSequence Method
Examples:
Delphi - Delphi RingBuffer Example
Visual Basic - VB RingBuffer Example 1 and VB RingBuffer Example 2
Visual C++ - VC RingBuffer Example

◆ GetBufferSequence()

long GetBufferSequence ( long  SequenceNumber)

Returns the buffer index for a given sequence number.

As the ringbuffer is filled automatically the index of a buffer does not necessarily correspond to the timewise sequence in which the images have been captured. E.g. the SequenceNumber 0 returns the index of the last acquired buffer. SequenceNumber NumBuffers-1 returns the 'oldest' image in the ringbuffer.

Parameters
[in]SequenceNumberThe sequence number defining the sequence in which the buffer was filled.
Returns
The index to the buffer in the ringbuffer.
Related Topics:
GetTag Method
GetTimestamp Method
GetBufferImage Method
Examples:
Delphi - Delphi RingBuffer Example
Visual Basic - VB RingBuffer Example 1 and VB RingBuffer Example 2
Visual C++ - VC RingBuffer Example

◆ GetTag()

double GetTag ( long  BufferIndex)

Returns a tag of a buffer at a given index.

A tag represents some optional and additional information that is tagged to the image such as a configuration information for this specific image on Silicon Software frame grabber. As the buffer are acquired in a sequence you may have to get the index based on the sequence number using the GetBufferSequence method. Tags may not be supported by every image acquisition device driver.

Attention
Please refer to the CVB Driver User Guide for the image acquisition device used in your application.
Parameters
[in]BufferIndexThe index of the buffer you want to access.
Returns
Tag of the buffer at the given index.
Related Topics:
GetBufferImage Method
GetTimestamp Method
GetBufferSequence Method
Examples:
Delphi - Delphi RingBuffer Example
Visual Basic - VB RingBuffer Example 1 and VB RingBuffer Example 2
Visual C++ - VC RingBuffer Example

◆ GetTimestamp()

double GetTimestamp ( long  BufferIndex)

Returns a timestamp of a buffer at a given index.

As the buffers are acquired in a sequence you may have to get the index based on the sequence number using the GetBufferSequence method.

Attention
Timestamps may not be supported by every image acquisition device driver. Please refer to the CVB Driver User Guide for the image acquisition device used in your application.
Parameters
[in]BufferIndexThe index of the buffer you want to access.
Returns
Timestamp of the buffer at the given index.
Related Topics:
GetBufferImage Method
GetTag Method
GetBufferSequence Method
Examples:
Delphi - Delphi RingBuffer Example
Visual Basic - VB RingBuffer Example 1 and VB RingBuffer Example 2
Visual C++ - VC RingBuffer Example

◆ IsLocked()

boolean IsLocked ( long  BufferIndex)

Checks whether a buffer is locked or not.

Parameters
[in]BufferIndexThe index of the buffer you want to access.
Returns
TRUE if busser is locked, FALSE otherwise.
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

◆ Unlock()

boolean Unlock ( long  BufferIndex)

Unlocks the buffer at the given index.

You have to unlock the buffers of the ringbuffer if you use the LOCKMODE_ON mode (see LockMode).

Parameters
[in]BufferIndexThe index of the buffer you want to access.
Returns
FALSE if any error occured, TRUE otherwise.
Related Topics:
IsLocked Method
Examples:
Delphi - Delphi RingBuffer Example
Visual Basic - VB RingBuffer Example 1 and VB RingBuffer Example 2
Visual C++ - VC RingBuffer Example