juce::EdgeTable Class Reference

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

#include <juce_EdgeTable.h>

Collaboration diagram for juce::EdgeTable:

Classes
struct	LineItem

Public Member Functions
	EdgeTable (const RectangleList< float > &rectanglesToAdd)
	Creates an edge table containing a rectangle list.
	EdgeTable (const RectangleList< int > &rectanglesToAdd)
	Creates an edge table containing a rectangle list.
	EdgeTable (Rectangle< float > rectangleToAdd)
	Creates an edge table containing a rectangle.
	EdgeTable (Rectangle< int > clipLimits, const Path &pathToAdd, const AffineTransform &transform)
	Creates an edge table containing a path.
	EdgeTable (Rectangle< int > rectangleToAdd)
	Creates an edge table containing a rectangle.
void	clipLineToMask (int x, int y, const uint8 *mask, int maskStride, int numPixels)
void	clipToEdgeTable (const EdgeTable &)
void	clipToRectangle (Rectangle< int > r)
void	excludeRectangle (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.
void	multiplyLevels (float factor)
	Scales all the alpha-levels in the table by the given multiplier.
void	optimiseTable ()
	Reduces the amount of space the table has allocated.
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	remapWithExtraSpace (int numPointsNeeded)
void	sanitiseLevels (bool useNonZeroWinding) noexcept

Private Attributes
Rectangle< int >	bounds
int	lineStrideElements
int	maxEdgesPerLine
bool	needToCheckEmptiness = true
CopyableHeapBlock< int >	table

Static Private Attributes
static constexpr auto	defaultEdgesPerLine = 32
static constexpr auto	scale = 256

Detailed Description

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

See also

Path, Graphics

@tags{Graphics}

Constructor & Destructor Documentation

EdgeTable() [1/5]

juce::EdgeTable::EdgeTable	(	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/5]

juce::EdgeTable::EdgeTable ( Rectangle< int >  rectangleToAdd )

explicit

Creates an edge table containing a rectangle.

EdgeTable() [3/5]

juce::EdgeTable::EdgeTable ( Rectangle< float >  rectangleToAdd )

explicit

Creates an edge table containing a rectangle.

EdgeTable() [4/5]

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

explicit

Creates an edge table containing a rectangle list.

EdgeTable() [5/5]

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

explicit

Creates an edge table containing a rectangle list.

Member Function Documentation

addEdgePoint()

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

private

addEdgePointPair()

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

private

allocate()

void juce::EdgeTable::allocate ( )

private

clearLineSizes()

void juce::EdgeTable::clearLineSizes ( )

privatenoexcept

clipEdgeTableLineToRange()

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

privatenoexcept

clipLineToMask()

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

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

clipToEdgeTable()

void juce::EdgeTable::clipToEdgeTable

(

const EdgeTable &

)

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

clipToRectangle()

void juce::EdgeTable::clipToRectangle

(

Rectangle< int >

r

)

Referenced by juce::RenderingHelpers::ClipRegions::EdgeTableRegion< SavedStateType >::clipToRectangle(), and juce::RenderingHelpers::ClipRegions::EdgeTableRegion< SavedStateType >::straightClipImage().

excludeRectangle()

void juce::EdgeTable::excludeRectangle

(

Rectangle< int >

r

)

Referenced by juce::RenderingHelpers::ClipRegions::EdgeTableRegion< SavedStateType >::clipToRectangleList(), and juce::RenderingHelpers::ClipRegions::EdgeTableRegion< SavedStateType >::excludeClipRectangle().

getMaximumBounds()

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

inlinenoexcept

Referenced by juce::RenderingHelpers::ClipRegions::EdgeTableRegion< SavedStateType >::clipRegionIntersects(), juce::RenderingHelpers::ClipRegions::EdgeTableRegion< SavedStateType >::clipToImageAlpha(), juce::RenderingHelpers::ClipRegions::EdgeTableRegion< SavedStateType >::clipToPath(), juce::RenderingHelpers::ClipRegions::EdgeTableRegion< SavedStateType >::clipToRectangleList(), juce::RenderingHelpers::ClipRegions::EdgeTableRegion< SavedStateType >::fillRectWithColourImpl(), juce::RenderingHelpers::ClipRegions::EdgeTableRegion< SavedStateType >::getClipBounds(), and juce::RenderingHelpers::ClipRegions::EdgeTableRegion< SavedStateType >::transformedClipImage().

intersectWithEdgeTableLine()

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

private

isEmpty()

bool juce::EdgeTable::isEmpty ( )

noexcept

Referenced by juce::RenderingHelpers::ClipRegions::EdgeTableRegion< SavedStateType >::clipToEdgeTable(), juce::RenderingHelpers::ClipRegions::EdgeTableRegion< SavedStateType >::clipToImageAlpha(), juce::RenderingHelpers::ClipRegions::EdgeTableRegion< SavedStateType >::clipToPath(), juce::RenderingHelpers::ClipRegions::EdgeTableRegion< SavedStateType >::clipToRectangle(), juce::RenderingHelpers::ClipRegions::EdgeTableRegion< SavedStateType >::clipToRectangleList(), and juce::RenderingHelpers::ClipRegions::EdgeTableRegion< SavedStateType >::excludeClipRectangle().

iterate()

template<class EdgeTableIterationCallback >

void juce::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 juce::EdgeTable::multiplyLevels

(

float

factor

)

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

optimiseTable()

void juce::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 juce::EdgeTable::remapTableForNumEdges ( int  newNumEdgesPerLine )

private

remapWithExtraSpace()

void juce::EdgeTable::remapWithExtraSpace ( int  numPointsNeeded )

private

sanitiseLevels()

void juce::EdgeTable::sanitiseLevels ( bool  useNonZeroWinding )

privatenoexcept

translate()

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

noexcept

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

Member Data Documentation

bounds

Rectangle<int> juce::EdgeTable::bounds

private

defaultEdgesPerLine

constexpr auto juce::EdgeTable::defaultEdgesPerLine = 32

staticconstexprprivate

lineStrideElements

int juce::EdgeTable::lineStrideElements

private

maxEdgesPerLine

int juce::EdgeTable::maxEdgesPerLine

private

needToCheckEmptiness

bool juce::EdgeTable::needToCheckEmptiness = true

private

scale

constexpr auto juce::EdgeTable::scale = 256

staticconstexprprivate

table

CopyableHeapBlock<int> juce::EdgeTable::table

private

---

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

• juce_EdgeTable.h