Murl::Util::OutlineRasterizer Class Reference

A class for rasterizing vector outlines. More...

#include "murl_util_outline_rasterizer.h"

Classes
class	Handle
	A handle for rasterizing individual vector outlines. More...

Public Member Functions
const Handle *	BeginRasterizing ()
	Begin rasterizing a sequence of outlines. More...
Bool	EndRasterizing (const Handle *handle)
	End rasterizing a sequence of outlines. More...
Bool	Rasterize (const Handle *handle, const Resource::IOutline *outline, const Color &outlineColor, const Color &backColor, IVideoSurface *surface, Real posX, Real posY, Real scaleX, Real scaleY, Real embolden, UInt32 flags)
	Rasterize an outline. More...

Static Public Member Functions
static OutlineRasterizer *	Acquire ()
	Acquire a rasterizer. More...
static Bool	Release (OutlineRasterizer *&rasterizer)
	Release a previously acquired rasterizer. More...

Detailed Description

A class for rasterizing vector outlines.

Member Function Documentation

Acquire()

static OutlineRasterizer* Murl::Util::OutlineRasterizer::Acquire ( )

static

Acquire a rasterizer.

Each call to Acquire() must have a corresponding call to Release(), when the rasterizer is not needed anymore.

Returns

The rasterizer instance.

Release()

static Bool Murl::Util::OutlineRasterizer::Release ( OutlineRasterizer *&  rasterizer )

static

Release a previously acquired rasterizer.

Parameters

rasterizer

A reference to a pointer of the rasterizer to be released.

Returns

true if successful.

BeginRasterizing()

const Handle* Murl::Util::OutlineRasterizer::BeginRasterizing

(

)

Begin rasterizing a sequence of outlines.

Rasterizing any number of outlines must always be enclosed within paired calls to BeginRasterizing() and EndRasterizing(). These methods ensure that no two threads are using the same rasterizer instance concurrently, by locking/unlocking an internal mutex.

Returns

A pointer to a rasterizer handle, or null if failed.

EndRasterizing()

Bool Murl::Util::OutlineRasterizer::EndRasterizing

(

const Handle *

handle

)

End rasterizing a sequence of outlines.

Parameters

handle

The rasterizer handle obtained via BeginRasterizing().

Returns

true if successful.

Rasterize()

Bool Murl::Util::OutlineRasterizer::Rasterize	(	const Handle *	handle,
		const Resource::IOutline *	outline,
		const Color &	outlineColor,
		const Color &	backColor,
		IVideoSurface *	surface,
		Real	posX,
		Real	posY,
		Real	scaleX,
		Real	scaleY,
		Real	embolden,
		UInt32	flags
	)

Rasterize an outline.

Parameters

handle	A handle obtained via BeginRasterizing().
outline	The resource outline object to rasterize.
outlineColor	The outline color.
backColor	The background color.
surface	The output surface to rasterize to.
posX	The horizontal position of the outline in the surface.
posY	The vertical position of the outline in the surface.
scaleX	The horizontal scale factor.
scaleY	The vertical scale factor.
embolden	The emboldening value. A value of 0.0 renders an unmodified outline, a negative value produces a thinner outline.
flags	A bit-mask of flags from the IEnums::TextHint enumeration.

Returns

true if successful.

---

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

• murl_util_outline_rasterizer.h