com.sun.pisces

Class PiscesRenderer

java.lang.Object

com.sun.pisces.PiscesRenderer

public final class PiscesRenderer
extends Object

PiscesRenderer class is basic public API accessing Pisces library capabilities. Pisces renderer is intended to draw directly into underlying data buffer of AbstractSurface. Basic implementation of AbstractSurface is e.g. GraphicsSurface. All coordinates are in 15.16 representation. ie. 13 will be passed as 13<<16. Simple use-case for PiscesRenderer together with GraphicsSurface would be e.g. -

GraphicsSurface surface = new GraphicsSurface();

PiscesRenderer pr = new PiscesRenderer(surface);


Now, when we have instances ready, we can render something from our paint(Graphics g) method


void paint(Graphics g) {

surface.bindTarget(g);
//we set stroke color
pr.setColor(0xFF, 0x00, 0xAF);
// we set required Porter-Duff Compositing Rule
pr.setComposite(RendererBase.COMPOSITE_SRC_OVER);

//switch antialising on/off as required
pr.setAntialiasing(true); // on

pr.setTransform(ourTransform6Matrix);

//and now let's draw something finally
pr.beginRendering(RendererBase.WIND_EVEN_ODD);
pr.moveTo(50 << 16, 100 << 16); //
pr.lineTo(30<<16, 1<<16); pr.endRendering();

surface.releaseTarget();

}

Field Summary

Fields

Modifier and Type	Field and Description
static int	ARC_CHORD
static int	ARC_OPEN
static int	ARC_PIE

Constructor Summary

Constructors

Constructor and Description
PiscesRenderer(AbstractSurface surface) Creates a renderer that will write into a given surface.

Method Summary

Modifier and Type	Method and Description
void	clearRect(int x, int y, int w, int h) Clears rectangle (x, y, x + w, y + h).
void	drawImage(int imageType, int imageMode, int[] data, int width, int height, int offset, int stride, Transform6 textureTransform, boolean repeat, int bboxX, int bboxY, int bboxW, int bboxH, int lEdge, int rEdge, int tEdge, int bEdge, int txMin, int tyMin, int txMax, int tyMax, boolean hasAlpha)
void	emitAndClearAlphaRow(byte[] alphaMap, int[] alphaDeltas, int pix_y, int pix_x_from, int pix_x_to, int rowNum)
void	fillAlphaMask(byte[] mask, int x, int y, int width, int height, int offset, int stride)
void	fillLCDAlphaMask(byte[] mask, int x, int y, int width, int height, int offset, int stride)
void	fillRect(int x, int y, int w, int h)
protected void	finalize()
void	resetClip() Resets the clip rectangle.
void	setClip(int minX, int minY, int width, int height) Sets a clip rectangle for all primitives.
void	setColor(int red, int green, int blue) Sets the current paint color.
void	setColor(int red, int green, int blue, int alpha) Sets the current paint color.
void	setCompositeRule(int compositeRule) Sets current Compositing Rule (Porter-Duff) to be used in following rendering operation.
void	setLCDGammaCorrection(float gamma)
void	setLinearGradient(int x0, int y0, int x1, int y1, GradientColorMap gradientColorMap, Transform6 gradientTransform) This method sets linear color-gradient data to be used as paint data in following rendering operation.
void	setLinearGradient(int x0, int y0, int x1, int y1, int[] fractions, int[] rgba, int cycleMethod, Transform6 gradientTransform) This method sets linear color-gradient data to be used as paint data in following rendering operation.
void	setLinearGradient(int x0, int y0, int color0, int x1, int y1, int color1, int cycleMethod) Java2D-style linear gradient creation.
void	setRadialGradient(int cx, int cy, int fx, int fy, int radius, GradientColorMap gradientColorMap, Transform6 gradientTransform) This method sets radial gradient paint data to be used in subsequent rendering.
void	setRadialGradient(int cx, int cy, int fx, int fy, int radius, int[] fractions, int[] rgba, int cycleMethod, Transform6 gradientTransform) This method sets radial gradient paint data to be used in subsequent rendering.
void	setTexture(int imageType, int[] data, int width, int height, int stride, Transform6 textureTransform, boolean repeat, boolean hasAlpha)

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ARC_OPEN

public static final int ARC_OPEN

See Also:

Constant Field Values

ARC_CHORD

public static final int ARC_CHORD

See Also:

Constant Field Values

ARC_PIE

public static final int ARC_PIE

See Also:

Constant Field Values

Constructor Detail

PiscesRenderer

