Namespaces
	EuresysCustomGenTL

Classes
struct	S_EVENT_NEW_BUFFER
	Structure of the data returned from a signaled "New Buffer" event. More...

struct	S_PORT_REGISTER_STACK_ENTRY
	Structure to be use with GCWritePortStacked and GCReadPortStacked. More...

struct	S_SINGLE_CHUNK_DATA
	Structure carrying information about a single chunk in the buffer. More...

Typedefs
typedef int32_t	GC_ERROR

typedef void *	TL_HANDLE
	Transport Layer handle, obtained through the TLOpen. More...

typedef void *	IF_HANDLE
	Interface handle, obtained through TLOpenInterface. More...

typedef void *	DEV_HANDLE
	Device Handle, obtained through the IFOpenDevice. More...

typedef void *	DS_HANDLE
	Handle to an image stream object, obtained through DevOpenDataStream. More...

typedef void *	PORT_HANDLE
	A Port handle is used to access the register space of a port. More...

typedef void *	BUFFER_HANDLE
	BufferHandle, obtained through the DSAnnounceBuffer function. More...

typedef void *	EVENTSRC_HANDLE
	A Event source handle is used to register a OS Event and to retrieve a GenTL event handle. More...

typedef void *	EVENT_HANDLE
	Event Handle. More...

typedef int32_t	INFO_DATATYPE

typedef int32_t	TL_CHAR_ENCODING

typedef int32_t	TL_INFO_CMD

typedef int32_t	INTERFACE_INFO_CMD

typedef int32_t	DEVICE_ACCESS_FLAGS

typedef int32_t	DEVICE_ACCESS_STATUS

typedef int32_t	DEVICE_INFO_CMD

typedef int32_t	ACQ_STOP_FLAGS

typedef int32_t	ACQ_START_FLAGS

typedef int32_t	ACQ_QUEUE_TYPE

typedef int32_t	STREAM_INFO_CMD

typedef int32_t	BUFFER_INFO_CMD

typedef int32_t	BUFFER_PART_INFO_CMD

typedef int32_t	PAYLOADTYPE_INFO_ID

typedef int32_t	PIXELFORMAT_NAMESPACE_ID

typedef int32_t	PIXELENDIANNESS_ID

typedef int32_t	PARTDATATYPE_ID

typedef int32_t	PORT_INFO_CMD

typedef int32_t	URL_SCHEME_ID

typedef int32_t	URL_INFO_CMD

typedef int32_t	EVENT_TYPE

typedef int32_t	EVENT_INFO_CMD

typedef int32_t	EVENT_DATA_INFO_CMD

typedef struct GenTL::S_EVENT_NEW_BUFFER	EVENT_NEW_BUFFER_DATA
	Structure of the data returned from a signaled "New Buffer" event. More...

typedef struct GenTL::S_PORT_REGISTER_STACK_ENTRY	PORT_REGISTER_STACK_ENTRY
	Structure to be use with GCWritePortStacked and GCReadPortStacked. More...

typedef struct GenTL::S_SINGLE_CHUNK_DATA	SINGLE_CHUNK_DATA
	Structure carrying information about a single chunk in the buffer. More...

Enumerations
enum	GC_ERROR_LIST { GC_ERR_SUCCESS = 0, GC_ERR_ERROR = -1001, GC_ERR_NOT_INITIALIZED = -1002, GC_ERR_NOT_IMPLEMENTED = -1003, GC_ERR_RESOURCE_IN_USE = -1004, GC_ERR_ACCESS_DENIED = -1005, GC_ERR_INVALID_HANDLE = -1006, GC_ERR_INVALID_ID = -1007, GC_ERR_NO_DATA = -1008, GC_ERR_INVALID_PARAMETER = -1009, GC_ERR_IO = -1010, GC_ERR_TIMEOUT = -1011, GC_ERR_ABORT = -1012, GC_ERR_INVALID_BUFFER = -1013, GC_ERR_NOT_AVAILABLE = -1014, GC_ERR_INVALID_ADDRESS = -1015, GC_ERR_BUFFER_TOO_SMALL = -1016, GC_ERR_INVALID_INDEX = -1017, GC_ERR_PARSING_CHUNK_DATA = -1018, GC_ERR_INVALID_VALUE = -1019, GC_ERR_RESOURCE_EXHAUSTED = -1020, GC_ERR_OUT_OF_MEMORY = -1021, GC_ERR_BUSY = -1022, GC_ERR_CUSTOM_ID = -10000 }
	Errors. More...

enum	INFO_DATATYPE_LIST { INFO_DATATYPE_UNKNOWN = 0, INFO_DATATYPE_STRING = 1, INFO_DATATYPE_STRINGLIST = 2, INFO_DATATYPE_INT16 = 3, INFO_DATATYPE_UINT16 = 4, INFO_DATATYPE_INT32 = 5, INFO_DATATYPE_UINT32 = 6, INFO_DATATYPE_INT64 = 7, INFO_DATATYPE_UINT64 = 8, INFO_DATATYPE_FLOAT64 = 9, INFO_DATATYPE_PTR = 10, INFO_DATATYPE_BOOL8 = 11, INFO_DATATYPE_SIZET = 12, INFO_DATATYPE_BUFFER = 13, INFO_DATATYPE_PTRDIFF = 14, INFO_DATATYPE_CUSTOM_ID = 1000 }
	Defines the data type possible for the various Info functions. More...

enum	TL_CHAR_ENCODING_LIST { TL_CHAR_ENCODING_ASCII = 0, TL_CHAR_ENCODING_UTF8 = 1 }
	Defines char encoding schemes used by the producer. More...

enum	TL_INFO_CMD_LIST { TL_INFO_ID = 0, TL_INFO_VENDOR = 1, TL_INFO_MODEL = 2, TL_INFO_VERSION = 3, TL_INFO_TLTYPE = 4, TL_INFO_NAME = 5, TL_INFO_PATHNAME = 6, TL_INFO_DISPLAYNAME = 7, TL_INFO_CHAR_ENCODING = 8, TL_INFO_GENTL_VER_MAJOR = 9, TL_INFO_GENTL_VER_MINOR = 10, TL_INFO_CUSTOM_ID = 1000 }
	System module information commands for the GenICam::TL::Client::TLGetInfo and GenICam::TL::Client::GCGetInfo functions. More...

enum	INTERFACE_INFO_CMD_LIST { INTERFACE_INFO_ID = 0, INTERFACE_INFO_DISPLAYNAME = 1, INTERFACE_INFO_TLTYPE = 2, INTERFACE_INFO_CUSTOM_ID = 1000 }
	This enumeration defines commands to retrieve information with the GenICam::TL::Client::IFGetInfo function from the Interface module. More...

enum	DEVICE_ACCESS_FLAGS_LIST { DEVICE_ACCESS_UNKNOWN = 0, DEVICE_ACCESS_NONE = 1, DEVICE_ACCESS_READONLY = 2, DEVICE_ACCESS_CONTROL = 3, DEVICE_ACCESS_EXCLUSIVE = 4, DEVICE_ACCESS_CUSTOM_ID = 1000 }
	This enumeration defines flags of how a device is to be opened with the GenICam::TL::Client::IFOpenDevice function. More...

enum	DEVICE_ACCESS_STATUS_LIST { DEVICE_ACCESS_STATUS_UNKNOWN = 0, DEVICE_ACCESS_STATUS_READWRITE = 1, DEVICE_ACCESS_STATUS_READONLY = 2, DEVICE_ACCESS_STATUS_NOACCESS = 3, DEVICE_ACCESS_STATUS_BUSY = 4, DEVICE_ACCESS_STATUS_OPEN_READWRITE = 5, DEVICE_ACCESS_STATUS_OPEN_READONLY = 6, DEVICE_ACCESS_STATUS_CUSTOM_ID = 1000 }
	This enumeration defines values for the accessibility of the device to be returned in the GenICam::TL::Client::DevGetInfo function on a device handle. More...

enum	DEVICE_INFO_CMD_LIST { DEVICE_INFO_ID = 0, DEVICE_INFO_VENDOR = 1, DEVICE_INFO_MODEL = 2, DEVICE_INFO_TLTYPE = 3, DEVICE_INFO_DISPLAYNAME = 4, DEVICE_INFO_ACCESS_STATUS = 5, DEVICE_INFO_USER_DEFINED_NAME = 6, DEVICE_INFO_SERIAL_NUMBER = 7, DEVICE_INFO_VERSION = 8, DEVICE_INFO_TIMESTAMP_FREQUENCY = 9, DEVICE_INFO_CUSTOM_ID = 1000 }
	This enumeration defines commands to retrieve information with the GenICam::TL::Client::DevGetInfo function on a device handle. More...

enum	ACQ_STOP_FLAGS_LIST { ACQ_STOP_FLAGS_DEFAULT = 0, ACQ_STOP_FLAGS_KILL = 1, ACQ_STOP_FLAGS_CUSTOM_ID = 1000 }
	This enumeration defines special stop flags for the acquisition engine. More...

enum	ACQ_START_FLAGS_LIST { ACQ_START_FLAGS_DEFAULT = 0, ACQ_START_FLAGS_CUSTOM_ID = 1000 }
	This enumeration defines special start flags for the acquisition engine. More...

enum	ACQ_QUEUE_TYPE_LIST { ACQ_QUEUE_INPUT_TO_OUTPUT = 0, ACQ_QUEUE_OUTPUT_DISCARD = 1, ACQ_QUEUE_ALL_TO_INPUT = 2, ACQ_QUEUE_UNQUEUED_TO_INPUT = 3, ACQ_QUEUE_ALL_DISCARD = 4, ACQ_QUEUE_CUSTOM_ID = 1000 }
	This enumeration commands from which to which queue/pool buffers are flushed with the GenICam::TL::Client::DSFlushQueue function. More...

enum	STREAM_INFO_CMD_LIST { STREAM_INFO_ID = 0, STREAM_INFO_NUM_DELIVERED = 1, STREAM_INFO_NUM_UNDERRUN = 2, STREAM_INFO_NUM_ANNOUNCED = 3, STREAM_INFO_NUM_QUEUED = 4, STREAM_INFO_NUM_AWAIT_DELIVERY = 5, STREAM_INFO_NUM_STARTED = 6, STREAM_INFO_PAYLOAD_SIZE = 7, STREAM_INFO_IS_GRABBING = 8, STREAM_INFO_DEFINES_PAYLOADSIZE = 9, STREAM_INFO_TLTYPE = 10, STREAM_INFO_NUM_CHUNKS_MAX = 11, STREAM_INFO_BUF_ANNOUNCE_MIN = 12, STREAM_INFO_BUF_ALIGNMENT = 13, STREAM_INFO_CUSTOM_ID = 1000 }
	This enumeration defines commands to retrieve information with the GenICam::TL::Client::DSGetInfo function on a data stream handle. More...

