API Docs for: 2.0.0
Show:

Graphics Class

Extends DisplayObjectContainer
Defined in: src/pixi/primitives/Graphics.js:6
Module: PIXI

The Graphics class contains a set of methods that you can use to create primitive shapes and lines. It is important to know that with the webGL renderer only simple polygons can be filled at this stage Complex polygons will not be filled. Heres an example of a complex polygon: http://www.goodboydigital.com/wp-content/uploads/2013/06/complexPolygon.png

Constructor

Graphics

()

Defined in src/pixi/primitives/Graphics.js:6

Methods

_generateCachedSprite

() private

Defined in src/pixi/primitives/Graphics.js:962

Generates the cached sprite when the sprite has cacheAsBitmap = true

_renderCanvas

(
  • renderSession
)
private

Inherited from DisplayObject but overwritten in src/pixi/primitives/Graphics.js:758

Renders the object using the Canvas renderer

Parameters:

  • renderSession RenderSession

_renderWebGL

(
  • renderSession
)
private

Inherited from DisplayObject but overwritten in src/pixi/primitives/Graphics.js:682

Renders the object using the WebGL renderer

Parameters:

  • renderSession RenderSession

addChild

(
  • child
)

Inherited from DisplayObjectContainer: src/pixi/display/DisplayObjectContainer.js:92

Adds a child to the container.

Parameters:

addChildAt

(
  • child
  • index
)

Inherited from DisplayObjectContainer: src/pixi/display/DisplayObjectContainer.js:103

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

Parameters:

  • child DisplayObject

    The child to add

  • index Number

    The index to place the child in

arc

(
  • cx
  • cy
  • radius
  • startAngle
  • endAngle
  • anticlockwise
)
PIXI.Graphics

Defined in src/pixi/primitives/Graphics.js:438

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

Parameters:

  • 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:

beginFill

(
  • color
  • alpha
)

Defined in src/pixi/primitives/Graphics.js:509

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

Parameters:

  • color Number

    the color of the fill

  • alpha Number

    the alpha of the fill

bezierCurveTo

(
  • cpX
  • cpY
  • cpX2
  • cpY2
  • toX
  • toY
)
PIXI.Graphics

Defined in src/pixi/primitives/Graphics.js:311

Calculate the points for a bezier curve.

Parameters:

  • 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:

clear

()

Defined in src/pixi/primitives/Graphics.js:634

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

click

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:220

A callback that is used when the users clicks on the displayObject with their mouse's left button

Parameters:

drawCircle

(
  • x
  • y
  • radius
)

Defined in src/pixi/primitives/Graphics.js:588

Draws a circle.

Parameters:

  • 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

drawEllipse

(
  • x
  • y
  • width
  • height
)

Defined in src/pixi/primitives/Graphics.js:603

Draws an ellipse.

Parameters:

  • 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

drawRect

(
  • x
  • y
  • width
  • height
)

Defined in src/pixi/primitives/Graphics.js:550

Parameters:

  • 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

drawRoundedRect

(
  • x
  • y
  • width
  • height
  • radius
)

Defined in src/pixi/primitives/Graphics.js:565

Parameters:

  • 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 //* PIXI.Graphics.prototype.drawRoundedRect = function( x, y, width, height, radius ) { if (!this.currentPath.points.length) this.graphicsData.pop();

    // this.currentPath = {lineWidth:this.lineWidth, lineColor:this.lineColor, lineAlpha:this.lineAlpha, /// fillColor:this.fillColor, fillAlpha:this.fillAlpha, fill:this.filling, // points:[x, y, width, height, radius], shape:new PIXI.Rectangle(x,y, width, height), type:PIXI.Graphics.RREC};

    this.graphicsData.push(this.currentPath); this.dirty = true;

    return this; };

endFill

()

Defined in src/pixi/primitives/Graphics.js:536

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

generateTexture

(
  • resolution
  • scaleMode
)
Texture

Inherited from DisplayObject but overwritten in src/pixi/primitives/Graphics.js:653

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:

  • resolution Number

    The resolution of the texture being generated

  • scaleMode Number

    Should be one of the PIXI.scaleMode consts

Returns:

Texture:

a texture of the graphics object

getBounds

() Rectangle

Inherited from DisplayObject but overwritten in src/pixi/primitives/Graphics.js:806

Retrieves the bounds of the graphic shape as a rectangle object

Returns:

Rectangle:

the rectangular bounding area

getChildAt

(
  • index
)

Inherited from DisplayObjectContainer: src/pixi/display/DisplayObjectContainer.js:195

Returns the child at the specified index

Parameters:

  • index Number

    The index to get the child from

getChildIndex

(
  • child
)
Number

Inherited from DisplayObjectContainer: src/pixi/display/DisplayObjectContainer.js:160

