AOI_Renderer Class Reference

Renderer / RIP. More...

Public Member Functions
	AOI_Renderer (AOI_Document &doc)
ExceptionCode	Setup (const aur::ACPL::FileSpec &profilePath, const aur::ACPL::StringList &extraChannels, int32_t bytesPerComponent, void *banddata, int32_t w, int32_t h, bool alpha, bool shape=false)
void	SetColorConvertCallBack (ColorConvertCB cb, void *ref)
void	SetAntiAlias (bool)
void	SetMapping (const AOI_Mapping &docToBandMap)
void	Render (const AOI_Rectangle &docRect, AOI_ObjectPtr toRenderObj=NULL)

Detailed Description

Renderer / RIP.

See also

AOI_WriteTIFF, AOI_Screener

The renderer is the actual engine that converts a page to pixels and renders everything down to an image.

The renderer can render a complete page at once or in band or in tiles depending on the resource limitations that are present on the computer or imposed by the output device.

Definition at line 23 of file AOI_Renderer.h.

Constructor & Destructor Documentation

AOI_Renderer()

AOI_Renderer::AOI_Renderer

(

AOI_Document &

doc

)

Constructor of a renderer (aka RIP) that is to be used to render the given document.

Parameters

doc	Document that will be used to display.

Definition at line 126 of file AOI_Renderer.cpp.

Member Function Documentation

Render()

void AOI_Renderer::Render	(	const AOI_Rectangle &	docRect,
		AOI_ObjectPtr	toRenderObj = NULL )

Render the page. This is the actual render call. Before calling this method the following method must be called once:

• Setup
• SetMapping

This method defines which part of the page (crop) will be rendered. Using multiple calls of SetMapping and Render allows the host to render multiple tiles in the output.

Parameters

docRect	Rectangle (crop) in the page that needs to be rendered.
toRenderObj	Pointer to the object to render. This can be a group or any type of object. Passing NULL will render the complete document content.

Definition at line 265 of file AOI_Renderer.cpp.

SetAntiAlias()

void AOI_Renderer::SetAntiAlias

(

bool

on

)

Turn anti-aliasing on or off.

Anti-aliasing currently is limited to text only.

Parameters

on	True when to use anti-aliasing.

Definition at line 163 of file AOI_Renderer.cpp.

SetColorConvertCallBack()

void AOI_Renderer::SetColorConvertCallBack	(	ColorConvertCB	cb,
		void *	ref )

Set the routine that will be called to convert colors to inks. The renderer will call this routine for each color. Then the routine is not supplied or returns false then the internal CMM is used.

Parameters

cb	Routine called to convert colors to inks
ref	Private pointer that will be supplied to the routine every time it is called

Definition at line 148 of file AOI_Renderer.cpp.

SetMapping()

void AOI_Renderer::SetMapping

(

const AOI_Mapping &

docToBandMap

)

Sets the mapping of the current page to the output band. This mapping defines which part of the page is rendered (banding) and at which resolution. Default the identity mapping is set. This means that the page will be rendered from the top left (0,0) at 18 DPI (because 1 AOI unit is 1/18th of an inch).

Parameters

docToBandMap

Mapping to be used when rendering the page

Definition at line 243 of file AOI_Renderer.cpp.

Setup()

ExceptionCode AOI_Renderer::Setup	(	const aur::ACPL::FileSpec &	profilePath,
		const aur::ACPL::StringList &	extraChannels,
		int32_t	bytesPerComponent,
		void *	banddata,
		int32_t	w,
		int32_t	h,
		bool	alpha,
		bool	shape = false )

Sets up the renderer before calling actual render calls. The setup defines the output bitmap(band) format and output channels/inks among others.

The allowed output formats are dictated by the license.

Parameters

profilePath	Unicode full path to the ICC profile used to convert colors to. This profile is required even if all color conversion are done through the callback routine. The renderer uses this ICC profile to determine the first set of the channels.
extraChannels	Names of the additional channels. These can be any names as long as they are unique.
bytesPerComponent	Number of bytes per component. Allowed are 1 (8 bit rendering) or 2 (16 bit rendering).
banddata	Pointer to the memory where the renderer will write the output in contone.
w	Width in pixels of the output band. The banddata is assumed to be w * bytesPerComponent * channels * h bytes is size.
h	Height in pixels of the output band.
alpha	True is an alpha channel is to be added. This adds up in the channel count needed to define the bandsize.
shape	True is an shape channel is to be added. This adds up in the channel count needed to define the bandsize.

Returns

Error during setup. 1 is a license violation, others are OS errors.

Definition at line 187 of file AOI_Renderer.cpp.

---

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

• C:/Environments/desktop/Source/PDFEngine/OpenAPI/AOI_Renderer.h
• C:/Environments/desktop/Source/PDFEngine/OpenAPI/AOI_Renderer.cpp