Image output plugins

Classes, methods, etc. related to the development of image output plugins. More...

Classes
struct	HGL::ImageOutput::ICanvas::_transformationInfo
	This structure holds the calculated transformation info. More...
struct	HGL::ImageOutput::CurvePrimitive
	A curve primitive. More...
class	HGL::ImageOutput::DefaultPreRenderOutput
	Empty implementation of the HGL::ImageOutput::IPreRenderOutput interface. More...
struct	HGL::ImageOutput::EllipsePrimitive
	An ellipse primitive. More...
interface	HGL::ImageOutput::ICanvas
	Interface for rendering images to concrete file formats. More...
class	HGL::ImageOutput::ImageOutputException
	Exception thrown if there was an unrecoverable error. More...
interface	HGL::ImageOutput::IOutput
	Interface for writing images into a file. More...
interface	HGL::ImageOutput::IPreRenderOutput
	Interface for writing images into a file. More...
struct	HGL::ImageOutput::LinePrimitive
	A line primitive. More...
struct	HGL::ImageOutput::PointPrimitive
	A point primitive. More...
struct	HGL::ImageOutput::PolyPrimitive
	A poly primitive. More...
struct	HGL::ImageOutput::ICanvas::RGB
	Structure representing a color. More...
struct	HGL::ImageOutput::ICanvas::RGBA
	Structure representing a color. More...
struct	HGL::ImageOutput::TextPrimitive
	A text primitive. More...
class	HGL::ImageOutput::Writer
	A simple exception safe writer for image output plugins. More...

Macros
#define	COLORSPACEINDEX(colorspace, index)
	Returns the index (position) of the color within the colorspace. More...
#define	REGISTER_IOPLUGIN(Typename, ImageType, Name, Author, Copyright, Description)
	Registers the image output plugin with HGL. More...

Typedefs
typedef struct HGL::ImageOutput::ICanvas::_transformationInfo	HGL::ImageOutput::ICanvas::TRANSFORMATIONINFO
	This structure holds the calculated transformation info. More...

Detailed Description

Classes, methods, etc. related to the development of image output plugins.

See Image Output Plugins in detail for more information.

Macro Definition Documentation

#define COLORSPACEINDEX	(		colorspace,
			index
	)

Returns the index (position) of the color within the colorspace.

Use this macro if you need the index (position) of a given color to reference that color

Note

A non-existing color will return a value beyond the size of the colorspace

Parameters

colorspace	the colorspace
index	the color index

Returns

the index (position) of the given color

Since

0.4.49

#define REGISTER_IOPLUGIN	(		Typename,
			ImageType,
			Name,
			Author,
			Copyright,
			Description
	)

Registers the image output plugin with HGL.

Put this macro into the C++-implementation file of your plugin. Example of usage:

* REGISTER_IOPLUGIN(PNGOutput,
*                   "PNG",
*                   L"PNG Image Output",
*                   L"Heiko Schäfer",
*                   L"© 2013 by Heiko Schäfer <heiko@hgl.rangun.de>",
*                   L"writes PNG images")
* 

Parameters

Typename	the class name of your plugin
ImageType	the image type this plugin produces
Name	the name of this plugin
Author	the author of this plugin
Copyright	a copyright message
Description	a short description of the plugin

Examples:

exampleoutput.cpp.

Typedef Documentation

typedef struct HGL::ImageOutput::ICanvas::_transformationInfo HGL::ImageOutput::ICanvas::TRANSFORMATIONINFO

This structure holds the calculated transformation info.

Since

0.5.2