Group CImageList¶

Modules > CImageList

The functions in this section provide access to information, objects, and functionality of image lists. This includes updating, size and image retrieval, and clearance.

Public Functions¶

Type	Name
	spinImageListAppend (spinImageList hImageListBase, spinImageList hImageListToAppend)
	spinImageListClear (spinImageList hImageList)
	spinImageListCreateEmpty (spinImageList * phImageList)
	spinImageListDestroy (spinImageList hImageList)
	spinImageListGet (spinImageList hImageList, size_t index, spinImage * phImage)
	spinImageListGetByPixelFormat (spinImageList hImageList, spinPixelFormatEnums pixelFormat, spinImage * phImage)
	spinImageListGetByStreamIndex (spinImageList hImageList, uint64_t streamIndex, spinImage * phImage)
	spinImageListGetImagesByPixelFormat (spinImageList hImageList, spinPixelFormatEnums pixelFormat, spinImageList * hImageListReturn)
	spinImageListGetSize (spinImageList hImageList, size_t * pSize)
	spinImageListLoad (spinImageList * phImageList, const char * fileName)
	spinImageListRelease (spinImageList hImageList)
	spinImageListRemove (spinImageList hImageList, size_t index)
	spinImageListRemoveByPixelFormat (spinImageList hImageList, spinPixelFormatEnums pixelFormat)
	spinImageListRemoveByStreamIndex (spinImageList hImageList, uint64_t streamIndex)
	spinImageListSave (spinImageList hImageList, const char * fileName)

Public Functions Documentation¶

function spinImageListAppend¶

spinImageListAppend (
    spinImageList hImageListBase,
    spinImageList hImageListToAppend
)

Appends all the images from one image list to another

See also: spinError

Parameters:

hImageListBase The image list to receive the other
hImageListToAppend The image list to add to the other

Returns:

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

function spinImageListClear¶

spinImageListClear (
    spinImageList hImageList
)

Clears a image list

See also: spinError

Parameters:

hImageList The image list to clear

Returns:

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

function spinImageListCreateEmpty¶

spinImageListCreateEmpty (
    spinImageList * phImageList
)

Creates an empty image list (image lists created this way must be destroyed)

See also: spinError

Parameters:

phImageList The image list handle pointer in which the empty image list is returned

Returns:

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

function spinImageListDestroy¶

spinImageListDestroy (
    spinImageList hImageList
)

Destroys a image list

See also: spinError

Parameters:

hImageList The image list to destroy

Returns:

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

function spinImageListGet¶

spinImageListGet (
    spinImageList hImageList,
    size_t index,
    spinImage * phImage
)

Retrieves a image from a image list using an index. This function will return a SPINNAKER_ERR_INVALID_PARAMETER error if the input index is out of range.

See also: spinError

Parameters:

hImageList The image list of the image to retrieve
index The index of the image
phImage The image handle pointer in which the image is returned

Returns:

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

function spinImageListGetByPixelFormat¶

spinImageListGetByPixelFormat (
    spinImageList hImageList,
    spinPixelFormatEnums pixelFormat,
    spinImage * phImage
)

Retrieves an image from a image list given its pixel format. This function will return a NULL spinImage pointer if no matching image pixel format is found.

See also: spinError

Parameters:

hImageList The image list of the image to retrieve
pixelFormat The pixel format of the image to retrieve
phImage The image handle pointer in which the image is returned

Returns:

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

function spinImageListGetByStreamIndex¶

spinImageListGetByStreamIndex (
    spinImageList hImageList,
    uint64_t streamIndex,
    spinImage * phImage
)

Retrieves a image from a image list given its stream index. This function will return a NULL spinImage pointer if no matching image stream index is found.

See also: spinError

Parameters:

hImageList The image list of the image to retrieve
streamIndex The stream index of the image to retrieve
phImage The image handle pointer in which the image is returned

Returns:

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

function spinImageListGetImagesByPixelFormat¶

spinImageListGetImagesByPixelFormat (
    spinImageList hImageList,
    spinPixelFormatEnums pixelFormat,
    spinImageList * hImageListReturn
)

Returns an image list containing images matching pixel format. This function will retrieve an empty list if no match is found.

See also: spinError

Parameters:

hImageList The image list of the image to retrieve
pixelFormat The pixel format of the image to retrieve
hImageListReturn The image list that is returned

Returns:

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

function spinImageListGetSize¶

spinImageListGetSize (
    spinImageList hImageList,
    size_t * pSize
)

Retrieves the number of images in an image list

See also: spinError

Parameters:

hImageList The image list where the images to be counted are
pSize The unsigned integer pointer in which the number of images is returned

Returns:

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

function spinImageListLoad¶

spinImageListLoad (
    spinImageList * phImageList,
    const char * fileName
)

Creates an image list object from file.

See also: spinImageListSave()

See also: spinError

Parameters:

phImageList The image list handle pointer in which the empty image list is returned
fileName Name of the file to load an image object from.

Returns:

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

function spinImageListRelease¶

spinImageListRelease (
    spinImageList hImageList
)

function spinImageListRemove¶

spinImageListRemove (
    spinImageList hImageList,
    size_t index
)

Removes a image from a image list using its index

See also: spinError

Parameters:

hImageList The image list of the camera to remove
index The index of the image to remove

Returns:

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

function spinImageListRemoveByPixelFormat¶

spinImageListRemoveByPixelFormat (
    spinImageList hImageList,
    spinPixelFormatEnums pixelFormat
)

Removes a image from a image list using its pixel format

See also: spinError

Parameters:

hImageList The image list of the image to remove
pixelFormat The pixel format of the image to remove

Returns:

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

function spinImageListRemoveByStreamIndex¶

spinImageListRemoveByStreamIndex (
    spinImageList hImageList,
    uint64_t streamIndex
)

Removes a image from a image list using its stream index

See also: spinError

Parameters:

hImageList The image list of the image to remove
streamIndex The stream index of the image to remove

Returns:

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

function spinImageListSave¶

spinImageListSave (
    spinImageList hImageList,
    const char * fileName
)

Saves an image list as an object to a file.

See also: spinImageListLoad()

See also: spinError

Parameters:

hImageList The image list of the image to remove
fileName Name of the file to save the current image list object to. It is recommended to use the file extension 'sil'.

Returns:

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