Discover
Learn
Get
Create
Community
Login
Navigation
These archived docs are for Phaser 2.4.2 Phaser 3 docs can be found on newdocs.phaser.io.
Phaser CE docs can be found on the Phaser CE Documentation site.

Constructor

PIXI. Graphics

new Graphics()

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

Source code: pixi/primitives/Graphics.js (Line 5)

Extends

Public Properties

alpha : number

The opacity of the object.

Inherited From
Source code: pixi/display/DisplayObject.js (Line 65)

blendMode : number

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

Default Value
  • PIXI.blendModes.NORMAL;
Source code: pixi/primitives/Graphics.js (Line 61)

boundsPadding : number

The bounds' padding used for bounds calculation.

Source code: pixi/primitives/Graphics.js (Line 96)

[readonly] children : Array.<DisplayObject>

[read-only] The array of children of this container.

Type
Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 17)

fillAlpha : number

The alpha value used when filling the Graphics object.

Source code: pixi/primitives/Graphics.js (Line 18)

filterArea :Rectangle

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

Inherited From
Source code: pixi/display/DisplayObject.js (Line 183)

filters : Array.<Filter>

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'

Type
  • Array.<Filter>
Inherited From
Source code: pixi/display/DisplayObject.js (Line 328)

height : number

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

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 61)

hitArea :Rectangle | Circle | Ellipse | Polygon

This is the defined area that will pick up mouse / touch events. It is null by default. Setting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)

Type
  • Rectangle | Circle | Ellipse | Polygon
Inherited From
Source code: pixi/display/DisplayObject.js (Line 81)

isMask : boolean

Whether this shape is being used as a mask.

Source code: pixi/primitives/Graphics.js (Line 88)

lineColor : string

The color of any lines drawn.

Default Value
  • 0
Source code: pixi/primitives/Graphics.js (Line 34)

lineWidth : number

The width (thickness) of any lines drawn.

Source code: pixi/primitives/Graphics.js (Line 26)

mask : PIXI.Graphics

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 object. This allows for much faster masking in canvas as it utilises shape clipping. To remove a mask, set this property to null.

Inherited From
Source code: pixi/display/DisplayObject.js (Line 303)

[readonly] parent : PIXI.DisplayObjectContainer

[read-only] The display object container that contains this display object.

Inherited From
Source code: pixi/display/DisplayObject.js (Line 98)

pivot :Point

The pivot point of the displayObject that it rotates around

Inherited From
Source code: pixi/display/DisplayObject.js (Line 49)

position :Point

The coordinate of the object relative to the local coordinates of the parent.

Inherited From
Source code: pixi/display/DisplayObject.js (Line 14)

renderable : boolean

Can this object be rendered

Inherited From
Source code: pixi/display/DisplayObject.js (Line 90)

rotation : number

The rotation of the object in radians.

Inherited From
Source code: pixi/display/DisplayObject.js (Line 57)

scale :Point

The scale factor of the object.

Inherited From
Source code: pixi/display/DisplayObject.js (Line 22)

[readonly] stage : PIXI.Stage

[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.

Inherited From
Source code: pixi/display/DisplayObject.js (Line 107)

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
Source code: pixi/primitives/Graphics.js (Line 52)

transformCallback : Function

The transform callback is an optional callback that if set will be called at the end of the updateTransform method and sent two parameters: This Display Objects worldTransform matrix and its parents transform matrix. Both are PIXI.Matrix object types. The matrix are passed by reference and can be modified directly without needing to return them. This ability allows you to check any of the matrix values and perform actions such as clamping scale or limiting rotation, regardless of the parent transforms.

Inherited From
Source code: pixi/display/DisplayObject.js (Line 30)

transformCallbackContext : Object

The context under which the transformCallback is invoked.

Inherited From
Source code: pixi/display/DisplayObject.js (Line 41)

visible : boolean

The visibility of the object.

Inherited From
Source code: pixi/display/DisplayObject.js (Line 73)

width : number

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

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 32)

[readonly] worldAlpha : number

[read-only] The multiplied alpha of the displayObject

Inherited From
Source code: pixi/display/DisplayObject.js (Line 116)

[readonly] worldPosition :Point

The position of the Display Object based on the world transform. This value is updated at the end of updateTransform and takes all parent transforms into account.