Returns the index position of a child DisplayObject instance

Parameters:

Returns:

Number:

The index position of the child display object to identify

getLocalBounds

() Rectangle

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:528

Retrieves the local bounds of the displayObject as a rectangle object

Returns:

Rectangle:

the rectangular bounding area

lineStyle

(
  • lineWidth
  • color
  • alpha
)

Defined in src/pixi/primitives/Graphics.js:163

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

Parameters:

  • lineWidth Number

    width of the line to draw, will update the object's stored style

  • color Number

    color of the line to draw, will update the object's stored style

  • alpha Number

    alpha of the line to draw, will update the object's stored style

lineTo

(
  • x
  • y
)

Defined in src/pixi/primitives/Graphics.js:245

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:

  • x Number

    the X coordinate to draw to

  • y Number

    the Y coordinate to draw to

lineTo

(
  • x
  • y
)

Defined in src/pixi/primitives/Graphics.js:619

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:

  • x Number

    the X coordinate to draw to

  • y Number

    the Y coordinate to draw to

mousedown

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:226

A callback that is used when the user clicks the mouse's left button down over the sprite

Parameters:

mouseout

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:213

A callback that is used when the users mouse leaves the displayObject

Parameters:

mouseover

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:207

A callback that is used when the users mouse rolls over the displayObject

Parameters:

mouseup

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:232

A callback that is used when the user releases the mouse's left button that was over the displayObject for this callback to be fired, the mouse's left button must have been pressed down over the displayObject

Parameters:

mouseupoutside

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:239

A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject for this callback to be fired, the mouse's left button must have been pressed down over the displayObject

Parameters:

moveTo

(
  • x
  • y
)

Defined in src/pixi/primitives/Graphics.js:196

Moves the current drawing position to (x, y).

Parameters:

  • x Number

    the X coordinate to move to

  • y Number

    the Y coordinate to move to

quadraticCurveTo

(
  • cpX
  • cpY
  • toX
  • toY
)
PIXI.Graphics

Defined in src/pixi/primitives/Graphics.js:261

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

Parameters:

  • cpX Number

    Control point x

  • cpY Number

    Control point y

  • toX Number

    Destination point x

  • toY Number

    Destination point y

Returns:

PIXI.Graphics:

removeChild

(
  • child
)

Inherited from DisplayObjectContainer: src/pixi/display/DisplayObjectContainer.js:211

Removes a child from the container.

Parameters:

removeChildAt

(
  • index
)

Inherited from DisplayObjectContainer: src/pixi/display/DisplayObjectContainer.js:225

Removes a child from the specified index position in the child list of the container.

Parameters:

  • index Number

    The index to get the child from

removeChildren

(
  • beginIndex
  • endIndex
)

Inherited from DisplayObjectContainer: src/pixi/display/DisplayObjectContainer.js:242

Removes all child instances from the child list of the container.

Parameters:

  • beginIndex Number

    The beginning position. Predefined value is 0.

  • endIndex Number

    The ending position. Predefined value is children's array length.

removeStageReference

()

Inherited from DisplayObjectContainer: src/pixi/display/DisplayObjectContainer.js:399

removes the current stage reference of the container

rightclick

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:247

A callback that is used when the users clicks on the displayObject with their mouse's right button

Parameters:

rightdown

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:253

A callback that is used when the user clicks the mouse's right button down over the sprite

Parameters:

rightup

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:259

A callback that is used when the user releases the mouse's right button that was over the displayObject for this callback to be fired the mouse's right button must have been pressed down over the displayObject

Parameters:

rightupoutside

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:266

A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject for this callback to be fired, the mouse's right button must have been pressed down over the displayObject

Parameters:

setChildIndex

(
  • child
  • index
)

Inherited from DisplayObjectContainer: src/pixi/display/DisplayObjectContainer.js:177

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

Parameters:

  • child 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

setInteractive

(
  • interactive
)
deprecated

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:307

Deprecated: Simply set the `interactive` property directly

[Deprecated] Indicates if the sprite will have touch and mouse interactivity. It is false by default Instead of using this function you can now simply set the interactive property to true or false

Parameters:

  • interactive Boolean

setStageReference

(
  • stage
)

Inherited from DisplayObject but overwritten in src/pixi/display/DisplayObjectContainer.js:381

Sets the container's stage reference, the stage this object is connected to

Parameters:

  • stage Stage

    the stage that the container will have as its current stage reference

swapChildren

(
  • child
  • child2
)
private

Inherited from DisplayObjectContainer: src/pixi/display/DisplayObjectContainer.js:133

[NYI] Swaps the depth of 2 displayObjects

Parameters:

tap

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:277

A callback that is used when the users taps on the sprite with their finger basically a touch version of click