enum	BUFFER_INFO_CMD_LIST { BUFFER_INFO_BASE = 0, BUFFER_INFO_SIZE = 1, BUFFER_INFO_USER_PTR = 2, BUFFER_INFO_TIMESTAMP = 3, BUFFER_INFO_NEW_DATA = 4, BUFFER_INFO_IS_QUEUED = 5, BUFFER_INFO_IS_ACQUIRING = 6, BUFFER_INFO_IS_INCOMPLETE = 7, BUFFER_INFO_TLTYPE = 8, BUFFER_INFO_SIZE_FILLED = 9, BUFFER_INFO_WIDTH = 10, BUFFER_INFO_HEIGHT = 11, BUFFER_INFO_XOFFSET = 12, BUFFER_INFO_YOFFSET = 13, BUFFER_INFO_XPADDING = 14, BUFFER_INFO_YPADDING = 15, BUFFER_INFO_FRAMEID = 16, BUFFER_INFO_IMAGEPRESENT = 17, BUFFER_INFO_IMAGEOFFSET = 18, BUFFER_INFO_PAYLOADTYPE = 19, BUFFER_INFO_PIXELFORMAT = 20, BUFFER_INFO_PIXELFORMAT_NAMESPACE = 21, BUFFER_INFO_DELIVERED_IMAGEHEIGHT = 22, BUFFER_INFO_DELIVERED_CHUNKPAYLOADSIZE = 23, BUFFER_INFO_CHUNKLAYOUTID = 24, BUFFER_INFO_FILENAME = 25, BUFFER_INFO_PIXEL_ENDIANNESS = 26, BUFFER_INFO_DATA_SIZE = 27, BUFFER_INFO_TIMESTAMP_NS = 28, BUFFER_INFO_DATA_LARGER_THAN_BUFFER = 29, BUFFER_INFO_CONTAINS_CHUNKDATA = 30, BUFFER_INFO_CUSTOM_ID = 1000 }
	This enumeration defines commands to retrieve information with the GenICam::TL::Client::DSGetBufferInfo function on a buffer handle. More...

enum	BUFFER_PART_INFO_CMD_LIST { BUFFER_PART_INFO_BASE = 0, BUFFER_PART_INFO_DATA_SIZE = 1, BUFFER_PART_INFO_DATA_TYPE = 2, BUFFER_PART_INFO_DATA_FORMAT = 3, BUFFER_PART_INFO_DATA_FORMAT_NAMESPACE = 4, BUFFER_PART_INFO_WIDTH = 5, BUFFER_PART_INFO_HEIGHT = 6, BUFFER_PART_INFO_XOFFSET = 7, BUFFER_PART_INFO_YOFFSET = 8, BUFFER_PART_INFO_XPADDING = 9, BUFFER_PART_INFO_SOURCE_ID = 10, BUFFER_PART_INFO_DELIVERED_IMAGEHEIGHT = 11, BUFFER_PART_INFO_CUSTOM_ID = 1000 }
	This enumeration defines commands to retrieve information about individual data parts in a multi-part buffer using the GenICam::TL::Client::DSGetBufferPartInfo function. More...

enum	PAYLOADTYPE_INFO_IDS { PAYLOAD_TYPE_UNKNOWN = 0, PAYLOAD_TYPE_IMAGE = 1, PAYLOAD_TYPE_RAW_DATA = 2, PAYLOAD_TYPE_FILE = 3, PAYLOAD_TYPE_CHUNK_DATA = 4, PAYLOAD_TYPE_JPEG = 5, PAYLOAD_TYPE_JPEG2000 = 6, PAYLOAD_TYPE_H264 = 7, PAYLOAD_TYPE_CHUNK_ONLY = 8, PAYLOAD_TYPE_DEVICE_SPECIFIC = 9, PAYLOAD_TYPE_MULTI_PART = 10, PAYLOAD_TYPE_CUSTOM_ID = 1000 }
	Enumeration of TLType dependent payload types. More...

enum	PIXELFORMAT_NAMESPACE_IDS { PIXELFORMAT_NAMESPACE_UNKNOWN = 0, PIXELFORMAT_NAMESPACE_GEV = 1, PIXELFORMAT_NAMESPACE_IIDC = 2, PIXELFORMAT_NAMESPACE_PFNC_16BIT = 3, PIXELFORMAT_NAMESPACE_PFNC_32BIT = 4, PIXELFORMAT_NAMESPACE_CUSTOM_ID = 1000 }
	Enumeration of TLType dependent pixel format namespaces. More...

enum	PIXELENDIANNESS_IDS { PIXELENDIANNESS_UNKNOWN = 0, PIXELENDIANNESS_LITTLE = 1, PIXELENDIANNESS_BIG = 2 }
	Enumeration of pixel endianness values. More...

enum	PARTDATATYPE_IDS { PART_DATATYPE_UNKNOWN = 0, PART_DATATYPE_2D_IMAGE = 1, PART_DATATYPE_2D_PLANE_BIPLANAR = 2, PART_DATATYPE_2D_PLANE_TRIPLANAR = 3, PART_DATATYPE_2D_PLANE_QUADPLANAR = 4, PART_DATATYPE_3D_IMAGE = 5, PART_DATATYPE_3D_PLANE_BIPLANAR = 6, PART_DATATYPE_3D_PLANE_TRIPLANAR = 7, PART_DATATYPE_3D_PLANE_QUADPLANAR = 8, PART_DATATYPE_CONFIDENCE_MAP = 9, PART_DATATYPE_CUSTOM_ID = 1000 }
	Enumeration describing which data type is present in given buffer part. More...

enum	PORT_INFO_CMD_LIST { PORT_INFO_ID = 0, PORT_INFO_VENDOR = 1, PORT_INFO_MODEL = 2, PORT_INFO_TLTYPE = 3, PORT_INFO_MODULE = 4, PORT_INFO_LITTLE_ENDIAN = 5, PORT_INFO_BIG_ENDIAN = 6, PORT_INFO_ACCESS_READ = 7, PORT_INFO_ACCESS_WRITE = 8, PORT_INFO_ACCESS_NA = 9, PORT_INFO_ACCESS_NI = 10, PORT_INFO_VERSION = 11, PORT_INFO_PORTNAME = 12, PORT_INFO_CUSTOM_ID = 1000 }
	This enumeration defines commands to retrieve information with the GenICam::TL::Client::GCGetPortInfo function on a module or remote device handle. More...

enum	URL_SCHEME_IDS { URL_SCHEME_LOCAL = 0, URL_SCHEME_HTTP = 1, URL_SCHEME_FILE = 2, URL_SCHEME_CUSTOM_ID = 1000 }
	This enumeration defines enum values returned by the URL_INFO_SCHEME command. More...

enum	URL_INFO_CMD_LIST { URL_INFO_URL = 0, URL_INFO_SCHEMA_VER_MAJOR = 1, URL_INFO_SCHEMA_VER_MINOR = 2, URL_INFO_FILE_VER_MAJOR = 3, URL_INFO_FILE_VER_MINOR = 4, URL_INFO_FILE_VER_SUBMINOR = 5, URL_INFO_FILE_SHA1_HASH = 6, URL_INFO_FILE_REGISTER_ADDRESS = 7, URL_INFO_FILE_SIZE = 8, URL_INFO_SCHEME = 9, URL_INFO_FILENAME = 10, URL_INFO_CUSTOM_ID = 1000 }
	This enumeration defines commands to retrieve information with the GenICam::TL::Client::GCGetPortURLInfo function on a module or remote device handle. More...

enum	EVENT_TYPE_LIST { EVENT_ERROR = 0, EVENT_NEW_BUFFER = 1, EVENT_FEATURE_INVALIDATE = 2, EVENT_FEATURE_CHANGE = 3, EVENT_REMOTE_DEVICE = 4, EVENT_MODULE = 5, EVENT_CUSTOM_ID = 1000 }
	Known event types that can be registered on certain modules with the GenICam::TL::Client::GCRegisterEvent function. More...

enum	EVENT_INFO_CMD_LIST { EVENT_EVENT_TYPE = 0, EVENT_NUM_IN_QUEUE = 1, EVENT_NUM_FIRED = 2, EVENT_SIZE_MAX = 3, EVENT_INFO_DATA_SIZE_MAX = 4, EVENT_INFO_CUSTOM_ID = 1000 }
	Event info command. More...

enum	EVENT_DATA_INFO_CMD_LIST { EVENT_DATA_ID = 0, EVENT_DATA_VALUE = 1, EVENT_DATA_NUMID = 2, EVENT_DATA_CUSTOM_ID = 1000 }
	Event data info command. More...

Functions
GC_API	GCGetInfo (TL_INFO_CMD iInfoCmd, INFO_DATATYPE piType, void pBuffer, size_t *piSize)

GC_API	GCGetLastError (GC_ERROR piErrorCode, char sErrText, size_t *piSize)

GC_API	GCInitLib (void)

GC_API	GCCloseLib (void)

GC_API	GCReadPort (PORT_HANDLE hPort, uint64_t iAddress, void pBuffer, size_t piSize)

GC_API	GCWritePort (PORT_HANDLE hPort, uint64_t iAddress, const void pBuffer, size_t piSize)

GC_API	GCGetPortURL (PORT_HANDLE hPort, char sURL, size_t piSize)

GC_API	GCGetPortInfo (PORT_HANDLE hPort, PORT_INFO_CMD iInfoCmd, INFO_DATATYPE piType, void pBuffer, size_t *piSize)

GC_API	GCRegisterEvent (EVENTSRC_HANDLE hEventSrc, EVENT_TYPE iEventID, EVENT_HANDLE *phEvent)

GC_API	GCUnregisterEvent (EVENTSRC_HANDLE hEventSrc, EVENT_TYPE iEventID)

GC_API	EventGetData (EVENT_HANDLE hEvent, void pBuffer, size_t piSize, uint64_t iTimeout)

GC_API	EventGetDataInfo (EVENT_HANDLE hEvent, const void pInBuffer, size_t iInSize, EVENT_DATA_INFO_CMD iInfoCmd, INFO_DATATYPE piType, void pOutBuffer, size_t piOutSize)

GC_API	EventGetInfo (EVENT_HANDLE hEvent, EVENT_INFO_CMD iInfoCmd, INFO_DATATYPE piType, void pBuffer, size_t *piSize)

GC_API	EventFlush (EVENT_HANDLE hEvent)

GC_API	EventKill (EVENT_HANDLE hEvent)

GC_API	TLOpen (TL_HANDLE *phTL)

GC_API	TLClose (TL_HANDLE hTL)

GC_API	TLGetInfo (TL_HANDLE hTL, TL_INFO_CMD iInfoCmd, INFO_DATATYPE piType, void pBuffer, size_t *piSize)

GC_API	TLGetNumInterfaces (TL_HANDLE hTL, uint32_t *piNumIfaces)

GC_API	TLGetInterfaceID (TL_HANDLE hTL, uint32_t iIndex, char sID, size_t piSize)

GC_API	TLGetInterfaceInfo (TL_HANDLE hTL, const char sIfaceID, INTERFACE_INFO_CMD iInfoCmd, INFO_DATATYPE piType, void pBuffer, size_t piSize)

GC_API	TLOpenInterface (TL_HANDLE hTL, const char sIfaceID, IF_HANDLE phIface)

GC_API	TLUpdateInterfaceList (TL_HANDLE hTL, bool8_t *pbChanged, uint64_t iTimeout)

GC_API	IFClose (IF_HANDLE hIface)

GC_API	IFGetInfo (IF_HANDLE hIface, INTERFACE_INFO_CMD iInfoCmd, INFO_DATATYPE piType, void pBuffer, size_t *piSize)

GC_API	IFGetNumDevices (IF_HANDLE hIface, uint32_t *piNumDevices)

GC_API	IFGetDeviceID (IF_HANDLE hIface, uint32_t iIndex, char sIDeviceID, size_t piSize)

GC_API	IFUpdateDeviceList (IF_HANDLE hIface, bool8_t *pbChanged, uint64_t iTimeout)

