pylonc/PylonC.h#

pylon C bindings

Classes#

Types#

Functions#

Attributes#

Defines#

Types Documentation#

typedef PYLON_AVI_WRITER_HANDLE#

typedef struct PYLON_AVI_WRITER_HANDLE_* PYLON_AVI_WRITER_HANDLE;

A handle for an AVI writer.

typedef PYLON_CHUNKPARSER_HANDLE#

typedef struct PYLON_CHUNKPARSER_HANDLE_* PYLON_CHUNKPARSER_HANDLE;

A handle for a chunk parser object.

typedef PYLON_DEVICE_HANDLE#

typedef struct PYLON_DEVICE_HANDLE_* PYLON_DEVICE_HANDLE;

A handle for a device object.

typedef PYLON_DEVICE_INFO_HANDLE#

typedef struct PYLON_DEVICE_INFO_HANDLE_* PYLON_DEVICE_INFO_HANDLE;

A handle for a device info object.

typedef PYLON_DEVICECALLBACK_HANDLE#

typedef struct PYLON_DEVICECALLBACK_HANDLE_* PYLON_DEVICECALLBACK_HANDLE;

A handle for a device callback object.

typedef PYLON_EVENTADAPTER_HANDLE#

typedef struct PYLON_EVENTADAPTER_HANDLE_* PYLON_EVENTADAPTER_HANDLE;

A handle for an event adapter object.

typedef PYLON_EVENTGRABBER_HANDLE#

typedef struct PYLON_EVENTGRABBER_HANDLE_* PYLON_EVENTGRABBER_HANDLE;

A handle for an event grabber object.

typedef PYLON_FORMAT_CONVERTER_HANDLE#

typedef struct PYLON_FORMAT_CONVERTER_HANDLE_* PYLON_FORMAT_CONVERTER_HANDLE;

A handle for a pixel format converter object.

typedef PYLON_IMAGE_DECOMPRESSOR_HANDLE#

typedef struct PYLON_IMAGE_DECOMPRESSOR_HANDLE_* PYLON_IMAGE_DECOMPRESSOR_HANDLE;

A handle for an image decompressor object.

typedef PYLON_IMAGE_FORMAT_CONVERTER_HANDLE#

typedef struct PYLON_IMAGE_FORMAT_CONVERTER_HANDLE_* PYLON_IMAGE_FORMAT_CONVERTER_HANDLE;

A handle for a pixel format converter object.

typedef PYLON_INTERFACE_HANDLE#

typedef struct PYLON_INTERFACE_HANDLE_* PYLON_INTERFACE_HANDLE;

A handle for an interface object.

typedef PYLON_INTERFACE_INFO_HANDLE#

typedef struct PYLON_INTERFACE_INFO_HANDLE_* PYLON_INTERFACE_INFO_HANDLE;

A handle for an interface info object.

typedef PYLON_STREAMBUFFER_HANDLE#

typedef struct PYLON_STREAMBUFFER_HANDLE_* PYLON_STREAMBUFFER_HANDLE;

A handle for a stream buffer object.

typedef PYLON_STREAMGRABBER_HANDLE#

typedef struct PYLON_STREAMGRABBER_HANDLE_* PYLON_STREAMGRABBER_HANDLE;

A handle for a stream grabber object.

typedef PYLON_WAITOBJECT_HANDLE#

typedef struct PYLON_WAITOBJECT_HANDLE_* PYLON_WAITOBJECT_HANDLE;

A handle for a wait object.

typedef PYLON_WAITOBJECTS_HANDLE#

typedef struct PYLON_WAITOBJECTS_HANDLE_* PYLON_WAITOBJECTS_HANDLE;

A handle for a node object set.

typedef PylonAviCompressionOptions_t#

typedef struct tag_PylonAviCompressionOptions_t PylonAviCompressionOptions_t;

typedef PylonDeviceRemCb_t#

typedef void PylonDeviceRemCb_t(PYLON_DEVICE_HANDLE h);

pylon device removal callback handler type.

Functions Documentation#

function PylonAviWriterAdd#

GENAPIC_RESULT PylonAviWriterAdd(
    PYLON_AVI_WRITER_HANDLE hWriter,
    const void * pBuffer,
    size_t bufferSize,
    EPylonPixelType pixelType,
    uint32_t width,
    uint32_t height,
    size_t paddingX,
    EPylonImageOrientation orientation,
    EPylonKeyFrameSelection keyFrameSelection
)

Adds an image to the AVI file.

Parameters:

• hWriter Handle for the AVI writer.
• pBuffer The pointer to the buffer of the image.
• bufferSize The size of the buffer in bytes.
• pixelType The pixel type of the image to save.
• width The number of pixels in a row of the image to save.
• height The number of rows of the image to save.
• paddingX The number of extra data bytes at the end of each row.
• orientation The vertical orientation of the image in the image buffer.
• keyFrameSelection Can be used to control key frame selection for compressed images if needed.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Adds an image to the AVI file.

function PylonAviWriterCanAddWithoutConversion#

GENAPIC_RESULT PylonAviWriterCanAddWithoutConversion(
    PYLON_AVI_WRITER_HANDLE hWriter,
    EPylonPixelType pixelType,
    uint32_t width,
    uint32_t height,
    size_t paddingX,
    EPylonImageOrientation orientation,
    _Bool * pCanAddWithoutConversion
)

Can be used to check whether the given image is added to the AVI file without prior conversion when PylonAviWriterAdd() is called.

Parameters:

• hWriter Handle for the AVI writer.
• pixelType The pixel type of the image to save.
• width The number of pixels in a row of the image to save.
• height The number of rows of the image to save.
• paddingX The number of extra data bytes at the end of each row.
• orientation The vertical orientation of the image in the image buffer.
• pCanAddWithoutConversion True if the image can be added to the AVI stream without prior conversion. False if the image cannot be added at all.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Can be used to check whether the given image is added to the AVI file without prior conversion when PylonAviWriterAdd() is called.

function PylonAviWriterClose#

GENAPIC_RESULT PylonAviWriterClose(
    PYLON_AVI_WRITER_HANDLE hWriter
)

Closes the AVI file.

Parameters:

• hWriter Handle for the AVI writer.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Closes the AVI file.

function PylonAviWriterCreate#

GENAPIC_RESULT PylonAviWriterCreate(
    PYLON_AVI_WRITER_HANDLE * phWriter
)

Creates an AVI writer object.

Parameters:

• phWriter Handle for the AVI writer.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Creates an AVI writer object.

function PylonAviWriterDestroy#

GENAPIC_RESULT PylonAviWriterDestroy(
    PYLON_AVI_WRITER_HANDLE hWriter
)

Destroys an AVI writer object.

Parameters:

• hWriter Handle for the AVI writer.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Destroys an AVI writer object.

function PylonAviWriterGetCountOfAddedImages#

GENAPIC_RESULT PylonAviWriterGetCountOfAddedImages(
    PYLON_AVI_WRITER_HANDLE hWriter,
    size_t * pCountOfAddedImages
)

Provides access to the number of images that have been added to the AVI file.

Parameters:

• hWriter Handle for the AVI writer.
• pCountOfAddedImages Returns the number of images added to the the AVI File. Returns 0 if no AVI File has been written yet.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

This value is updated with each call to PylonAviWriterAdd().

Depending on the used image format and codec about 5 KB of header information and padding bytes are written to the AVI file. Furthermore, 24 additional bytes are needed per image for chunk header and index entry data.

function PylonAviWriterGetImageDataBytesWritten#

GENAPIC_RESULT PylonAviWriterGetImageDataBytesWritten(
    PYLON_AVI_WRITER_HANDLE hWriter,
    size_t * pImageDataBytesWritten
)

Provides access to the number of image data bytes written to the AVI file.

Parameters:

• hWriter Handle for the AVI writer.
• pImageDataBytesWritten Returns the the number of image data bytes written to the the AVI File. Returns 0 if no AVI File has been written yet. This size does not contain the size of the AVI File Header and AVI File Index.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

This value is updated with each call to PylonAviWriterAdd().

function PylonAviWriterIsOpen#

GENAPIC_RESULT PylonAviWriterIsOpen(
    PYLON_AVI_WRITER_HANDLE hWriter,
    _Bool * pIsOpen
)

Returns the open state of the AVI file.

Parameters:

• hWriter Handle of AVI writer.
• pIsOpen The open state of the AVI file.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Destroys an AVI writer object.

function PylonAviWriterOpen#

