myscript::iink::IImagePainter Class Reference

#include <IImagePainter.h>

Public Member Functions
virtual	~IImagePainter ()=default
virtual void	prepareImage (int width, int height, float dpi)=0
virtual void	saveImage (const String &path)=0
virtual std::shared_ptr< graphics::ICanvas >	createCanvas ()=0

Detailed Description

The ImagePainter converts rendering data into images in view e.g. for integration into .docx exports.

Constructor & Destructor Documentation

~IImagePainter()

virtual myscript::iink::IImagePainter::~IImagePainter ( )

virtualdefault

Member Function Documentation

prepareImage()

virtual void myscript::iink::IImagePainter::prepareImage ( int  width, int  height, float  dpi  )

pure virtual

Invoked before starting to draw an image. This call is meant to enable preparation of the image destination in memory (e.g. memory allocation).

Parameters

width	the image width.
height	the image height.
dpi	the resolution of the image in dots per inch.

saveImage()

virtual void myscript::iink::IImagePainter::saveImage ( const String &  path )

pure virtual

Invoked once image drawing is over. Requests saving the image to disk.

Parameters

path	the image destination.

createCanvas()

virtual std::shared_ptr< graphics::ICanvas > myscript::iink::IImagePainter::createCanvas ( )

pure virtual

Creates a canvas to draw the image.

Returns

a canvas to draw the image.

Since

2.0

---

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

• iink/IImagePainter.h