The functions in this section provide access to information and functionality of images. This includes creation, destruction, and saving as well as a wealth of information including things like width, height, stride, and timestamp. More...

Functions
SPINNAKERC_API	spinImageCreateEmpty (spinImage *phImage)
	Creates an empty image; images created this way must be destroyed. More...

SPINNAKERC_API	spinImageCreate (spinImage hSrcImage, spinImage *phDestImage)
	Creates an image from another; images created this way must be destroyed. More...

SPINNAKERC_API	spinImageCreateEx (spinImage phImage, size_t width, size_t height, size_t offsetX, size_t offsetY, spinPixelFormatEnums pixelFormat, void pData)
	Creates an image with some set properties; images created this way must be destroyed. More...

SPINNAKERC_API	spinImageCreateEx2 (spinImage phImage, size_t width, size_t height, size_t offsetX, size_t offsetY, spinPixelFormatEnums pixelFormat, void pData, spinTLPayloadType dataPayloadType, size_t dataSize)
	Creates an image with some set properties; images created this way must be destroyed. More...

SPINNAKERC_API	spinImageDestroy (spinImage hImage)
	Destroys an image. More...

SPINNAKERC_API	spinImageGetColorProcessing (spinImage hImage, spinColorProcessingAlgorithm *pAlgorithm)
	Retrieves the color processing algorithm of a specific image. More...

SPINNAKERC_API	spinImageReset (spinImage hImage, size_t width, size_t height, size_t offsetX, size_t offsetY, spinPixelFormatEnums pixelFormat)
	Resets an image with some set properties. More...

SPINNAKERC_API	spinImageResetEx (spinImage hImage, size_t width, size_t height, size_t offsetX, size_t offsetY, spinPixelFormatEnums pixelFormat, void *pData)
	Resets an image with some set properties and image data. More...

SPINNAKERC_API	spinImageGetID (spinImage hImage, uint64_t *pId)
	Retrieves the ID of an image. More...

SPINNAKERC_API	spinImageGetData (spinImage hImage, void **ppData)
	Retrieves the image data of an image. More...

SPINNAKERC_API	spinImageGetPrivateData (spinImage hImage, void **ppData)
	Retrieves the private data of an image. More...

SPINNAKERC_API	spinImageGetBufferSize (spinImage hImage, size_t *pSize)
	Retrieves the buffer size of an image. More...

SPINNAKERC_API	spinImageDeepCopy (spinImage hSrcImage, spinImage hDestImage)
	Creates a deep copy of an image (the destination image must be created as an empty image prior to the deep copy) More...

SPINNAKERC_API	spinImageGetWidth (spinImage hImage, size_t *pWidth)
	Retrieves the width of an image. More...

SPINNAKERC_API	spinImageGetHeight (spinImage hImage, size_t *pHeight)
	Retrieves the height of an image. More...

SPINNAKERC_API	spinImageGetOffsetX (spinImage hImage, size_t *pOffsetX)
	Retrieves the offset of an image along its X axis. More...

SPINNAKERC_API	spinImageGetOffsetY (spinImage hImage, size_t *pOffsetY)
	Retrieves the offset of an image along its Y axis. More...

SPINNAKERC_API	spinImageGetPaddingX (spinImage hImage, size_t *pPaddingX)
	Retrieves the padding of an image along its X axis. More...

SPINNAKERC_API	spinImageGetPaddingY (spinImage hImage, size_t *pPaddingY)
	Retrieves the padding of an image along its Y axis. More...

SPINNAKERC_API	spinImageGetFrameID (spinImage hImage, uint64_t *pFrameID)
	Retrieves the frame ID of an image. More...

SPINNAKERC_API	spinImageGetTimeStamp (spinImage hImage, uint64_t *pTimeStamp)
	Retrieves the timestamp of an image. More...

SPINNAKERC_API	spinImageGetPayloadType (spinImage hImage, size_t *pPayloadType)
	Retrieves the payload type of an image (as an enum, spinPayloadTypeInfoIds) More...

