Baumer-GAPI2 SDK Programmer's Guide - Site ftp Elvitec

3.2.5
Buffer
Buffer
Inherits from:
EventControl
This class realizes the data access to the memory. It contains
information about the received data (e.g. image size,
pixel format) too.
The Buffer module encapsulates a single memory buffer.
Its purpose is to act as the target for the image acquisition.
Buffers can be allocated automatically by the producer or
by the user.
Notice
On activated Chunk mode, there is no access to some
features of the buffer object (e.g. GetHeight, GetWidth
or GetPixelFormat). Please use the GetChunkNodeTree
function instead.
Functions of the class Buffer
BGAPI2::Buffer:: ...
Buffer();
Buffer( void * pUserObj
);
Buffer( void *pUserBuffer,
bo_uint64
uUserBufferSize,
void *pUserObj);
GetID();
QueueBuffer();
GetMemPtr();
GetMemSize();
GetUserObj();
GetTimestamp();
GetNewData();
GetIsQueued();
Creates a buffer object.
Creates a buffer object including user specific data.
Creates a buffer object with using user allocated memory.
Returns the unique ID of buffer (e.g. Buffer_01f94fb), not
the memory address of the buffer.
Allocates the buffer to the input queue of a DataStream.
Returns the memory address of the buffer.
Returns the memory size of the buffer.
Returns the user specific data of the buffer.
Returns the buffer´s timestamp.
Returns "true" if the buffer is filled until GetFilledBuffer is
performed.
Returns "true" as long as the buffer is allocated to the input
queue of a DataStream.
Returns "true", if buffer being filled.
Returns "true" on defect image data.
GetIsAcquiring();
GetIsIncomplete();
GetTLType(); Returns the type of buffer (GEV, USB3, ...).
GetSizeFilled(); Returns the current fill level of the buffer [Bytes].
GetWidth();
Returns the image width.
GetHeight();
Returns the image height.
GetXOffset(); Returns the offset in x-direction.
GetYOffset(); Returns the offset in y-direction.
GetFrameID(); Returns a hardware generated counter (1...65535).
GetImagePresent(); Returns the availability of the image within the buffer.
GetImageOffset(); Returns the position of the first byte of image data within
the buffer.
GetPayloadType(); Returns whether the payload is chunck or image data .
GetPixelFormat(); Returns the pixel format of the image.
17