GENAPIC_RESULT PylonAviWriterOpen(
    PYLON_AVI_WRITER_HANDLE hWriter,
    const char * pFilename,
    double framesPerSecondPlayback,
    EPylonPixelType pixelType,
    uint32_t width,
    uint32_t height,
    EPylonImageOrientation orientation,
    PylonAviCompressionOptions_t * pCompressionOptions
)

Opens an AVI file for writing.

Parameters:

• hWriter Handle for the AVI writer.
• pFilename Name and path of he filename
• framesPerSecondPlayback The frame rate (play back frame rate) of the AVI file when shown in a media player.
• pixelType The pixel type of the image in the AVI file.
• width The number of pixels in a row.
• height The number of rows of the image.
• orientation The vertical orientation of the image data in the AVI file.
• pCompressionOptions Compression can be enabled by passing compression options. See SPylonAviCompressionOptions_t.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Destroys an AVI writer object.

function PylonBitsPerPixel#

GENAPIC_RESULT PylonBitsPerPixel(
    EPylonPixelType pixelType,
    int * pResult
)

Return the number of bits per pixel for a pixel type.

Parameters:

• pixelType Pixel type
• pResult Result pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Returns the number of bits required to store a single pixel for the given format.

function PylonChunkParserAttachBuffer#

GENAPIC_RESULT PylonChunkParserAttachBuffer(
    PYLON_CHUNKPARSER_HANDLE hChp,
    const void * pBuffer,
    size_t BufLen
)

Attach a data buffer to a chunk parser.

Parameters:

• hChp Chunk parser handle
• pBuffer Data buffer pointer
• BufLen Size of data buffer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Attach a data buffer containing chunk data to a chunk parser.

function PylonChunkParserCheckCRC#

GENAPIC_RESULT PylonChunkParserCheckCRC(
    PYLON_CHUNKPARSER_HANDLE hChp,
    _Bool * pResult
)

Return true if CRC checksum chunk data is valid.

Parameters:

• hChp Chunk parser handle
• pResult Boolean result pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Check, whether the chunk data buffer contains valid data using its CRC checksum. The boolean result pointed to by pResult is set to true if the checksum matches the data, false otherwise.

function PylonChunkParserDetachBuffer#

GENAPIC_RESULT PylonChunkParserDetachBuffer(
    PYLON_CHUNKPARSER_HANDLE hChp
)

Detach a data buffer from a chunk parser.

Parameters:

• hChp Chunk parser handle

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Detach data buffer from chunk parser.

function PylonChunkParserHasCRC#

GENAPIC_RESULT PylonChunkParserHasCRC(
    PYLON_CHUNKPARSER_HANDLE hChp,
    _Bool * pResult
)

Return true if CRC checksum chunk data is present.

Parameters:

• hChp Chunk parser handle
• pResult Boolean result pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Check, whether the chunk data buffer has an attached CRC checksum.

function PylonChunkParserUpdateBuffer#

GENAPIC_RESULT PylonChunkParserUpdateBuffer(
    PYLON_CHUNKPARSER_HANDLE hChp,
    const void * pBuffer
)

Replace a data buffer attached to a chunk parser.

Parameters:

• hChp Chunk parser handle
• pBuffer Data buffer pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Replace a data buffer currently attached to a chunk parser with another one of identical layout.

function PylonCreateDeviceByIndex#

GENAPIC_RESULT PylonCreateDeviceByIndex(
    size_t index,
    PYLON_DEVICE_HANDLE * phDev
)

Create a device object.

Parameters:

• index Index of device info object
• phDev Pointer to result device handle

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

This function creates a device object from a device info object identified by its index index.

function PylonCreateDeviceFromDirectShowID#

GENAPIC_RESULT PylonCreateDeviceFromDirectShowID(
    int id,
    PYLON_DEVICE_HANDLE * phDev
)

Creates a device from a device ID returned from the pylon DirectShow source filter.

Parameters:

• id The device returned from IBaslerGenICamConfig interface
• phDev Pointer to result device handle

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

This function creates a device object from an ID returned by the IBaslerGenICamConfig::GetActiveDevice() function.

function PylonCreateInterfaceByIndex#

GENAPIC_RESULT PylonCreateInterfaceByIndex(
    size_t index,
    PYLON_INTERFACE_HANDLE * phIf
)

Create an interface object.

Parameters:

• index Index of interface info object
• phIf Pointer to result interface handle

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

This function creates an interface object from an interface info object identified by its index.

function PylonDestroyDevice#

GENAPIC_RESULT PylonDestroyDevice(
    PYLON_DEVICE_HANDLE hDev
)

Delete a device object.

Parameters:

• hDev Device object handle

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

This function destroys a device object previously created by PylonCreateDeviceByIndex().

function PylonDestroyInterface#

GENAPIC_RESULT PylonDestroyInterface(
    PYLON_INTERFACE_HANDLE hIf
)

Delete an interface object.

Parameters:

• hIf Interface object handle

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

This function destroys an interface object previously created by PylonCreateInterfaceByIndex().

function PylonDeviceAccessMode#

GENAPIC_RESULT PylonDeviceAccessMode(
    PYLON_DEVICE_HANDLE hDev,
    int * pAccessMode
)

Return access mode flags for a device.

Parameters:

• hDev Device handle
• pAccessMode Result pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Given a device handle, this function returns the access mode specified when the device was created.

function PylonDeviceClose#

GENAPIC_RESULT PylonDeviceClose(
    PYLON_DEVICE_HANDLE hDev
)

Close a device.

Parameters:

• hDev Device handle

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

This function closes a device. After closing, the device can no longer be accessed.

function PylonDeviceCreateChunkParser#

GENAPIC_RESULT PylonDeviceCreateChunkParser(
    PYLON_DEVICE_HANDLE hDev,
    PYLON_CHUNKPARSER_HANDLE * phChp
)

Create a chunk parser for a device.

Parameters:

• hDev Device handle
• phChp Result pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

This function creates a chunk parser for a device and returns a handle for it. If the device does not support a chunk parser an invalid handle is returned.

function PylonDeviceCreateEventAdapter#

GENAPIC_RESULT PylonDeviceCreateEventAdapter(
    PYLON_DEVICE_HANDLE hDev,
    PYLON_EVENTADAPTER_HANDLE * phEva
)

Create an event adapter for a device.

Parameters:

• hDev Device handle
• phEva Result pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

This function creates an event adapter for a device and returns a handle for it. If the device does not support an event adapter an invalid handle is returned.

function PylonDeviceDeregisterRemovalCallback#

GENAPIC_RESULT PylonDeviceDeregisterRemovalCallback(
    PYLON_DEVICE_HANDLE hDev,
    PYLON_DEVICECALLBACK_HANDLE hCb
)

Unregister device removal callback.

Parameters:

• hDev Device handle
• hCb Callback handle

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Detach a device removal callback from a device.

function PylonDeviceDestroyChunkParser#

GENAPIC_RESULT PylonDeviceDestroyChunkParser(
    PYLON_DEVICE_HANDLE hDev,
    PYLON_CHUNKPARSER_HANDLE hChp
)

Destroy a chunk parser.

Parameters:

• hDev Device handle
• hChp Chunk parser handle

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

This function destroys a chunk parser handle previously obtained from the device by calling PylonDeviceCreateChunkParser().

function PylonDeviceDestroyEventAdapter#

GENAPIC_RESULT PylonDeviceDestroyEventAdapter(
    PYLON_DEVICE_HANDLE hDev,
    PYLON_EVENTADAPTER_HANDLE hEva
)

Destroy an event adapter.

Parameters:

• hDev Device handle
• hEva Event adapter handle

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

This function destroys an event adapter handle previously obtained from the device by calling PylonDeviceCreateEventAdapter().

function PylonDeviceExecuteCommandFeature#

GENAPIC_RESULT PylonDeviceExecuteCommandFeature(
    PYLON_DEVICE_HANDLE hDev,
    const char * pName
)

Execute a command.

Parameters:

• hDev Device handle
• pName Pointer to feature name

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Look up a command feature node with a given name and try to execute its command.

function PylonDeviceFeatureFromString#

GENAPIC_RESULT PylonDeviceFeatureFromString(
    PYLON_DEVICE_HANDLE hDev,
    const char * pName,
    const char * pValue
)

Set a feature's value from a string.

Parameters:

• hDev Device handle
• pName Pointer to feature name
• pValue Pointer to string argument

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Look up a feature node with a given name and and set its value from the argument string value.

function PylonDeviceFeatureGetAccessMode#