SPINNAKERC_API	spinImageGetTLPayloadType (spinImage hImage, spinTLPayloadType *pPayloadType)
	Retrieves the transport layer payload type of an image (as an enum, spinPayloadTypeInfoIds) More...

SPINNAKERC_API	spinImageGetPixelFormat (spinImage hImage, spinPixelFormatEnums *pPixelFormat)
	Retrieves the pixel format of an image (as an enum, spinPixelFormatEnums) More...

SPINNAKERC_API	spinImageGetTLPixelFormat (spinImage hImage, uint64_t *pPixelFormat)
	Retrieves the transport layer pixel format of an image (as an unsigned integer) More...

SPINNAKERC_API	spinImageGetTLPixelFormatNamespace (spinImage hImage, spinTLPixelFormatNamespace *pPixelFormatNamespace)
	Retrieves the transport layer pixel format namespace of an image (as an enum, spinPixelFormatNamespaceID) More...

SPINNAKERC_API	spinImageGetPixelFormatName (spinImage hImage, char pBuf, size_t pBufLen)
	Retrieves the pixel format of an image (as a symbolic) More...

SPINNAKERC_API	spinImageIsIncomplete (spinImage hImage, bool8_t *pbIsIncomplete)
	Checks whether an image is incomplete. More...

SPINNAKERC_API	spinImageGetValidPayloadSize (spinImage hImage, size_t *pSize)
	Retrieves the valid payload size of an image. More...

SPINNAKERC_API	spinImageSave (spinImage hImage, const char *pFilename, spinImageFileFormat format)
	Saves an image using a specified file format (using an enum, spinImageFileFormat) More...

SPINNAKERC_API	spinImageSaveFromExt (spinImage hImage, const char *pFilename)
	Saves an image using a specified file format (using the extension of the filename) More...

SPINNAKERC_API	spinImageSavePng (spinImage hImage, const char pFilename, const spinPNGOption pOption)
	Saves an image as a PNG image. More...

SPINNAKERC_API	spinImageSavePpm (spinImage hImage, const char pFilename, const spinPPMOption pOption)
	Saves an image as a PPM image. More...

SPINNAKERC_API	spinImageSavePgm (spinImage hImage, const char pFilename, const spinPGMOption pOption)
	Saves an image as an PGM image. More...

SPINNAKERC_API	spinImageSaveTiff (spinImage hImage, const char pFilename, const spinTIFFOption pOption)
	Saves an image as a TIFF image. More...

SPINNAKERC_API	spinImageSaveJpeg (spinImage hImage, const char pFilename, const spinJPEGOption pOption)
	Saves an image as a JPEG image. More...

SPINNAKERC_API	spinImageSaveJpg2 (spinImage hImage, const char pFilename, const spinJPG2Option pOption)
	Saves an image as a JPEG 2000 image. More...

SPINNAKERC_API	spinImageSaveBmp (spinImage hImage, const char pFilename, const spinBMPOption pOption)
	Saves an image as a BMP image. More...

SPINNAKERC_API	spinImageGetChunkLayoutID (spinImage hImage, uint64_t *pId)
	Retrieves the chunk layout ID of an image. More...

SPINNAKERC_API	spinImageCalculateStatistics (spinImage hImage, const spinImageStatistics hStatistics)
	Calculates the image statistics of an image. More...

SPINNAKERC_API	spinImageGetStatus (spinImage hImage, spinImageStatus *pStatus)
	Retrieves the image status of an image. More...

SPINNAKERC_API	spinImageGetStatusDescription (spinImageStatus status, char pBuf, size_t pBufLen)
	Retrieves the description of image status. More...

SPINNAKERC_API	spinImageRelease (spinImage hImage)
	Releases an image. More...

SPINNAKERC_API	spinImageHasCRC (spinImage hImage, bool8_t *pbHasCRC)
	Checks whether an image has CRC. More...

SPINNAKERC_API	spinImageCheckCRC (spinImage hImage, bool8_t *pbCheckCRC)
	Checks whether the CRC of an image is correct. More...

SPINNAKERC_API	spinImageGetBitsPerPixel (spinImage hImage, size_t *pBitsPerPixel)
	Retrieves the number of bits per pixel of an image. More...

