PIXI

Class: Graphics

PIXI. Graphics

The Graphics class contains methods used to draw primitive shapes such as lines, circles and
rectangles to the display, and to color and fill them.

new PIXI.Graphics()

core/graphics/Graphics.js, line 29

Extends

Members

cacheAsBitmapboolean

When cacheAsBitmap is set to true the graphics object will be rendered as if it was a sprite.
This is useful if your graphics element does not change often, as it will speed up the rendering
of the object in exchange for taking up texture memory. It is also useful if you need the graphics
object to be anti-aliased, because it will be rendered using canvas. This is not recommended if
you are constantly redrawing the graphics element.

Default Value:
  • false

filters

Shallow copies the array to the filters of the object.

height

Sets the height of the container by modifying the scale.

mask

Sets the mask.

pivot

Copies the point to the pivot of the object.

position

Copies the point to the position of the object.

rotation

Sets the rotation of the object.

scale

Copies the point to the scale of the object.

skew

Copies the point to the skew of the object.

width

Sets the width of the container by modifying the scale.

x

Sets the X position of the object.

y

Sets the Y position of the object.

Methods

inherited _recursivePostUpdateTransform()

core/display/DisplayObject.js, line 151

recursively updates transform of all objects from the root to this one
internal function for toLocal()

inherited addChild(child){PIXI.DisplayObject}

core/display/Container.js, line 55

Adds a child or multiple children to the container.

Multple items can be added like so: myContainer.addChild(thinkOne, thingTwo, thingThree)

Name Type Description
child PIXI.DisplayObject repeatable

The DisplayObject(s) to add to the container
Returns:
Type Description
PIXI.DisplayObject The first child that was added.

inherited addChildAt(child, index){PIXI.DisplayObject}

core/display/Container.js, line 90

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown

Name Type Description
child PIXI.DisplayObject

The child to add
index number

The index to place the child in
Returns:
Type Description
PIXI.DisplayObject The child that was added.

addHole(){PIXI.Graphics}

core/graphics/Graphics.js, line 1077

Adds a hole in the current path.

Returns:
Type Description
PIXI.Graphics Returns itself.

arc(cx, cy, radius, startAngle, endAngle, anticlockwise){PIXI.Graphics}

core/graphics/Graphics.js, line 469

The arc method creates an arc/curve (used to create circles, or parts of circles).

Name Type Default Description
cx number

The x-coordinate of the center of the circle
cy number

The y-coordinate of the center of the circle
radius number

The radius of the circle
startAngle number

