IC Imaging Control C++

createFrameQueueBuffer Method

createFrameQueueBuffer Method

Creates a single or multiple FrameQueueBuffer objects, matching the passed in FrameTypeInfo or the frame type of the passed sink.
Syntax:
Error createFrameQueueBuffer( tFrameQueueBufferPtr& rval, const FrameTypeInfo& type, void* userPtr = nullptr );
Error createFrameQueueBuffer( tFrameQueueBufferList& rval, const FrameTypeInfo& type, size_t count, void* userPtr = nullptr );
Error createFrameQueueBuffer( tFrameQueueBufferPtr& rval, const FrameTypeInfo& type, BYTE* dataPointer, size_t dataSize, void* userPtr = nullptr );

Error createFrameQueueBuffer( tFrameQueueBufferPtr& rval, const FrameSnapSink& sink, void* userPtr = nullptr );
Error createFrameQueueBuffer( tFrameQueueBufferList& rval, const FrameSnapSink& sink, size_t count, void* userPtr = nullptr );
Error createFrameQueueBuffer( tFrameQueueBufferPtr& rval, const FrameSnapSink& sink, BYTE* dataPointer, size_t dataSize, void* userPtr = nullptr );

Error createFrameQueueBuffer( tFrameQueueBufferPtr& rval, const FrameQueueSink& sink, void* userPtr = nullptr );
Error createFrameQueueBuffer( tFrameQueueBufferList& rval, const FrameQueueSink& sink, size_t count, void* userPtr = nullptr );
Error createFrameQueueBuffer( tFrameQueueBufferPtr& rval, const FrameQueueSink& sink, BYTE* dataPointer, size_t dataSize, void* userPtr = nullptr );

Parameter Description
rval

Receives a single tFrameQueueBufferPtr or a list of tFrameQueueBufferPtr in a tFrameQueueBufferList.

type

Specifies the type of the FrameQueueBuffer to create.

sink

Specifies a sink for whose current frame type the FrameQueueBuffer is to be created.

count

The number of buffers to create.

userPtr

A pointer that is associated with the buffer. It is not used internally, but can be retrieved by calling FrameQueueBuffer::getUserPointer.

dataPointer

A pointer to a user-allocated block of memory that the FrameQueueBuffer shall use for storing its data.

The FrameQueueBuffer does not take ownership of this memory block.

dataSize

Size of the user-allocated block of memory pointer to by dataPointer.

Return value:

This method returns an error object. If successful, it is set to eNOERROR. If the system cannot allocate enough memory, it is set to eOUT_OF_MEMORY.

Information:

Namespace: DShowLib
Introduced in version 3.5

See also: FrameQueueBuffer, tFrameQueueBufferPtr, tFrameQueueBufferList, FrameTypeInfo, Error

<< Functions

Get in touch with us


About The Imaging Source

Established in 1990, The Imaging Source is one of the leading manufacturers of industrial cameras, frame grabbers and video converters for production automation, quality assurance, logistics, medicine, science and security.

Our comprehensive range of cameras with USB 3.1, USB 3.0, USB 2.0, GigE interfaces and other innovative machine vision products are renowned for their high quality and ability to meet the performance requirements of demanding applications.

Automated Imaging Association ISO 9001:2015 certified

Contact us