SPINNAKERC_API	spinImageGetSize (spinImage hImage, size_t *pImageSize)
	Retrieves the size of an image. More...

SPINNAKERC_API	spinImageGetStride (spinImage hImage, size_t *pStride)
	Retrieves the stride of an image. More...

Detailed Description

The functions in this section provide access to information and functionality of images. This includes creation, destruction, and saving as well as a wealth of information including things like width, height, stride, and timestamp.

Function Documentation

◆ spinImageCalculateStatistics()

SPINNAKERC_API spinImageCalculateStatistics	(	spinImage	hImage,
		const spinImageStatistics	hStatistics
	)

Calculates the image statistics of an image.

See also: spinError

Parameters

hImage	The image to be saved
hStatistics	The image statistics context in which the calculated statistics are returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageCheckCRC()

SPINNAKERC_API spinImageCheckCRC	(	spinImage	hImage,
		bool8_t *	pbCheckCRC
	)

Checks whether the CRC of an image is correct.

See also: spinError

Parameters

hImage	The image to be saved
pbCheckCRC	The boolean pointer to return whether the image CRC passes

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageCreate()

SPINNAKERC_API spinImageCreate	(	spinImage	hSrcImage,
		spinImage *	phDestImage
	)

Creates an image from another; images created this way must be destroyed.

See also: spinError

Parameters

hSrcImage	The image to be copied
phDestImage	The image handle pointer of the image to be created

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageCreateEmpty()

SPINNAKERC_API spinImageCreateEmpty ( spinImage * phImage )

Creates an empty image; images created this way must be destroyed.

See also: spinError

Parameters

phImage The image handle pointer in which the empty image is returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

Examples: Acquisition_C.c, AcquisitionMultipleCamera_C.c, ChunkData_C.c, Exposure_C.c, Exposure_C_Quickspin.c, ImageEvents_C.c, ImageFormatControl_C.c, ImageFormatControl_C_Quickspin.c, LookupTable_C.c, NodeMapCallback_C.c, SaveToVideo_C.c, Sequencer_C.c, Trigger_C.c, and Trigger_C_QuickSpin.c.

◆ spinImageCreateEx()

SPINNAKERC_API spinImageCreateEx	(	spinImage *	phImage,
		size_t	width,
		size_t	height,
		size_t	offsetX,
		size_t	offsetY,
		spinPixelFormatEnums	pixelFormat,
		void *	pData
	)

Creates an image with some set properties; images created this way must be destroyed.

See also: spinError

Parameters

phImage	The image handle pointer in which the image is returned
width	The width to set
height	The height to set
offsetX	The offset along the X axis to set
offsetY	The offset along the Y axis to set
pixelFormat	The pixel format to set
pData	The image data to set; can be set to null

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageCreateEx2()

SPINNAKERC_API spinImageCreateEx2	(	spinImage *	phImage,
		size_t	width,
		size_t	height,
		size_t	offsetX,
		size_t	offsetY,
		spinPixelFormatEnums	pixelFormat,
		void *	pData,
		spinTLPayloadType	dataPayloadType,
		size_t	dataSize
	)

Creates an image with some set properties; images created this way must be destroyed.

See also: spinError; spinImageGetTLPayloadType

Parameters

phImage	The image handle pointer in which the image is returned
width	The width to set
height	The height to set
offsetX	The offset along the X axis to set
offsetY	The offset along the Y axis to set
pixelFormat	The pixel format to set
pData	The image data to set; can be set to null
dataPayloadType	The payload type of the data. This value can be retrieved from an existing image by using the spinImageGetTLPayloadType() function call.
dataSize	The size of the provided data in bytes

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageDeepCopy()

SPINNAKERC_API spinImageDeepCopy	(	spinImage	hSrcImage,
		spinImage	hDestImage
	)

Creates a deep copy of an image (the destination image must be created as an empty image prior to the deep copy)

See also: spinError

Parameters

hSrcImage	The image to be copied
hDestImage	The image handle in which the image is copied

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageDestroy()

