Spinnaker C
4.3.0.189
 
Data Structures | Typedefs | Enumerations | Variables
SpinnakerDefsC.h File Reference

Data Structures

struct  _spinPNGOption
 Options for saving PNG images. More...
 
struct  _spinPPMOption
 Options for saving PPM images. More...
 
struct  _spinPGMOption
 Options for saving PGM images. More...
 
struct  _spinTIFFOption
 Options for saving TIFF images. More...
 
struct  _spinJPEGOption
 Options for saving JPEG images. More...
 
struct  _spinJPG2Option
 Options for saving JPEG 2000 images. More...
 
struct  _spinBMPOption
 Options for saving BMP images. More...
 
struct  _spinMJPGOption
 Options for saving MJPG videos. More...
 
struct  _spinH264Option
 Options for saving H264 videos. More...
 
struct  _spinAVIOption
 Options for saving uncompressed videos. More...
 
struct  _spinLibraryVersion
 Provides easier access to the current version of Spinnaker. More...
 
struct  _actionCommandResult
 Action Command Result. More...
 

Typedefs

typedef uint8_t bool8_t
 
typedef void * spinSystem
 Handle for system functionality. More...
 
typedef void * spinInterfaceList
 Handle for interface list functionality. More...
 
typedef void * spinInterface
 Handle for interface functionality. More...
 
typedef void * spinCameraList
 Handle for interface functionality. More...
 
typedef void * spinCamera
 Handle for camera functionality. More...
 
typedef void * spinImage
 Handle for image functionality. More...
 
typedef void * spinImageList
 Handle for image list functionality. More...
 
typedef void * spinImageProcessor
 Handle for image processor functionality. More...
 
typedef void * spinImageStatistics
 Handle for image statistics functionality. More...
 
typedef void * spinDeviceEventHandler
 Handle for device event handler functionality. More...
 
typedef void * spinImageEventHandler
 Handle for image event handler functionality. More...
 
typedef void * spinImageListEventHandler
 Handle for image list event handler functionality. More...
 
typedef void * spinDeviceArrivalEventHandler
 Handle for arrival event handler functionality. More...
 
typedef void * spinDeviceRemovalEventHandler
 Handle for removal event handler functionality. More...
 
typedef void * spinInterfaceEventHandler
 Handle for interface event handler functionality. More...
 
typedef void * spinLogEventHandler
 Handle for logging event handler functionality. More...
 
typedef void * spinLogEventData
 Handle for logging event data functionality. More...
 
typedef void * spinDeviceEventData
 Handle for device event data functionality. More...
 
typedef void * spinVideo
 Handle for video recording functionality. More...
 
typedef void(* spinDeviceEventFunction) (const spinDeviceEventData hEventData, const char *pEventName, void *pUserData)
 Function signatures are used to create and trigger callbacks and events. More...
 
typedef void(* spinImageEventFunction) (const spinImage hImage, void *pUserData)
 
typedef void(* spinImageListEventFunction) (const spinImageList hImage, void *pUserData)
 
typedef void(* spinArrivalEventFunction) (const spinCamera hCamera, void *pUserData)
 
typedef void(* spinRemovalEventFunction) (const spinCamera hCamera, void *pUserData)
 
typedef void(* spinLogEventFunction) (const spinLogEventData hEventData, void *pUserData)
 

Enumerations

enum  _spinError {
  SPINNAKER_ERR_SUCCESS = 0, SPINNAKER_ERR_ERROR = -1001, SPINNAKER_ERR_NOT_INITIALIZED = -1002, SPINNAKER_ERR_NOT_IMPLEMENTED = -1003,
  SPINNAKER_ERR_RESOURCE_IN_USE = -1004, SPINNAKER_ERR_ACCESS_DENIED = -1005, SPINNAKER_ERR_INVALID_HANDLE = -1006, SPINNAKER_ERR_INVALID_ID = -1007,
  SPINNAKER_ERR_NO_DATA = -1008, SPINNAKER_ERR_INVALID_PARAMETER = -1009, SPINNAKER_ERR_IO = -1010, SPINNAKER_ERR_TIMEOUT = -1011,
  SPINNAKER_ERR_ABORT = -1012, SPINNAKER_ERR_INVALID_BUFFER = -1013, SPINNAKER_ERR_NOT_AVAILABLE = -1014, SPINNAKER_ERR_INVALID_ADDRESS = -1015,
  SPINNAKER_ERR_BUFFER_TOO_SMALL = -1016, SPINNAKER_ERR_INVALID_INDEX = -1017, SPINNAKER_ERR_PARSING_CHUNK_DATA = -1018, SPINNAKER_ERR_INVALID_VALUE = -1019,
  SPINNAKER_ERR_RESOURCE_EXHAUSTED = -1020, SPINNAKER_ERR_OUT_OF_MEMORY = -1021, SPINNAKER_ERR_BUSY = -1022, SPINNAKER_ERR_GENICAM_INVALID_ARGUMENT = -2001,
  SPINNAKER_ERR_GENICAM_OUT_OF_RANGE = -2002, SPINNAKER_ERR_GENICAM_PROPERTY = -2003, SPINNAKER_ERR_GENICAM_RUN_TIME = -2004, SPINNAKER_ERR_GENICAM_LOGICAL = -2005,
  SPINNAKER_ERR_GENICAM_ACCESS = -2006, SPINNAKER_ERR_GENICAM_TIMEOUT = -2007, SPINNAKER_ERR_GENICAM_DYNAMIC_CAST = -2008, SPINNAKER_ERR_GENICAM_GENERIC = -2009,
  SPINNAKER_ERR_GENICAM_BAD_ALLOCATION = -2010, SPINNAKER_ERR_IM_CONVERT = -3001, SPINNAKER_ERR_IM_COPY = -3002, SPINNAKER_ERR_IM_MALLOC = -3003,
  SPINNAKER_ERR_IM_NOT_SUPPORTED = -3004, SPINNAKER_ERR_IM_HISTOGRAM_RANGE = -3005, SPINNAKER_ERR_IM_HISTOGRAM_MEAN = -3006, SPINNAKER_ERR_IM_MIN_MAX = -3007,
  SPINNAKER_ERR_IM_COLOR_CONVERSION = -3008, SPINNAKER_ERR_CUSTOM_ID = -10000
}
 The error codes used in Spinnaker C. More...
 