GC_API	IFGetDeviceInfo (IF_HANDLE hIface, const char sDeviceID, DEVICE_INFO_CMD iInfoCmd, INFO_DATATYPE piType, void pBuffer, size_t piSize)

GC_API	IFOpenDevice (IF_HANDLE hIface, const char sDeviceID, DEVICE_ACCESS_FLAGS iOpenFlags, DEV_HANDLE phDevice)

GC_API	DevGetPort (DEV_HANDLE hDevice, PORT_HANDLE *phRemoteDevice)

GC_API	DevGetNumDataStreams (DEV_HANDLE hDevice, uint32_t *piNumDataStreams)

GC_API	DevGetDataStreamID (DEV_HANDLE hDevice, uint32_t iIndex, char sDataStreamID, size_t piSize)

GC_API	DevOpenDataStream (DEV_HANDLE hDevice, const char sDataStreamID, DS_HANDLE phDataStream)

GC_API	DevGetInfo (DEV_HANDLE hDevice, DEVICE_INFO_CMD iInfoCmd, INFO_DATATYPE piType, void pBuffer, size_t *piSize)

GC_API	DevClose (DEV_HANDLE hDevice)

GC_API	DSAnnounceBuffer (DS_HANDLE hDataStream, void pBuffer, size_t iSize, void pPrivate, BUFFER_HANDLE *phBuffer)

GC_API	DSAllocAndAnnounceBuffer (DS_HANDLE hDataStream, size_t iSize, void pPrivate, BUFFER_HANDLE phBuffer)

GC_API	DSFlushQueue (DS_HANDLE hDataStream, ACQ_QUEUE_TYPE iOperation)

GC_API	DSStartAcquisition (DS_HANDLE hDataStream, ACQ_START_FLAGS iStartFlags, uint64_t iNumToAcquire)

GC_API	DSStopAcquisition (DS_HANDLE hDataStream, ACQ_STOP_FLAGS iStopFlags)

GC_API	DSGetInfo (DS_HANDLE hDataStream, STREAM_INFO_CMD iInfoCmd, INFO_DATATYPE piType, void pBuffer, size_t *piSize)

GC_API	DSGetBufferID (DS_HANDLE hDataStream, uint32_t iIndex, BUFFER_HANDLE *phBuffer)

GC_API	DSClose (DS_HANDLE hDataStream)

GC_API	DSRevokeBuffer (DS_HANDLE hDataStream, BUFFER_HANDLE hBuffer, void pBuffer, void pPrivate)

GC_API	DSQueueBuffer (DS_HANDLE hDataStream, BUFFER_HANDLE hBuffer)

GC_API	DSGetBufferInfo (DS_HANDLE hDataStream, BUFFER_HANDLE hBuffer, BUFFER_INFO_CMD iInfoCmd, INFO_DATATYPE piType, void pBuffer, size_t *piSize)

GC_API	GCGetNumPortURLs (PORT_HANDLE hPort, uint32_t *piNumURLs)

GC_API	GCGetPortURLInfo (PORT_HANDLE hPort, uint32_t iURLIndex, URL_INFO_CMD iInfoCmd, INFO_DATATYPE piType, void pBuffer, size_t *piSize)

GC_API	GCReadPortStacked (PORT_HANDLE hPort, PORT_REGISTER_STACK_ENTRY pEntries, size_t piNumEntries)

GC_API	GCWritePortStacked (PORT_HANDLE hPort, PORT_REGISTER_STACK_ENTRY pEntries, size_t piNumEntries)

GC_API	DSGetBufferChunkData (DS_HANDLE hDataStream, BUFFER_HANDLE hBuffer, SINGLE_CHUNK_DATA pChunkData, size_t piNumChunks)

GC_API	IFGetParentTL (IF_HANDLE hIface, TL_HANDLE *phSystem)

GC_API	DevGetParentIF (DEV_HANDLE hDevice, IF_HANDLE *phIface)

GC_API	DSGetParentDev (DS_HANDLE hDataStream, DEV_HANDLE *phDevice)

GC_API	DSGetNumBufferParts (DS_HANDLE hDataStream, BUFFER_HANDLE hBuffer, uint32_t *piNumParts)

GC_API	DSGetBufferPartInfo (DS_HANDLE hDataStream, BUFFER_HANDLE hBuffer, uint32_t iPartIndex, BUFFER_PART_INFO_CMD iInfoCmd, INFO_DATATYPE piType, void pBuffer, size_t *piSize)

GC_API_P()	PGCGetInfo (TL_INFO_CMD iInfoCmd, INFO_DATATYPE piType, void pBuffer, size_t *piSize)

GC_API_P()	PGCGetLastError (GC_ERROR piErrorCode, char sErrText, size_t *piSize)

GC_API_P()	PGCInitLib (void)

GC_API_P()	PGCCloseLib (void)

GC_API_P()	PGCReadPort (PORT_HANDLE hPort, uint64_t iAddress, void pBuffer, size_t piSize)

GC_API_P()	PGCWritePort (PORT_HANDLE hPort, uint64_t iAddress, const void pBuffer, size_t piSize)

GC_API_P()	PGCGetPortURL (PORT_HANDLE hPort, char sURL, size_t piSize)

GC_API_P()	PGCGetPortInfo (PORT_HANDLE hPort, PORT_INFO_CMD iInfoCmd, INFO_DATATYPE piType, void pBuffer, size_t *piSize)

GC_API_P()	PGCRegisterEvent (EVENTSRC_HANDLE hEventSrc, EVENT_TYPE iEventID, EVENT_HANDLE *phEvent)

GC_API_P()	PGCUnregisterEvent (EVENTSRC_HANDLE hEventSrc, EVENT_TYPE iEventID)

GC_API_P()	PEventGetData (EVENT_HANDLE hEvent, void pBuffer, size_t piSize, uint64_t iTimeout)

GC_API_P()	PEventGetDataInfo (EVENT_HANDLE hEvent, const void pInBuffer, size_t iInSize, EVENT_DATA_INFO_CMD iInfoCmd, INFO_DATATYPE piType, void pOutBuffer, size_t piOutSize)

GC_API_P()	PEventGetInfo (EVENT_HANDLE hEvent, EVENT_INFO_CMD iInfoCmd, INFO_DATATYPE piType, void pBuffer, size_t *piSize)

GC_API_P()	PEventFlush (EVENT_HANDLE hEvent)

GC_API_P()	PEventKill (EVENT_HANDLE hEvent)

GC_API_P()	PTLOpen (TL_HANDLE *phTL)

GC_API_P()	PTLClose (TL_HANDLE hTL)

GC_API_P()	PTLGetInfo (TL_HANDLE hTL, TL_INFO_CMD iInfoCmd, INFO_DATATYPE piType, void pBuffer, size_t *piSize)

GC_API_P()	PTLGetNumInterfaces (TL_HANDLE hTL, uint32_t *piNumIfaces)

GC_API_P()	PTLGetInterfaceID (TL_HANDLE hTL, uint32_t iIndex, char sID, size_t piSize)

GC_API_P()	PTLGetInterfaceInfo (TL_HANDLE hTL, const char sIfaceID, INTERFACE_INFO_CMD iInfoCmd, INFO_DATATYPE piType, void pBuffer, size_t piSize)

GC_API_P()	PTLOpenInterface (TL_HANDLE hTL, const char sIfaceID, IF_HANDLE phIface)

GC_API_P()	PTLUpdateInterfaceList (TL_HANDLE hTL, bool8_t *pbChanged, uint64_t iTimeout)

GC_API_P()	PIFClose (IF_HANDLE hIface)

GC_API_P()	PIFGetInfo (IF_HANDLE hIface, INTERFACE_INFO_CMD iInfoCmd, INFO_DATATYPE piType, void pBuffer, size_t *piSize)

GC_API_P()	PIFGetNumDevices (IF_HANDLE hIface, uint32_t *piNumDevices)

GC_API_P()	PIFGetDeviceID (IF_HANDLE hIface, uint32_t iIndex, char sIDeviceID, size_t piSize)

GC_API_P()	PIFUpdateDeviceList (IF_HANDLE hIface, bool8_t *pbChanged, uint64_t iTimeout)

GC_API_P()	PIFGetDeviceInfo (IF_HANDLE hIface, const char sDeviceID, DEVICE_INFO_CMD iInfoCmd, INFO_DATATYPE piType, void pBuffer, size_t piSize)

GC_API_P()	PIFOpenDevice (IF_HANDLE hIface, const char sDeviceID, DEVICE_ACCESS_FLAGS iOpenFlags, DEV_HANDLE phDevice)

GC_API_P()	PDevGetPort (DEV_HANDLE hDevice, PORT_HANDLE *phRemoteDevice)

GC_API_P()	PDevGetNumDataStreams (DEV_HANDLE hDevice, uint32_t *piNumDataStreams)

GC_API_P()	PDevGetDataStreamID (DEV_HANDLE hDevice, uint32_t iIndex, char sDataStreamID, size_t piSize)

GC_API_P()	PDevOpenDataStream (DEV_HANDLE hDevice, const char sDataStreamID, DS_HANDLE phDataStream)

GC_API_P()	PDevGetInfo (DEV_HANDLE hDevice, DEVICE_INFO_CMD iInfoCmd, INFO_DATATYPE piType, void pBuffer, size_t *piSize)

GC_API_P()	PDevClose (DEV_HANDLE hDevice)

GC_API_P()	PDSAnnounceBuffer (DS_HANDLE hDataStream, void pBuffer, size_t iSize, void pPrivate, BUFFER_HANDLE *phBuffer)

GC_API_P()	PDSAllocAndAnnounceBuffer (DS_HANDLE hDataStream, size_t iSize, void pPrivate, BUFFER_HANDLE phBuffer)

GC_API_P()	PDSFlushQueue (DS_HANDLE hDataStream, ACQ_QUEUE_TYPE iOperation)

GC_API_P()	PDSStartAcquisition (DS_HANDLE hDataStream, ACQ_START_FLAGS iStartFlags, uint64_t iNumToAcquire)

GC_API_P()	PDSStopAcquisition (DS_HANDLE hDataStream, ACQ_STOP_FLAGS iStopFlags)

GC_API_P()	PDSGetInfo (DS_HANDLE hDataStream, STREAM_INFO_CMD iInfoCmd, INFO_DATATYPE piType, void pBuffer, size_t *piSize)

GC_API_P()	PDSGetBufferID (DS_HANDLE hDataStream, uint32_t iIndex, BUFFER_HANDLE *phBuffer)

GC_API_P()	PDSClose (DS_HANDLE hDataStream)

GC_API_P()	PDSRevokeBuffer (DS_HANDLE hDataStream, BUFFER_HANDLE hBuffer, void pBuffer, void pPrivate)

GC_API_P()	PDSQueueBuffer (DS_HANDLE hDataStream, BUFFER_HANDLE hBuffer)

GC_API_P()	PDSGetBufferInfo (DS_HANDLE hDataStream, BUFFER_HANDLE hBuffer, BUFFER_INFO_CMD iInfoCmd, INFO_DATATYPE piType, void pBuffer, size_t *piSize)

GC_API_P()	PGCGetNumPortURLs (PORT_HANDLE hPort, uint32_t *iNumURLs)

GC_API_P()	PGCGetPortURLInfo (PORT_HANDLE hPort, uint32_t iURLIndex, URL_INFO_CMD iInfoCmd, INFO_DATATYPE piType, void pBuffer, size_t *piSize)

