final class Graphics

A transparent or opaque bitmap image that contains the bits to be displayed.

A matrix object (of the openfl.geom.Matrix class), which you can use to define transformations on the bitmap. For example, you can use the following matrix to rotate a bitmap by 45 degrees(pi/4 radians):

matrix = new openfl.geom.Matrix();
matrix.rotate(Math.PI / 4);

If true, the bitmap image repeats in a tiled pattern. If false, the bitmap image does not repeat, and the edges of the bitmap are used for any fill area that extends beyond the bitmap.

For example, consider the following bitmap (a 20 x 20-pixel checkerboard pattern):

When repeat is set to true(as in the following example), the bitmap fill repeats the bitmap:

When repeat is set to false, the bitmap fill uses the edge pixels for the fill area outside the bitmap:

If false, upscaled bitmap images are rendered by using a nearest-neighbor algorithm and look pixelated. If true, upscaled bitmap images are rendered by using a bilinear algorithm. Rendering by using the nearest neighbor algorithm is faster.

The color of the fill(0xRRGGBB).

The alpha value of the fill(0.0 to 1.0).

A value from the GradientType class that specifies which gradient type to use: GradientType.LINEAR or GradientType.RADIAL.

An array of RGB hexadecimal color values used in the gradient; for example, red is 0xFF0000, blue is 0x0000FF, and so on. You can specify up to 15 colors. For each color, specify a corresponding value in the alphas and ratios parameters.

An array of alpha values for the corresponding colors in the colors array; valid values are 0 to 1. If the value is less than 0, the default is 0. If the value is greater than 1, the default is 1.

An array of color distribution ratios; valid values are 0-255. This value defines the percentage of the width where the color is sampled at 100%. The value 0 represents the left position in the gradient box, and 255 represents the right position in the gradient box. Note: This value represents positions in the gradient box, not the coordinate space of the final gradient, which can be wider or thinner than the gradient box. Specify a value for each value in the colors parameter. For example, for a linear gradient that includes two colors, blue and green, the following example illustrates the placement of the colors in the gradient based on different values in the ratios array: | ratios | Gradient | | --- | --- | | [0, 127] | | | [0, 255] | | | [127, 255] | | The values in the array must increase sequentially; for example, [0, 63, 127, 190, 255].

A transformation matrix as defined by the openfl.geom.Matrix class. The openfl.geom.Matrix class includes a createGradientBox() method, which lets you conveniently set up the matrix for use with the beginGradientFill() method.

A value from the SpreadMethod class that specifies which spread method to use, either: SpreadMethod.PAD, SpreadMethod.REFLECT, or SpreadMethod.REPEAT. For example, consider a simple linear gradient between two colors:

import flash.geom.*
import flash.display.*
var fillType:String = GradientType.LINEAR;
var colors:Array = [0xFF0000, 0x0000FF];
var alphas:Array = [1, 1];
var ratios:Array = [0x00, 0xFF];
var matr:Matrix = new Matrix();
matr.createGradientBox(20, 20, 0, 0, 0);
var spreadMethod:String = SpreadMethod.PAD;
this.graphics.beginGradientFill(fillType, colors, alphas, ratios, matr, spreadMethod);
this.graphics.drawRect(0,0,100,100);

This example uses SpreadMethod.PAD for the spread method, and the gradient fill looks like the following: If you use SpreadMethod.REFLECT for the spread method, the gradient fill looks like the following: If you use SpreadMethod.REPEAT for the spread method, the gradient fill looks like the following:

A value from the InterpolationMethod class that specifies which value to use: InterpolationMethod.LINEAR_RGB or InterpolationMethod.RGB For example, consider a simple linear gradient between two colors (with the spreadMethod parameter set to SpreadMethod.REFLECT). The different interpolation methods affect the appearance as follows: | | | | --- | --- | |
InterpolationMethod.LINEAR_RGB |
InterpolationMethod.RGB |

A number that controls the location of the focal point of the gradient. 0 means that the focal point is in the center. 1 means that the focal point is at one border of the gradient circle. -1 means that the focal point is at the other border of the gradient circle. A value less than -1 or greater than 1 is rounded to -1 or 1. For example, the following example shows a focalPointRatio set to 0.75:

The shader to use for the fill. This Shader instance is not required to specify an image input. However, if an image input is specified in the shader, the input must be provided manually. To specify the input, set the input property of the corresponding ShaderInput property of the Shader.data property. When you pass a Shader instance as an argument the shader is copied internally. The drawing fill operation uses that internal copy, not a reference to the original shader. Any changes made to the shader, such as changing a parameter value, input, or bytecode, are not applied to the copied shader that's used for the fill.

A matrix object (of the openfl.geom.Matrix class), which you can use to define transformations on the shader. For example, you can use the following matrix to rotate a shader by 45 degrees (pi/4 radians):

matrix = new openfl.geom.Matrix();
matrix.rotate(Math.PI / 4);