public PiscesRenderer(AbstractSurface surface)

Creates a renderer that will write into a given surface.

Parameters:

surface - destination surface

Method Detail

setColor

public void setColor(int red,
                     int green,
                     int blue,
                     int alpha)

Sets the current paint color.

Parameters:

red - a value between 0 and 255.

green - a value between 0 and 255.

blue - a value between 0 and 255.

alpha - a value between 0 and 255.

setColor

public void setColor(int red,
                     int green,
                     int blue)

Sets the current paint color. An alpha value of 255 is used. Calling setColor also switches painting mode - i.e. if we have specified gradient, or texture previously, this will be overcome with setColor call. Also note, that 3-param setColor sets fully opaque RGB color. To draw with semi-transparent color use 4-param convenience method.

Parameters:

red - a value between 0 and 255.

green - a value between 0 and 255.

blue - a value between 0 and 255.

setCompositeRule

public void setCompositeRule(int compositeRule)

Sets current Compositing Rule (Porter-Duff) to be used in following rendering operation. Note that compositeAlpha is not changed.

Parameters:

compositeRule - one of RendererBase.COMPOSITE_* constants.

setLinearGradient

public void setLinearGradient(int x0,
                              int y0,
                              int x1,
                              int y1,
                              int[] fractions,
                              int[] rgba,
                              int cycleMethod,
                              Transform6 gradientTransform)

This method sets linear color-gradient data to be used as paint data in following rendering operation. Imagine, we want to draw simple gradient from blue to red color. Each pixel on line perpendicular to line L = [[x0,y0], [x1, y1]] will have same constant color. Pixels on perpendicular-line which passes [x0, y0] will be blue. Those on line passing [x1, y1] will be red. Colors on lines in between will be interpolated by fractions.

Parameters:

x0 - x-coordinate of the starting point of the linear gradient

y0 - y-coordinate of the starting point of the linear gradient

x1 - x-coordinate of the end point of the linear gradient

y0 - y-coordinate of the end point of the linear gradient

fractions - this array defines normalized distances in which color (rgba[i]) starts to fade into next color (rgba[i+1]). This distance from the point [x0,y0] is given as fraction[i]*l, where l is length of line [[x0,y0], [x1,y1]]. fraction[i+1] says, in what distance fraction[i+1]*l from [x0,y0] should color already have firm value of rgba[i+1]. Values passed in fractions should be from interval <0.0, 1.0>, in 15.16 format.

rgba - colors which the linear gradient passes through. Generally should be fulfilled this formula rgba.length == fractions.length

cycleMethod - some value from GradientColorMap.CYCLE_*. @see GradienColorMap

gradientTransform - transformation applied to gradient paint data. This way we can either transform gradient fill together with filled object or leave it as if transformed gradient-filled object was a window through which we observe gradient area.

See Also:

GradienColorMap

setLinearGradient

public void setLinearGradient(int x0,
                              int y0,
                              int x1,
                              int y1,
                              GradientColorMap gradientColorMap,
                              Transform6 gradientTransform)

This method sets linear color-gradient data to be used as paint data in following rendering operation. Imagine, we want to draw simple gradient from blue to red color. Each pixel on line perpendicular to line L = [[x0,y0], [x1, y1]] will have same constant color. Pixels on perpendicular-line which passes [x0, y0] will be blue. Those on line passing [x1, y1] will be red. Colors on lines in between will be interpolated by fractions.

Parameters:

x0 - x-coordinate of the starting point of the linear gradient

y0 - y-coordinate of the starting point of the linear gradient

x1 - x-coordinate of the end point of the linear gradient

y0 - y-coordinate of the end point of the linear gradient

gradientColorMap - The GradientColorMap calculated with @see calculateLinearGradient.

gradientTransform - transformation applied to gradient paint data. This way we can either transform gradient fill together with filled object or leave it as if transformed gradient-filled object was a window through which we observe gradient area.

See Also:

GradienColorMap

setLinearGradient

public void setLinearGradient(int x0,
                              int y0,
                              int color0,
                              int x1,
                              int y1,
                              int color1,
                              int cycleMethod)

Java2D-style linear gradient creation. The color changes proportionally between point P0 (color0) nad P1 (color1). Cycle method constants are defined in GradientColorMap (CYCLE_*). This is convenience method only. Same as if setLinearGradient method with 8 parameters was called with fractions = {0x0000, 0x10000}, rgba = {color0, color1} and identity transformation matrix.

Parameters:

x0 - x coordinate of point P0

y0 - y coordinate of point P0