SPINNAKERC_API spinImageDestroy ( spinImage hImage )

Destroys an image.

See also: spinError

Parameters

hImage The image to destroy

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

Examples: Acquisition_C.c, AcquisitionMultipleCamera_C.c, ChunkData_C.c, Exposure_C.c, Exposure_C_Quickspin.c, ImageEvents_C.c, ImageFormatControl_C.c, ImageFormatControl_C_Quickspin.c, LookupTable_C.c, NodeMapCallback_C.c, SaveToVideo_C.c, Sequencer_C.c, Trigger_C.c, and Trigger_C_QuickSpin.c.

◆ spinImageGetBitsPerPixel()

SPINNAKERC_API spinImageGetBitsPerPixel	(	spinImage	hImage,
		size_t *	pBitsPerPixel
	)

Retrieves the number of bits per pixel of an image.

See also: spinError

Parameters

hImage	The image to be saved
pBitsPerPixel	The unsigned integer pointer in which the number of bits per pixel is returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageGetBufferSize()

SPINNAKERC_API spinImageGetBufferSize	(	spinImage	hImage,
		size_t *	pSize
	)

Retrieves the buffer size of an image.

See also: spinError

Parameters

hImage	The image of image data buffer to retrieve
pSize	The unsigned integer pointer in which the size of the image data if returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageGetChunkLayoutID()

SPINNAKERC_API spinImageGetChunkLayoutID	(	spinImage	hImage,
		uint64_t *	pId
	)

Retrieves the chunk layout ID of an image.

See also: spinError

Parameters

hImage	The image to be saved
pId	The unsigned integer pointer in which the chunk layout ID is returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageGetColorProcessing()

SPINNAKERC_API spinImageGetColorProcessing	(	spinImage	hImage,
		spinColorProcessingAlgorithm *	pAlgorithm
	)

Retrieves the color processing algorithm of a specific image.

See also: spinError

Parameters

hImage	The image of the color processing algorithm to retrieve
pAlgorithm	The color processing algorithm pointer in which the color processing algorithm is returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageGetData()

SPINNAKERC_API spinImageGetData	(	spinImage	hImage,
		void **	ppData
	)

Retrieves the image data of an image.

See also: spinError

Parameters

hImage	The image of the image data to retrieve
ppData	The pointer to the void pointer in which the image data is retrieved

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageGetFrameID()

SPINNAKERC_API spinImageGetFrameID	(	spinImage	hImage,
		uint64_t *	pFrameID
	)

Retrieves the frame ID of an image.

See also: spinError

Parameters

hImage	The image of the frame ID to retrieve
pFrameID	The unsigned integer pointer in which the frame ID is returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageGetHeight()

SPINNAKERC_API spinImageGetHeight	(	spinImage	hImage,
		size_t *	pHeight
	)

Retrieves the height of an image.

See also: spinError

Parameters

hImage	The image of the height to retrieve
pHeight	The unsigned integer pointer in which the height is returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

Examples: Acquisition_C.c, AcquisitionMultipleCamera_C.c, ChunkData_C.c, Exposure_C.c, Exposure_C_Quickspin.c, ImageEvents_C.c, ImageFormatControl_C.c, ImageFormatControl_C_Quickspin.c, LookupTable_C.c, NodeMapCallback_C.c, SaveToVideo_C.c, Sequencer_C.c, Trigger_C.c, and Trigger_C_QuickSpin.c.

◆ spinImageGetID()

SPINNAKERC_API spinImageGetID	(	spinImage	hImage,
		uint64_t *	pId
	)

Retrieves the ID of an image.

See also: spinError

Parameters

hImage	The image of the ID to retrieve
pId	The unsigned integer pointer in which the ID is returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageGetOffsetX()

SPINNAKERC_API spinImageGetOffsetX	(	spinImage	hImage,
		size_t *	pOffsetX
	)

Retrieves the offset of an image along its X axis.

See also: spinError

Parameters

hImage	The image of the offset along the X axis to retrieve
pOffsetX	The unsigned integer pointer in which the offset along the X axis is returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageGetOffsetY()

