PixiJS

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 (nativeLines)

Graphics.js:24
Name Type Default Description
nativeLines boolean false optional

If true the lines will be draw using LINES instead of TRIANGLE_STRIP

Extends

Members

alpha number inherited

The opacity of the object.

blendMode number

The blend mode to be applied to the graphic shape. Apply a value of PIXI.BLEND_MODES.NORMAL to reset the blend mode.

Default Value:
  • PIXI.BLEND_MODES.NORMAL;
See:

boundsDirty Number

Used to detect if we we need to recalculate local bounds

boundsPadding number

The bounds' padding used for bounds calculation.

buttonMode boolean inherited

If enabled, the mouse cursor use the pointer behavior when hovered over the displayObject if it is interactive Setting this changes the 'cursor' property to 'pointer'.

Example
const sprite = new PIXI.Sprite(texture);
sprite.interactive = true;
sprite.buttonMode = true;

cacheAsBitmap boolean inherited

Set this to true if you want this display object to be cached as a bitmap. This basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects. To remove simply set this property to 'false'

IMPORTANT GOTCHA - make sure that all your textures are preloaded BEFORE setting this property to true as it will take a snapshot of what is currently there. If the textures have not loaded then they will not appear.

children Array.<PIXI.DisplayObject> readonly inherited

The array of children of this container.

clearDirty Number

Used to detect if we clear the graphics webGL data

cursor string inherited

This defines what cursor mode is used when the mouse cursor is hovered over the displayObject.

See:
Example
const sprite = new PIXI.Sprite(texture);
sprite.interactive = true;
sprite.cursor = 'wait';

fastRectDirty Number

Used to detect if we need to do a fast rect check using the id compare method

fillAlpha number

The alpha value used when filling the Graphics object.

Default Value:
  • 1

filterArea PIXI.Rectangle inherited

The area the filter is applied to. This is used as more of an optimisation rather than figuring out the dimensions of the displayObject each frame you can set this rectangle

Also works as an interaction mask

filters Array.<PIXI.Filter> inherited

Sets the filters for the displayObject.

  • IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer. To remove filters simply set this property to 'null'

height number inherited

The height of the Container, setting this will actually modify the scale to achieve the value set

hitArea PIXI.Rectangle | PIXI.Circle | PIXI.Ellipse | PIXI.Polygon | PIXI.RoundedRectangle inherited

Interaction shape. Children will be hit first, then this shape will be checked. Setting this will cause this shape to be checked in hit tests rather than the displayObject's bounds.

Example
const sprite = new PIXI.Sprite(texture);
sprite.interactive = true;
sprite.hitArea = new PIXI.Rectangle(0, 0, 100, 100);

interactive boolean inherited

Enable interaction events for the DisplayObject. Touch, pointer and mouse events will not be emitted unless interactive is set to true.

Example
const sprite = new PIXI.Sprite(texture);
sprite.interactive = true;
sprite.on('tap', (event) => {
   //handle event
});

interactiveChildren boolean inherited

Determines if the children to the displayObject can be clicked/touched Setting this to false allows PixiJS to bypass a recursive hitTest function

isMask boolean

Whether this shape is being used as a mask.

lineColor string

The color of any lines drawn.

Default Value:
  • 0

lineWidth number

The width (thickness) of any lines drawn.

Default Value:
  • 0

localTransform PIXI.Matrix readonly inherited

Current transform of the object based on local factors: position, scale, other stuff

mask PIXI.Graphics | PIXI.Sprite inherited

Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it. In PIXI a regular mask must be a PIXI.Graphics or a PIXI.Sprite object. This allows for much faster masking in canvas as it utilises shape clipping. To remove a mask, set this property to null.

For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask.

TODO
  • For the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.

name string inherited

The instance name of the object.

nativeLines boolean

If true the lines will be draw using LINES instead of TRIANGLE_STRIP

parent PIXI.Container readonly inherited

The display object container that contains this display object.

pivot PIXI.Point | PIXI.ObservablePoint inherited

The pivot point of the displayObject that it rotates around Assignment by value since pixi-v4.

position PIXI.Point | PIXI.ObservablePoint inherited

The coordinate of the object relative to the local coordinates of the parent. Assignment by value since pixi-v4.

renderable boolean inherited

Can this object be rendered, if false the object will not be drawn but the updateTransform methods will still be called.

Only affects recursive calls from parent. You can ask for bounds manually

rotation number inherited

The rotation of the object in radians.

scale PIXI.Point | PIXI.ObservablePoint inherited

The scale factor of the object. Assignment by value since pixi-v4.

skew PIXI.ObservablePoint inherited

The skew factor for the object in radians. Assignment by value since pixi-v4.

tint number

The tint applied to the graphic shape. This is a hex value. Apply a value of 0xFFFFFF to reset the tint.

Default Value:
  • 0xFFFFFF

transform PIXI.TransformBase inherited

World transform and local transform of this object. This will become read-only later, please do not assign anything there unless you know what are you doing

visible boolean inherited