GENAPIC_RESULT PylonDeviceFeatureGetAccessMode(
    PYLON_DEVICE_HANDLE hDev,
    const char * pName,
    EGenApiAccessMode * pResult
)

Return a feature's access permissions.

Parameters:

• hDev Device handle
• pName Pointer to feature name
• pValue Result pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Look up a feature node with a given name and and return its access mode in the variable pointed to by pValue.

function PylonDeviceFeatureIsAvailable#

_Bool PylonDeviceFeatureIsAvailable(
    PYLON_DEVICE_HANDLE hDev,
    const char * pName
)

Return boolean 'available' status for feature.

Parameters:

• hDev Device handle
• pName Pointer to feature name

Return: True if feature is available, false if not

Look up a feature node with a given name and and return its 'available' status (PylonDeviceFeatureGetAccessMode() returns neither NA nor NI).

function PylonDeviceFeatureIsImplemented#

_Bool PylonDeviceFeatureIsImplemented(
    PYLON_DEVICE_HANDLE hDev,
    const char * pName
)

Return boolean 'implemented' status for feature.

Parameters:

• hDev Device handle
• pName Pointer to feature name

Return: True if feature is implemented, false if not

Look up a feature node with a given name and and return its 'implemented' status (PylonDeviceFeatureGetAccessMode() returns not NI).

function PylonDeviceFeatureIsReadable#

_Bool PylonDeviceFeatureIsReadable(
    PYLON_DEVICE_HANDLE hDev,
    const char * pName
)

Return boolean 'readable' status for feature.

Parameters:

• hDev Device handle
• pName Pointer to feature name

Return: True if feature is readable, false if not

Look up a feature node with a given name and and return its 'readable' status (PylonDeviceFeatureGetAccessMode() returns RO or RW).

function PylonDeviceFeatureIsWritable#

_Bool PylonDeviceFeatureIsWritable(
    PYLON_DEVICE_HANDLE hDev,
    const char * pName
)

Return boolean 'writable' status for feature.

Parameters:

• hDev Device handle
• pName Pointer to feature name

Return: True if feature is writable, false if not

Look up a feature node with a given name and and return its 'writable' status (PylonDeviceFeatureGetAccessMode() returns WO or RW).

function PylonDeviceFeatureToString#

GENAPIC_RESULT PylonDeviceFeatureToString(
    PYLON_DEVICE_HANDLE hDev,
    const char * pName,
    char * pBuf,
    size_t * pBufLen
)

Return a feature's value as a string.

Parameters:

• hDev Device handle
• pName Feature pName
• pBuf Pointer to string buffer receiving result
• pBufLen String buffer size

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Look up a feature node with a given name and return its value as string. The buffer passed to this function must be large enough to hold the entire string, including a terminating zero. If the function is called with pBuf set to NULL, the variable pointed to by pBufLen is set to the required buffer size.

function PylonDeviceGetBooleanFeature#

GENAPIC_RESULT PylonDeviceGetBooleanFeature(
    PYLON_DEVICE_HANDLE hDev,
    const char * pName,
    _Bool * pValue
)

Return a boolean feature's value.

Parameters:

• hDev Device handle
• pName Pointer to feature name
• pValue Result pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Look up a feature node with a given name and and return its boolean value in the variable pointed to by pValue.

function PylonDeviceGetDeviceInfo#

GENAPIC_RESULT PylonDeviceGetDeviceInfo(
    PYLON_DEVICE_HANDLE hDev,
    PylonDeviceInfo_t * pDeviceInfo
)

Get device information from device.

Parameters:

• hDev Device handle
• pDeviceInfo Result pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Given a device handle, this function will return basic information about the device in a PylonDeviceInfo_t struct pointed to by pDeviceInfo. Do not confuse a PylonDeviceInfo_t struct with a PYLON_DEVICE_INFO_HANDLE. They are completly unrelated.

function PylonDeviceGetDeviceInfoHandle#

GENAPIC_RESULT PylonDeviceGetDeviceInfoHandle(
    PYLON_DEVICE_HANDLE hDev,
    PYLON_DEVICE_INFO_HANDLE * phDi
)

Return the handle to the device info object from which a device was created.

Parameters:

• hDev Device handle
• phDi Result pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Given a device handle, this function returns a handle for the device object from which the device has originally been created.

function PylonDeviceGetEventGrabber#

GENAPIC_RESULT PylonDeviceGetEventGrabber(
    PYLON_DEVICE_HANDLE hDev,
    PYLON_EVENTGRABBER_HANDLE * phEvg
)

Obtain an event grabber handle from a device.

Parameters:

• hDev Device handle
• phEvg Result pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

This function returns a handle for an event grabber of a device.

function PylonDeviceGetFloatFeature#

GENAPIC_RESULT PylonDeviceGetFloatFeature(
    PYLON_DEVICE_HANDLE hDev,
    const char * pName,
    double * pValue
)

Return a float feature's value.

Parameters:

• hDev Device handle
• pName Pointer to feature name
• pValue Result pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Look up a feature node with a given name and and return its value in the variable pointed to by pValue.

function PylonDeviceGetFloatFeatureMax#

GENAPIC_RESULT PylonDeviceGetFloatFeatureMax(
    PYLON_DEVICE_HANDLE hDev,
    const char * pName,
    double * pValue
)

Return a float feature's maximum value.

Parameters:

• hDev Device handle
• pName Pointer to feature name
• pValue Result pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Look up a feature node with a given name and and return its maximum value in the variable pointed to by pValue.

function PylonDeviceGetFloatFeatureMin#

GENAPIC_RESULT PylonDeviceGetFloatFeatureMin(
    PYLON_DEVICE_HANDLE hDev,
    const char * pName,
    double * pValue
)

Return a float feature's minimum value.

Parameters:

• hDev Device handle
• pName Pointer to feature name
• pValue Result pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Look up a feature node with a given name and and return its minimum value in the variable pointed to by pValue.

function PylonDeviceGetIntegerFeature#

GENAPIC_RESULT PylonDeviceGetIntegerFeature(
    PYLON_DEVICE_HANDLE hDev,
    const char * pName,
    int64_t * pValue
)

Return an integer feature's value.

Parameters:

• hDev Device handle
• pName Pointer to feature name
• pValue Result pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Look up a feature node with a given name and and return its value in the variable pointed to by pValue.

function PylonDeviceGetIntegerFeatureInc#

GENAPIC_RESULT PylonDeviceGetIntegerFeatureInc(
    PYLON_DEVICE_HANDLE hDev,
    const char * pName,
    int64_t * pValue
)

Return an integer feature's increment value.

Parameters:

• hDev Device handle
• pName Pointer to feature name
• pValue Result pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Look up a feature node with a given name and and return its increment value in the variable pointed to by pValue.

function PylonDeviceGetIntegerFeatureMax#

GENAPIC_RESULT PylonDeviceGetIntegerFeatureMax(
    PYLON_DEVICE_HANDLE hDev,
    const char * pName,
    int64_t * pValue
)

Return an integer feature's maximum value.

Parameters:

• hDev Device handle
• pName Pointer to feature name
• pValue Result pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Look up a feature node with a given name and and return its maximum value in the variable pointed to by pValue.

function PylonDeviceGetIntegerFeatureMin#

GENAPIC_RESULT PylonDeviceGetIntegerFeatureMin(
    PYLON_DEVICE_HANDLE hDev,
    const char * pName,
    int64_t * pValue
)

Return an integer feature's minimum value.

Parameters:

• hDev Device handle
• pName Pointer to feature name
• pValue Result pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Look up a feature node with a given name and and return its minimum value in the variable pointed to by pValue.

function PylonDeviceGetNodeMap#

GENAPIC_RESULT PylonDeviceGetNodeMap(
    PYLON_DEVICE_HANDLE hDev,
    NODEMAP_HANDLE * phMap
)

Return the parameter node map for a device.

Parameters:

• hDev Device handle
• phMap Result pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

This function returns a handle for the node map of a device. If the device does not support a node map an invalid handle is returned.

function PylonDeviceGetNumStreamGrabberChannels#

GENAPIC_RESULT PylonDeviceGetNumStreamGrabberChannels(
    PYLON_DEVICE_HANDLE hDev,
    size_t * pNumChannels
)

Return the number of stream grabber channels for a device.

Parameters:

• hDev Device handle
• pNumChannels Result pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Note Some devices may return 0 as they do not support stream grabbers at all.

This function returns the number of stream grabber channels supported by the device.

function PylonDeviceGetStreamGrabber#

