All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Fields
PylonGrabResult_t Struct Reference

Result data struct for PylonStreamGrabberRetrieveResult(). This data describes grab results (typically image data) retrieved from the device. Some items are optional (marked as "optional") and are only filled in if they are supported by the device. More...

#include <pylonc/PylonC.h>

Data Fields

uint64_t BlockID
 
const void * Context
 
unsigned int ErrorCode
 
unsigned int FrameNr
 
PYLON_STREAMBUFFER_HANDLE hBuffer
 
int OffsetX
 
int OffsetY
 
int PaddingX
 
int PaddingY
 
uint64_t PayloadSize
 
EPylonPayloadType PayloadType
 
const void * pBuffer
 
EPylonPixelType PixelType
 
int SizeX
 
int SizeY
 
EPylonGrabStatus Status
 
uint64_t TimeStamp
 

Detailed Description

Result data struct for PylonStreamGrabberRetrieveResult(). This data describes grab results (typically image data) retrieved from the device. Some items are optional (marked as "optional") and are only filled in if they are supported by the device.

Field Documentation

uint64_t PylonGrabResult_t::BlockID

The block ID of the grabbed frame (camera device specific).

IEEE 1394 Camera Devices
The value of block ID is always UINT64_MAX.
GigE Camera Devices
The sequence number starts with 1 and wraps at 65535. The value 0 has a special meaning and indicates that this feature is not supported by the camera.
USB Camera Devices
The sequence number starts with 0 and uses the full 64 Bit range.
Attention
A block ID of value UINT64_MAX indicates that the Block ID is invalid and must not be used.
const void* PylonGrabResult_t::Context

Application specific context specified when calling PylonStreamGrabberRegisterBuffer()

unsigned int PylonGrabResult_t::ErrorCode

Additional error code in case Status is gst_Failed (optional)

unsigned int PylonGrabResult_t::FrameNr

Deprecated: FrameNr has been deprecated. Use BlockID instead.

PYLON_STREAMBUFFER_HANDLE PylonGrabResult_t::hBuffer

Data buffer handle returned when calling PylonStreamGrabberRegisterBuffer()

int PylonGrabResult_t::OffsetX

Starting column, in pixels (only if payload is image data)

int PylonGrabResult_t::OffsetY

Starting row, in pixels (only if payload is image data)

int PylonGrabResult_t::PaddingX

Number of extra data bytes at end of row (only if payload is image data)

int PylonGrabResult_t::PaddingY

Number of extra data bytes at end of image (only if payload is image data)

uint64_t PylonGrabResult_t::PayloadSize

Total payload size, in bytes, pointed to by pBuffer

EPylonPayloadType PylonGrabResult_t::PayloadType

Type of data contained in buffer

const void* PylonGrabResult_t::pBuffer

Pointer to the raw data

EPylonPixelType PylonGrabResult_t::PixelType

Pixel type (if the result contains pixel data)

int PylonGrabResult_t::SizeX

Number of columns, in pixels (only if payload is image data)

int PylonGrabResult_t::SizeY

Number of rows, in pixels (only if payload is image data)

EPylonGrabStatus PylonGrabResult_t::Status

Result status. check this to check whether the result contains valid data.

uint64_t PylonGrabResult_t::TimeStamp

Time stamp generated by the device when filling the result (optional)


pylon C 5.0.5
Copyright © 2006-2016 Basler AG (Thu Aug 11 2016 18:01:26)