enum  _spinColorProcessingAlgorithm {
  SPINNAKER_COLOR_PROCESSING_ALGORITHM_NONE, SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR, SPINNAKER_COLOR_PROCESSING_ALGORITHM_NEAREST_NEIGHBOR_AVG, SPINNAKER_COLOR_PROCESSING_ALGORITHM_BILINEAR,
  SPINNAKER_COLOR_PROCESSING_ALGORITHM_EDGE_SENSING, SPINNAKER_COLOR_PROCESSING_ALGORITHM_HQ_LINEAR, SPINNAKER_COLOR_PROCESSING_ALGORITHM_IPP, SPINNAKER_COLOR_PROCESSING_ALGORITHM_DIRECTIONAL_FILTER,
  SPINNAKER_COLOR_PROCESSING_ALGORITHM_RIGOROUS, SPINNAKER_COLOR_PROCESSING_ALGORITHM_WEIGHTED_DIRECTIONAL_FILTER
}
 Color processing algorithms. More...
 
enum  _spinStatisticsChannel {
  SPINNAKER_STATISTICS_CHANNEL_GREY, SPINNAKER_STATISTICS_CHANNEL_RED, SPINNAKER_STATISTICS_CHANNEL_GREEN, SPINNAKER_STATISTICS_CHANNEL_BLUE,
  SPINNAKER_STATISTICS_CHANNEL_HUE, SPINNAKER_STATISTICS_CHANNEL_SATURATION, SPINNAKER_STATISTICS_CHANNEL_LIGHTNESS, SPINNAKER_STATISTICS_CHANNEL_NUM_CHANNELS
}
 Channels that allow statistics to be calculated. More...
 
enum  _spinImageFileFormat {
  SPINNAKER_IMAGE_FILE_FORMAT_FROM_FILE_EXT = -1, SPINNAKER_IMAGE_FILE_FORMAT_PGM, SPINNAKER_IMAGE_FILE_FORMAT_PPM, SPINNAKER_IMAGE_FILE_FORMAT_BMP,
  SPINNAKER_IMAGE_FILE_FORMAT_JPEG, SPINNAKER_IMAGE_FILE_FORMAT_JPEG2000, SPINNAKER_IMAGE_FILE_FORMAT_TIFF, SPINNAKER_IMAGE_FILE_FORMAT_PNG,
  SPINNAKER_IMAGE_FILE_FORMAT_RAW, SPINNAKER_IMAGE_FILE_FORMAT_FORCE_32BITS = 0x7FFFFFFF
}
 File formats to be used for saving images to disk. More...
 
enum  _spinTLPixelFormatNamespace {
  SPINNAKER_TLPIXELFORMAT_NAMESPACE_UNKNOWN = 0, SPINNAKER_TLPIXELFORMAT_NAMESPACE_GEV = 1, SPINNAKER_TLPIXELFORMAT_NAMESPACE_IIDC = 2, SPINNAKER_TLPIXELFORMAT_NAMESPACE_PFNC_16BIT = 3,
  SPINNAKER_TLPIXELFORMAT_NAMESPACE_PFNC_32BIT = 4, SPINNAKER_PIXELFORMAT_NAMESPACE_CUSTOM_ID = 1000
}
 This enum represents the namespace in which the TL specific pixel format resides. More...
 
