eLynx::Image::IImageFileFormat Class Reference

Interface defining an image file format. More...

#include <IImageFileFormat.h>

Inheritance diagram for eLynx::Image::IImageFileFormat:

List of all members.

Public Member Functions
Import image from file
virtual size_t	GetInputExtCount () const =0
	Get the number of supported file extension for input file.
virtual const char *	GetInputExt (size_t iIndex) const =0
	Get the ith supported file extension for input file.
virtual bool	IsSupported (const char *iprFilename, ImageFileInfo &oInfo, bool ibPreview=false) const =0
	Check is the file is supported by this format.
virtual bool	GeneratePreview (const char *iprFilenameIn, const char *iprFilenameOut, ProgressNotifier &iNotifier) const =0
	Generate a preview file from source file.
virtual bool	Import (ImageVariant &oImage, const char *iprFilename, ImageFileInfo &oInfo, ProgressNotifier &iNotifier)=0
	Import an image from filename.
Export image to file
virtual size_t	GetOutputExtCount () const =0
	Get the number of supported file extension for output file.
virtual const char *	GetOutputExt (size_t iIndex) const =0
	Get the ith supported file extension for output file.
virtual size_t	GetOutputImageFormatCount () const =0
	Get the number of supported image pixel format for output file.
virtual EPixelFormat	GetOutputPixelFormat (size_t iIndex) const =0
	Get the ith supported format for export.
virtual bool	Export (const ImageVariant &iImage, const char *iprFilename, ProgressNotifier &iNotifier, const ImageFileOptions *iprOptions=NULL)=0
	Export image to file.

---

Detailed Description

Interface defining an image file format.

TODO

---

Member Function Documentation

virtual bool eLynx::Image::IImageFileFormat::Export	(	const ImageVariant &	iImage,
		const char *	iprFilename,
		ProgressNotifier &	iNotifier,
		const ImageFileOptions *	iprOptions = NULL
	)		[pure virtual]

Export image to file.

Parameters:

iImage	The image to export.
iprFilename	The image filename.
iNotifier	a notifier for progression and cancel.
iprOptions	Some specific format options.

Returns:

true if image has been saved, false otherwise.

virtual bool eLynx::Image::IImageFileFormat::GeneratePreview	(	const char *	iprFilenameIn,
		const char *	iprFilenameOut,
		ProgressNotifier &	iNotifier
	)		const [pure virtual]

Generate a preview file from source file.

Parameters:

iprFilenameIn	The input file name, file to be readed.
iprFilenameOut	The preview file name, file to be writen.
iNotifier	a notifier for progression and cancel.

Returns:

true if preview has been generated, false otherwise.

virtual const char* eLynx::Image::IImageFileFormat::GetInputExt

(

size_t

iIndex )

const [pure virtual]

Get the ith supported file extension for input file.

Parameters:

iIndex

The index in range [0, GetInputExtCount()-1].

Returns:

The const reference pointer on extension, NULL if bad index.

virtual size_t eLynx::Image::IImageFileFormat::GetInputExtCount

(

)

const [pure virtual]

Get the number of supported file extension for input file.

Returns:

The number of supported file extension for reading.

virtual const char* eLynx::Image::IImageFileFormat::GetOutputExt

(

size_t

iIndex )

const [pure virtual]

Get the ith supported file extension for output file.

Parameters:

iIndex

The index in range [0, GetOutputExtCount()-1].

Returns:

The const reference pointer on extension, NULL if bad index.

virtual size_t eLynx::Image::IImageFileFormat::GetOutputExtCount

(

)

const [pure virtual]

Get the number of supported file extension for output file.

Returns:

The number of supported file extension for writing.

virtual size_t eLynx::Image::IImageFileFormat::GetOutputImageFormatCount

(

)

const [pure virtual]

Get the number of supported image pixel format for output file.

Returns:

The number of supported image pixel format for writing.

virtual EPixelFormat eLynx::Image::IImageFileFormat::GetOutputPixelFormat

(

size_t

iIndex )

const [pure virtual]

Get the ith supported format for export.

Parameters:

iIndex

The index in range [0, GetOutputImageFormatCount()-1].

Returns:

the ith supported pixel format.

virtual bool eLynx::Image::IImageFileFormat::Import	(	ImageVariant &	oImage,
		const char *	iprFilename,
		ImageFileInfo &	oInfo,
		ProgressNotifier &	iNotifier
	)		[pure virtual]

Import an image from filename.

Parameters:

oImage	The variant image receiving the new image implementation.
iprFilename	The image filename to create.
oInfo	Informations that could be retrieved from file.
iNotifier	a notifier for progression and cancel.

Returns:

true if file has been loaded, false otherwise.

virtual bool eLynx::Image::IImageFileFormat::IsSupported	(	const char *	iprFilename,
		ImageFileInfo &	oInfo,
		bool	ibPreview = false
	)		const [pure virtual]

Check is the file is supported by this format.

It checks filename extension and file header integrity. Be carefull, file can be valid but not supported !

Parameters:

iprFilename	The filename of the file to check.
oInfo	Informations that could be retrieved from file.
ibPreview	Set to true if preview is requested in informations.

Returns:

true if file can be loaded with Import, false otherwise.

---

The documentation for this class was generated from the following file:

• E:/dev/eLynx/include/elx/image/IImageFileFormat.h