Group SpinnakerEnumsC¶

Public Types¶

Type	Name
enum	_spinActionCommandStatus
enum	_spinColorProcessingAlgorithm
enum	_spinError
enum	_spinImageFileFormat
enum	_spinImageStatus
enum	_spinLogLevel
enum	_spinStatisticsChannel
enum	_spinTIFFCompressionMethod
enum	_spinTLPayloadType
enum	_spinTLPixelFormatNamespace
typedef enum _spinActionCommandStatus	spinActionCommandStatus
typedef enum _spinColorProcessingAlgorithm	spinColorProcessingAlgorithm
typedef enum _spinError	spinError
typedef enum _spinImageFileFormat	spinImageFileFormat
typedef enum _spinImageStatus	spinImageStatus
typedef enum _spinStatisticsChannel	spinStatisticsChannel
typedef enum _spinTIFFCompressionMethod	spinTIFFCompressionMethod
typedef enum _spinTLPayloadType	spinTLPayloadType
typedef enum _spinTLPixelFormatNamespace	spinTLPixelFormatNamespace
typedef enum _spinLogLevel	spinnakerLogLevel

Detailed Description¶

Spinnaker C enumumeration definitions

Public Types Documentation¶

enum _spinActionCommandStatus¶

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.

enum _spinColorProcessingAlgorithm¶

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. Please refer to our knowledge base at article at https://www.teledynevisionsolutions.com/support/support-center/technical-guidance/iis/different-color-processing-algorithms-in-flycapture2/ for complete details for each algorithm.

enum _spinError¶

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_IP_CONFLICT = -1023,
    SPINNAKER_ERR_INVALID_CAMERA = -1024,
    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. These codes are returned from every function in Spinnaker C. The error codes in the range of -2000 to -2999 are reserved for GenICam related errors. The error codes in the range of -3000 to -3999 are reserved for image processing related errors.

enum _spinImageFileFormat¶

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.

enum _spinImageStatus¶

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 =
        3,
    SPINNAKER_IMAGE_STATUS_LEADER_BUFFER_SIZE_INCONSISTENT =
        4,
    SPINNAKER_IMAGE_STATUS_TRAILER_BUFFER_SIZE_INCONSISTENT =
        5,
    SPINNAKER_IMAGE_STATUS_PACKETID_INCONSISTENT =
        6,
    SPINNAKER_IMAGE_STATUS_MISSING_LEADER =
        7,
    SPINNAKER_IMAGE_STATUS_MISSING_TRAILER =
        8,
    SPINNAKER_IMAGE_STATUS_DATA_INCOMPLETE =
        9,
    SPINNAKER_IMAGE_STATUS_INFO_INCONSISTENT =
        10,
    SPINNAKER_IMAGE_STATUS_CHUNK_DATA_INVALID = 11,
    SPINNAKER_IMAGE_STATUS_NO_SYSTEM_RESOURCES = 12,
    SPINNAKER_IMAGE_STATUS_GENDC_DATA_INVALID =
        13,
    SPINNAKER_IMAGE_STATUS_GENDC_PART_DATA_INVALID = 14
};

Status of images returned from spinImageGetStatus() call.

enum _spinLogLevel¶

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

enum _spinStatisticsChannel¶

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.

enum _spinTIFFCompressionMethod¶

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.

enum _spinTLPayloadType¶

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 _spinTLPixelFormatNamespace¶

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. This enum is returned from a captured image when calling spinImageGetTLPixelFormatNamespace(). It can be used to interpret the raw pixel format returned from spinImageGetTLPixelFormat().

See also: spinImageGetTLPixelFormat()

typedef spinActionCommandStatus¶

typedef enum _spinActionCommandStatus spinActionCommandStatus;

Possible Status Codes Returned from Action Command.

typedef spinColorProcessingAlgorithm¶

typedef enum _spinColorProcessingAlgorithm spinColorProcessingAlgorithm;

Color processing algorithms. Please refer to our knowledge base at article at https://www.teledynevisionsolutions.com/support/support-center/technical-guidance/iis/different-color-processing-algorithms-in-flycapture2/ for complete details for each algorithm.

typedef spinError¶

typedef enum _spinError spinError;

The error codes used in Spinnaker C. These codes are returned from every function in Spinnaker C. The error codes in the range of -2000 to -2999 are reserved for GenICam related errors. The error codes in the range of -3000 to -3999 are reserved for image processing related errors.

typedef spinImageFileFormat¶

typedef enum _spinImageFileFormat spinImageFileFormat;

File formats to be used for saving images to disk.

typedef spinImageStatus¶

typedef enum _spinImageStatus spinImageStatus;

Status of images returned from spinImageGetStatus() call.

typedef spinStatisticsChannel¶

typedef enum _spinStatisticsChannel spinStatisticsChannel;

Channels that allow statistics to be calculated.

typedef spinTIFFCompressionMethod¶

typedef enum _spinTIFFCompressionMethod spinTIFFCompressionMethod;

Compression method to use for encoding TIFF images.

typedef spinTLPayloadType¶

typedef enum _spinTLPayloadType spinTLPayloadType;

typedef spinTLPixelFormatNamespace¶

typedef enum _spinTLPixelFormatNamespace spinTLPixelFormatNamespace;

This enum represents the namespace in which the TL specific pixel format resides. This enum is returned from a captured image when calling spinImageGetTLPixelFormatNamespace(). It can be used to interpret the raw pixel format returned from spinImageGetTLPixelFormat().

See also: spinImageGetTLPixelFormat()

typedef spinnakerLogLevel¶

typedef enum _spinLogLevel spinnakerLogLevel;

log levels