SPINNAKERC_API spinImageGetOffsetY	(	spinImage	hImage,
		size_t *	pOffsetY
	)

Retrieves the offset of an image along its Y axis.

See also: spinError

Parameters

hImage	The image of the offset along the Y axis to retrieve
pOffsetY	The unsigned integer pointer in which the offset along the Y axis is returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageGetPaddingX()

SPINNAKERC_API spinImageGetPaddingX	(	spinImage	hImage,
		size_t *	pPaddingX
	)

Retrieves the padding of an image along its X axis.

See also: spinError

Parameters

hImage	The image of the padding along the X axis to retrieve
pPaddingX	The unsigned integer pointer in which the padding along the X axis is returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageGetPaddingY()

SPINNAKERC_API spinImageGetPaddingY	(	spinImage	hImage,
		size_t *	pPaddingY
	)

Retrieves the padding of an image along its Y axis.

See also: spinError

Parameters

hImage	The image of the padding along the Y axis to retrieve
pPaddingY	The unsigned integer pointer in which the padding along the Y axis is returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageGetPayloadType()

SPINNAKERC_API spinImageGetPayloadType	(	spinImage	hImage,
		size_t *	pPayloadType
	)

Retrieves the payload type of an image (as an enum, spinPayloadTypeInfoIds)

See also: spinError; spinPayloadTypeInfoIds

Parameters

hImage	The image of the payload type to retrieve
pPayloadType	The payload type enum pointer in which the payload type is returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageGetPixelFormat()

SPINNAKERC_API spinImageGetPixelFormat	(	spinImage	hImage,
		spinPixelFormatEnums *	pPixelFormat
	)

Retrieves the pixel format of an image (as an enum, spinPixelFormatEnums)

See also: spinError; spinPixelFormatEnums

Parameters

hImage	The image of the pixel format to retrieve
pPixelFormat	The pixel format enum pointer in which the pixel format is returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageGetPixelFormatName()

SPINNAKERC_API spinImageGetPixelFormatName	(	spinImage	hImage,
		char *	pBuf,
		size_t *	pBufLen
	)

Retrieves the pixel format of an image (as a symbolic)

See also: spinError

Parameters

hImage	The image of the pixel format to retrieve
pBuf	The c-string character buffer in which the pixel format symbolic is returned
pBufLen	The unsigned integer pointer in which the length of the c-string is returned; the input value is the maximum length

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageGetPrivateData()

SPINNAKERC_API spinImageGetPrivateData	(	spinImage	hImage,
		void **	ppData
	)

Retrieves the private data of an image.

See also: spinError

Parameters

hImage	The image of the private image data to retrieve
ppData	The pointer to the void pointer in which the private image data is retrieved

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageGetSize()

SPINNAKERC_API spinImageGetSize	(	spinImage	hImage,
		size_t *	pImageSize
	)

Retrieves the size of an image.

See also: spinError

Parameters

hImage	The image to be saved
pImageSize	The unsigned integer pointer in which the size of the image is returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageGetStatus()

SPINNAKERC_API spinImageGetStatus	(	spinImage	hImage,
		spinImageStatus *	pStatus
	)

Retrieves the image status of an image.

See also: spinError

Parameters

hImage	The image to be saved
pStatus	The status enum pointer in which the image status is returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

Examples: Acquisition_C.c, AcquisitionMultipleCamera_C.c, ChunkData_C.c, Exposure_C.c, Exposure_C_Quickspin.c, ImageEvents_C.c, ImageFormatControl_C.c, ImageFormatControl_C_Quickspin.c, LookupTable_C.c, NodeMapCallback_C.c, SaveToVideo_C.c, Sequencer_C.c, Trigger_C.c, and Trigger_C_QuickSpin.c.

◆ spinImageGetStatusDescription()

SPINNAKERC_API spinImageGetStatusDescription	(	spinImageStatus	status,
		char *	pBuf,
		size_t *	pBufLen
	)

Retrieves the description of image status.

See also: spinError

Parameters