GENAPIC_RESULT PylonDeviceGetStreamGrabber(
    PYLON_DEVICE_HANDLE hDev,
    size_t index,
    PYLON_STREAMGRABBER_HANDLE * phStg
)

Obtain a stream grabber handle from a device.

Parameters:

• hDev Device handle
• index Stream grabber index. This value must be in the range of 0 .. (PylonDeviceGetNumStreamGrabberChannels()-1)
• phStg Result pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

This function returns a handle for one of the stream grabbers supported by the device.

function PylonDeviceGetTLNodeMap#

GENAPIC_RESULT PylonDeviceGetTLNodeMap(
    PYLON_DEVICE_HANDLE hDev,
    NODEMAP_HANDLE * phMap
)

Obtain a transport layer parameter node map from a device.

Parameters:

• hDev Device handle
• phMap Result pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

This function returns a handle for the transport layer node map of a device. If the device does not support a transport layer node map an invalid handle is returned. You must use the GenApi functions to access nodes in the node map.

function PylonDeviceGrabSingleFrame#

GENAPIC_RESULT PylonDeviceGrabSingleFrame(
    PYLON_DEVICE_HANDLE hDev,
    size_t channel,
    void * pBuffer,
    size_t bufferSize,
    PylonGrabResult_t * pGrabResult,
    _Bool * pReady,
    uint32_t timeout
)

Set the acquision mode to 'single frame' and grab one image.

Parameters:

• hDev Device handle
• channel Stream grabber channel to use
• pBuffer Buffer receiving image data
• bufferSize Data buffer size
• pGrabResult Pointer to variable receiving grab result
• pReady Pointer to 'buffer ready' flag
• timeout Grab timeout

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes. one of the documented error codes otherwise

Grab a single image into the data buffer passed in pBuffer. Wait at most timeout milliseconds for the camera to produce an image.

function PylonDeviceInfoGetNumProperties#

GENAPIC_RESULT PylonDeviceInfoGetNumProperties(
    PYLON_DEVICE_INFO_HANDLE hDi,
    size_t * numProperties
)

Return the number of properties stored in a device info object.

Parameters:

• hDi Device info handle
• numProperties Result pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

This function returns the total number of properties of the device info object represented by hDi has.

function PylonDeviceInfoGetPropertyName#

GENAPIC_RESULT PylonDeviceInfoGetPropertyName(
    PYLON_DEVICE_INFO_HANDLE hDi,
    size_t index,
    char * pName,
    size_t * pBufLen
)

Return the name of a device property identified by its index.

Parameters:

• hDi Device info handle
• index Property index. This value must be in the range 0 .. (PylonDeviceInfoGetNumProperties()-1)
• pBuf Buffer receiving result
• pBufLen Pointer to buffer length

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

This function returns the name of the device property identified by index index. The buffer passed to this function must be large enough to hold the entire string, including a terminating zero. If the function is called with pBuf set to NULL, the variable pointed to by pBufLen is set to the required buffer size.

function PylonDeviceInfoGetPropertyValueByIndex#

GENAPIC_RESULT PylonDeviceInfoGetPropertyValueByIndex(
    PYLON_DEVICE_INFO_HANDLE hDi,
    size_t index,
    char * pBuf,
    size_t * pBufLen
)

Return the value of a device property identified by its index.

Parameters:

• hDi Device info handle
• index Property index. This value must be in the range 0 .. (PylonDeviceInfoGetNumProperties()-1)
• pBuf Buffer receiving result
• pBufLen Pointer to buffer length

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

This function returns the value of the device property identified by index index. The buffer passed to this function must be large enough to hold the entire string, including a terminating zero. If the function is called with pBuf set to NULL, the variable pointed to by pBufLen is set to the required buffer size.

function PylonDeviceInfoGetPropertyValueByName#

GENAPIC_RESULT PylonDeviceInfoGetPropertyValueByName(
    PYLON_DEVICE_INFO_HANDLE hDi,
    const char * pName,
    char * pValue,
    size_t * pBufLen
)

Return the value of a device property identified by its name.

Parameters:

• hDi Device info handle
• pName Property name
• pBuf Buffer receiving result
• pBufLen Pointer to buffer length

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

This function returns the value of the device property identified by its name. The buffer passed to this function must be large enough to hold the entire string, including a terminating zero. If the function is called with pBuf set to NULL, the variable pointed to by pBufLen is set to the required buffer size.

function PylonDeviceIsCommandDone#

GENAPIC_RESULT PylonDeviceIsCommandDone(
    PYLON_DEVICE_HANDLE hDev,
    const char * pName,
    _Bool * pResult
)

Return true if command execution has finished.

Parameters:

• hDev Device handle
• pName Pointer to feature name
• pResult Pointer to boolean result

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes. one of the documented error codes otherwise

Look up a command feature node with a given name and return true if the node is not currently busy executing its command, false otherwise.

function PylonDeviceIsOpen#

GENAPIC_RESULT PylonDeviceIsOpen(
    PYLON_DEVICE_HANDLE hDev,
    _Bool * pOpen
)

Return device open status.

Parameters:

• hDev Device handle
• pOpen Result pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Call this function to find out whether a device is currently open.

function PylonDeviceOpen#

GENAPIC_RESULT PylonDeviceOpen(
    PYLON_DEVICE_HANDLE hDev,
    int accessMode
)

Open a device.

Parameters:

• hDev Device handle
• accessMode Intended access mode. You can pass one or more of the flags specified below.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

This function opens a device. A device must be opened before any operations can be performed on it. The accessMode argument can be used to restrict the type of access allowed by the device. The following access modes are available:

• PYLONC_ACCESS_MODE_CONTROL - Allows to read or write camera parameters to configure the camera.
• PYLONC_ACCESS_MODE_STREAM - Allows to read image data from the camera's stream grabber object.
• PYLONC_ACCESS_MODE_EVENT - Allows to read event data from the camera's stream grabber object.
• PYLONC_ACCESS_MODE_EXCLUSIVE - Allows exclusive access. When this flag is specified no other application may access the camera.
• PYLONC_ACCESS_MODE_MONITOR - Allows only read access. This flag cannot be combined with any other flags. It is typically used in Multicast/Broadcast applications with GigE cameras.

You can pass one or more flags. If you pass more than one flag you can combine them using the 'or' operator.

function PylonDevicePortRead#

GENAPIC_RESULT PylonDevicePortRead(
    PYLON_DEVICE_HANDLE hDev,
    void * pBuffer,
    int64_t Address,
    size_t Length
)

Perform a raw read on the standard "Device"-node port.

Parameters:

• hDev Node of the port to read from. Use GenApiNodeMapGetNode to get the nodehandle.
• pBuffer Points to the buffer to copy the data to.
• Address Address to start reading data from.
• Length Number of bytes to read starting at Address.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Reads raw data from the "Device" port. Specify the address from where to read data. The count of data bytes passed in Length is read. The data read will be written to the buffer passed in pBuffer. Make sure the buffer has at least a size of Length-bytes.

function PylonDevicePortWrite#

GENAPIC_RESULT PylonDevicePortWrite(
    PYLON_DEVICE_HANDLE hDev,
    const void * pBuffer,
    int64_t Address,
    size_t Length
)

Perform a raw write on the standard "Device"-node port.

Parameters:

• hDev Node of the port to write to. Use GenApiNodeMapGetNode to get the nodehandle.
• pBuffer Points to the buffer to read the data from.
• Address Address to start writing the data to.
• Length Number of bytes to write starting at Address.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Writes raw data to the "Device" port. Specify the address from where to read data. The count of data bytes passed in Length is read. The data read will be read from the buffer passed in pBuffer.

function PylonDeviceRegisterRemovalCallback#

GENAPIC_RESULT PylonDeviceRegisterRemovalCallback(
    PYLON_DEVICE_HANDLE hDev,
    PylonDeviceRemCb_t * pCbFunction,
    PYLON_DEVICECALLBACK_HANDLE * phCb
)

Register device removal callback.

Parameters:

• hDev Device handle
• pCbFunction Callback function pointer
• phCb Pointer to callback handle result

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Note The time the callback will be fired can vary depending on the transport layer used. Some devices, e.g. devices with GigE interface, may take some time to detect the device removal (see [Debugging pylon Applications Using GigE Cameras]). If your program is currently grabbing images it is likely to get failed buffers before the callback is fired.

Register a device removal callback on the device. The callback function will be called when the device is removed (unplugged). When the callback is fired all subsequent calls to functions which need to communicate with the device will fail.

Some devices may not support callback removal and will return an invalid handle.

function PylonDeviceSetBooleanFeature#