The visibility of the object. If false the object will not be drawn, and the updateTransform function will not be called.

Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually

width number inherited

The width of the Container, setting this will actually modify the scale to achieve the value set

worldAlpha number readonly inherited

The multiplied alpha of the displayObject

worldTransform PIXI.Matrix readonly inherited

Current transform of the object based on world (parent) factors

worldVisible boolean readonly inherited

Indicates if the object is globally visible.

x number inherited

The position of the displayObject on the x axis relative to the local coordinates of the parent. An alias to position.x

y number inherited

The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y

Methods

_recursivePostUpdateTransform () inherited

DisplayObject.js:175

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

addChild (child)PIXI.DisplayObject inherited

Container.js:55

Adds one or more children to the container.

Multiple items can be added like so: myContainer.addChild(thingOne, 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.

addChildAt (child, index)PIXI.DisplayObject inherited

Container.js:101

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

Graphics.js:1097

Adds a hole in the current path.

Returns:
Type Description
PIXI.Graphics Returns itself.

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

Graphics.js:472

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

Graphics.js:402

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

Graphics.js:553

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

Graphics.js:362

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

calculateBounds () inherited

Container.js:345

Recalculates the bounds of the container.

clear ()PIXI.Graphics

Graphics.js:728

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

Graphics.js:199

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

Graphics.js:1079

Closes the current path.

Returns:
Type Description
PIXI.Graphics Returns itself.

containsPoint (point)boolean

Graphics.js:863

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) overrides

Graphics.js:1122

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.
texture boolean false optional

Only used for child Sprites if options.children is set to true Should it destroy the texture of the child sprite
baseTexture boolean false optional

Only used for child Sprites if options.children is set to true Should it destroy the base texture of the child sprite

drawCircle (x, y, radius)PIXI.Graphics

Graphics.js:625

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

Graphics.js:641

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

Graphics.js:654

Draws a polygon using the given path.

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

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

Graphics.js:594
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

Graphics.js:610
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

Graphics.js:1037

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.

drawStar (x, y, points, radius, innerRadius, rotation)PIXI.Graphics

Graphics.js:700

Draw a star shape with an abitrary number of points.

Name Type Default Description
x number

Center X position of the star
y number

Center Y position of the star
points number

The number of points of the star, must be > 1
radius number

The outer radius of the star
innerRadius number optional

The inner radius between points, default half radius
rotation number 0 optional

The rotation of the star in radians, where 0 is vertical
Returns:
Type Description
PIXI.Graphics This Graphics object. Good for chaining method calls

endFill ()PIXI.Graphics

Graphics.js:577

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

Graphics.js:9

Generates a canvas texture.

Name Type Description
scaleMode number

The scale mode of the texture.
resolution number

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

getBounds (skipUpdate, rect)PIXI.Rectangle inherited

DisplayObject.js:197

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

getChildAt (index)PIXI.DisplayObject inherited

Container.js:195

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.

getChildByName (name)PIXI.DisplayObject inherited

index.js:11

Returns the display object in the container

Name Type Description
name string

instance name
Returns:
Type Description
PIXI.DisplayObject The child with the specified name.

getChildIndex (child)number inherited

Container.js:156

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

getGlobalPosition (point, skipUpdate)Point inherited

index.js:4

Returns the global position of the displayObject. Does not depend on object scale, rotation and pivot.

Name Type Description
point Point

the point to write the global value to. If null a new point will be returned
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
Returns:
Type Description
Point The updated point

getLocalBounds (rect)PIXI.Rectangle inherited

DisplayObject.js:238

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

Graphics.js:753

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

Graphics.js:236

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

Graphics.js:290

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

Graphics.js:272

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

Graphics.js:308

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

removeChild (child)PIXI.DisplayObject inherited

Container.js:211

Removes one or more children from the container.

Name Type Description
child PIXI.DisplayObject repeatable

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

removeChildAt (index)PIXI.DisplayObject inherited

Container.js:253

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.

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

Container.js:279

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

render (renderer) inherited

Container.js:396

Renders the object using the WebGL renderer

Name Type Description
renderer PIXI.Renderer

The renderer

renderAdvancedWebGL (renderer) Deprecated : since 5.0.0 inherited

deprecated.js:601
Name Type Description
renderer PIXI.Renderer

Instance of renderer
See:
  • PIXI.Container#renderAdvanced

renderWebGL (renderer) Deprecated : since 5.0.0 inherited

deprecated.js:575
Name Type Description
renderer PIXI.Renderer

Instance of renderer
See:

setChildIndex (child, index) inherited

Container.js:174

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

setParent (container)PIXI.Container inherited

DisplayObject.js:354

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

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

DisplayObject.js:380

Convenience function to set the position, 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

swapChildren (child, child2) inherited

Container.js:135

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

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

DisplayObject.js:273

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

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

DisplayObject.js:308

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 ()

Graphics.js:908

Update the bounds of the object

updateTransform () inherited

Container.js:321

Updates the transform on all children of this container for rendering