EdgeTable Class Reference

A table of horizontal scan-line segments - used for rasterising Paths. More...

#include <juce_EdgeTable.h>

Collaboration diagram for EdgeTable:

Classes
struct	LineItem

Public Member Functions
	EdgeTable (const Rectangle< int > &clipLimits, const Path &pathToAdd, const AffineTransform &transform)
	Creates an edge table containing a path. More...
	EdgeTable (const Rectangle< int > &rectangleToAdd)
	Creates an edge table containing a rectangle. More...
	EdgeTable (const RectangleList< int > &rectanglesToAdd)
	Creates an edge table containing a rectangle list. More...
	EdgeTable (const RectangleList< float > &rectanglesToAdd)
	Creates an edge table containing a rectangle list. More...
	EdgeTable (const Rectangle< float > &rectangleToAdd)
	Creates an edge table containing a rectangle. More...
	EdgeTable (const EdgeTable &)
	Creates a copy of another edge table. More...
	~EdgeTable ()
	Destructor. More...
void	clipLineToMask (int x, int y, const uint8 *mask, int maskStride, int numPixels)
void	clipToEdgeTable (const EdgeTable &)
void	clipToRectangle (const Rectangle< int > &r)
void	excludeRectangle (const Rectangle< int > &r)
const Rectangle< int > &	getMaximumBounds () const noexcept
bool	isEmpty () noexcept
template<class EdgeTableIterationCallback >
void	iterate (EdgeTableIterationCallback &iterationCallback) const noexcept
	Iterates the lines in the table, for rendering. More...
void	multiplyLevels (float factor)
	Scales all the alpha-levels in the table by the given multiplier. More...
EdgeTable &	operator= (const EdgeTable &)
	Copies from another edge table. More...
void	optimiseTable ()
	Reduces the amount of space the table has allocated. More...
void	translate (float dx, int dy) noexcept

Private Member Functions
void	addEdgePoint (int x, int y, int winding)
void	addEdgePointPair (int x1, int x2, int y, int winding)
void	allocate ()
void	clearLineSizes () noexcept
void	clipEdgeTableLineToRange (int *line, int x1, int x2) noexcept
void	intersectWithEdgeTableLine (int y, const int *otherLine)
void	remapTableForNumEdges (int newNumEdgesPerLine)
void	sanitiseLevels (bool useNonZeroWinding) noexcept

Static Private Member Functions
static void	copyEdgeTableData (int *dest, int destLineStride, const int *src, int srcLineStride, int numLines) noexcept

Private Attributes
Rectangle< int >	bounds
int	lineStrideElements
int	maxEdgesPerLine
bool	needToCheckEmptiness
HeapBlock< int >	table

Detailed Description

A table of horizontal scan-line segments - used for rasterising Paths.

See also

Path, Graphics

Constructor & Destructor Documentation

EdgeTable() [1/6]

EdgeTable::EdgeTable	(	const Rectangle< int > &	clipLimits,
		const Path &	pathToAdd,
		const AffineTransform &	transform
	)

Creates an edge table containing a path.

A table is created with a fixed vertical range, and only sections of the path which lie within this range will be added to the table.

Parameters

clipLimits	only the region of the path that lies within this area will be added
pathToAdd	the path to add to the table
transform	a transform to apply to the path being added

EdgeTable() [2/6]

EdgeTable::EdgeTable ( const Rectangle< int > &  rectangleToAdd )

explicit

Creates an edge table containing a rectangle.

EdgeTable() [3/6]

EdgeTable::EdgeTable ( const RectangleList< int > &  rectanglesToAdd )

explicit

Creates an edge table containing a rectangle list.

EdgeTable() [4/6]

EdgeTable::EdgeTable ( const RectangleList< float > &  rectanglesToAdd )

explicit

Creates an edge table containing a rectangle list.

EdgeTable() [5/6]

EdgeTable::EdgeTable ( const Rectangle< float > &  rectangleToAdd )

explicit

Creates an edge table containing a rectangle.

EdgeTable() [6/6]

EdgeTable::EdgeTable

(

const EdgeTable &

)

Creates a copy of another edge table.

~EdgeTable()

EdgeTable::~EdgeTable

(

)

Destructor.

Member Function Documentation

addEdgePoint()

void EdgeTable::addEdgePoint ( int  x, int  y, int  winding  )

private

addEdgePointPair()

void EdgeTable::addEdgePointPair ( int  x1, int  x2, int  y, int  winding  )

private

allocate()