GENAPIC_RESULT PylonDeviceSetBooleanFeature(
    PYLON_DEVICE_HANDLE hDev,
    const char * pName,
    _Bool value
)

Set a boolean feature's value.

Parameters:

• hDev Device handle
• pName Pointer to feature name
• value Value to set

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Look up a feature node with a given name and and set its boolean value from argument value.

function PylonDeviceSetFloatFeature#

GENAPIC_RESULT PylonDeviceSetFloatFeature(
    PYLON_DEVICE_HANDLE hDev,
    const char * pName,
    double value
)

Set a float feature's value.

Parameters:

• hDev Device handle
• pName Pointer to feature name
• value Value to set. Make sure the value is in the range of PylonDeviceGetFloatFeatureMin() .. PylonDeviceGetFloatFeatureMax()

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Look up a feature node with a given name and and set its value from argument value.

function PylonDeviceSetIntegerFeature#

GENAPIC_RESULT PylonDeviceSetIntegerFeature(
    PYLON_DEVICE_HANDLE hDev,
    const char * pName,
    int64_t value
)

Set an integer feature's value.

Parameters:

• hDev Device handle
• pName Pointer to feature name
• value Value to set. Make sure the value is valid for the node (see remarks)

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Look up a feature node with a given name and and set its value from argument value. The value must obey certain rules which may vary from node to node. The value must be in the range PylonDeviceGetIntegerFeatureMin()..PylonDeviceGetIntegerFeatureMax(). The value must also be PylonDeviceGetIntegerFeatureMin() + N * PylonDeviceGetIntegerFeatureInc() with N = 0,1,2,3,…,n

function PylonEnumerateDevices#

GENAPIC_RESULT PylonEnumerateDevices(
    size_t * numDevices
)

Enumerate all camera devices.

Parameters:

• numDevices Result value pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes. Depending on device class, other errors are possible as well.

Thread Safety:

The internal list of device information objects changes for all threads.

This function returns the total count of all camera devices detected by the pylon C system regardless of the cameras' interfaces (GigE, Camera Link,…) and creates an internal list of device information objects ordered by device type (USB first, then GigE, CameraLink) and serial number. The device information objects are accessible via the index with PylonGetDeviceInfo() function.

function PylonEnumerateInterfaces#

GENAPIC_RESULT PylonEnumerateInterfaces(
    size_t * numInterfaces
)

Enumerate all interfaces.

Parameters:

• numInterfaces Result value pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes. Depending on device class, other errors are possible as well.

Thread Safety:

The internal list of interface information objects changes for all threads.

This function returns the total count of all interfaces detected by the pylon C system and creates an internal list of interface information objects. The device information objects are accessible via the index with Pylon GetInterfaceInfo() function.

function PylonEnumerateInterfacesByDeviceClass#

GENAPIC_RESULT PylonEnumerateInterfacesByDeviceClass(
    const char * pDeviceClass,
    size_t * numInterfaces
)

Enumerate all interfaces.

Parameters:

• pDeviceClass The device class to check. Using NULL or an empty string matches every deviceclass.
• numInterfaces Result value pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes. Depending on device class, other errors are possible as well.

Thread Safety:

The internal list of interface information objects changes for all threads.

This function returns the total count of all interfaces detected by the pylon C system matching a given device class and creates an internal list of interface information objects. The device information objects are accessible via the index with PylonGetInterfaceInfo() function.

function PylonEventAdapterDeliverMessage#

GENAPIC_RESULT PylonEventAdapterDeliverMessage(
    PYLON_EVENTADAPTER_HANDLE hEva,
    const PylonEventResult_t * pEventResult
)

Process event messages.

Parameters:

• hEva Event adapter handle
• pEventResult Event buffer to process

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Pass an event buffer to an event adapter. The events in the buffer will be processed, updating properties of the device associated with the event adapter.

function PylonEventGrabberClose#

GENAPIC_RESULT PylonEventGrabberClose(
    PYLON_EVENTGRABBER_HANDLE hEvg
)

Close an event grabber.

Parameters:

• hEvg Event grabber to close

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Close an event grabber after use.

function PylonEventGrabberGetNodeMap#

GENAPIC_RESULT PylonEventGrabberGetNodeMap(
    PYLON_EVENTGRABBER_HANDLE hEvg,
    NODEMAP_HANDLE * phMap
)

Return an event grabber's parameter node map.

Parameters:

• hEvg Event grabber handle
• phMap Pointer to node map handle result

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Return a handle for the event grabber's parameter node map. If the event grabber does not support a node map an invalid handle is returned.

function PylonEventGrabberGetNumBuffers#

GENAPIC_RESULT PylonEventGrabberGetNumBuffers(
    PYLON_EVENTGRABBER_HANDLE hEvg,
    size_t * pNumBuffers
)

Return the number of event buffers used by an event grabber.

Parameters:

• hEvg Event grabber handle
• pNumBuffers Result pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes. one of the documented error codes otherwise

Returns the number of event buffers for an event grabber.

function PylonEventGrabberGetWaitObject#

GENAPIC_RESULT PylonEventGrabberGetWaitObject(
    PYLON_EVENTGRABBER_HANDLE hEvg,
    PYLON_WAITOBJECT_HANDLE * phWobj
)

Return an event grabber's wait object.

Parameters:

• hEvg Event grabber handle
• phWobj Result wait object pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

This function returns a wait object handle for an event grabber.

function PylonEventGrabberIsOpen#

GENAPIC_RESULT PylonEventGrabberIsOpen(
    PYLON_EVENTGRABBER_HANDLE hEvg,
    _Bool * pOpen
)

Return an event grabber's boolean 'open' status.

Parameters:

• hEvg Event grabber to check
• pOpen Boolean result

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Check, whether an event grabber is currently open.

function PylonEventGrabberOpen#

GENAPIC_RESULT PylonEventGrabberOpen(
    PYLON_EVENTGRABBER_HANDLE hEvg
)

Open an event grabber.

Parameters:

• hEvg Event grabber to open

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Open an event grabber for use.

function PylonEventGrabberRetrieveEvent#

GENAPIC_RESULT PylonEventGrabberRetrieveEvent(
    PYLON_EVENTGRABBER_HANDLE hEvg,
    PylonEventResult_t * pEventResult,
    _Bool * pReady
)

Retrieve an event from an event grabber.

Parameters:

• hEvg Event grabber handle
• pEventResult Pointer to result data struct
• pReady Pointer to 'ready' flag

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Calling this function returns a boolean status in the variable pointed to by pReady, indicating whether at least one event is available. If so, the event is returned in the result struct pointed to by pEventResult.

function PylonEventGrabberSetNumBuffers#

GENAPIC_RESULT PylonEventGrabberSetNumBuffers(
    PYLON_EVENTGRABBER_HANDLE hEvg,
    size_t numBuffers
)

Set the number of event buffers used by an event grabber.

Parameters:

• hEvg Event grabber handle
• numBuffers New buffer count

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes. one of the documented error codes otherwise

Set the number of event buffers for an event grabber.

function PylonFeaturePersistenceLoad#

GENAPIC_RESULT PylonFeaturePersistenceLoad(
    NODEMAP_HANDLE hMap,
    const char * pFileName,
    _Bool verify
)

Loads the features from a file and stores it to the node tree.

Parameters:

• hMap Node map handle.
• pFileName Name of the file containing the node map values.
• verify If verify==true (default) all node values will be validated.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Loads the features from a file and stores it to the node tree.

function PylonFeaturePersistenceLoadFromString#

GENAPIC_RESULT PylonFeaturePersistenceLoadFromString(
    NODEMAP_HANDLE hMap,
    const char * pFeatures,
    _Bool verify
)

Loads the features from a string and stores it to the node tree.

Parameters:

• hMap Node map handle.
• pFeatures The string containing the node map values.
• verify If verify==true (default) all node values will be validated.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Loads the features from a string and stores it to the node tree.

function PylonFeaturePersistenceSave#

GENAPIC_RESULT PylonFeaturePersistenceSave(
    NODEMAP_HANDLE hMap,
    const char * pFileName
)

Saves the node tree to a file.

Parameters:

• pFileName Name of the file to store the node map values in.
• hMap Node map handle.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Sequence sets of a camera are automatically saved when SequenceEnable is activated.

function PylonFeaturePersistenceSaveToString#

GENAPIC_RESULT PylonFeaturePersistenceSaveToString(
    NODEMAP_HANDLE hMap,
    char * pFeatures,
    size_t * pFeaturesLen
)

Saves the node tree to a string.