Inherited From
Source code: pixi/display/DisplayObject.js (Line 135)

[readonly] worldRotation : number

The rotation of the Display Object, in radians, based on the world transform. This value is updated at the end of updateTransform and takes all parent transforms into account.

Inherited From
Source code: pixi/display/DisplayObject.js (Line 155)

[readonly] worldScale :Point

The scale of the Display Object based on the world transform. This value is updated at the end of updateTransform and takes all parent transforms into account.

Inherited From
Source code: pixi/display/DisplayObject.js (Line 145)

worldVisible : boolean

[read-only] Indicates if the sprite is globally visible.

Inherited From
Source code: pixi/display/DisplayObject.js (Line 279)

x : number

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

Inherited From
Source code: pixi/display/DisplayObject.js (Line 726)

y : number

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

Inherited From
Source code: pixi/display/DisplayObject.js (Line 744)

Public Methods

addChild(child) → {PIXI.DisplayObject}

Adds a child to the container.

Parameters
Name Type Description
child PIXI.DisplayObject

The DisplayObject to add to the container
Returns
PIXI.DisplayObject -

The child that was added.

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 91)

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

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

Parameters
Name Type Description
child PIXI.DisplayObject

The child to add
index Number

The index to place the child in
Returns
PIXI.DisplayObject -

The child that was added.

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 103)

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

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

Parameters
Name Type 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

Optional. Specifies whether the drawing should be counterclockwise or clockwise. False is default, and indicates clockwise, while true indicates counter-clockwise.
Returns
PIXI.Graphics -
Source code: pixi/primitives/Graphics.js (Line 391)

beginFill(color, alpha) → {PIXI.Graphics}

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

Parameters
Name Type Description
color Number

the color of the fill
alpha Number

the alpha of the fill
Returns
PIXI.Graphics -
Source code: pixi/primitives/Graphics.js (Line 474)

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

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

Parameters
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
PIXI.Graphics -
Source code: pixi/primitives/Graphics.js (Line 264)

clear() → {PIXI.Graphics}

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

Returns
PIXI.Graphics -
Source code: pixi/primitives/Graphics.js (Line 616)

destroy()

Destroy this DisplayObject. Removes all references to transformCallbacks, its parent, the stage, filters, bounds, mask and cached Sprites.

Inherited From
Source code: pixi/display/DisplayObject.js (Line 242)

destroyCachedSprite()

Destroys a previous cached sprite.

Source code: pixi/primitives/Graphics.js (Line 1116)

drawCircle(x, y, diameter) → {PIXI.Graphics}

Draws a circle.

Parameters
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
diameter Number

The diameter of the circle
Returns
PIXI.Graphics -
Source code: pixi/primitives/Graphics.js (Line 548)

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

Draws an ellipse.

Parameters
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
PIXI.Graphics -
Source code: pixi/primitives/Graphics.js (Line 564)

drawPolygon(path) → {PIXI.Graphics}

Draws a polygon using the given path.

Parameters
Name Type Description
path Array | PhaserPolygon

The path data used to construct the polygon. Can either be an array of points or a Phaser.Polygon object.
Returns
PIXI.Graphics -
Source code: pixi/primitives/Graphics.js (Line 581)

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

Parameters
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
PIXI.Graphics -
Source code: pixi/primitives/Graphics.js (Line 517)

drawRoundedRect(x, y, width, height, radius)

Parameters
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. In WebGL this must be a value between 0 and 9.
Source code: pixi/primitives/Graphics.js (Line 533)

drawShape(shape) → {PIXI.GraphicsData}

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

Parameters
Name Type Description
shape Circle | Rectangle | Ellipse | Line | Polygon

The Shape object to draw.
Returns
PIXI.GraphicsData -

The generated GraphicsData object.

Source code: pixi/primitives/Graphics.js (Line 1127)

endFill() → {PIXI.Graphics}

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

Returns
PIXI.Graphics -
Source code: pixi/primitives/Graphics.js (Line 502)

generateTexture(resolution, scaleMode) → {PIXI.Texture}

Useful function that returns a texture of the graphics object that can then be used to create sprites This can be quite useful if your geometry is complicated and needs to be reused multiple times.

Parameters
Name Type Description
resolution Number

The resolution of the texture being generated
scaleMode Number

Should be one of the PIXI.scaleMode consts
Returns
PIXI.Texture -