GC_API_P()	PGCReadPortStacked (PORT_HANDLE hPort, PORT_REGISTER_STACK_ENTRY pEntries, size_t piNumEntries)

GC_API_P()	PGCWritePortStacked (PORT_HANDLE hPort, PORT_REGISTER_STACK_ENTRY pEntries, size_t piNumEntries)

GC_API_P()	PDSGetBufferChunkData (DS_HANDLE hDataStream, BUFFER_HANDLE hBuffer, SINGLE_CHUNK_DATA pChunkData, size_t piNumChunks)

GC_API_P()	PIFGetParentTL (IF_HANDLE hIface, TL_HANDLE *phSystem)

GC_API_P()	PDevGetParentIF (DEV_HANDLE hDevice, IF_HANDLE *phIface)

GC_API_P()	PDSGetParentDev (DS_HANDLE hDataStream, DEV_HANDLE *phDevice)

GC_API_P()	PDSGetNumBufferParts (DS_HANDLE hDataStream, BUFFER_HANDLE hBuffer, uint32_t *piNumParts)

GC_API_P()	PDSGetBufferPartInfo (DS_HANDLE hDataStream, BUFFER_HANDLE hBuffer, uint32_t iPartIndex, BUFFER_PART_INFO_CMD iInfoCmd, INFO_DATATYPE piType, void pBuffer, size_t *piSize)

Class Documentation

◆ GenTL::S_EVENT_NEW_BUFFER

struct GenTL::S_EVENT_NEW_BUFFER

Structure of the data returned from a signaled "New Buffer" event.

Class Members
BUFFER_HANDLE	BufferHandle	Buffer handle which contains new data.
void *	pUserPointer	User pointer provided at announcement of the buffer.

◆ GenTL::S_PORT_REGISTER_STACK_ENTRY

struct GenTL::S_PORT_REGISTER_STACK_ENTRY

Structure to be use with GCWritePortStacked and GCReadPortStacked.

Class Members
uint64_t	Address	Address of the register.
void *	pBuffer	Pointer to the buffer containing the data.
size_t	Size	Number of bytes to read write.

◆ GenTL::S_SINGLE_CHUNK_DATA

struct GenTL::S_SINGLE_CHUNK_DATA

Structure carrying information about a single chunk in the buffer.

Class Members
uint64_t	ChunkID	Numeric representation of ChunkID.
ptrdiff_t	ChunkOffset	Chunk offset in the buffer.
size_t	ChunkLength	Size of the chunk data.

Typedef Documentation

◆ GC_ERROR

typedef int32_t GC_ERROR

◆ TL_HANDLE

typedef void* TL_HANDLE

Transport Layer handle, obtained through the TLOpen.

◆ IF_HANDLE

typedef void* IF_HANDLE

Interface handle, obtained through TLOpenInterface.

◆ DEV_HANDLE

typedef void* DEV_HANDLE

Device Handle, obtained through the IFOpenDevice.

◆ DS_HANDLE

typedef void* DS_HANDLE

Handle to an image stream object, obtained through DevOpenDataStream.

◆ PORT_HANDLE

typedef void* PORT_HANDLE

A Port handle is used to access the register space of a port.

a PORT_HANDLE can be one of the following TL_HANDLE, IF_HANDLE, DEV_HANDLE, handle to a device port, obtained through DevGetPort, DS_HANDLE, BUFFER_HANDLE

◆ BUFFER_HANDLE

typedef void* BUFFER_HANDLE

BufferHandle, obtained through the DSAnnounceBuffer function.

◆ EVENTSRC_HANDLE

typedef void* EVENTSRC_HANDLE

A Event source handle is used to register a OS Event and to retrieve a GenTL event handle.

a EVENTSRC_HANDLE can be on of the following TL_HANDLE, IF_HANDLE, DEV_HANDLE, A handle to a device port, obtained through DevGetPort DS_HANDLE, BUFFER_HANDLE

◆ EVENT_HANDLE

typedef void* EVENT_HANDLE

Event Handle.

◆ INFO_DATATYPE

typedef int32_t INFO_DATATYPE

◆ TL_CHAR_ENCODING

typedef int32_t TL_CHAR_ENCODING

◆ TL_INFO_CMD

typedef int32_t TL_INFO_CMD

◆ INTERFACE_INFO_CMD

typedef int32_t INTERFACE_INFO_CMD

◆ DEVICE_ACCESS_FLAGS

typedef int32_t DEVICE_ACCESS_FLAGS

◆ DEVICE_ACCESS_STATUS

typedef int32_t DEVICE_ACCESS_STATUS

◆ DEVICE_INFO_CMD

typedef int32_t DEVICE_INFO_CMD

◆ ACQ_STOP_FLAGS

typedef int32_t ACQ_STOP_FLAGS

◆ ACQ_START_FLAGS

typedef int32_t ACQ_START_FLAGS

◆ ACQ_QUEUE_TYPE

typedef int32_t ACQ_QUEUE_TYPE

◆ STREAM_INFO_CMD

typedef int32_t STREAM_INFO_CMD

◆ BUFFER_INFO_CMD

typedef int32_t BUFFER_INFO_CMD

◆ BUFFER_PART_INFO_CMD

typedef int32_t BUFFER_PART_INFO_CMD

◆ PAYLOADTYPE_INFO_ID

typedef int32_t PAYLOADTYPE_INFO_ID

◆ PIXELFORMAT_NAMESPACE_ID

typedef int32_t PIXELFORMAT_NAMESPACE_ID

◆ PIXELENDIANNESS_ID

typedef int32_t PIXELENDIANNESS_ID

◆ PARTDATATYPE_ID

typedef int32_t PARTDATATYPE_ID

◆ PORT_INFO_CMD

typedef int32_t PORT_INFO_CMD

◆ URL_SCHEME_ID

typedef int32_t URL_SCHEME_ID

◆ URL_INFO_CMD

typedef int32_t URL_INFO_CMD

◆ EVENT_TYPE

typedef int32_t EVENT_TYPE

◆ EVENT_INFO_CMD

typedef int32_t EVENT_INFO_CMD

◆ EVENT_DATA_INFO_CMD

typedef int32_t EVENT_DATA_INFO_CMD

◆ EVENT_NEW_BUFFER_DATA

typedef struct GenTL::S_EVENT_NEW_BUFFER EVENT_NEW_BUFFER_DATA

Structure of the data returned from a signaled "New Buffer" event.

◆ PORT_REGISTER_STACK_ENTRY

typedef struct GenTL::S_PORT_REGISTER_STACK_ENTRY PORT_REGISTER_STACK_ENTRY

Structure to be use with GCWritePortStacked and GCReadPortStacked.

◆ SINGLE_CHUNK_DATA

typedef struct GenTL::S_SINGLE_CHUNK_DATA SINGLE_CHUNK_DATA

Structure carrying information about a single chunk in the buffer.

Enumeration Type Documentation

◆ GC_ERROR_LIST

enum GC_ERROR_LIST

Errors.

Enumerator
GC_ERR_SUCCESS	No Error.
GC_ERR_ERROR	Unspecified runtime error.
GC_ERR_NOT_INITIALIZED	Module or resource is not initialized.
GC_ERR_NOT_IMPLEMENTED	Requested operation is not implemented.
GC_ERR_RESOURCE_IN_USE	Requested resource is already in use.
GC_ERR_ACCESS_DENIED	Requested operation is not allowed.
GC_ERR_INVALID_HANDLE	Given handle does not support the operation.
GC_ERR_INVALID_ID	ID could not be connected to a resource.
GC_ERR_NO_DATA	The function has no data to work on.
GC_ERR_INVALID_PARAMETER	One of the parameters given was not valid.
GC_ERR_IO	Communication error has occurred.
GC_ERR_TIMEOUT	Timeout expired before the operation could be completed.
GC_ERR_ABORT	An operation has been aborted before it could be completed.
GC_ERR_INVALID_BUFFER	The GenTL Consumer has not announced enough buffers.
GC_ERR_NOT_AVAILABLE	Resource or information is not available.
GC_ERR_INVALID_ADDRESS	A given address is out of range or invalid.
GC_ERR_BUFFER_TOO_SMALL	A provided buffer is too small to receive the expected amount of data.
GC_ERR_INVALID_INDEX	A provided index referencing a Producer internal object is out of bounds.
GC_ERR_PARSING_CHUNK_DATA	An error occurred parsing a buffer containing chunk data.
GC_ERR_INVALID_VALUE	A register write function was trying to write an invalid value.
GC_ERR_RESOURCE_EXHAUSTED	A requested resource is exhausted.
GC_ERR_OUT_OF_MEMORY	The system ran out of memory.
GC_ERR_BUSY	Requested operation cannot be performed (module or resource is busy)
GC_ERR_CUSTOM_ID	Starting value for custom IDs.

◆ INFO_DATATYPE_LIST

enum INFO_DATATYPE_LIST

Defines the data type possible for the various Info functions.

Enumerator
INFO_DATATYPE_UNKNOWN	Unknown data type.
INFO_DATATYPE_STRING	NULL-terminated C string (ASCII encoded).
INFO_DATATYPE_STRINGLIST	Concatenated INFO_DATATYPE_STRING list. End of list is signaled with an additional NULL.
INFO_DATATYPE_INT16	Signed 16 bit integer.
INFO_DATATYPE_UINT16	Unsigned 16 bit integer.
INFO_DATATYPE_INT32	Signed 32 bit integer.
INFO_DATATYPE_UINT32	Unsigned 32 bit integer.
INFO_DATATYPE_INT64	Signed 64 bit integer.
INFO_DATATYPE_UINT64	Unsigned 64 bit integer.
INFO_DATATYPE_FLOAT64	Signed 64 bit floating point number.
INFO_DATATYPE_PTR	Pointer type (void*). Size is platform dependent (32 bit on 32 bit platforms).
INFO_DATATYPE_BOOL8	Boolean value occupying 8 bit. 0 for false and anything for true.
INFO_DATATYPE_SIZET	Platform dependent unsigned integer (32 bit on 32 bit platforms).
INFO_DATATYPE_BUFFER	Like a INFO_DATATYPE_STRING but with arbitrary data and no NULL termination.
INFO_DATATYPE_PTRDIFF	Platform dependent signed integer (32 bit on 32 bit platforms).
INFO_DATATYPE_CUSTOM_ID	Starting value for custom IDs.

◆ TL_CHAR_ENCODING_LIST

enum TL_CHAR_ENCODING_LIST

Defines char encoding schemes used by the producer.

Enumerator
TL_CHAR_ENCODING_ASCII
TL_CHAR_ENCODING_UTF8

◆ TL_INFO_CMD_LIST

enum TL_INFO_CMD_LIST

System module information commands for the GenICam::TL::Client::TLGetInfo and GenICam::TL::Client::GCGetInfo functions.

Enumerator
TL_INFO_ID	STRING Transport layer ID.
TL_INFO_VENDOR	STRING Transport layer vendor name.
TL_INFO_MODEL	STRING Transport layer model name.
TL_INFO_VERSION	STRING Transport layer version.
TL_INFO_TLTYPE	STRING Transport layer technology that is supported.
TL_INFO_NAME	STRING File name including extension of the library.
TL_INFO_PATHNAME	STRING Full path including file name and extension of the library.
TL_INFO_DISPLAYNAME	STRING User readable name of the device. If this is not defined in the device this should be VENDOR MODEL (ID).
TL_INFO_CHAR_ENCODING	INT32 Reporting the char encoding used by this Producer.
TL_INFO_GENTL_VER_MAJOR	UINT32 Major number of the GenTL spec this producer complies with.
TL_INFO_GENTL_VER_MINOR	UINT32 Minor number of the GenTL spec this producer complies with.
TL_INFO_CUSTOM_ID	Starting value for custom IDs.