The starting angle, in radians (0 is at the 3 o'clock position
of the arc's circle)
endAngle number

The ending angle, in radians
anticlockwise boolean false optional

Specifies whether the drawing should be
counter-clockwise or clockwise. False is default, and indicates clockwise, while true
indicates counter-clockwise.
Returns:
Type Description
PIXI.Graphics This Graphics object. Good for chaining method calls

arcTo(x1, y1, x2, y2, radius){PIXI.Graphics}

core/graphics/Graphics.js, line 399

The arcTo() method creates an arc/curve between two tangents on the canvas.

"borrowed" from https://code.google.com/p/fxcanvas/ - thanks google!

Name Type Description
x1 number

The x-coordinate of the beginning of the arc
y1 number

The y-coordinate of the beginning of the arc
x2 number

The x-coordinate of the end of the arc
y2 number

The y-coordinate of the end of the arc
radius number

The radius of the arc
Returns:
Type Description
PIXI.Graphics This Graphics object. Good for chaining method calls

beginFill(color, alpha){PIXI.Graphics}

core/graphics/Graphics.js, line 548

Specifies a simple one-color fill that subsequent calls to other Graphics methods
(such as lineTo() or drawCircle()) use when drawing.

Name Type Default Description
color number 0 optional

the color of the fill
alpha number 1 optional

the alpha of the fill
Returns:
Type Description
PIXI.Graphics This Graphics object. Good for chaining method calls

bezierCurveTo(cpX, cpY, cpX2, cpY2, toX, toY){PIXI.Graphics}

core/graphics/Graphics.js, line 359

Calculate the points for a bezier curve and then draws it.

Name Type Description
cpX number

Control point x
cpY number

Control point y
cpX2 number

Second Control point x
cpY2 number

Second Control point y
toX number

Destination point x
toY number

Destination point y
Returns:
Type Description
PIXI.Graphics This Graphics object. Good for chaining method calls

inherited calculateBounds()

core/display/Container.js, line 303

Recalculates the bounds of the container.

clear(){PIXI.Graphics}

core/graphics/Graphics.js, line 689

Clears the graphics that were drawn to this Graphics object, and resets fill and line style settings.

Returns:
Type Description
PIXI.Graphics This Graphics object. Good for chaining method calls

clone(){PIXI.Graphics}

core/graphics/Graphics.js, line 196

Creates a new Graphics object with the same values as this one.
Note that the only the properties of the object are cloned, not its transform (position,scale,etc)

Returns:
Type Description
PIXI.Graphics A clone of the graphics object

closePath(){PIXI.Graphics}

core/graphics/Graphics.js, line 1059

Closes the current path.

Returns:
Type Description
PIXI.Graphics Returns itself.

containsPoint(point){boolean}

core/graphics/Graphics.js, line 850

Tests if a point is inside this graphics object

Name Type Description
point PIXI.Point

the point to test
Returns:
Type Description
boolean the result of the test

destroy(options)

core/graphics/Graphics.js, line 1098

Destroys the Graphics object.

Name Type Description
options object | boolean optional

Options parameter. A boolean will act as if all
options have been set to that value

Name Type Default Description
children boolean false optional

if set to true, all the children will have
their destroy method called as well. 'options' will be passed on to those calls.

drawCircle(x, y, radius){PIXI.Graphics}

core/graphics/Graphics.js, line 620

Draws a circle.

Name Type Description
x number

The X coordinate of the center of the circle
y number

The Y coordinate of the center of the circle
radius number

The radius of the circle
Returns:
Type Description
PIXI.Graphics This Graphics object. Good for chaining method calls

drawEllipse(x, y, width, height){PIXI.Graphics}

core/graphics/Graphics.js, line 636

Draws an ellipse.

Name Type Description
x number

The X coordinate of the center of the ellipse
y number

The Y coordinate of the center of the ellipse
width number

The half width of the ellipse
height number

The half height of the ellipse
Returns:
Type Description
PIXI.Graphics This Graphics object. Good for chaining method calls

drawPolygon(path){PIXI.Graphics}

core/graphics/Graphics.js, line 649

Draws a polygon using the given path.

Name Type Description
path Array.<number> | Array.<PIXI.Point>

The path data used to construct the polygon.
Returns:
Type Description
PIXI.Graphics This Graphics object. Good for chaining method calls

drawRect(x, y, width, height){PIXI.Graphics}

core/graphics/Graphics.js, line 589
Name Type Description
x number

The X coord of the top-left of the rectangle
y number

The Y coord of the top-left of the rectangle
width number

The width of the rectangle
height number

The height of the rectangle
Returns:
Type Description
PIXI.Graphics This Graphics object. Good for chaining method calls

drawRoundedRect(x, y, width, height, radius){PIXI.Graphics}

core/graphics/Graphics.js, line 605
Name Type Description
x number

The X coord of the top-left of the rectangle
y number

The Y coord of the top-left of the rectangle
width number

The width of the rectangle
height number

The height of the rectangle
radius number

Radius of the rectangle corners
Returns:
Type Description
PIXI.Graphics This Graphics object. Good for chaining method calls

drawShape(shape){PIXI.GraphicsData}

core/graphics/Graphics.js, line 987

Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon.

Name Type Description
shape PIXI.Circle | PIXI.Ellipse | PIXI.Polygon | PIXI.Rectangle | PIXI.RoundedRectangle

The shape object to draw.
Returns:
Type Description
PIXI.GraphicsData The generated GraphicsData object.

endFill(){PIXI.Graphics}

core/graphics/Graphics.js, line 572

Applies a fill to the lines and shapes that were added since the last call to the beginFill() method.

Returns:
Type Description
PIXI.Graphics This Graphics object. Good for chaining method calls

generateCanvasTexture(scaleMode, resolution){PIXI.Texture}

core/graphics/Graphics.js, line 1030

Generates a canvas texture.

Name Type Default Description
scaleMode number

The scale mode of the texture.
resolution number 1

The resolution of the texture.
Returns:
Type Description
PIXI.Texture The new texture.

inherited getBounds(skipUpdate, rect){PIXI.Rectangle}

core/display/DisplayObject.js, line 173

Retrieves the bounds of the displayObject as a rectangle object.

Name Type Description
skipUpdate boolean

setting to true will stop the transforms of the scene graph from
being updated. This means the calculation returned MAY be out of date BUT will give you a
nice performance boost
rect PIXI.Rectangle

Optional rectangle to store the result of the bounds calculation
Returns:
Type Description
PIXI.Rectangle the rectangular bounding area

inherited getChildAt(index){PIXI.DisplayObject}

core/display/Container.js, line 178

Returns the child at the specified index

Name Type Description
index number

The index to get the child at
Returns:
Type Description
PIXI.DisplayObject The child at the given index, if any.

inherited getChildIndex(child){number}

core/display/Container.js, line 140

Returns the index position of a child DisplayObject instance

Name Type Description
child PIXI.DisplayObject

The DisplayObject instance to identify
Returns:
Type Description
number The index position of the child display object to identify

inherited getLocalBounds(rect){PIXI.Rectangle}

core/display/DisplayObject.js, line 214

Retrieves the local bounds of the displayObject as a rectangle object

Name Type Description
rect PIXI.Rectangle optional

Optional rectangle to store the result of the bounds calculation
Returns:
Type Description
PIXI.Rectangle the rectangular bounding area

isFastRect(){boolean}

core/graphics/Graphics.js, line 710

True if graphics consists of one rectangle, and thus, can be drawn like a Sprite and
masked with gl.scissor.

Returns:
Type Description
boolean True if only 1 rect.

lineStyle(lineWidth, color, alpha){PIXI.Graphics}

core/graphics/Graphics.js, line 233

Specifies the line style used for subsequent calls to Graphics methods such as the lineTo()
method or the drawCircle() method.

Name Type Default Description
lineWidth number 0 optional

width of the line to draw, will update the objects stored style
color number 0 optional

color of the line to draw, will update the objects stored style
alpha number 1 optional

alpha of the line to draw, will update the objects stored style
Returns:
Type Description
PIXI.Graphics This Graphics object. Good for chaining method calls

lineTo(x, y){PIXI.Graphics}

core/graphics/Graphics.js, line 287

Draws a line using the current line style from the current drawing position to (x, y);
The current drawing position is then set to (x, y).

Name Type Description
x number

the X coordinate to draw to
y number

the Y coordinate to draw to
Returns:
Type Description
PIXI.Graphics This Graphics object. Good for chaining method calls

moveTo(x, y){PIXI.Graphics}

core/graphics/Graphics.js, line 269

Moves the current drawing position to x, y.

Name Type Description
x number

the X coordinate to move to
y number

the Y coordinate to move to
Returns:
Type Description
PIXI.Graphics This Graphics object. Good for chaining method calls

quadraticCurveTo(cpX, cpY, toX, toY){PIXI.Graphics}

core/graphics/Graphics.js, line 305

Calculate the points for a quadratic bezier curve and then draws it.
Based on: https://stackoverflow.com/questions/785097/how-do-i-implement-a-bezier-curve-in-c

Name Type Description
cpX number

Control point x
cpY number

Control point y
toX number

Destination point x
toY number

Destination point y
Returns:
Type Description
PIXI.Graphics This Graphics object. Good for chaining method calls

inherited removeChild(childs){PIXI.DisplayObject}

core/display/Container.js, line 194

Removes a child from the container.

Name Type Description
childs PIXI.DisplayObject repeatable

The DisplayObject(s) to remove
Returns:
Type Description
PIXI.DisplayObject The first child that was removed.

inherited removeChildAt(index){PIXI.DisplayObject}

core/display/Container.js, line 220

Removes a child from the specified index position.

Name Type Description
index number

The index to get the child from
Returns:
Type Description
PIXI.DisplayObject The child that was removed.

inherited removeChildren(beginIndex, endIndex){Array.<DisplayObject>}

core/display/Container.js, line 241

Removes all children from this container that are within the begin and end indexes.

Name Type Default Description
beginIndex number 0 optional

The beginning position.
endIndex number this.children.length optional

The ending position. Default value is size of the container.
Returns:
Type Description
Array.<DisplayObject> List of removed children

inherited renderCanvas(renderer)

core/display/Container.js, line 474

Renders the object using the Canvas renderer

Name Type Description
renderer PIXI.CanvasRenderer

The renderer

inherited renderWebGL(renderer)

core/display/Container.js, line 354

Renders the object using the WebGL renderer

Name Type Description
renderer PIXI.WebGLRenderer

The renderer

inherited setChildIndex(child, index)

core/display/Container.js, line 158

Changes the position of an existing child in the display object container

Name Type Description
child PIXI.DisplayObject

The child DisplayObject instance for which you want to change the index number
index number

The resulting index number for the child display object

inherited setParent(container){PIXI.Container}

core/display/DisplayObject.js, line 340

Set the parent Container of this DisplayObject

Name Type Description
container PIXI.Container

The Container to add this DisplayObject to
Returns:
Type Description
PIXI.Container The Container that this DisplayObject was added to

inherited setTransform(x, y, scaleX, scaleY, rotation, skewX, skewY, pivotX, pivotY){PIXI.DisplayObject}

core/display/DisplayObject.js, line 366

Convenience function to set the postion, scale, skew and pivot at once.

Name Type Default Description
x number 0 optional

The X position
y number 0 optional

The Y position
scaleX number 1 optional

The X scale value
scaleY number 1 optional

The Y scale value
rotation number 0 optional

The rotation
skewX number 0 optional

The X skew value
skewY number 0 optional

The Y skew value
pivotX number 0 optional

The X pivot value
pivotY number 0 optional

The Y pivot value
Returns:
Type Description
PIXI.DisplayObject The DisplayObject instance

inherited swapChildren(child, child2)

core/display/Container.js, line 119

Swaps the position of 2 Display Objects within this container.

Name Type Description
child PIXI.DisplayObject

First display object to swap
child2 PIXI.DisplayObject

Second display object to swap

inherited toGlobal(position, point, skipUpdate){PIXI.Point}

core/display/DisplayObject.js, line 249

Calculates the global position of the display object

Name Type Default Description
position PIXI.Point

The world origin to calculate from
point PIXI.Point optional

A Point object in which to store the value, optional
(otherwise will create a new Point)
skipUpdate boolean false optional

Should we skip the update transform.
Returns:
Type Description
PIXI.Point A point object representing the position of this object

inherited toLocal(position, from, point, skipUpdate){PIXI.Point}

core/display/DisplayObject.js, line 284

Calculates the local position of the display object relative to another point

Name Type Default Description
position PIXI.Point

The world origin to calculate from
from PIXI.DisplayObject optional

The DisplayObject to calculate the global position from
point PIXI.Point optional

A Point object in which to store the value, optional
(otherwise will create a new Point)
skipUpdate boolean false optional

Should we skip the update transform
Returns:
Type Description
PIXI.Point A point object representing the position of this object

updateLocalBounds()

core/graphics/Graphics.js, line 882

Update the bounds of the object