color0 - color of P0

x1 - x coordinate of point P1

y1 - y coordinate of point P1

color1 - color of P1

cycleMethod - type of cycling of the gradient (NONE, REFLECT, REPEAT) As Pisces Gradient support was added to support features introduced in SVG, see e.g. http://www.w3.org/TR/SVG11/pservers.html for more information and examples.

setRadialGradient

public void setRadialGradient(int cx,
                              int cy,
                              int fx,
                              int fy,
                              int radius,
                              int[] fractions,
                              int[] rgba,
                              int cycleMethod,
                              Transform6 gradientTransform)

This method sets radial gradient paint data to be used in subsequent rendering. Radial gradient data generated will be used to fill the touched pixels of the path we draw.

Parameters:

cx - cx, cy and radius triplet defines the largest circle for the gradient. 100% gradient stop is mapped to perimeter of this circle.

cy -

fx - fx,fy defines focal point of the gradient. ie. 0% gradient stop is mapped to fx,fy point. If cx == fx and cy == fy, then gradient consists of homocentric circles. If these relations are not met, gradient field is deformed and eccentric ovals can be observed.

fy -

radius - @see cx

fractions - @see setLinearGradient

rgba - @see setLinearGradient

cycleMethod - @see setLinearGradient

gradientTransform - @see setLinearGradient As Pisces Gradient support was added to support features introduced in SVG, see e.g. http://www.w3.org/TR/SVG11/pservers.html for more information and examples.

setRadialGradient

public void setRadialGradient(int cx,
                              int cy,
                              int fx,
                              int fy,
                              int radius,
                              GradientColorMap gradientColorMap,
                              Transform6 gradientTransform)

This method sets radial gradient paint data to be used in subsequent rendering. Radial gradient data generated will be used to fill the touched pixels of the path we draw.

Parameters:

cx - cx, cy and radius triplet defines the largest circle for the gradient. 100% gradient stop is mapped to perimeter of this circle.

cy -

fx - fx,fy defines focal point of the gradient. ie. 0% gradient stop is mapped to fx,fy point. If cx == fx and cy == fy, then gradient consists of homocentric circles. If these relations are not met, gradient field is deformed and eccentric ovals can be observed.

fy -

radius - @see cx

gradientColorMap - @see setLinearGradient

gradientTransform - @see setLinearGradient As Pisces Gradient support was added to support features introduced in SVG, see e.g. http://www.w3.org/TR/SVG11/pservers.html for more information and examples.

setTexture

public void setTexture(int imageType,
                       int[] data,
                       int width,
                       int height,
                       int stride,
                       Transform6 textureTransform,
                       boolean repeat,
                       boolean hasAlpha)

setClip

public void setClip(int minX,
                    int minY,
                    int width,
                    int height)

Sets a clip rectangle for all primitives. Each primitive will be clipped to the intersection of this rectangle and the destination image bounds.

resetClip

public void resetClip()

Resets the clip rectangle. Each primitive will be clipped only to the destination image bounds.

clearRect

public void clearRect(int x,
                      int y,
                      int w,
                      int h)

Clears rectangle (x, y, x + w, y + h). Clear sets all pixels to transparent black (0x00000000 ARGB).

fillRect

public void fillRect(int x,
                     int y,
                     int w,
                     int h)

emitAndClearAlphaRow

public void emitAndClearAlphaRow(byte[] alphaMap,
                                 int[] alphaDeltas,
                                 int pix_y,
                                 int pix_x_from,
                                 int pix_x_to,
                                 int rowNum)

fillAlphaMask

public void fillAlphaMask(byte[] mask,
                          int x,
                          int y,
                          int width,
                          int height,
                          int offset,
                          int stride)

setLCDGammaCorrection

public void setLCDGammaCorrection(float gamma)

fillLCDAlphaMask

public void fillLCDAlphaMask(byte[] mask,
                             int x,
                             int y,
                             int width,
                             int height,
                             int offset,
                             int stride)

drawImage

public void drawImage(int imageType,
                      int imageMode,
                      int[] data,
                      int width,
                      int height,
                      int offset,
                      int stride,
                      Transform6 textureTransform,
                      boolean repeat,
                      int bboxX,
                      int bboxY,
                      int bboxW,
                      int bboxH,
                      int lEdge,
                      int rEdge,
                      int tEdge,
                      int bEdge,
                      int txMin,
                      int tyMin,
                      int txMax,
                      int tyMax,
                      boolean hasAlpha)

finalize

protected void finalize()

Overrides:

finalize in class Object