HGL::ImageOutput::IOutput Interface Reference
[Image output plugins]

Interface for writing images into a file. More...

#include <ioutput.h>

List of all members.

Public Member Functions
Information functions
virtual std::string	getOutputFilename () const =0
	Get the effective output filename of the rendered picture.
Command line options support
virtual struct::poptOption *	getPoptOptions () const
	Get plugin supplied command line options.
Bitmap render methods
virtual void	writeImage (const ICanvas &canvas, const std::string &filename=std::string()) const =0 throw (ImageOutputException)
	Writes an ICanvas bitmap into an image.

---

Detailed Description

Interface for writing images into a file.

See Image Output Plugins in detail for more information.

See also:

REGISTER_IOPLUGIN

Deprecated:

New plugins have to use the interface IPreRenderOutput. This interface exists only for compatibility to pre 0.4.70 plugins.

Author:

Heiko Schäfer <heiko@hgl.rangun.de> BSD License

---

Member Function Documentation

virtual std::string HGL::ImageOutput::IOutput::getOutputFilename

(

)

const [pure virtual]

Get the effective output filename of the rendered picture.

It should return an empty std::string if the standard output is used

Returns:

the output filename of the rendered picture

Implemented in HGL::ImageOutput::DefaultPreRenderOutput.

virtual struct ::poptOption* HGL::Common::IPluginPoptOptions::getPoptOptions

(

)

const [virtual, inherited]

Get plugin supplied command line options.

Note:

See http://linux.die.net/man/3/popt for how to create and use the popt structure and Command line options support for details on how to use it in your plugins.

The default implementation returns NULL i.e. it won't provide own command line options

In your POPT_ARG_CALLBACK you can indicate HGL to exit gracefully by throwing HGL::Exception::PoptExitException

Returns:

structure to popt options

Since:

0.4.53

virtual void HGL::ImageOutput::IOutput::writeImage	(	const ICanvas &	canvas,
		const std::string &	filename = std::string()
	)			const throw (ImageOutputException) [pure virtual]

Writes an ICanvas bitmap into an image.

Parameters:

	canvas	the ICanvas bitmap to write
	filename	filename to write the image to, if the filename is the empty string it should write to the standard output

Exceptions:

ImageOutputException

if an unrecoverable error occured while writing

See also:

Writer

Implemented in HGL::ImageOutput::DefaultPreRenderOutput.