a texture of the graphics object

Source code: pixi/primitives/Graphics.js (Line 634)

getBounds() → {Rectangle}

Retrieves the bounds of the graphic shape as a rectangle object

Returns
Rectangle -

the rectangular bounding area

Source code: pixi/primitives/Graphics.js (Line 818)

getChildAt(index) → {PIXI.DisplayObject}

Returns the child at the specified index

Parameters
Name Type Description
index Number

The index to get the child from
Returns
PIXI.DisplayObject -

The child at the given index, if any.

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 194)

getChildIndex(child) → {Number}

Returns the index position of a child DisplayObject instance

Parameters
Name Type Description
child PIXI.DisplayObject

The DisplayObject instance to identify
Returns
Number -

The index position of the child display object to identify

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 159)

getLocalBounds() → {Rectangle}

Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.

Returns
Rectangle -

The rectangular bounding area

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 367)

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

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

Parameters
Name Type Description
lineWidth Number

width of the line to draw, will update the objects stored style
color Number

color of the line to draw, will update the objects stored style
alpha Number

alpha of the line to draw, will update the objects stored style
Returns
PIXI.Graphics -
Source code: pixi/primitives/Graphics.js (Line 139)

lineTo(x, y) → {PIXI.Graphics}

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

Parameters
Name Type Description
x Number

the X coordinate to draw to
y Number

the Y coordinate to draw to
Returns
PIXI.Graphics -
Source code: pixi/primitives/Graphics.js (Line 188)

moveTo(x, y) → {PIXI.Graphics}

Moves the current drawing position to x, y.

Parameters
Name Type Description
x Number

the X coordinate to move to
y Number

the Y coordinate to move to
Returns
PIXI.Graphics -
Source code: pixi/primitives/Graphics.js (Line 173)

preUpdate()

Empty, to be overridden by classes that require it.

Inherited From
Source code: pixi/display/DisplayObject.js (Line 540)

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

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

Parameters
Name Type Description
cpX Number

Control point x
cpY Number

Control point y
toX Number

Destination point x
toY Number

Destination point y
Returns
PIXI.Graphics -
Source code: pixi/primitives/Graphics.js (Line 210)

removeChild(child) → {PIXI.DisplayObject}

Removes a child from the container.

Parameters
Name Type Description
child PIXI.DisplayObject

The DisplayObject to remove
Returns
PIXI.DisplayObject -

The child that was removed.

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 211)

removeChildAt(index) → {PIXI.DisplayObject}

Removes a child from the specified index position.

Parameters
Name Type Description
index Number

The index to get the child from
Returns
PIXI.DisplayObject -

The child that was removed.

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 226)

removeChildren(beginIndex, endIndex)

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

Parameters
Name Type Description
beginIndex Number

The beginning position. Default value is 0.
endIndex Number

The ending position. Default value is size of the container.
Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 244)

removeStageReference()

Removes the current stage reference from the container and all of its children.

Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 407)

setChildIndex(child, index)

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

Parameters
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 From
Source code: pixi/display/DisplayObjectContainer.js (Line 176)

setStageReference(stage)

Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.

Parameters
Name Type Description
stage PIXI.Stage

the stage that the container will have as its current stage reference
Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 391)

swapChildren(child, child2)

Swaps the position of 2 Display Objects within this container.

Parameters
Name Type Description
child PIXI.DisplayObject

-
child2 PIXI.DisplayObject

-
Inherited From
Source code: pixi/display/DisplayObjectContainer.js (Line 134)

toGlobal(position) → {Point}

Calculates the global position of the display object

Parameters
Name Type Description
position Point

The world origin to calculate from
Returns
Point -

A point object representing the position of this object

Inherited From
Source code: pixi/display/DisplayObject.js (Line 583)

toLocal(position, from) → {Point}

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

Parameters
Name Type Argument Description
position Point

The world origin to calculate from
from PIXI.DisplayObject <optional>

The DisplayObject to calculate the global position from
Returns
Point -

A point object representing the position of this object

Inherited From
Source code: pixi/display/DisplayObject.js (Line 597)

updateCache()

Generates and updates the cached sprite for this object.

Inherited From
Source code: pixi/display/DisplayObject.js (Line 573)

updateLocalBounds()

Update the bounds of the object

Source code: pixi/primitives/Graphics.js (Line 940)