Back to FabImage Library website
You are here: Start » Function Reference » GenTL » GenTL_GetPixelFormats
GenTL_GetPixelFormats
| Header: | Genicam.h |
|---|---|
| Namespace: | fil |
| Module: | Genicam |
Retrieves a list of available pixel formats supported by opened device.
Syntax
C++
C#
void fil::GenTL_GetPixelFormats
(
GenTLHandle inDeviceHandle,
ftl::Array< ftl::String >& outFormats
)
Parameters
| Name | Type | Default | Description | |
|---|---|---|---|---|
 |
inDeviceHandle | GenTLHandle | Handle of an opened device. | |
 |
outFormats | Array< String >& | Array that will return a list of format strings. |
Description
This function accesses GenICam "PixelFormat" standard enumeration parameter and reads its entries. Only entries marked as implemented and available will be present in the returned list. The list will contain names of PixelFormat enumeration entries (not display names).
One of the format names returned by this function can be passed to GenTL_StartAcquisition function.
Exceptions
This function will throw an exception in the following situations:
- Device handle is invalid.
- Connection with device is lost.
- Device is not a video transmitter.
- Other general GenTL or GenICam error occurred.
