CImageSource_interface.h File Reference

Interface for CImageSource wrapper. More...

Go to the source code of this file.

Functions
CImageSource	CImageSource_Create (CIDRS argIDRS, idrs_exception *pargException)
	Create creates a CImageSource object.
enum ImageSource	CImageSource_EstimateSourceType (CImageSource argCImageSource, const CImage argImage, idrs_exception *pargException)
	EstimateSourceType analyzes the image to identify its source.
enum ImageSource	CImageSource_EstimateSourceType2 (CImageSource argCImageSource, const idrs_string strFilePath, idrs_exception *pargException)
	EstimateSourceType analyzes the image file to identify its source.
void	CImageSource_Destroy (CImageSource argCImageSource, idrs_exception *pargException)
	Destroys a CImageSource handle.

Detailed Description

Interface for CImageSource wrapper.

Function Documentation

CImageSource_Create()

CImageSource CImageSource_Create	(	CIDRS	argIDRS,
		idrs_exception *	pargException
	)

Create creates a CImageSource object.

Parameters

argIDRS	- CIDRS handle object
pargException	Pointer to exception structure that will be filled if an exception occurs

CImageSource_Destroy()

void CImageSource_Destroy	(	CImageSource	argCImageSource,
		idrs_exception *	pargException
	)

Destroys a CImageSource handle.

Parameters

argCImageSource	CImageSource handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CImageSource_EstimateSourceType()

enum ImageSource CImageSource_EstimateSourceType	(	CImageSource	argCImageSource,
		const CImage	argImage,
		idrs_exception *	pargException
	)

EstimateSourceType analyzes the image to identify its source.

Remarks

If input file is available, EstimateSourceType() overload taking a file path as argument can be more accurate than the overload taking a CImage as argument, because it will also inspect the EXIF metadata when available.

Parameters

argCImageSource	CImageSource handle
argImage	The image to analyze.
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

The type of the source for the image.

CImageSource_EstimateSourceType2()

enum ImageSource CImageSource_EstimateSourceType2	(	CImageSource	argCImageSource,
		const idrs_string	strFilePath,
		idrs_exception *	pargException
	)

EstimateSourceType analyzes the image file to identify its source.

Remarks

If input file is available, EstimateSourceType() overload taking a file path as argument can be more accurate than the overload taking a CImage as argument, because it will also inspect the EXIF metadata when available.

Parameters

argCImageSource	CImageSource handle
strFilePath	The path to the file.
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

The type of the source for the image.