The coordinates received in the shader are based on the matrix that is specified for the matrix parameter. For a default (null) matrix, the coordinates in the shader are local pixel coordinates which can be used to sample an input.

The Graphics object from which to copy the drawing commands.

Specifies the horizontal position of the first control point relative to the registration point of the parent display object.

Specifies the vertical position of the first control point relative to the registration point of the parent display object.

Specifies the horizontal position of the second control point relative to the registration point of the parent display object.

Specifies the vertical position of the second control point relative to the registration point of the parent display object.

Specifies the horizontal position of the anchor point relative to the registration point of the parent display object.

Specifies the vertical position of the anchor point relative to the registration point of the parent display object.

A number that specifies the horizontal position of the control point relative to the registration point of the parent display object.

A number that specifies the vertical position of the control point relative to the registration point of the parent display object.

A number that specifies the horizontal position of the next anchor point relative to the registration point of the parent display object.

A number that specifies the vertical position of the next anchor point relative to the registration point of the parent display object.

The x location of the top-left of the bounding-box of the ellipse relative to the registration point of the parent display object (in pixels).

The y location of the top left of the bounding-box of the ellipse relative to the registration point of the parent display object (in pixels).

The width of the ellipse (in pixels).

The height of the ellipse (in pixels).

A Vector of integers representing drawing commands. The set of accepted values is defined by the constants in the GraphicsPathCommand class.

A Vector of Number instances where each pair of numbers is treated as a coordinate location (an x, y pair). The x- and y-coordinate value pairs are not Point objects; the data vector is a series of numbers where each group of two numbers represents a coordinate location.

Specifies the winding rule using a value defined in the GraphicsPathWinding class.

A Vector containing rectangle coordinates in [ x0, y0, width0, height0, x1, y1 ... ] format.

A Vector containing optional index values to reference the data contained in rects. Each index is a rectangle index in the Vector, not an array index. If this parameter is ommitted, each index from rects will be used in order.

A Vector containing optional transform data to adjust x, y, a, b, c or d value for the resulting quadrilateral. A transforms Vector that is double the size of the draw count (the length of indices, or if omitted, the rectangle count in rects) will be treated as [ x, y, ... ] pairs. A transforms Vector that is four times the size of the draw count will be used as matrix [ a, b, c, d, ... ] values. A transforms object which is six times the draw count in size will use full matrix [ a, b, c, d, tx, ty, ... ] values per draw.

A number indicating the horizontal position relative to the registration point of the parent display object (in pixels).

A number indicating the vertical position relative to the registration point of the parent display object (in pixels).

The width of the rectangle (in pixels).

The height of the rectangle (in pixels).

A number indicating the horizontal position relative to the registration point of the parent display object(in pixels).

A number indicating the vertical position relative to the registration point of the parent display object (in pixels).

The width of the round rectangle (in pixels).

The height of the round rectangle (in pixels).

The width of the ellipse used to draw the rounded corners(in pixels).

The height of the ellipse used to draw the rounded corners(in pixels). Optional; if no value is specified, the default value matches that provided for the ellipseWidth parameter.

Specifies whether to render triangles that face in a specified direction. This parameter prevents the rendering of triangles that cannot be seen in the current view. This parameter can be set to any value defined by the TriangleCulling class.

The bitmap to use for the line stroke.

An optional transformation matrix as defined by the openfl.geom.Matrix class. The matrix can be used to scale or otherwise manipulate the bitmap before applying it to the line style.

Whether to repeat the bitmap in a tiled fashion.

Whether smoothing should be applied to the bitmap.

A value from the GradientType class that specifies which gradient type to use: GradientType.LINEAR or GradientType.RADIAL.

An array of RGB hex color values to be used in the gradient (for example, red is 0xFF0000, blue is 0x0000FF, and so on).

An array of alpha values for the corresponding colors in the colors array; valid values are 0 to 1. If the value is less than 0, the default is 0. If the value is greater than 1, the default is 1.

An array of color distribution ratios; valid values are from 0 to 255. This value defines the percentage of the width where the color is sampled at 100%. The value 0 represents the left position in the gradient box, and 255 represents the right position in the gradient box. This value represents positions in the gradient box, not the coordinate space of the final gradient, which can be wider or thinner than the gradient box. Specify a value for each value in the colors parameter. For example, for a linear gradient that includes two colors, blue and green, the following figure illustrates the placement of the colors in the gradient based on different values in the ratios array: | ratios | Gradient | | --- | --- | | [0, 127] | | | [0, 255] | | | [127, 255] | | The values in the array must increase sequentially; for example, [0, 63, 127, 190, 255].

A transformation matrix as defined by the openfl.geom.Matrix class. The openfl.geom.Matrix class includes a createGradientBox() method, which lets you conveniently set up the matrix for use with the lineGradientStyle() method.

A value from the SpreadMethod class that specifies which spread method to use: | | | | | --- | --- | --- | |
SpreadMethod.PAD |
SpreadMethod.REFLECT |
SpreadMethod.REPEAT |