status	The status enum
pBuf	The c-string character buffer in which the explanation of image status enum is returned
pBufLen	The unsigned integer pointer in which the length of the c-string is returned; the input value is the maximum length; if pBuf is NULL, minimum length of string buffer is returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageGetStride()

SPINNAKERC_API spinImageGetStride	(	spinImage	hImage,
		size_t *	pStride
	)

Retrieves the stride of an image.

See also: spinError

Parameters

hImage	The image to be saved
pStride	The unsigned integer pointer in which the stride is returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageGetTimeStamp()

SPINNAKERC_API spinImageGetTimeStamp	(	spinImage	hImage,
		uint64_t *	pTimeStamp
	)

Retrieves the timestamp of an image.

See also: spinError

Parameters

hImage	The image of the timestamp to retrieve
pTimeStamp	The unsigned integer pointer om which the timestamp is returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageGetTLPayloadType()

SPINNAKERC_API spinImageGetTLPayloadType	(	spinImage	hImage,
		spinTLPayloadType *	pPayloadType
	)

Retrieves the transport layer payload type of an image (as an enum, spinPayloadTypeInfoIds)

See also: spinError; spinPayloadTypeInfoIds

Parameters

hImage	The image of the TL payload type to retrieve
pPayloadType	The payload type enum pointer in which the TL payload type is returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageGetTLPixelFormat()

SPINNAKERC_API spinImageGetTLPixelFormat	(	spinImage	hImage,
		uint64_t *	pPixelFormat
	)

Retrieves the transport layer pixel format of an image (as an unsigned integer)

See also: spinError

Parameters

hImage	The image of the TL pixel format to retrieve
pPixelFormat	The unsigned integer pointer in which the TL pixel format is returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageGetTLPixelFormatNamespace()

SPINNAKERC_API spinImageGetTLPixelFormatNamespace	(	spinImage	hImage,
		spinTLPixelFormatNamespace *	pPixelFormatNamespace
	)

Retrieves the transport layer pixel format namespace of an image (as an enum, spinPixelFormatNamespaceID)

See also: spinError; spinPixelFormatNamespaceID

Parameters

hImage	The image of the TL pixel format namespace to retrieve
pPixelFormatNamespace	The pixel format namespace pointer in which the pixel format namespace is returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageGetValidPayloadSize()

SPINNAKERC_API spinImageGetValidPayloadSize	(	spinImage	hImage,
		size_t *	pSize
	)

Retrieves the valid payload size of an image.

See also: spinError

Parameters

hImage	The image of the payload size to retrieve
pSize	The unsigned integer pointer in which the size of the valid payload is returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageGetWidth()

SPINNAKERC_API spinImageGetWidth	(	spinImage	hImage,
		size_t *	pWidth
	)

Retrieves the width of an image.

See also: spinError

Parameters

hImage	The image of the width to retrieve
pWidth	The unsigned integer pointer in which the width is returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

Examples: Acquisition_C.c, AcquisitionMultipleCamera_C.c, ChunkData_C.c, Exposure_C.c, Exposure_C_Quickspin.c, ImageEvents_C.c, ImageFormatControl_C.c, ImageFormatControl_C_Quickspin.c, LookupTable_C.c, NodeMapCallback_C.c, SaveToVideo_C.c, Sequencer_C.c, Trigger_C.c, and Trigger_C_QuickSpin.c.

◆ spinImageHasCRC()

SPINNAKERC_API spinImageHasCRC	(	spinImage	hImage,
		bool8_t *	pbHasCRC
	)

Checks whether an image has CRC.

See also: spinError

Parameters

hImage	The image to be saved
pbHasCRC	The boolean pointer to return whether the image has CRC available

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageIsIncomplete()

SPINNAKERC_API spinImageIsIncomplete	(	spinImage	hImage,
		bool8_t *	pbIsIncomplete
	)

Checks whether an image is incomplete.

See also: spinError

Parameters

hImage	The image to check
pbIsIncomplete	The boolean pointer to return whether or not the image is incomplete

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