◆ INTERFACE_INFO_CMD_LIST

enum INTERFACE_INFO_CMD_LIST

This enumeration defines commands to retrieve information with the GenICam::TL::Client::IFGetInfo function from the Interface module.

Enumerator
INTERFACE_INFO_ID	STRING Unique ID of the interface.
INTERFACE_INFO_DISPLAYNAME	STRING User readable name of the interface.
INTERFACE_INFO_TLTYPE	STRING Transport layer technology that is supported.
INTERFACE_INFO_CUSTOM_ID	Starting value for GenTL Producer custom IDs.

◆ DEVICE_ACCESS_FLAGS_LIST

enum DEVICE_ACCESS_FLAGS_LIST

This enumeration defines flags of how a device is to be opened with the GenICam::TL::Client::IFOpenDevice function.

Enumerator
DEVICE_ACCESS_UNKNOWN	Not used in a command. Can be used to initialize a variable to query that information.
DEVICE_ACCESS_NONE	This either means that the device is not open because it was not opened before or the access to it was denied.
DEVICE_ACCESS_READONLY	Open the device read only. All Port functions can only read from the device.
DEVICE_ACCESS_CONTROL	Open the device in a way that other hosts/processes can have read only access to the device. Device access level is read/write for this process.
DEVICE_ACCESS_EXCLUSIVE	Open the device in a way that only this host/process can have access to the device. Device access level is read/write for this process.
DEVICE_ACCESS_CUSTOM_ID	Starting value for GenTL Producer custom IDs.

◆ DEVICE_ACCESS_STATUS_LIST

enum DEVICE_ACCESS_STATUS_LIST

This enumeration defines values for the accessibility of the device to be returned in the GenICam::TL::Client::DevGetInfo function on a device handle.

Enumerator
DEVICE_ACCESS_STATUS_UNKNOWN	The device accessibility is not known.
DEVICE_ACCESS_STATUS_READWRITE	The device is available for read/write access.
DEVICE_ACCESS_STATUS_READONLY	The device is available for read only access.
DEVICE_ACCESS_STATUS_NOACCESS	The device is not accessible.
DEVICE_ACCESS_STATUS_BUSY	The device has already been opened by another process/host.
DEVICE_ACCESS_STATUS_OPEN_READWRITE	The device has already been opened by this process.
DEVICE_ACCESS_STATUS_OPEN_READONLY	The device has already been opened by this process.
DEVICE_ACCESS_STATUS_CUSTOM_ID	Starting value for custom IDs.

◆ DEVICE_INFO_CMD_LIST

enum DEVICE_INFO_CMD_LIST

This enumeration defines commands to retrieve information with the GenICam::TL::Client::DevGetInfo function on a device handle.

Enumerator
DEVICE_INFO_ID	STRING Unique ID of the device.
DEVICE_INFO_VENDOR	STRING Device vendor name.
DEVICE_INFO_MODEL	STRING Device model name.
DEVICE_INFO_TLTYPE	STRING Transport layer technology that is supported.
DEVICE_INFO_DISPLAYNAME	STRING String containing a display name for the device ( including a unique id )
DEVICE_INFO_ACCESS_STATUS	INT32 Gets the access mode the GenTL Producer has on the opened device. (DEVICE_ACCESS_STATUS enumeration value).
DEVICE_INFO_USER_DEFINED_NAME	STRING String containing the user defined name.
DEVICE_INFO_SERIAL_NUMBER	STRING String containing the device's serial number.
DEVICE_INFO_VERSION	STRING String containing the device version.
DEVICE_INFO_TIMESTAMP_FREQUENCY	UINT64 Tick-frequency of the time stamp clock.
DEVICE_INFO_CUSTOM_ID	Starting value for GenTL Producer custom IDs.

◆ ACQ_STOP_FLAGS_LIST

enum ACQ_STOP_FLAGS_LIST

This enumeration defines special stop flags for the acquisition engine.

The function used is GenICam::TL::Client::DSStopAcquisition.

Enumerator
ACQ_STOP_FLAGS_DEFAULT	Stop the acquisition engine when the currently running tasks like filling a buffer are completed (default behavior).
ACQ_STOP_FLAGS_KILL	Stop the acquisition engine immediately and leave buffers currently being filled in the Input Buffer Pool.
ACQ_STOP_FLAGS_CUSTOM_ID	Starting value for GenTL Producer custom IDs.

◆ ACQ_START_FLAGS_LIST

enum ACQ_START_FLAGS_LIST

This enumeration defines special start flags for the acquisition engine.

The function used is GenICam::TL::Client::DSStartAcquisition.

Enumerator
ACQ_START_FLAGS_DEFAULT	Default behavior.
ACQ_START_FLAGS_CUSTOM_ID	Starting value for GenTL Producer custom IDs.

◆ ACQ_QUEUE_TYPE_LIST

enum ACQ_QUEUE_TYPE_LIST

This enumeration commands from which to which queue/pool buffers are flushed with the GenICam::TL::Client::DSFlushQueue function.

Enumerator
ACQ_QUEUE_INPUT_TO_OUTPUT	Flushes the input pool to the output queue and if necessary adds entries in the New Buffer event data queue.
ACQ_QUEUE_OUTPUT_DISCARD	Discards all buffers in the output queue and if necessary remove the entries from the event data queue.
ACQ_QUEUE_ALL_TO_INPUT	Puts all buffers in the input pool. Even those in the output queue and discard entries in the event data queue.
ACQ_QUEUE_UNQUEUED_TO_INPUT	Puts all buffers that are not in the input pool or the output queue in the input pool.
ACQ_QUEUE_ALL_DISCARD	Discards all buffers in the input pool and output queue.
ACQ_QUEUE_CUSTOM_ID	Starting value for GenTL Producer custom IDs.

◆ STREAM_INFO_CMD_LIST

enum STREAM_INFO_CMD_LIST

This enumeration defines commands to retrieve information with the GenICam::TL::Client::DSGetInfo function on a data stream handle.

Enumerator
STREAM_INFO_ID	STRING Unique ID of the data stream.
STREAM_INFO_NUM_DELIVERED	UINT64 Number of delivered buffers since last acquisition start.
STREAM_INFO_NUM_UNDERRUN	UINT64 Number of lost buffers due to queue underrun.
STREAM_INFO_NUM_ANNOUNCED	SIZET Number of announced buffers.
STREAM_INFO_NUM_QUEUED	SIZET Number of buffers in the input pool.
STREAM_INFO_NUM_AWAIT_DELIVERY	SIZET Number of buffers in the output queue.
STREAM_INFO_NUM_STARTED	UINT64 Number of buffers started in the acquisition engine.
STREAM_INFO_PAYLOAD_SIZE	SIZET Size of the expected data in bytes.
STREAM_INFO_IS_GRABBING	BOOL8 Flag indicating whether the acquisition engine is started or not.
STREAM_INFO_DEFINES_PAYLOADSIZE	BOOL8 Flag that indicated that this data stream defines a payload size independent from the remote device.
STREAM_INFO_TLTYPE	STRING Transport layer technology that is supported.
STREAM_INFO_NUM_CHUNKS_MAX	SIZET Max number of chunks in a buffer, if known.
STREAM_INFO_BUF_ANNOUNCE_MIN	SIZET Min number of buffers to announce before acq can start, if known.
STREAM_INFO_BUF_ALIGNMENT	SIZET Buffer alignment in bytes.
STREAM_INFO_CUSTOM_ID	Starting value for GenTL Producer custom IDs.

◆ BUFFER_INFO_CMD_LIST

enum BUFFER_INFO_CMD_LIST

This enumeration defines commands to retrieve information with the GenICam::TL::Client::DSGetBufferInfo function on a buffer handle.

Enumerator
BUFFER_INFO_BASE	PTR Base address of the buffer memory.
BUFFER_INFO_SIZE	SIZET Size of the buffer in bytes.
BUFFER_INFO_USER_PTR	PTR Private data pointer of the GenTL Consumer.
BUFFER_INFO_TIMESTAMP	UINT64 Timestamp the buffer was acquired.
BUFFER_INFO_NEW_DATA	BOOL8 Flag to indicate that the buffer contains new data since the last call.
BUFFER_INFO_IS_QUEUED	BOOL8 Flag to indicate if the buffer is in the input pool or output queue.
BUFFER_INFO_IS_ACQUIRING	BOOL8 Flag to indicate that the buffer is currently being filled with data.
BUFFER_INFO_IS_INCOMPLETE	BOOL8 Flag to indicate that a buffer was filled but an error occurred during that process.
BUFFER_INFO_TLTYPE	STRING Transport layer technology that is supported.
BUFFER_INFO_SIZE_FILLED	SIZET Number of bytes written into the buffer last time it has been filled. This value is reset to 0 when the buffer is placed into the Input Buffer Pool.
BUFFER_INFO_WIDTH	SIZET
BUFFER_INFO_HEIGHT	SIZET
BUFFER_INFO_XOFFSET	SIZET
BUFFER_INFO_YOFFSET	SIZET
BUFFER_INFO_XPADDING	SIZET
BUFFER_INFO_YPADDING	SIZET
BUFFER_INFO_FRAMEID	UINT64
BUFFER_INFO_IMAGEPRESENT	BOOL8
BUFFER_INFO_IMAGEOFFSET	SIZET
BUFFER_INFO_PAYLOADTYPE	SIZET
BUFFER_INFO_PIXELFORMAT	UINT64
BUFFER_INFO_PIXELFORMAT_NAMESPACE	UINT64
BUFFER_INFO_DELIVERED_IMAGEHEIGHT	SIZET
BUFFER_INFO_DELIVERED_CHUNKPAYLOADSIZE	SIZET
BUFFER_INFO_CHUNKLAYOUTID	UINT64
BUFFER_INFO_FILENAME	STRING
BUFFER_INFO_PIXEL_ENDIANNESS	INT32
BUFFER_INFO_DATA_SIZE	SIZET
BUFFER_INFO_TIMESTAMP_NS	UINT64
BUFFER_INFO_DATA_LARGER_THAN_BUFFER	BOOL8
BUFFER_INFO_CONTAINS_CHUNKDATA	BOOL8
BUFFER_INFO_CUSTOM_ID	Starting value for GenTL Producer custom IDs.

◆ BUFFER_PART_INFO_CMD_LIST

enum BUFFER_PART_INFO_CMD_LIST

This enumeration defines commands to retrieve information about individual data parts in a multi-part buffer using the GenICam::TL::Client::DSGetBufferPartInfo function.