void EdgeTable::allocate ( )

private

clearLineSizes()

void EdgeTable::clearLineSizes ( )

privatenoexcept

clipEdgeTableLineToRange()

void EdgeTable::clipEdgeTableLineToRange ( int *  line, int  x1, int  x2  )

privatenoexcept

clipLineToMask()

void EdgeTable::clipLineToMask	(	int	x,
		int	y,
		const uint8 *	mask,
		int	maskStride,
		int	numPixels
	)

Referenced by RenderingHelpers::EdgeTableFillers::ImageFill< DestPixelType, SrcPixelType, repeatPattern >::clipEdgeTableLine(), and RenderingHelpers::EdgeTableFillers::TransformedImageFill< DestPixelType, SrcPixelType, repeatPattern >::clipEdgeTableLine().

clipToEdgeTable()

void EdgeTable::clipToEdgeTable

(

const EdgeTable &

)

Referenced by RenderingHelpers::ClipRegions< SavedStateType >::EdgeTableRegion::clipToImageAlpha(), RenderingHelpers::ClipRegions< SavedStateType >::EdgeTableRegion::clipToPath(), and RenderingHelpers::ClipRegions< SavedStateType >::EdgeTableRegion::fillRectWithColour().

clipToRectangle()

void EdgeTable::clipToRectangle

(

const Rectangle< int > &

r

)

Referenced by RenderingHelpers::ClipRegions< SavedStateType >::EdgeTableRegion::straightClipImage().

copyEdgeTableData()

static void EdgeTable::copyEdgeTableData ( int *  dest, int  destLineStride, const int *  src, int  srcLineStride, int  numLines  )

staticprivatenoexcept

excludeRectangle()

void EdgeTable::excludeRectangle

(

const Rectangle< int > &

r

)

getMaximumBounds()

const Rectangle<int>& EdgeTable::getMaximumBounds ( ) const

inlinenoexcept

References juce::translate().

Referenced by RenderingHelpers::ClipRegions< SavedStateType >::EdgeTableRegion::transformedClipImage().

intersectWithEdgeTableLine()

void EdgeTable::intersectWithEdgeTableLine ( int  y, const int *  otherLine  )

private

isEmpty()

bool EdgeTable::isEmpty ( )

noexcept

iterate()

template<class EdgeTableIterationCallback >

void EdgeTable::iterate ( EdgeTableIterationCallback &  iterationCallback ) const

inlinenoexcept

Iterates the lines in the table, for rendering.

This function will iterate each line in the table, and call a user-defined class to render each pixel or continuous line of pixels that the table contains.

Parameters

iterationCallback

this templated class must contain the following methods: inline void setEdgeTableYPos (int y); inline void handleEdgeTablePixel (int x, int alphaLevel) const; inline void handleEdgeTablePixelFull (int x) const; inline void handleEdgeTableLine (int x, int width, int alphaLevel) const; inline void handleEdgeTableLineFull (int x, int width) const; (these don't necessarily have to be 'const', but it might help it go faster)

References juce::isPositiveAndBelow(), and jassert.

multiplyLevels()

void EdgeTable::multiplyLevels

(

float

factor

)

Scales all the alpha-levels in the table by the given multiplier.

Referenced by RenderingHelpers::SavedStateBase< SoftwareRendererSavedState >::fillEdgeTable().

operator=()

EdgeTable& EdgeTable::operator=

(

const EdgeTable &

)

Copies from another edge table.

optimiseTable()

void EdgeTable::optimiseTable

(

)

Reduces the amount of space the table has allocated.

This will shrink the table down to use as little memory as possible - useful for read-only tables that get stored and re-used for rendering.

remapTableForNumEdges()

void EdgeTable::remapTableForNumEdges ( int  newNumEdgesPerLine )

private

sanitiseLevels()

void EdgeTable::sanitiseLevels ( bool  useNonZeroWinding )

privatenoexcept

translate()

void EdgeTable::translate ( float  dx, int  dy  )

noexcept

Referenced by RenderingHelpers::SavedStateBase< SoftwareRendererSavedState >::fillEdgeTable().

Member Data Documentation

bounds

Rectangle<int> EdgeTable::bounds

private

lineStrideElements

int EdgeTable::lineStrideElements

private

maxEdgesPerLine

int EdgeTable::maxEdgesPerLine

private

needToCheckEmptiness

bool EdgeTable::needToCheckEmptiness

private

table

HeapBlock<int> EdgeTable::table

private

---

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

• juce_EdgeTable.h