Examples: Acquisition_C.c, AcquisitionMultipleCamera_C.c, ChunkData_C.c, Exposure_C.c, Exposure_C_Quickspin.c, ImageEvents_C.c, ImageFormatControl_C.c, ImageFormatControl_C_Quickspin.c, LookupTable_C.c, NodeMapCallback_C.c, SaveToVideo_C.c, Sequencer_C.c, Trigger_C.c, and Trigger_C_QuickSpin.c.

◆ spinImageRelease()

SPINNAKERC_API spinImageRelease ( spinImage hImage )

Releases an image.

See also: spinError

Parameters

hImage The image to be saved

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

Examples: Acquisition_C.c, AcquisitionMultipleCamera_C.c, ChunkData_C.c, Exposure_C.c, Exposure_C_Quickspin.c, ImageFormatControl_C.c, ImageFormatControl_C_Quickspin.c, LookupTable_C.c, NodeMapCallback_C.c, SaveToVideo_C.c, Sequencer_C.c, Trigger_C.c, and Trigger_C_QuickSpin.c.

◆ spinImageReset()

SPINNAKERC_API spinImageReset	(	spinImage	hImage,
		size_t	width,
		size_t	height,
		size_t	offsetX,
		size_t	offsetY,
		spinPixelFormatEnums	pixelFormat
	)

Resets an image with some set properties.

See also: spinError

Parameters

hImage	The image to be reset
width	The width to be reset to
height	The height to be reset to
offsetX	The offset to be reset to along the X axis
offsetY	The offset to be reset to along the Y axis
pixelFormat	The pixel format to be reset to

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageResetEx()

SPINNAKERC_API spinImageResetEx	(	spinImage	hImage,
		size_t	width,
		size_t	height,
		size_t	offsetX,
		size_t	offsetY,
		spinPixelFormatEnums	pixelFormat,
		void *	pData
	)

Resets an image with some set properties and image data.

See also: spinError

Parameters

hImage	The image to reset
width	The width to be reset to
height	The height to be reset to
offsetX	The offset to be reset to along the X axis
offsetY	The offset to be reset to along the Y axis
pixelFormat	The pixel format to be reset to
pData	The image data to reset to

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageSave()

SPINNAKERC_API spinImageSave	(	spinImage	hImage,
		const char *	pFilename,
		spinImageFileFormat	format
	)

Saves an image using a specified file format (using an enum, spinImageFileFormat)

See also: spinError; spinImageFileFormat

Parameters

hImage	The image to be saved
pFilename	The filename to use to save the image (with or without the appropriate file extension) @Param format The file format to use to save the image

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

Examples: Acquisition_C.c, AcquisitionMultipleCamera_C.c, ChunkData_C.c, Exposure_C.c, Exposure_C_Quickspin.c, ImageEvents_C.c, ImageFormatControl_C.c, ImageFormatControl_C_Quickspin.c, LookupTable_C.c, Sequencer_C.c, Trigger_C.c, and Trigger_C_QuickSpin.c.

◆ spinImageSaveBmp()

SPINNAKERC_API spinImageSaveBmp	(	spinImage	hImage,
		const char *	pFilename,
		const spinBMPOption *	pOption
	)

Saves an image as a BMP image.

See also: spinError

Parameters

hImage	The image to be saved
pFilename	The filename to use to save the image (with or without the appropriate file extension)
pOption	The image options related to saving as BMP; includes whether to save as indexed 8-bit

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageSaveFromExt()

SPINNAKERC_API spinImageSaveFromExt	(	spinImage	hImage,
		const char *	pFilename
	)

Saves an image using a specified file format (using the extension of the filename)

See also: spinError

Parameters

hImage	The image to be saved
pFilename	The filename to use to save the image (with or without the appropriate file extension)

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageSaveJpeg()

SPINNAKERC_API spinImageSaveJpeg	(	spinImage	hImage,
		const char *	pFilename,
		const spinJPEGOption *	pOption
	)

Saves an image as a JPEG image.

See also: spinError

Parameters