Enumerator
BUFFER_PART_INFO_BASE	PTR Base address of the buffer part memory.
BUFFER_PART_INFO_DATA_SIZE	SIZET Size of the buffer part in bytes.
BUFFER_PART_INFO_DATA_TYPE	SIZET Type of the data in given part (PARTDATATYPE_ID enumeration value).
BUFFER_PART_INFO_DATA_FORMAT	UINT64 Format of individual items (such as pixels) in the buffer part.
BUFFER_PART_INFO_DATA_FORMAT_NAMESPACE	UINT64 Allows interpretation of BUFFER_PART_INFO_DATA_FORMAT (PIXELFORMAT_NAMESPACE_ID enumeration value).
BUFFER_PART_INFO_WIDTH	SIZET Width of data in the buffer part in pixels.
BUFFER_PART_INFO_HEIGHT	SIZET Expected height of data in the buffer part in pixels .
BUFFER_PART_INFO_XOFFSET	SIZET Horizontal offset of data in the buffer part in pixels.
BUFFER_PART_INFO_YOFFSET	SIZET Vertical offset of data in the buffer part in pixels.
BUFFER_PART_INFO_XPADDING	SIZET Horizontal padding of data in the buffer part in pixels.
BUFFER_PART_INFO_SOURCE_ID	UINT64 Identifier allowing to group data parts belonging to the same source.
BUFFER_PART_INFO_DELIVERED_IMAGEHEIGHT	SIZET Height of the data currently in the buffer part in pixels.
BUFFER_PART_INFO_CUSTOM_ID	Starting value for GenTL Producer custom IDs.

◆ PAYLOADTYPE_INFO_IDS

enum PAYLOADTYPE_INFO_IDS

Enumeration of TLType dependent payload types.

Enumerator
PAYLOAD_TYPE_UNKNOWN
PAYLOAD_TYPE_IMAGE
PAYLOAD_TYPE_RAW_DATA
PAYLOAD_TYPE_FILE
PAYLOAD_TYPE_CHUNK_DATA	Deprecated in GenTL 1.5.
PAYLOAD_TYPE_JPEG
PAYLOAD_TYPE_JPEG2000
PAYLOAD_TYPE_H264
PAYLOAD_TYPE_CHUNK_ONLY
PAYLOAD_TYPE_DEVICE_SPECIFIC
PAYLOAD_TYPE_MULTI_PART
PAYLOAD_TYPE_CUSTOM_ID	Starting value for GenTL Producer custom IDs.

◆ PIXELFORMAT_NAMESPACE_IDS

enum PIXELFORMAT_NAMESPACE_IDS

Enumeration of TLType dependent pixel format namespaces.

Enumerator
PIXELFORMAT_NAMESPACE_UNKNOWN
PIXELFORMAT_NAMESPACE_GEV
PIXELFORMAT_NAMESPACE_IIDC
PIXELFORMAT_NAMESPACE_PFNC_16BIT
PIXELFORMAT_NAMESPACE_PFNC_32BIT
PIXELFORMAT_NAMESPACE_CUSTOM_ID	Starting value for GenTL Producer custom IDs.

◆ PIXELENDIANNESS_IDS

enum PIXELENDIANNESS_IDS

Enumeration of pixel endianness values.

Enumerator
PIXELENDIANNESS_UNKNOWN	Unknown pixel endianness.
PIXELENDIANNESS_LITTLE	Little endian pixel data.
PIXELENDIANNESS_BIG	Big endian pixel data.

◆ PARTDATATYPE_IDS

enum PARTDATATYPE_IDS

Enumeration describing which data type is present in given buffer part.

Enumerator
PART_DATATYPE_UNKNOWN	Unknown data type.
PART_DATATYPE_2D_IMAGE	Color or monochrome 2D image.
PART_DATATYPE_2D_PLANE_BIPLANAR	Single color plane of a planar 2D image consisting of 2 planes.
PART_DATATYPE_2D_PLANE_TRIPLANAR	Single color plane of a planar 2D image consisting of 3 planes.
PART_DATATYPE_2D_PLANE_QUADPLANAR	Single color plane of a planar 2D image consisting of 4 planes.
PART_DATATYPE_3D_IMAGE	3D image (pixel coordinates).
PART_DATATYPE_3D_PLANE_BIPLANAR	Single plane of a planar 3D image consisting of 2 planes.
PART_DATATYPE_3D_PLANE_TRIPLANAR	Single plane of a planar 3D image consisting of 3 planes.
PART_DATATYPE_3D_PLANE_QUADPLANAR	Single plane of a planar 3D image consisting of 4 planes.
PART_DATATYPE_CONFIDENCE_MAP	Confidence of the individual pixel values.
PART_DATATYPE_CUSTOM_ID	Starting value for GenTL Producer custom IDs.

◆ PORT_INFO_CMD_LIST

enum PORT_INFO_CMD_LIST

This enumeration defines commands to retrieve information with the GenICam::TL::Client::GCGetPortInfo function on a module or remote device handle.

Enumerator
PORT_INFO_ID	STRING Unique ID of the port.
PORT_INFO_VENDOR	STRING Port vendor name.
PORT_INFO_MODEL	STRING Port model name.
PORT_INFO_TLTYPE	STRING Transport layer technology that is supported.
PORT_INFO_MODULE	STRING GenTL Module the port refers to.
PORT_INFO_LITTLE_ENDIAN	BOOL8 Flag indicating that the port data is little endian.
PORT_INFO_BIG_ENDIAN	BOOL8 Flag indicating that the port data is big endian.
PORT_INFO_ACCESS_READ	BOOL8 Port has read access.
PORT_INFO_ACCESS_WRITE	BOOL8 Port has write access.
PORT_INFO_ACCESS_NA	BOOL8 Port is not accessible.
PORT_INFO_ACCESS_NI	BOOL8 Port is not implemented.
PORT_INFO_VERSION	STRING Version of the port.
PORT_INFO_PORTNAME	STRING Name of the port as referenced in the XML description.
PORT_INFO_CUSTOM_ID	Starting value for GenTL Producer custom IDs.

◆ URL_SCHEME_IDS

enum URL_SCHEME_IDS

This enumeration defines enum values returned by the URL_INFO_SCHEME command.

Enumerator
URL_SCHEME_LOCAL	The XML can be read from the local register map.
URL_SCHEME_HTTP	The XML can be downloaded from a http server.
URL_SCHEME_FILE	The XML can be read from the local hard drive.
URL_SCHEME_CUSTOM_ID	Starting value for custom scheme locations.

◆ URL_INFO_CMD_LIST

enum URL_INFO_CMD_LIST

This enumeration defines commands to retrieve information with the GenICam::TL::Client::GCGetPortURLInfo function on a module or remote device handle.

Enumerator
URL_INFO_URL	STRING URL as defined in chapter 4.1.2.
URL_INFO_SCHEMA_VER_MAJOR	INT32 Major version of the schema this URL refers to.
URL_INFO_SCHEMA_VER_MINOR	INT32 Minor version of the schema this URL refers to.
URL_INFO_FILE_VER_MAJOR	INT32 Major version of the XML-file this URL refers to.
URL_INFO_FILE_VER_MINOR	INT32 Minor version of the XML-file this URL refers to.
URL_INFO_FILE_VER_SUBMINOR	INT32 Subminor version of the XML-file this URL refers to.
URL_INFO_FILE_SHA1_HASH	BUFFER 160-bit SHA1 Hash code of XML-file.
URL_INFO_FILE_REGISTER_ADDRESS	UINT64 Register address in the device's register map.
URL_INFO_FILE_SIZE	UINT64 File size in bytes.
URL_INFO_SCHEME	INT32 Scheme of the URL as defined in URL_SCHEME_IDS.
URL_INFO_FILENAME	STRING File name if the scheme of the URL is file.
URL_INFO_CUSTOM_ID	Starting value for GenTL Producer custom IDs.

◆ EVENT_TYPE_LIST

enum EVENT_TYPE_LIST

Known event types that can be registered on certain modules with the GenICam::TL::Client::GCRegisterEvent function.

Enumerator
EVENT_ERROR	Notification on module errors.
EVENT_NEW_BUFFER	Notification on newly filled buffers.
EVENT_FEATURE_INVALIDATE	Notification if a feature was changed by the GenTL Producer library and thus needs to be invalidated in the GenICam GenApi instance using the module.
EVENT_FEATURE_CHANGE	Notification if the GenTL Producer library wants to manually set a feature in the GenICam GenApi instance using the module.
EVENT_REMOTE_DEVICE	Notification if the GenTL Producer wants to inform the GenICam GenApi instance of the remote device that a GenApi compatible event was fired.
EVENT_MODULE	Notification if the GenTL Producer wants to inform the GenICam GenApi instance of the module that a GenApi compatible event was fired.
EVENT_CUSTOM_ID	Starting value for GenTL Producer custom IDs.

◆ EVENT_INFO_CMD_LIST

enum EVENT_INFO_CMD_LIST

Event info command.

Enumerator
EVENT_EVENT_TYPE	INT32 The event type of the event handle (EVENT_TYPE enum value).
EVENT_NUM_IN_QUEUE	SIZET Number of events in the event data queue.
EVENT_NUM_FIRED	UINT64 Number of events that were fired since the creation of the module.
EVENT_SIZE_MAX	SIZET Max size of data carried with an event in bytes.
EVENT_INFO_DATA_SIZE_MAX	SIZET Max size of data provided through EventGetDataInfo in bytes.
EVENT_INFO_CUSTOM_ID	Starting value for GenTL Producer custom IDs.

◆ EVENT_DATA_INFO_CMD_LIST

enum EVENT_DATA_INFO_CMD_LIST

Event data info command.

Enumerator
EVENT_DATA_ID	Event specific Unique Event ID (String or Number)
EVENT_DATA_VALUE	Event specific Data.
EVENT_DATA_NUMID	UINT64 Numeric representation of the unique Event ID.
EVENT_DATA_CUSTOM_ID	Starting value for GenTL Producer custom IDs.

Function Documentation

◆ GCGetInfo()

GC_API GenTL::GCGetInfo	(	TL_INFO_CMD	iInfoCmd,
		INFO_DATATYPE *	piType,
		void *	pBuffer,
		size_t *	piSize
	)

◆ GCGetLastError()

GC_API GenTL::GCGetLastError	(	GC_ERROR *	piErrorCode,
		char *	sErrText,
		size_t *	piSize
	)

◆ GCInitLib()

GC_API GenTL::GCInitLib ( void )

◆ GCCloseLib()

GC_API GenTL::GCCloseLib ( void )

◆ GCReadPort()

GC_API GenTL::GCReadPort	(	PORT_HANDLE	hPort,
		uint64_t	iAddress,
		void *	pBuffer,
		size_t *	piSize
	)

◆ GCWritePort()

GC_API GenTL::GCWritePort	(	PORT_HANDLE	hPort,
		uint64_t	iAddress,
		const void *	pBuffer,
		size_t *	piSize
	)

◆ GCGetPortURL()

GC_API GenTL::GCGetPortURL	(	PORT_HANDLE	hPort,
		char *	sURL,
		size_t *	piSize
	)

◆ GCGetPortInfo()

GC_API GenTL::GCGetPortInfo	(	PORT_HANDLE	hPort,
		PORT_INFO_CMD	iInfoCmd,
		INFO_DATATYPE *	piType,
		void *	pBuffer,
		size_t *	piSize
	)

◆ GCRegisterEvent()

GC_API GenTL::GCRegisterEvent	(	EVENTSRC_HANDLE	hEventSrc,
		EVENT_TYPE	iEventID,
		EVENT_HANDLE *	phEvent
	)

◆ GCUnregisterEvent()

GC_API GenTL::GCUnregisterEvent	(	EVENTSRC_HANDLE	hEventSrc,
		EVENT_TYPE	iEventID
	)

◆ EventGetData()

GC_API GenTL::EventGetData	(	EVENT_HANDLE	hEvent,
		void *	pBuffer,
		size_t *	piSize,
		uint64_t	iTimeout
	)