Parameters:

toGlobal

(
  • position
)
Point

Inherited from DisplayObject but overwritten in src/pixi/display/DisplayObject.js:575

Calculates the global position of the display object

Parameters:

  • position Point

    The world origin to calculate from

Returns:

Point:

A point object representing the position of this object

touchend

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:290

A callback that is used when the user releases a touch over the displayObject

Parameters:

touchendoutside

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:296

A callback that is used when the user releases the touch that was over the displayObject for this callback to be fired, The touch must have started over the sprite

Parameters:

touchstart

(
  • interactionData
)

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:284

A callback that is used when the user touches over the displayObject

Parameters:

updateBounds

()

Defined in src/pixi/primitives/Graphics.js:876

Update the bounds of the object

Properties

_bounds

Rectangle private

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:174

The original, cached bounds of the object

_currentBounds

Rectangle private

Inherited from DisplayObject but overwritten in src/pixi/display/DisplayObject.js:182

The most up-to-date bounds of the object

_interactive

Boolean private

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:114

[read-only] Whether or not the object is interactive, do not toggle directly! use the interactive property

_webGL

Array private

Defined in src/pixi/primitives/Graphics.js:84

Array containing some WebGL-related properties used by the WebGL renderer

alpha

Number

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:46

The opacity of the object.

blendMode

Number

Defined in src/pixi/primitives/Graphics.js:64

The blend mode to be applied to the graphic shape

Default: PIXI.blendModes.NORMAL;

bounds

Rectangle

Defined in src/pixi/primitives/Graphics.js:101

The bounds of the graphic shape as rectangle object

boundsPadding

Number

Defined in src/pixi/primitives/Graphics.js:109

the bounds' padding used for bounds calculation

buttonMode

Boolean

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:71

This is used to indicate if the displayObject should display a mouse hand cursor on rollover

cacheAsBitmap

Boolean private

Inherited from DisplayObject but overwritten in src/pixi/primitives/Graphics.js:131

If cacheAsBitmap is true the graphics object will then 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 It is also usful as the graphics object will always be antialiased because it will be rendered using canvas Not recommended if you are constanly redrawing the graphics element.

Default: false

children

Array

Inherited from DisplayObjectContainer: src/pixi/display/DisplayObjectContainer.js:18

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

color

Array<> private

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:143

[NYI] Unknown

currentPath

Object private

Defined in src/pixi/primitives/Graphics.js:73

Current path

defaultCursor

String

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:124

This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true

dirty

Boolean private

Defined in src/pixi/primitives/Graphics.js:117

Used to detect if the graphics object has changed if this is set to true then the graphics object will be recalculated

dynamic

Boolean private

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:152

[NYI] Holds whether or not this object is dynamic, for rendering optimization

fillAlpha

Number

Defined in src/pixi/primitives/Graphics.js:21

The alpha of the fill of this graphics object

filterArea

Rectangle

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:165

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

filters

Array An array of filters

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:381

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'

graphicsData

Array private

Defined in src/pixi/primitives/Graphics.js:45

Graphics data

height

Number

Inherited from DisplayObjectContainer: src/pixi/display/DisplayObjectContainer.js:63

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

hitArea

Rectangle | Circle | Ellipse | Polygon

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:62

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)

interactive

Boolean

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:320

Indicates if the sprite will have touch and mouse interactivity. It is false by default

Default: false

isMask

IsMask

Defined in src/pixi/primitives/Graphics.js:93

Whether this shape is being used as a mask

lineColor

String

Defined in src/pixi/primitives/Graphics.js:37

The color of any lines drawn

lineWidth

Number

Defined in src/pixi/primitives/Graphics.js:29

The width of any lines drawn

mask

Graphics

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:361

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.

parent

DisplayObjectContainer

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:87

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

pivot

Point

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:30

The pivot point of the displayObject that it rotates around

position

Point

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:14

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

renderable

Boolean

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:79

Can this object be rendered

rotation

Number

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:38

The rotation of the object in radians.

scale

Point

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:22

The scale factor of the object.

stage

Stage

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:96

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

tint

Number

Defined in src/pixi/primitives/Graphics.js:55

The tint applied to the graphic shape. This is a hex value

Default: 0xFFFFFF

visible

Boolean

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:54

The visibility of the object.

width

Number

Inherited from DisplayObjectContainer: src/pixi/display/DisplayObjectContainer.js:32

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

worldAlpha

Number

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:105

[read-only] The multiplied alpha of the displayObject

worldTransform

Mat3 private

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:133

[read-only] Current transform of the object based on world (parent) factors

worldVisible

Boolean

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:340

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

x

Number

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:699

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

y

Number

Inherited from DisplayObject: src/pixi/display/DisplayObject.js:714

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