Parameters:

• hMap Node map handle.
• pFeatures The string to store the node map values in.
• pFeaturesLen The size string buffer to store the node map values in.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Sequence sets of a camera are automatically saved if SequenceEnable is activated.

function PylonGetDeviceInfo#

GENAPIC_RESULT PylonGetDeviceInfo(
    size_t index,
    PylonDeviceInfo_t * pDi
)

Get information about camera device identified by its index.

Parameters:

• index Device index.
• pDi Pointer to camera device info struct to fill

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Note Do not confuse a PylonDeviceInfo_t struct with a PYLON_DEVICE_INFO_HANDLE. They are completly unrelated.

Given a device index, this function returns information about the camera device in a PylonDeviceInfo_t struct pointed to by pDi. The index parameter must be lower than the numDevices parameter returned from PylonEnumerateDevices().

function PylonGetDeviceInfoHandle#

GENAPIC_RESULT PylonGetDeviceInfoHandle(
    size_t index,
    PYLON_DEVICE_INFO_HANDLE * phDi
)

Return a handle for a camera device info object.

Parameters:

• index Device index
• phDi Device info handle

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

This function returns a handle for a device info object for the device identified by index index. The index parameter must be lower than the numDevices parameter returned from PylonEnumerateDevices().

function PylonGetInterfaceInfo#

GENAPIC_RESULT PylonGetInterfaceInfo(
    size_t index,
    PylonInterfaceInfo_t * pIfInfo
)

Get information about an interface identified by its index.

Parameters:

• index Interface index
• pIfInfo Pointer to interface info struct to fill

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Note Do not confuse a PylonInterfaceInfo_t struct with a PYLON_INTERFACE_INFO_HANDLE. They are completely unrelated.

Given an interface index, this function will return basic information about the device in a PylonInterfaceInfo_t struct pointed to by pIfInfo. The index parameter must be lower than the numInterfaces parameter returned by PylonEnumerateInterfaces().

function PylonGetProperty#

GENAPIC_RESULT PylonGetProperty(
    int propertyId,
    void * pData,
    size_t * pSize
)

Get the value of a property.

Parameters:

• propertyId Identifies the property.
• pData A pointer to the buffer containing the data.
• pSize Size of the buffer in bytes when calling. Holds the resulting size on return.

Return: GENAPI_E_OK if the property was retrieved successfully. If you haven't called PylonInitialize() before GENAPI_E_FAIL will be returned.

Note You must have called PylonInitialize() before you can call this function.

Call this function to get a property in pylon C.

function PylonGigEAnnounceRemoteDevice#

GENAPIC_RESULT PylonGigEAnnounceRemoteDevice(
    const char * pIpAddress
)

Announce that a remote device is going to be used.

Parameters:

• pIpAddress Address of device in "dot notation"

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes. one of the documented error codes otherwise

Note This device must be reachable, a route is configured.

Announce that a remote device is going to be used.

function PylonGigEBroadcastIpConfiguration#

GENAPIC_RESULT PylonGigEBroadcastIpConfiguration(
    const char * pMacAddress,
    _Bool EnablePersistentIp,
    _Bool EnableDHCP,
    const char * pIpAddress,
    const char * pSubnetMask,
    const char * pDefaultGateway,
    const char * pUserdefinedName,
    _Bool * pRetval
)

Broadcasts the IP configuration.

Parameters:

• pMacAddress specifies the target device
• EnablePersistentIp enable persistent (static) IP configuration
• EnableDHCP enable DHCP configuration
• pIpAddress IP address, "dot notation", e.g., 192.168.1.2
• pSubnetMask SubnetMask, "dot notation", eg. 255.255.255.0
• pDefaultGateway DefaultGateway, "dot notation", e.g., 192.168.1.1
• pUserdefinedName string with name for the device
• pRetval whether the configuration was applied successfully

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Broadcasts the IP configuration for the device with the specified MAC address.

function PylonGigEChangeIpConfiguration#

GENAPIC_RESULT PylonGigEChangeIpConfiguration(
    PYLON_DEVICE_HANDLE hDev,
    _Bool EnablePersistentIp,
    _Bool EnableDhcp
)

Enables/disables use of a persistent IP address and DHCP usage.

Parameters:

• hDev Device handle
• EnablePersistentIp Enable use of persistent IP address
• EnableDhcp Enable use of DHCP

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes. one of the documented error codes otherwise

Enables/disables use of a persistent IP address and DHCP usage.

function PylonGigEEnumerateAllDevices#

GENAPIC_RESULT PylonGigEEnumerateAllDevices(
    size_t * numDevices
)

Enumerate all GigE camera devices in all subnets.

Parameters:

• numDevices Result value pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes. Depending on device class, other errors are possible as well

Thread Safety:

The internal list of device information objects changes for all threads. This function uses the same internal list of device information objects as the PylonEnumerateDevices() function.

This function returns the total count of all GigE camera devices detected by the pylon C system and creates an internal list of device information objects ordered by serial number. The devices are accessible via the index with PylonGetDeviceInfo() function. In contrast to the PylonEnumerateDevices() function, devices will be listed that have a subnet configured that is different from the subnet of the host system network adapters.

function PylonGigEForceIp#

GENAPIC_RESULT PylonGigEForceIp(
    const char * pMacAddress,
    const char * pIpAddress,
    const char * pSubnetMask,
    const char * pDefaultGateway
)

'Force' a static IP address configuration into a device identified by its MAC Address.

Parameters:

• pMacAddress MAC address as a string, no delimiters are used. e.g., 003053061a58
• pIpAddress Temporary IP address, "dot notation", e.g., 192.168.1.2
• pSubnetMask Temporary SubnetMask, "dot notation", eg. 255.255.255.0
• pDefaultGateway Temporary DefaultGateway, "dot notation", e.g., 192.168.1.1

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes. one of the documented error codes otherwise

When calling this function, there must be no opened camera object for the device to reconfigure! PylonDeviceInfoGetPropertyValueByName() can be used to retrieve the MAC Address using the 'MacAddress' key.

function PylonGigEGetPersistentIpAddress#

GENAPIC_RESULT PylonGigEGetPersistentIpAddress(
    PYLON_DEVICE_HANDLE hDev,
    char * pIpAddress,
    size_t * pIpAddressLen,
    char * pSubnetMask,
    size_t * pSubnetMaskLen,
    char * pDefaultGateway,
    size_t * pDefaultGatewayLen
)

Reads the persistent IP address from the device.

Parameters:

• hDev Device handle
• pIpAddress IP address, "dot notation", e.g., 192.168.1.2
• pIpAddressLen Pointer to buffer length
• pSubnetMask SubnetMask, "dot notation", eg. 255.255.255.0
• pSubnetMaskLen Pointer to buffer length
• pDefaultGateway DefaultGateway, "dot notation", e.g., 192.168.1.1
• pDefaultGatewayLen Pointer to buffer length

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Reads the persistent IP address from the device.

function PylonGigEIssueActionCommand#

GENAPIC_RESULT PylonGigEIssueActionCommand(
    uint32_t deviceKey,
    uint32_t groupKey,
    uint32_t groupMask,
    const char * pBroadcastAddress,
    uint32_t timeoutMs,
    uint32_t * pNumResults,
    PylonGigEActionCommandResult_t * pResults
)

Issue an action command via broadcast.

Parameters:

• deviceKey The device key addresses devices managed by an application. The device key is only known to the application controlling its camera devices and it ensures that only this application can trigger the camera devices. Therefore the device key cannot be read from a device. An exact match of the send deviceKey and the device key stored in a device is required for executing an action.
• groupKey The group key is used to create groups of devices or actions. An exact match of the send groupKey and the group key stored in a device for an action is required for executing an action.
• groupMask The groupMask is a bit mask that allows to send an action to a subgroup of the devices addressed by the deviceKey``groupKey pair. The result of a bitwise AND operation of groupMask and the group mask stored in a device for an action must be non-zero for executing an action.
• pBroadcastAddress BroadcastAddress in dot notation where the command will be broadcast to, e.g. 255.255.255.255 (all adapters, default), 192.168.1.255 (all devices in a single subnet 192.168.1.xxx), 192.168.1.38 (single device). See the note below.
• timeoutMs Optional: Time in milliseconds the call is waiting for acknowledges of the addressed devices. Waiting for acknowledges is stopped if pNumResults have been received. This parameter can be 0 if a check of action command results is not required.
• pNumResults Optional: The number of results in the results array. The value passed should be equal to the expected number of devices that acknowledge the command. Returns the number of received results. This parameter is ignored if timeoutMs is 0. Thus, this parameter can be NULL if timeoutMs is 0.
• pResults Optional: An array with *pNumResults elements to hold the action command result status. The buffer is filled beginning from the start. Remaining results are not changed if less results are received than result items available. This parameter is ignored if timeoutMs is 0. Thus, this parameter can be NULL if timeoutMs is 0.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Note The request is sent via all existing network adapters. If a network adapter has more than one IP address, the request is sent separately for each address. This is not executed simultaneously but consecutively, IP address by IP address. That's why additional latency is added to the execution time. Directed broadcasts (192.168.1.255) or unicasts (192.168.1.38) are only sent if the request subnet matches the subnet of the IP address, i.e., if no gateway or routing are required.