◆ EventGetDataInfo()

GC_API GenTL::EventGetDataInfo	(	EVENT_HANDLE	hEvent,
		const void *	pInBuffer,
		size_t	iInSize,
		EVENT_DATA_INFO_CMD	iInfoCmd,
		INFO_DATATYPE *	piType,
		void *	pOutBuffer,
		size_t *	piOutSize
	)

◆ EventGetInfo()

GC_API GenTL::EventGetInfo	(	EVENT_HANDLE	hEvent,
		EVENT_INFO_CMD	iInfoCmd,
		INFO_DATATYPE *	piType,
		void *	pBuffer,
		size_t *	piSize
	)

◆ EventFlush()

GC_API GenTL::EventFlush ( EVENT_HANDLE hEvent )

◆ EventKill()

GC_API GenTL::EventKill ( EVENT_HANDLE hEvent )

◆ TLOpen()

GC_API GenTL::TLOpen ( TL_HANDLE * phTL )

◆ TLClose()

GC_API GenTL::TLClose ( TL_HANDLE hTL )

◆ TLGetInfo()

GC_API GenTL::TLGetInfo	(	TL_HANDLE	hTL,
		TL_INFO_CMD	iInfoCmd,
		INFO_DATATYPE *	piType,
		void *	pBuffer,
		size_t *	piSize
	)

◆ TLGetNumInterfaces()

GC_API GenTL::TLGetNumInterfaces	(	TL_HANDLE	hTL,
		uint32_t *	piNumIfaces
	)

◆ TLGetInterfaceID()

GC_API GenTL::TLGetInterfaceID	(	TL_HANDLE	hTL,
		uint32_t	iIndex,
		char *	sID,
		size_t *	piSize
	)

◆ TLGetInterfaceInfo()

GC_API GenTL::TLGetInterfaceInfo	(	TL_HANDLE	hTL,
		const char *	sIfaceID,
		INTERFACE_INFO_CMD	iInfoCmd,
		INFO_DATATYPE *	piType,
		void *	pBuffer,
		size_t *	piSize
	)

◆ TLOpenInterface()

GC_API GenTL::TLOpenInterface	(	TL_HANDLE	hTL,
		const char *	sIfaceID,
		IF_HANDLE *	phIface
	)

◆ TLUpdateInterfaceList()

GC_API GenTL::TLUpdateInterfaceList	(	TL_HANDLE	hTL,
		bool8_t *	pbChanged,
		uint64_t	iTimeout
	)

◆ IFClose()

GC_API GenTL::IFClose ( IF_HANDLE hIface )

◆ IFGetInfo()

GC_API GenTL::IFGetInfo	(	IF_HANDLE	hIface,
		INTERFACE_INFO_CMD	iInfoCmd,
		INFO_DATATYPE *	piType,
		void *	pBuffer,
		size_t *	piSize
	)

◆ IFGetNumDevices()

GC_API GenTL::IFGetNumDevices	(	IF_HANDLE	hIface,
		uint32_t *	piNumDevices
	)

◆ IFGetDeviceID()

GC_API GenTL::IFGetDeviceID	(	IF_HANDLE	hIface,
		uint32_t	iIndex,
		char *	sIDeviceID,
		size_t *	piSize
	)

◆ IFUpdateDeviceList()

GC_API GenTL::IFUpdateDeviceList	(	IF_HANDLE	hIface,
		bool8_t *	pbChanged,
		uint64_t	iTimeout
	)

◆ IFGetDeviceInfo()

GC_API GenTL::IFGetDeviceInfo	(	IF_HANDLE	hIface,
		const char *	sDeviceID,
		DEVICE_INFO_CMD	iInfoCmd,
		INFO_DATATYPE *	piType,
		void *	pBuffer,
		size_t *	piSize
	)

◆ IFOpenDevice()

GC_API GenTL::IFOpenDevice	(	IF_HANDLE	hIface,
		const char *	sDeviceID,
		DEVICE_ACCESS_FLAGS	iOpenFlags,
		DEV_HANDLE *	phDevice
	)

◆ DevGetPort()

GC_API GenTL::DevGetPort	(	DEV_HANDLE	hDevice,
		PORT_HANDLE *	phRemoteDevice
	)

◆ DevGetNumDataStreams()

GC_API GenTL::DevGetNumDataStreams	(	DEV_HANDLE	hDevice,
		uint32_t *	piNumDataStreams
	)

◆ DevGetDataStreamID()

GC_API GenTL::DevGetDataStreamID	(	DEV_HANDLE	hDevice,
		uint32_t	iIndex,
		char *	sDataStreamID,
		size_t *	piSize
	)

◆ DevOpenDataStream()

GC_API GenTL::DevOpenDataStream	(	DEV_HANDLE	hDevice,
		const char *	sDataStreamID,
		DS_HANDLE *	phDataStream
	)

◆ DevGetInfo()

GC_API GenTL::DevGetInfo	(	DEV_HANDLE	hDevice,
		DEVICE_INFO_CMD	iInfoCmd,
		INFO_DATATYPE *	piType,
		void *	pBuffer,
		size_t *	piSize
	)

◆ DevClose()

GC_API GenTL::DevClose ( DEV_HANDLE hDevice )

◆ DSAnnounceBuffer()

GC_API GenTL::DSAnnounceBuffer	(	DS_HANDLE	hDataStream,
		void *	pBuffer,
		size_t	iSize,
		void *	pPrivate,
		BUFFER_HANDLE *	phBuffer
	)

◆ DSAllocAndAnnounceBuffer()

GC_API GenTL::DSAllocAndAnnounceBuffer	(	DS_HANDLE	hDataStream,
		size_t	iSize,
		void *	pPrivate,
		BUFFER_HANDLE *	phBuffer
	)

◆ DSFlushQueue()

GC_API GenTL::DSFlushQueue	(	DS_HANDLE	hDataStream,
		ACQ_QUEUE_TYPE	iOperation
	)

◆ DSStartAcquisition()

GC_API GenTL::DSStartAcquisition	(	DS_HANDLE	hDataStream,
		ACQ_START_FLAGS	iStartFlags,
		uint64_t	iNumToAcquire
	)

◆ DSStopAcquisition()

GC_API GenTL::DSStopAcquisition	(	DS_HANDLE	hDataStream,
		ACQ_STOP_FLAGS	iStopFlags
	)

◆ DSGetInfo()

GC_API GenTL::DSGetInfo	(	DS_HANDLE	hDataStream,
		STREAM_INFO_CMD	iInfoCmd,
		INFO_DATATYPE *	piType,
		void *	pBuffer,
		size_t *	piSize
	)

◆ DSGetBufferID()

GC_API GenTL::DSGetBufferID	(	DS_HANDLE	hDataStream,
		uint32_t	iIndex,
		BUFFER_HANDLE *	phBuffer
	)

◆ DSClose()

GC_API GenTL::DSClose ( DS_HANDLE hDataStream )

◆ DSRevokeBuffer()

GC_API GenTL::DSRevokeBuffer	(	DS_HANDLE	hDataStream,
		BUFFER_HANDLE	hBuffer,
		void **	pBuffer,
		void **	pPrivate
	)

◆ DSQueueBuffer()

GC_API GenTL::DSQueueBuffer	(	DS_HANDLE	hDataStream,
		BUFFER_HANDLE	hBuffer
	)

◆ DSGetBufferInfo()

GC_API GenTL::DSGetBufferInfo	(	DS_HANDLE	hDataStream,
		BUFFER_HANDLE	hBuffer,
		BUFFER_INFO_CMD	iInfoCmd,
		INFO_DATATYPE *	piType,
		void *	pBuffer,
		size_t *	piSize
	)

◆ GCGetNumPortURLs()

GC_API GenTL::GCGetNumPortURLs	(	PORT_HANDLE	hPort,
		uint32_t *	piNumURLs
	)

◆ GCGetPortURLInfo()

GC_API GenTL::GCGetPortURLInfo	(	PORT_HANDLE	hPort,
		uint32_t	iURLIndex,
		URL_INFO_CMD	iInfoCmd,
		INFO_DATATYPE *	piType,
		void *	pBuffer,
		size_t *	piSize
	)

◆ GCReadPortStacked()

GC_API GenTL::GCReadPortStacked	(	PORT_HANDLE	hPort,
		PORT_REGISTER_STACK_ENTRY *	pEntries,
		size_t *	piNumEntries
	)

◆ GCWritePortStacked()

GC_API GenTL::GCWritePortStacked	(	PORT_HANDLE	hPort,
		PORT_REGISTER_STACK_ENTRY *	pEntries,
		size_t *	piNumEntries
	)

◆ DSGetBufferChunkData()

GC_API GenTL::DSGetBufferChunkData	(	DS_HANDLE	hDataStream,
		BUFFER_HANDLE	hBuffer,
		SINGLE_CHUNK_DATA *	pChunkData,
		size_t *	piNumChunks
	)

◆ IFGetParentTL()

GC_API GenTL::IFGetParentTL	(	IF_HANDLE	hIface,
		TL_HANDLE *	phSystem
	)

◆ DevGetParentIF()

GC_API GenTL::DevGetParentIF	(	DEV_HANDLE	hDevice,
		IF_HANDLE *	phIface
	)

◆ DSGetParentDev()

GC_API GenTL::DSGetParentDev	(	DS_HANDLE	hDataStream,
		DEV_HANDLE *	phDevice
	)

◆ DSGetNumBufferParts()

GC_API GenTL::DSGetNumBufferParts	(	DS_HANDLE	hDataStream,
		BUFFER_HANDLE	hBuffer,
		uint32_t *	piNumParts
	)

◆ DSGetBufferPartInfo()

GC_API GenTL::DSGetBufferPartInfo	(	DS_HANDLE	hDataStream,
		BUFFER_HANDLE	hBuffer,
		uint32_t	iPartIndex,
		BUFFER_PART_INFO_CMD	iInfoCmd,
		INFO_DATATYPE *	piType,
		void *	pBuffer,
		size_t *	piSize
	)

◆ PGCGetInfo()

GC_API_P() GenTL::PGCGetInfo	(	TL_INFO_CMD	iInfoCmd,
		INFO_DATATYPE *	piType,
		void *	pBuffer,
		size_t *	piSize
	)

◆ PGCGetLastError()

GC_API_P() GenTL::PGCGetLastError	(	GC_ERROR *	piErrorCode,
		char *	sErrText,
		size_t *	piSize
	)

◆ PGCInitLib()

GC_API_P() GenTL::PGCInitLib ( void )

◆ PGCCloseLib()

GC_API_P() GenTL::PGCCloseLib ( void )

◆ PGCReadPort()

GC_API_P() GenTL::PGCReadPort	(	PORT_HANDLE	hPort,
		uint64_t	iAddress,
		void *	pBuffer,
		size_t *	piSize
	)

◆ PGCWritePort()

GC_API_P() GenTL::PGCWritePort	(	PORT_HANDLE	hPort,
		uint64_t	iAddress,
		const void *	pBuffer,
		size_t *	piSize
	)

◆ PGCGetPortURL()

GC_API_P() GenTL::PGCGetPortURL	(	PORT_HANDLE	hPort,
		char *	sURL,
		size_t *	piSize
	)

◆ PGCGetPortInfo()