enum  _spinImageStatus {
  SPINNAKER_IMAGE_STATUS_UNKNOWN_ERROR = -1, SPINNAKER_IMAGE_STATUS_NO_ERROR = 0, SPINNAKER_IMAGE_STATUS_CRC_CHECK_FAILED = 1, SPINNAKER_IMAGE_STATUS_DATA_OVERFLOW = 2,
  SPINNAKER_IMAGE_STATUS_MISSING_PACKETS, SPINNAKER_IMAGE_STATUS_LEADER_BUFFER_SIZE_INCONSISTENT, SPINNAKER_IMAGE_STATUS_TRAILER_BUFFER_SIZE_INCONSISTENT, SPINNAKER_IMAGE_STATUS_PACKETID_INCONSISTENT,
  SPINNAKER_IMAGE_STATUS_MISSING_LEADER, SPINNAKER_IMAGE_STATUS_MISSING_TRAILER, SPINNAKER_IMAGE_STATUS_DATA_INCOMPLETE, SPINNAKER_IMAGE_STATUS_INFO_INCONSISTENT,
  SPINNAKER_IMAGE_STATUS_CHUNK_DATA_INVALID = 11, SPINNAKER_IMAGE_STATUS_NO_SYSTEM_RESOURCES = 12
}
 Status of images returned from spinImageGetStatus() call. More...
 
enum  _spinLogLevel {
  SPINNAKER_LOG_LEVEL_OFF = -1, SPINNAKER_LOG_LEVEL_FATAL = 0, SPINNAKER_LOG_LEVEL_ALERT = 100, SPINNAKER_LOG_LEVEL_CRIT = 200,
  SPINNAKER_LOG_LEVEL_ERROR = 300, SPINNAKER_LOG_LEVEL_WARN = 400, SPINNAKER_LOG_LEVEL_NOTICE = 500, SPINNAKER_LOG_LEVEL_INFO = 600,
  SPINNAKER_LOG_LEVEL_DEBUG = 700, SPINNAKER_LOG_LEVEL_NOTSET = 800
}
 log levels More...
 
enum  _spinTLPayloadType {
  SPINNAKER_TLPAYLOAD_TYPE_UNKNOWN = 0, SPINNAKER_TLPAYLOAD_TYPE_IMAGE = 1, SPINNAKER_TLPAYLOAD_TYPE_RAW_DATA = 2, SPINNAKER_TLPAYLOAD_TYPE_FILE = 3,
  SPINNAKER_TLPAYLOAD_TYPE_CHUNK_DATA = 4, SPINNAKER_TLPAYLOAD_TYPE_JPEG = 5, SPINNAKER_TLPAYLOAD_TYPE_JPEG2000 = 6, SPINNAKER_TLPAYLOAD_TYPE_H264 = 7,
  SPINNAKER_TLPAYLOAD_TYPE_CHUNK_ONLY = 8, SPINNAKER_TLPAYLOAD_TYPE_DEVICE_SPECIFIC = 9, SPINNAKER_TLPAYLOAD_TYPE_MULTI_PART = 10, SPINNAKER_TLPAYLOAD_TYPE_CUSTOM_ID = 1000,
  SPINNAKER_TLPAYLOAD_TYPE_LOSSLESS_COMPRESSED = SPINNAKER_TLPAYLOAD_TYPE_CUSTOM_ID + 1, SPINNAKER_TLPAYLOAD_TYPE_LOSSY_COMPRESSED = SPINNAKER_TLPAYLOAD_TYPE_CUSTOM_ID + 2, SPINNAKER_TLPAYLOAD_TYPE_JPEG_LOSSLESS_COMPRESSED = SPINNAKER_TLPAYLOAD_TYPE_CUSTOM_ID + 3
}
 
enum  _spinTIFFCompressionMethod {
  SPINNAKER_TIFF_COMPRESS_METHOD_NONE = 1, SPINNAKER_TIFF_COMPRESS_METHOD_PACKBITS, SPINNAKER_TIFF_COMPRESS_METHOD_DEFLATE, SPINNAKER_TIFF_COMPRESS_METHOD_ADOBE_DEFLATE,
  SPINNAKER_TIFF_COMPRESS_METHOD_CCITTFAX3, SPINNAKER_TIFF_COMPRESS_METHOD_CCITTFAX4, SPINNAKER_TIFF_COMPRESS_METHOD_LZW, SPINNAKER_TIFF_COMPRESS_METHOD_JPG
}
 Compression method to use for encoding TIFF images. More...
 
enum  _spinActionCommandStatus {
  SPINNAKER_ACTION_COMMAND_STATUS_OK = 0, SPINNAKER_ACTION_COMMAND_STATUS_NO_REF_TIME = 0x8013, SPINNAKER_ACTION_COMMAND_STATUS_OVERFLOW = 0x8015, SPINNAKER_ACTION_COMMAND_STATUS_ACTION_LATE = 0x8016,
  SPINNAKER_ACTION_COMMAND_STATUS_ERROR = 0x8FFF
}
 Possible Status Codes Returned from Action Command. More...
 

Variables

static const bool8_t False = 0
 
static const bool8_t True = 1