Precondition:

• IP4 addresses must be used.
• groupMask must not be 0.
• pNumResult, *pNumResult and pResults must not be 0 if a timeoutMs value other than 0 is passed.

Thread Safety:

The function is thread-safe.

The action command feature lets you trigger actions in multiple devices (e.g. cameras) at roughly the same time or at a defined point in time (scheduled action command) by using a single broadcast protocol message (without extra cabling). Action commands are used in cameras in the same way as for example the digital input lines.

function PylonGigEIssueScheduledActionCommand#

GENAPIC_RESULT PylonGigEIssueScheduledActionCommand(
    uint32_t deviceKey,
    uint32_t groupKey,
    uint32_t groupMask,
    uint64_t actiontimeNs,
    const char * pBroadcastAddress,
    uint32_t timeoutMs,
    uint32_t * pNumResults,
    PylonGigEActionCommandResult_t * pResults
)

Issue a scheduled action command via broadcast.

Parameters:

• deviceKey The device key addresses devices managed by an application. The device key is only known to the application controlling its camera devices and it ensures that only this application can trigger the camera devices. Therefore the device key cannot be read from a device. An exact match of the send deviceKey and the device key stored in a device is required for executing an action.
• groupKey The group key is used to create groups of devices or actions. An exact match of the send groupKey and the group key stored in a device for an action is required for executing an action.
• groupMask The groupMask is a bit mask that allows to send an action to a subgroup of the devices addressed by the deviceKey``groupKey pair. The result of a bitwise AND operation of groupMask and the group mask stored in a device for an action must be non-zero for executing an action.
• actionTimeNs Time in nanoseconds when the action is to be executed. The actual value depends on the used master clock. A master clock value can be obtained for instance for a set of synchronized camera devices by reading the timestamp value (GevTimestampValue) after latching the timestamp value (GevTimestampControlLatch) from one camera device of the set.
• pBroadcastAddress BroadcastAddress in dot notation where the command will be broadcast to, e.g. 255.255.255.255 (all adapters, default), 192.168.1.255 (all devices in a single subnet 192.168.1.xxx), 192.168.1.38 (single device). See the note below.
• timeoutMs Optional: Time in milliseconds the call is waiting for acknowledges of the addressed devices. Waiting for acknowledges is stopped if pNumResults have been received. This parameter can be 0 if a check of action command results is not required.
• pNumResults Optional: The number of results in the results array. The value passed should be equal to the expected number of devices that acknowledge the command. Returns the number of received results. This parameter is ignored if timeoutMs is 0. Thus, this parameter can be NULL if timeoutMs is 0.
• pResults Optional: An array with *pNumResults elements to hold the action command result status. The buffer is filled beginning from the start. Remaining results are not changed if less results are received than result items available. This parameter is ignored if timeoutMs is 0. Thus, this parameter can be NULL if timeoutMs is 0.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Note The request is sent via all existing network adapters. If a network adapter has more than one IP address, the request is sent separately for each address. This is not executed simultaneously but consecutively, IP address by IP address. That's why additional latency is added to the execution time. Directed broadcasts (192.168.1.255) or unicasts (192.168.1.38) are only sent if the request subnet matches the subnet of the IP address, i.e., if no gateway or routing are required.

Precondition:

• IP4 addresses must be used.
• groupMask must not be 0.
• pNumResult, *pNumResult and pResults must not be 0 if a timeoutMs value other than 0 is passed.
• actionTimeNs must be smaller than or equal INT64_MAX.

Thread Safety:

The function is thread-safe.

The action command feature lets you trigger actions in multiple devices (e.g. cameras) at roughly the same time or at a defined point in time (scheduled action command) by using a single broadcast protocol message (without extra cabling). Action commands are used in cameras in the same way as for example the digital input lines.

function PylonGigERenounceRemoteDevice#

GENAPIC_RESULT PylonGigERenounceRemoteDevice(
    const char * pIpAddress,
    _Bool * pFound
)

Stop using remote device.

Parameters:

• pIpAddress Address of device in "dot notation"
• pFound If not NULL: information wether device was found or not found. If NULL, this information is ignored.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes. one of the documented error codes otherwise

Stop using remote device.

function PylonGigERestartIpConfiguration#

GENAPIC_RESULT PylonGigERestartIpConfiguration(
    const char * pMacAddress
)

Let a device restart the IP configuration cycle.

Parameters:

• pMacAddress MAC address as a string, no delimiters are used. e.g., 003053061a58

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes. one of the documented error codes otherwise

This function fails when the device is open, i.e., when a control channel is established. PylonDeviceInfoGetPropertyValueByName() can be used to retrieve the MAC Address using the 'MacAddress' key.

function PylonGigESetPersistentIpAddress#

GENAPIC_RESULT PylonGigESetPersistentIpAddress(
    PYLON_DEVICE_HANDLE hDev,
    const char * pIpAddress,
    const char * pSubnetMask,
    const char * pDefaultGateway
)

Writes a persistent IP address to the device.

Parameters:

• hDev Device handle
• pIpAddress IP address, "dot notation", e.g., 192.168.1.2
• pSubnetMask SubnetMask, "dot notation", eg. 255.255.255.0
• pDefaultGateway DefaultGateway, "dot notation", e.g., 192.168.1.1

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes. one of the documented error codes otherwise

Writing the persistent IP address does not change the IP configuration. Use the ChangeIpConfiguration() method to enable the usage of persistent IP addresses.

function PylonImageDecompressorCreate#

GENAPIC_RESULT PylonImageDecompressorCreate(
    PYLON_IMAGE_DECOMPRESSOR_HANDLE * phDecompressor
)

Creates an empty decompressor without a compression descriptor.

Parameters:

• phDecompressor Handle for the decompressor. This parameter must not be NULL.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

This function creates a default decompressor without a compression descriptor. You will have to initialize the decompressor first by using the PylonImageDecompressorSetCompressionDescriptor() function in order to be able to decompress images. You must call PylonImageDecompressorDestroy() to release the decompressor and free its resources when you don't need it anymore.

function PylonImageDecompressorDecompressImage#

GENAPIC_RESULT PylonImageDecompressorDecompressImage(
    PYLON_IMAGE_DECOMPRESSOR_HANDLE hDecompressor,
    void * pOutputBuffer,
    size_t * pOutputBufferSize,
    const void * pPayload,
    size_t payloadSize,
    PylonCompressionInfo_t * pCompressionInfo
)

Decompresses the image of the grab buffer provided.

Parameters:

• hDecompressor Handle of image decompressor returned by PylonImageDecompressorCreate().
• pOutputBuffer Pointer to the buffer that will receive the decompressed image. This parameter must not be NULL.
• pOutputBufferSize On input, the variable specifies the size of the buffer in bytes of the decompressed image. On output, the variable will receive the actual buffer size required for the decompressed image. This parameter must not be NULL.
• pPayload Pointer to the grab buffer that holds the compressed data. This parameter must not be NULL.
• payloadSize Payload size (in bytes) of the data received (must be less or equal to the size of the grab buffer).
• pCompressionInfo Pointer to a PylonCompressionInfo_t struct. On return, the struct will contain information about the decompressed image. If this parameter is NULL, no info will be returned.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Decompresses the image of the grab buffer provided. This method requires that a compression descriptor has been set previously using PylonImageDecompressorSetCompressionDescriptor function. The grab buffer provided must contain a compressed image that has been received without errors. On successful return the decompressed image data is stored in the buffer passed pOutputBuffer. Information about the decompressed image is stored in the struct passed in pCompressionInfo.

function PylonImageDecompressorDestroy#

GENAPIC_RESULT PylonImageDecompressorDestroy(
    PYLON_IMAGE_DECOMPRESSOR_HANDLE hDecompressor
)

Destroys an image decompressor.

Parameters:

• hDecompressor Handle of image decompressor returned by PylonImageDecompressorCreate().

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Destroys an image decompressor. You must call PylonImageDecompressorDestroy() for each handle returned by PylonImageDecompressorCreate().

function PylonImageDecompressorGetCompressionInfo#

GENAPIC_RESULT PylonImageDecompressorGetCompressionInfo(
    const void * pPayload,
    size_t payloadSize,
    PylonCompressionInfo_t * pCompressionInfo
)

Return information about a compressed grab result.

Parameters:

• pPayload Pointer to the grab buffer that holds the compressed data. This parameter must not be NULL.
• payloadSize Payload size (in bytes) of the data received.
• pCompressionInfo Pointer to a PylonCompressionInfo_t struct. On return, the struct will contain information about the decompressed image. This parameter must not be NULL.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Return information about a compressed grab result. If the function returns success, it does not neccessarily mean the data is compressed. It only indicates that the output parameter has been set. You must check the HasCompressedImage and CompressionStatus fields of the returned PylonCompressionInfo_t struct.

function PylonImageDecompressorSetCompressionDescriptor#

GENAPIC_RESULT PylonImageDecompressorSetCompressionDescriptor(
    PYLON_IMAGE_DECOMPRESSOR_HANDLE hDecompressor,
    const void * pCompressionDescriptor,
    size_t sizeCompressionDescriptor
)

Initializes a decompressor with the compression descriptor provided.

Parameters:

• hDecompressor Handle of image decompressor returned by PylonImageDecompressorCreate().
• pCompressionDescriptor Pointer to the compression descriptor to set. If this parameter is NULL the descriptor will be reset.
• sizeCompressionDescriptor Size of the data (in bytes) of the compression descriptor when a descriptor has been passed in pCompressionDescriptor.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

A decompressor requires a compression descriptor in order to be able to decompress images. You can retrieve the compression descriptor from the camera's node map using the BslImageCompressionBCBDescriptor node.

function PylonImageFormatConverterConvert#

GENAPIC_RESULT PylonImageFormatConverterConvert(
    PYLON_IMAGE_FORMAT_CONVERTER_HANDLE hConv,
    void * targetBuffer,
    size_t targetBufferSize,
    const void * sourceBuffer,
    size_t sourceBufferSize,
    EPylonPixelType sourcePixelType,
    uint32_t sourceWidth,
    uint32_t sourceHeight,
    size_t sourcePaddingX,
    EPylonImageOrientation sourceOrientation
)

Converts an image.

Parameters:

• hConv Handle for image format converter.
• targetBuffer Buffer for converted image data.
• targetBufferSize Size of image buffer for converted data.
• sourceBuffer Buffer of source image data.
• sourceBufferSize Size of buffer of source image data.
• sourcePixelType Pixel type of source image.
• sourceWidth Number of columns (in pixels) of source image.
• sourceHeight Number of rows (in pixels) of source image.
• sourcePaddingX The number of additional data bytes at the end of each image row.
• sourceOrientation The vertical orientation of the source image in the image buffer. The default value is usually ImageOrientation_TopDown.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Converts an image. The buffer size of the target image can be determined by PylonImageFormatConverterGetBufferSizeForConversion.

function PylonImageFormatConverterCreate#

GENAPIC_RESULT PylonImageFormatConverterCreate(
    PYLON_IMAGE_FORMAT_CONVERTER_HANDLE * phConv
)

Creates an image format converter.

Parameters:

• phConv Handle for the image format converter.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Creates an image format converter and provides a handle for it.

function PylonImageFormatConverterDestroy#

GENAPIC_RESULT PylonImageFormatConverterDestroy(
    PYLON_IMAGE_FORMAT_CONVERTER_HANDLE hConv
)

Destroys an image format converter.

Parameters:

• hConv Handle of format converter.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Destroys an image format converter.

function PylonImageFormatConverterGetBufferSizeForConversion#

GENAPIC_RESULT PylonImageFormatConverterGetBufferSizeForConversion(
    PYLON_IMAGE_FORMAT_CONVERTER_HANDLE hConv,
    EPylonPixelType sourcePixelType,
    uint32_t sourceWidth,
    uint32_t sourceHeight,
    size_t * pBufSize
)

Gets the buffer size for a converted image.

Parameters:

• hConv Handle for image format converter.
• sourcePixelType Pixel type of source image.
• sourceWidth Number of columns (in pixels) of source image.
• sourceHeight Number of rows in (pixels) of source image.
• pBufSize Buffer size which is necessary for converted source image.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Gets the buffer size for a converted image. The buffer size depends on the pixel type, the width and the height of the source image and the output padding.

function PylonImageFormatConverterGetNodeMap#

GENAPIC_RESULT PylonImageFormatConverterGetNodeMap(
    PYLON_IMAGE_FORMAT_CONVERTER_HANDLE hConv,
    NODEMAP_HANDLE * phMap
)

Gets the handle for node map of an image format converter.

Parameters:

• hConv Handle for the image format converter.
• phMap Handle for the node map of the image format converter.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Gets the handle for node map of an image format converter.

function PylonImageFormatConverterGetOutputPaddingX#

GENAPIC_RESULT PylonImageFormatConverterGetOutputPaddingX(
    PYLON_IMAGE_FORMAT_CONVERTER_HANDLE hConv,
    size_t * pPaddingX
)

Gets the padding, i. e. the number of additional data bytes at the end of each image row.

Parameters:

• hConv The handle to the image format converter.
• pPaddingX The number of additional data bytes at the end of each image row.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Gets the padding, i. e. the number of additional data bytes at the end of each image row.

function PylonImageFormatConverterGetOutputPixelFormat#

GENAPIC_RESULT PylonImageFormatConverterGetOutputPixelFormat(
    PYLON_IMAGE_FORMAT_CONVERTER_HANDLE hConv,
    EPylonPixelType * pPixelType
)

Gets the output pixel format of an image format converter.

Parameters:

• hConv Handle for the image format converter.
• pPixelType The pixel type which defines the image format.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Gets the output pixel format of an image format converter.

function PylonImageFormatConverterSetOutputPaddingX#

GENAPIC_RESULT PylonImageFormatConverterSetOutputPaddingX(
    PYLON_IMAGE_FORMAT_CONVERTER_HANDLE hConv,
    size_t paddingX
)

Sets the padding, i. e. the number of additional data bytes at the end of each image row.

Parameters:

• hConv The handle to the image format converter.
• paddingX The number of additional data bytes at the end of each image row.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Sets the padding, i. e. the number of additional data bytes at the end of each image row.

function PylonImageFormatConverterSetOutputPixelFormat#

GENAPIC_RESULT PylonImageFormatConverterSetOutputPixelFormat(
    PYLON_IMAGE_FORMAT_CONVERTER_HANDLE hConv,
    EPylonPixelType pixelType
)

Sets the output pixel format of an image format converter.

Parameters:

• hConv Handle for the image format converter.
• pixelType The pixel type which defines the image format.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Sets the output pixel format of an image format converter.

function PylonImagePersistenceLoad#

GENAPIC_RESULT PylonImagePersistenceLoad(
    const char * pFilename,
    void * pBuffer,
    size_t * pBufferSize,
    EPylonPixelType * pPixelType,
    uint32_t * pWidth,
    uint32_t * pHeight,
    size_t * pPaddingX,
    EPylonImageOrientation * pOrientation
)

Loads an image from disk.

Parameters:

• pFilename Name and path of the image.
• pBuffer Buffer to be used.
• pBufferSize If the buffer size is too small, the buffer size is set to the required buffer size and GENAPI_E_INSUFFICIENT_BUFFER is returned.
• pPixelType Pixel type of the loaded image or PixelType_Undefined if the image is invalid.
• pWidth The current number of columns (in pixels) of the loaded image or 0 if the image is invalid.
• pHeight The current number of rows (in pixels) of the loaded image or 0 if the image is invalid.
• pPaddingX The number of extra data bytes at the end of each row or 0 if the image is invalid.
• pOrientation The orientation of the image or ImageOrientation_TopDown if the image is invalid.

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Load an image from a file.

function PylonImagePersistenceSave#

GENAPIC_RESULT PylonImagePersistenceSave(
    EPylonImageFileFormat imageFileFormat,
    const char * pFilename,
    const void * pBuffer,
    size_t bufferSize,
    EPylonPixelType pixelType,
    uint32_t width,
    uint32_t height,
    size_t paddingX,
    EPylonImageOrientation orientation,
    PylonImagePersistenceOptions_t * pOptions
)