GC_API_P() GenTL::PGCGetPortInfo	(	PORT_HANDLE	hPort,
		PORT_INFO_CMD	iInfoCmd,
		INFO_DATATYPE *	piType,
		void *	pBuffer,
		size_t *	piSize
	)

◆ PGCRegisterEvent()

GC_API_P() GenTL::PGCRegisterEvent	(	EVENTSRC_HANDLE	hEventSrc,
		EVENT_TYPE	iEventID,
		EVENT_HANDLE *	phEvent
	)

◆ PGCUnregisterEvent()

GC_API_P() GenTL::PGCUnregisterEvent	(	EVENTSRC_HANDLE	hEventSrc,
		EVENT_TYPE	iEventID
	)

◆ PEventGetData()

GC_API_P() GenTL::PEventGetData	(	EVENT_HANDLE	hEvent,
		void *	pBuffer,
		size_t *	piSize,
		uint64_t	iTimeout
	)

◆ PEventGetDataInfo()

GC_API_P() GenTL::PEventGetDataInfo	(	EVENT_HANDLE	hEvent,
		const void *	pInBuffer,
		size_t	iInSize,
		EVENT_DATA_INFO_CMD	iInfoCmd,
		INFO_DATATYPE *	piType,
		void *	pOutBuffer,
		size_t *	piOutSize
	)

◆ PEventGetInfo()

GC_API_P() GenTL::PEventGetInfo	(	EVENT_HANDLE	hEvent,
		EVENT_INFO_CMD	iInfoCmd,
		INFO_DATATYPE *	piType,
		void *	pBuffer,
		size_t *	piSize
	)

◆ PEventFlush()

GC_API_P() GenTL::PEventFlush ( EVENT_HANDLE hEvent )

◆ PEventKill()

GC_API_P() GenTL::PEventKill ( EVENT_HANDLE hEvent )

◆ PTLOpen()

GC_API_P() GenTL::PTLOpen ( TL_HANDLE * phTL )

◆ PTLClose()

GC_API_P() GenTL::PTLClose ( TL_HANDLE hTL )

◆ PTLGetInfo()

GC_API_P() GenTL::PTLGetInfo	(	TL_HANDLE	hTL,
		TL_INFO_CMD	iInfoCmd,
		INFO_DATATYPE *	piType,
		void *	pBuffer,
		size_t *	piSize
	)

◆ PTLGetNumInterfaces()

GC_API_P() GenTL::PTLGetNumInterfaces	(	TL_HANDLE	hTL,
		uint32_t *	piNumIfaces
	)

◆ PTLGetInterfaceID()

GC_API_P() GenTL::PTLGetInterfaceID	(	TL_HANDLE	hTL,
		uint32_t	iIndex,
		char *	sID,
		size_t *	piSize
	)

◆ PTLGetInterfaceInfo()

GC_API_P() GenTL::PTLGetInterfaceInfo	(	TL_HANDLE	hTL,
		const char *	sIfaceID,
		INTERFACE_INFO_CMD	iInfoCmd,
		INFO_DATATYPE *	piType,
		void *	pBuffer,
		size_t *	piSize
	)

◆ PTLOpenInterface()

GC_API_P() GenTL::PTLOpenInterface	(	TL_HANDLE	hTL,
		const char *	sIfaceID,
		IF_HANDLE *	phIface
	)

◆ PTLUpdateInterfaceList()

GC_API_P() GenTL::PTLUpdateInterfaceList	(	TL_HANDLE	hTL,
		bool8_t *	pbChanged,
		uint64_t	iTimeout
	)

◆ PIFClose()

GC_API_P() GenTL::PIFClose ( IF_HANDLE hIface )

◆ PIFGetInfo()

GC_API_P() GenTL::PIFGetInfo	(	IF_HANDLE	hIface,
		INTERFACE_INFO_CMD	iInfoCmd,
		INFO_DATATYPE *	piType,
		void *	pBuffer,
		size_t *	piSize
	)

◆ PIFGetNumDevices()

GC_API_P() GenTL::PIFGetNumDevices	(	IF_HANDLE	hIface,
		uint32_t *	piNumDevices
	)

◆ PIFGetDeviceID()

GC_API_P() GenTL::PIFGetDeviceID	(	IF_HANDLE	hIface,
		uint32_t	iIndex,
		char *	sIDeviceID,
		size_t *	piSize
	)

◆ PIFUpdateDeviceList()

GC_API_P() GenTL::PIFUpdateDeviceList	(	IF_HANDLE	hIface,
		bool8_t *	pbChanged,
		uint64_t	iTimeout
	)

◆ PIFGetDeviceInfo()

GC_API_P() GenTL::PIFGetDeviceInfo	(	IF_HANDLE	hIface,
		const char *	sDeviceID,
		DEVICE_INFO_CMD	iInfoCmd,
		INFO_DATATYPE *	piType,
		void *	pBuffer,
		size_t *	piSize
	)

◆ PIFOpenDevice()

GC_API_P() GenTL::PIFOpenDevice	(	IF_HANDLE	hIface,
		const char *	sDeviceID,
		DEVICE_ACCESS_FLAGS	iOpenFlags,
		DEV_HANDLE *	phDevice
	)

◆ PDevGetPort()

GC_API_P() GenTL::PDevGetPort	(	DEV_HANDLE	hDevice,
		PORT_HANDLE *	phRemoteDevice
	)

◆ PDevGetNumDataStreams()

GC_API_P() GenTL::PDevGetNumDataStreams	(	DEV_HANDLE	hDevice,
		uint32_t *	piNumDataStreams
	)

◆ PDevGetDataStreamID()

GC_API_P() GenTL::PDevGetDataStreamID	(	DEV_HANDLE	hDevice,
		uint32_t	iIndex,
		char *	sDataStreamID,
		size_t *	piSize
	)

◆ PDevOpenDataStream()

GC_API_P() GenTL::PDevOpenDataStream	(	DEV_HANDLE	hDevice,
		const char *	sDataStreamID,
		DS_HANDLE *	phDataStream
	)

◆ PDevGetInfo()

GC_API_P() GenTL::PDevGetInfo	(	DEV_HANDLE	hDevice,
		DEVICE_INFO_CMD	iInfoCmd,
		INFO_DATATYPE *	piType,
		void *	pBuffer,
		size_t *	piSize
	)

◆ PDevClose()

GC_API_P() GenTL::PDevClose ( DEV_HANDLE hDevice )

◆ PDSAnnounceBuffer()

GC_API_P() GenTL::PDSAnnounceBuffer	(	DS_HANDLE	hDataStream,
		void *	pBuffer,
		size_t	iSize,
		void *	pPrivate,
		BUFFER_HANDLE *	phBuffer
	)

◆ PDSAllocAndAnnounceBuffer()

GC_API_P() GenTL::PDSAllocAndAnnounceBuffer	(	DS_HANDLE	hDataStream,
		size_t	iSize,
		void *	pPrivate,
		BUFFER_HANDLE *	phBuffer
	)

◆ PDSFlushQueue()

GC_API_P() GenTL::PDSFlushQueue	(	DS_HANDLE	hDataStream,
		ACQ_QUEUE_TYPE	iOperation
	)

◆ PDSStartAcquisition()

GC_API_P() GenTL::PDSStartAcquisition	(	DS_HANDLE	hDataStream,
		ACQ_START_FLAGS	iStartFlags,
		uint64_t	iNumToAcquire
	)

◆ PDSStopAcquisition()

GC_API_P() GenTL::PDSStopAcquisition	(	DS_HANDLE	hDataStream,
		ACQ_STOP_FLAGS	iStopFlags
	)

◆ PDSGetInfo()

GC_API_P() GenTL::PDSGetInfo	(	DS_HANDLE	hDataStream,
		STREAM_INFO_CMD	iInfoCmd,
		INFO_DATATYPE *	piType,
		void *	pBuffer,
		size_t *	piSize
	)

◆ PDSGetBufferID()

GC_API_P() GenTL::PDSGetBufferID	(	DS_HANDLE	hDataStream,
		uint32_t	iIndex,
		BUFFER_HANDLE *	phBuffer
	)

◆ PDSClose()

GC_API_P() GenTL::PDSClose ( DS_HANDLE hDataStream )

◆ PDSRevokeBuffer()

GC_API_P() GenTL::PDSRevokeBuffer	(	DS_HANDLE	hDataStream,
		BUFFER_HANDLE	hBuffer,
		void **	pBuffer,
		void **	pPrivate
	)

◆ PDSQueueBuffer()

GC_API_P() GenTL::PDSQueueBuffer	(	DS_HANDLE	hDataStream,
		BUFFER_HANDLE	hBuffer
	)

◆ PDSGetBufferInfo()

GC_API_P() GenTL::PDSGetBufferInfo	(	DS_HANDLE	hDataStream,
		BUFFER_HANDLE	hBuffer,
		BUFFER_INFO_CMD	iInfoCmd,
		INFO_DATATYPE *	piType,
		void *	pBuffer,
		size_t *	piSize
	)

◆ PGCGetNumPortURLs()

GC_API_P() GenTL::PGCGetNumPortURLs	(	PORT_HANDLE	hPort,
		uint32_t *	iNumURLs
	)

◆ PGCGetPortURLInfo()

GC_API_P() GenTL::PGCGetPortURLInfo	(	PORT_HANDLE	hPort,
		uint32_t	iURLIndex,
		URL_INFO_CMD	iInfoCmd,
		INFO_DATATYPE *	piType,
		void *	pBuffer,
		size_t *	piSize
	)

◆ PGCReadPortStacked()

GC_API_P() GenTL::PGCReadPortStacked	(	PORT_HANDLE	hPort,
		PORT_REGISTER_STACK_ENTRY *	pEntries,
		size_t *	piNumEntries
	)

◆ PGCWritePortStacked()

GC_API_P() GenTL::PGCWritePortStacked	(	PORT_HANDLE	hPort,
		PORT_REGISTER_STACK_ENTRY *	pEntries,
		size_t *	piNumEntries
	)

◆ PDSGetBufferChunkData()

GC_API_P() GenTL::PDSGetBufferChunkData	(	DS_HANDLE	hDataStream,
		BUFFER_HANDLE	hBuffer,
		SINGLE_CHUNK_DATA *	pChunkData,
		size_t *	piNumChunks
	)

◆ PIFGetParentTL()

GC_API_P() GenTL::PIFGetParentTL	(	IF_HANDLE	hIface,
		TL_HANDLE *	phSystem
	)

◆ PDevGetParentIF()

GC_API_P() GenTL::PDevGetParentIF	(	DEV_HANDLE	hDevice,
		IF_HANDLE *	phIface
	)

◆ PDSGetParentDev()

GC_API_P() GenTL::PDSGetParentDev	(	DS_HANDLE	hDataStream,
		DEV_HANDLE *	phDevice
	)

◆ PDSGetNumBufferParts()

GC_API_P() GenTL::PDSGetNumBufferParts	(	DS_HANDLE	hDataStream,
		BUFFER_HANDLE	hBuffer,
		uint32_t *	piNumParts
	)

◆ PDSGetBufferPartInfo()

GC_API_P() GenTL::PDSGetBufferPartInfo	(	DS_HANDLE	hDataStream,
		BUFFER_HANDLE	hBuffer,
		uint32_t	iPartIndex,
		BUFFER_PART_INFO_CMD	iInfoCmd,
		INFO_DATATYPE *	piType,
		void *	pBuffer,
		size_t *	piSize
	)

Namespaces

Classes

Typedefs

Enumerations

Functions