CImagePluginCapabilities_interface.h File Reference

Interface for CImagePluginCapabilities wrapper. More...

Go to the source code of this file.

Functions
void	CImagePluginCapabilities_Add (CImagePluginCapabilities argCImagePluginCapabilities, const CImagePluginCapability argCapability, idrs_exception *pargException)
	Adds a new CImagePluginCapability to capabilities list.
void	CImagePluginCapabilities_Add2 (CImagePluginCapabilities argCImagePluginCapabilities, const CImagePluginCapability xCapabilities[], IDRS_UINT32 const uiCapabilitiesCount, idrs_exception *pargException)
	Adds a vector of image capabilities to the capabilities list.
CImagePluginCapability	CImagePluginCapabilities_GetAt (const CImagePluginCapabilities argCImagePluginCapabilities, IDRS_UINT32 const uiIndex, idrs_exception *pargException)
	GetAt returns the CImagePluginCapability at a certain index.
IDRS_UINT32	CImagePluginCapabilities_GetCount (const CImagePluginCapabilities argCImagePluginCapabilities, idrs_exception *pargException)
	GetCount returns the number of capabilities set.
void	CImagePluginCapabilities_RemoveAt (CImagePluginCapabilities argCImagePluginCapabilities, IDRS_UINT32 const uiIndex, idrs_exception *pargException)
	RemoveAt removes a CImagePluginCapability from the list.
void	CImagePluginCapabilities_RemoveAll (CImagePluginCapabilities argCImagePluginCapabilities, idrs_exception *pargException)
	RemoveAll removes all capabilities.
IDRS_BOOL	CImagePluginCapabilities_CanLoad (const CImagePluginCapabilities argCImagePluginCapabilities, const CImageLoadOptions argImageLoadOptions, idrs_exception *pargException)
	This method verifies whether the image plugin is able to load an image format with respect to the provided options.
IDRS_BOOL	CImagePluginCapabilities_CanSave (const CImagePluginCapabilities argCImagePluginCapabilities, const CImageSaveOptions argImageSaveOptions, idrs_exception *pargException)
	This method verifies whether the image plugin is able to save an image format with respect to the provided options.
CImagePluginCapabilities	CImagePluginCapabilities_Create (idrs_exception *pargException)
	Creates a new CImagePluginCapabilities object.
void	CImagePluginCapabilities_Destroy (CImagePluginCapabilities argCImagePluginCapabilities, idrs_exception *pargException)
	Destroys a CImagePluginCapabilities handle.

Detailed Description

Interface for CImagePluginCapabilities wrapper.

Function Documentation

CImagePluginCapabilities_Add()

void CImagePluginCapabilities_Add	(	CImagePluginCapabilities	argCImagePluginCapabilities,
		const CImagePluginCapability	argCapability,
		idrs_exception *	pargException
	)

Adds a new CImagePluginCapability to capabilities list.

Parameters

argCImagePluginCapabilities	CImagePluginCapabilities handle
argCapability	object containing the supported capability.
pargException	Pointer to exception structure that will be filled if an exception occurs

CImagePluginCapabilities_Add2()

void CImagePluginCapabilities_Add2	(	CImagePluginCapabilities	argCImagePluginCapabilities,
		const CImagePluginCapability	xCapabilities[],
		IDRS_UINT32 const	uiCapabilitiesCount,
		idrs_exception *	pargException
	)

Adds a vector of image capabilities to the capabilities list.

Parameters

argCImagePluginCapabilities	CImagePluginCapabilities handle
xCapabilities	Vector containing the capabilities to add
uiCapabilitiesCount	Number of capability objects to add
pargException	Pointer to exception structure that will be filled if an exception occurs

CImagePluginCapabilities_CanLoad()

IDRS_BOOL CImagePluginCapabilities_CanLoad	(	const CImagePluginCapabilities	argCImagePluginCapabilities,
		const CImageLoadOptions	argImageLoadOptions,
		idrs_exception *	pargException
	)

This method verifies whether the image plugin is able to load an image format with respect to the provided options.

Parameters

argCImagePluginCapabilities	CImagePluginCapabilities handle
argImageLoadOptions	The image loading options
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

IDRS_TRUE if the plugin can load the supplied format and options; otherwise IDRS_FALSE

CImagePluginCapabilities_CanSave()

IDRS_BOOL CImagePluginCapabilities_CanSave	(	const CImagePluginCapabilities	argCImagePluginCapabilities,
		const CImageSaveOptions	argImageSaveOptions,
		idrs_exception *	pargException
	)

This method verifies whether the image plugin is able to save an image format with respect to the provided options.

Parameters

argCImagePluginCapabilities	CImagePluginCapabilities handle
argImageSaveOptions	The image saving options
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

IDRS_TRUE if the plugin can save the supplied format and options; otherwise IDRS_FALSE

CImagePluginCapabilities_Create()

CImagePluginCapabilities CImagePluginCapabilities_Create

(

idrs_exception *

pargException

)

Creates a new CImagePluginCapabilities object.

Returns

The newly created CImagePluginCapabilities

Parameters

pargException

Pointer to exception structure that will be filled if an exception occurs

CImagePluginCapabilities_Destroy()

void CImagePluginCapabilities_Destroy	(	CImagePluginCapabilities	argCImagePluginCapabilities,
		idrs_exception *	pargException
	)

Destroys a CImagePluginCapabilities handle.

Parameters

argCImagePluginCapabilities	CImagePluginCapabilities handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CImagePluginCapabilities_GetAt()

CImagePluginCapability CImagePluginCapabilities_GetAt	(	const CImagePluginCapabilities	argCImagePluginCapabilities,
		IDRS_UINT32 const	uiIndex,
		idrs_exception *	pargException
	)

GetAt returns the CImagePluginCapability at a certain index.

Parameters

argCImagePluginCapabilities	CImagePluginCapabilities handle
uiIndex	Index where to read the CImagePluginCapability
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

The CImagePluginCapability at the supplied index

CImagePluginCapabilities_GetCount()

IDRS_UINT32 CImagePluginCapabilities_GetCount	(	const CImagePluginCapabilities	argCImagePluginCapabilities,
		idrs_exception *	pargException
	)

GetCount returns the number of capabilities set.

Returns

The number of capabilities

Parameters

argCImagePluginCapabilities	CImagePluginCapabilities handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CImagePluginCapabilities_RemoveAll()

void CImagePluginCapabilities_RemoveAll	(	CImagePluginCapabilities	argCImagePluginCapabilities,
		idrs_exception *	pargException
	)

RemoveAll removes all capabilities.

Parameters

argCImagePluginCapabilities	CImagePluginCapabilities handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CImagePluginCapabilities_RemoveAt()

void CImagePluginCapabilities_RemoveAt	(	CImagePluginCapabilities	argCImagePluginCapabilities,
		IDRS_UINT32 const	uiIndex,
		idrs_exception *	pargException
	)

RemoveAt removes a CImagePluginCapability from the list.

Parameters

argCImagePluginCapabilities	CImagePluginCapabilities handle
uiIndex	The index where to remove the object
pargException	Pointer to exception structure that will be filled if an exception occurs