hImage	The image to be saved
pFilename	The filename to use to save the image (with or without the appropriate file extension)
pOption	The image options related to saving as JPEG; includes quality and whether to save as progressive

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageSaveJpg2()

SPINNAKERC_API spinImageSaveJpg2	(	spinImage	hImage,
		const char *	pFilename,
		const spinJPG2Option *	pOption
	)

Saves an image as a JPEG 2000 image.

See also: spinError

Parameters

hImage	The image to be saved
pFilename	The filename to use to save the image (with or without the appropriate file extension)
pOption	The image options related to saving as JPEG 2000; includes quality

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageSavePgm()

SPINNAKERC_API spinImageSavePgm	(	spinImage	hImage,
		const char *	pFilename,
		const spinPGMOption *	pOption
	)

Saves an image as an PGM image.

See also: spinError

Parameters

hImage	The image to be saved
pFilename	The filename to use to save the image (with or without the appropriate file extension)
pOption	The image options related to saving as PGM; includes whether to save as binary

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageSavePng()

SPINNAKERC_API spinImageSavePng	(	spinImage	hImage,
		const char *	pFilename,
		const spinPNGOption *	pOption
	)

Saves an image as a PNG image.

See also: spinError

Parameters

hImage	The image to be saved
pFilename	The filename to use to save the image (with or without the appropriate file extension)
pOption	The image options related to saving as PNG; includes compression level and whether to save as interlaced

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageSavePpm()

SPINNAKERC_API spinImageSavePpm	(	spinImage	hImage,
		const char *	pFilename,
		const spinPPMOption *	pOption
	)

Saves an image as a PPM image.

See also: spinError

Parameters

hImage	The image to be saved
pFilename	The filename to use to save the image (with or without the appropriate file extension)
pOption	The image options related to saving as PPM; includes whether to save as binary

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

◆ spinImageSaveTiff()

SPINNAKERC_API spinImageSaveTiff	(	spinImage	hImage,
		const char *	pFilename,
		const spinTIFFOption *	pOption
	)

Saves an image as a TIFF image.

See also: spinError

Parameters

hImage	The image to be saved
pFilename	The filename to use to save the image (with or without the appropriate file extension)
pOption	The image options related to saving as TIFF; includes compression method

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

Functions

Detailed Description

Function Documentation

◆ spinImageCalculateStatistics()

◆ spinImageCheckCRC()

◆ spinImageCreate()

◆ spinImageCreateEmpty()

◆ spinImageCreateEx()

◆ spinImageCreateEx2()

◆ spinImageDeepCopy()

◆ spinImageDestroy()

◆ spinImageGetBitsPerPixel()

◆ spinImageGetBufferSize()

◆ spinImageGetChunkLayoutID()

◆ spinImageGetColorProcessing()

◆ spinImageGetData()

◆ spinImageGetFrameID()

◆ spinImageGetHeight()

◆ spinImageGetID()

◆ spinImageGetOffsetX()

◆ spinImageGetOffsetY()

◆ spinImageGetPaddingX()

◆ spinImageGetPaddingY()

◆ spinImageGetPayloadType()

◆ spinImageGetPixelFormat()

◆ spinImageGetPixelFormatName()

◆ spinImageGetPrivateData()

◆ spinImageGetSize()

◆ spinImageGetStatus()

◆ spinImageGetStatusDescription()

◆ spinImageGetStride()

◆ spinImageGetTimeStamp()

◆ spinImageGetTLPayloadType()

◆ spinImageGetTLPixelFormat()

◆ spinImageGetTLPixelFormatNamespace()

◆ spinImageGetValidPayloadSize()

◆ spinImageGetWidth()

◆ spinImageHasCRC()

◆ spinImageIsIncomplete()

◆ spinImageRelease()

◆ spinImageReset()

◆ spinImageResetEx()

◆ spinImageSave()

◆ spinImageSaveBmp()

◆ spinImageSaveFromExt()

◆ spinImageSaveJpeg()

◆ spinImageSaveJpg2()

◆ spinImageSavePgm()

◆ spinImageSavePng()

◆ spinImageSavePpm()

◆ spinImageSaveTiff()