A value from the InterpolationMethod class that specifies which value to use. For example, consider a simple linear gradient between two colors (with the spreadMethod parameter set to SpreadMethod.REFLECT). The different interpolation methods affect the appearance as follows: | | | | --- | --- | |
InterpolationMethod.LINEAR_RGB |
InterpolationMethod.RGB |

A number that controls the location of the focal point of the gradient. The value 0 means the focal point is in the center. The value 1 means the focal point is at one border of the gradient circle. The value -1 means that the focal point is at the other border of the gradient circle. Values less than -1 or greater than 1 are rounded to -1 or 1. The following image shows a gradient with a focalPointRatio of -0.75:

An integer that indicates the thickness of the line in points; valid values are 0-255. If a number is not specified, or if the parameter is undefined, a line is not drawn. If a value of less than 0 is passed, the default is 0. The value 0 indicates hairline thickness; the maximum thickness is 255. If a value greater than 255 is passed, the default is 255.

A hexadecimal color value of the line; for example, red is 0xFF0000, blue is 0x0000FF, and so on. If a value is not indicated, the default is 0x000000 (black). Optional.

A number that indicates the alpha value of the color of the line; valid values are 0 to 1. If a value is not indicated, the default is 1 (solid). If the value is less than 0, the default is 0. If the value is greater than 1, the default is 1.

(Not supported in Flash Lite 4) A Boolean value that specifies whether to hint strokes to full pixels. This affects both the position of anchors of a curve and the line stroke size itself. With pixelHinting set to true, line widths are adjusted to full pixel widths. With pixelHinting set to false, disjoints can appear for curves and straight lines. For example, the following illustrations show how Flash Player or Adobe AIR renders two rounded rectangles that are identical, except that the pixelHinting parameter used in the lineStyle() method is set differently (the images are scaled by 200%, to emphasize the difference):

If a value is not supplied, the line does not use pixel hinting.

(Not supported in Flash Lite 4) A value from the LineScaleMode class that specifies which scale mode to use:

• LineScaleMode.NORMAL - Always scale the line thickness when the object is scaled (the default).
• LineScaleMode.NONE - Never scale the line thickness.
• LineScaleMode.VERTICAL - Do not scale the line thickness if the object is scaled vertically only. For example, consider the following circles, drawn with a one-pixel line, and each with the scaleMode parameter set to LineScaleMode.VERTICAL. The circle on the left is scaled vertically only, and the circle on the right is scaled both vertically and horizontally:

• LineScaleMode.HORIZONTAL - Do not scale the line thickness if the object is scaled horizontally only. For example, consider the following circles, drawn with a one-pixel line, and each with the scaleMode parameter set to LineScaleMode.HORIZONTAL. The circle on the left is scaled horizontally only, and the circle on the right is scaled both vertically and horizontally:

(Not supported in Flash Lite 4) A value from the CapsStyle class that specifies the type of caps at the end of lines. Valid values are: CapsStyle.NONE, CapsStyle.ROUND, and CapsStyle.SQUARE. If a value is not indicated, Flash uses round caps.

For example, the following illustrations show the different capsStyle settings. For each setting, the illustration shows a blue line with a thickness of 30 (for which the capsStyle applies), and a superimposed black line with a thickness of 1 (for which no capsStyle applies):

(Not supported in Flash Lite 4) A value from the JointStyle class that specifies the type of joint appearance used at angles. Valid values are: JointStyle.BEVEL, JointStyle.MITER, and JointStyle.ROUND. If a value is not indicated, Flash uses round joints.

For example, the following illustrations show the different joints settings. For each setting, the illustration shows an angled blue line with a thickness of 30 (for which the jointStyle applies), and a superimposed angled black line with a thickness of 1 (for which no jointStyle applies):

Note: For joints set to JointStyle.MITER, you can use the miterLimit parameter to limit the length of the miter.

(Not supported in Flash Lite 4) A number that indicates the limit at which a miter is cut off. Valid values range from 1 to 255 (and values outside that range are rounded to 1 or 255). This value is only used if the jointStyle is set to "miter". The miterLimit value represents the length that a miter can extend beyond the point at which the lines meet to form a joint. The value expresses a factor of the line thickness. For example, with a miterLimit factor of 2.5 and a thickness of 10 pixels, the miter is cut off at 25 pixels.

For example, consider the following angled lines, each drawn with a thickness of 20, but with miterLimit set to 1, 2, and 4. Superimposed are black reference lines showing the meeting points of the joints:

Notice that a given miterLimit value has a specific maximum angle for which the miter is cut off. The following table lists some examples:

A number that indicates the horizontal position relative to the registration point of the parent display object (in pixels).

A number that indicates the vertical position relative to the registration point of the parent display object (in pixels).

A number that indicates the horizontal position relative to the registration point of the parent display object (in pixels).

A number that indicates the vertical position relative to the registration point of the parent display object (in pixels).

whether the runtime should also query display object children of the current display object. A recursive query can take more time and memory to execute. The results are returned in a single flattened result set, not separated by display object.