Phaser Class: Graphics

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:

PIXI.DisplayObject#filterArea

Source - pixi/display/DisplayObject.js, line 164

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

You cannot have a filter and a multiply blend mode active at the same time. Setting a filter will reset this objects blend mode to NORMAL.

Type:

Array.<Filter>

Inherited From:

PIXI.DisplayObject#filters

Source - pixi/display/DisplayObject.js, line 307

height :Number

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

Inherited From:

PIXI.DisplayObjectContainer#height

Source - pixi/display/DisplayObjectContainer.js, line 72

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:

PIXI.DisplayObject#hitArea

Source - pixi/display/DisplayObject.js, line 62

ignoreChildInput :Boolean

If ignoreChildInput is false it will allow this objects children to be considered as valid for Input events.

If this property is true then the children will not be considered as valid for Input events.

Note that this property isn't recursive: only immediate children are influenced, it doesn't scan further down.

Inherited From:

PIXI.DisplayObjectContainer#ignoreChildInput

Source - pixi/display/DisplayObjectContainer.js, line 26

isMask :Boolean

Whether this shape is being used as a mask.

Source - pixi/primitives/Graphics.js, line 88

lineColor :String

The color of any lines drawn.

Default Value:

Source - pixi/primitives/Graphics.js, line 34

lineWidth :Number

The width (thickness) of any lines drawn.

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

PIXI.DisplayObject#mask

Source - pixi/display/DisplayObject.js, line 282

<readonly> parent :PIXI.DisplayObjectContainer

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

Inherited From:

PIXI.DisplayObject#parent

Source - pixi/display/DisplayObject.js, line 79

pivot :Point

The pivot point of the displayObject that it rotates around

Inherited From:

PIXI.DisplayObject#pivot

Source - pixi/display/DisplayObject.js, line 30

position :Point

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

Inherited From:

PIXI.DisplayObject#position

Source - pixi/display/DisplayObject.js, line 14

renderable :Boolean

Can this object be rendered

Inherited From:

PIXI.DisplayObject#renderable

Source - pixi/display/DisplayObject.js, line 71

rotation :Number

The rotation of the object in radians.

Inherited From:

PIXI.DisplayObject#rotation

Source - pixi/display/DisplayObject.js, line 38

scale :Point

The scale factor of the object.

Inherited From:

PIXI.DisplayObject#scale

Source - pixi/display/DisplayObject.js, line 22

<readonly> stage :Stage

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

Inherited From:

PIXI.DisplayObject#stage

Source - pixi/display/DisplayObject.js, line 88

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 - pixi/primitives/Graphics.js, line 52

visible :Boolean

The visibility of the object.

Inherited From:

PIXI.DisplayObject#visible

Source - pixi/display/DisplayObject.js, line 54

width :Number

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

Inherited From:

PIXI.DisplayObjectContainer#width

Source - pixi/display/DisplayObjectContainer.js, line 43

<readonly> worldAlpha :Number

[read-only] The multiplied alpha of the displayObject

Inherited From:

PIXI.DisplayObject#worldAlpha

Source - pixi/display/DisplayObject.js, line 97

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

PIXI.DisplayObject#worldPosition

Source - pixi/display/DisplayObject.js, line 116

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

PIXI.DisplayObject#worldRotation

Source - pixi/display/DisplayObject.js, line 136

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

PIXI.DisplayObject#worldScale

Source - pixi/display/DisplayObject.js, line 126

worldVisible :Boolean

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

Inherited From:

PIXI.DisplayObject#worldVisible

Source - pixi/display/DisplayObject.js, line 258

x :Number

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

Inherited From:

PIXI.DisplayObject#x

Source - pixi/display/DisplayObject.js, line 722

y :Number

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

Inherited From:

PIXI.DisplayObject#y

Source - pixi/display/DisplayObject.js, line 740

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:

PIXI.DisplayObjectContainer#addChild

Source - pixi/display/DisplayObjectContainer.js, line 102

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:

PIXI.DisplayObjectContainer#addChildAt

Source - pixi/display/DisplayObjectContainer.js, line 114

arc(cx, cy, radius, startAngle, endAngle, anticlockwise, segments) → {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.
`segments`	Number	Optional. The number of segments to use when calculating the arc. The default is 40. If you need more fidelity use a higher number.

Returns:

PIXI.Graphics -

Source - 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 - pixi/primitives/Graphics.js, line 476

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 - 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 - pixi/primitives/Graphics.js, line 618

destroy()

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

Inherited From:

PIXI.DisplayObject#destroy

Source - pixi/display/DisplayObject.js, line 223

destroyCachedSprite()

Destroys a previous cached sprite.

Source - pixi/primitives/Graphics.js, line 1131

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 - pixi/primitives/Graphics.js, line 550

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 - pixi/primitives/Graphics.js, line 566

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 - pixi/primitives/Graphics.js, line 583

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 - pixi/primitives/Graphics.js, line 519

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 - pixi/primitives/Graphics.js, line 535

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 - pixi/primitives/Graphics.js, line 1142

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 - pixi/primitives/Graphics.js, line 504

generateTexture(resolution, scaleMode, padding) → {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	Argument	Default	Description
`resolution`	Number	<optional>	1	The resolution of the texture being generated
`scaleMode`	Number	<optional>	0	Should be one of the PIXI.scaleMode consts
`padding`	Number	<optional>	0	Add optional extra padding to the generated texture (default 0)

Returns:

PIXI.Texture -

a texture of the graphics object

Source - pixi/primitives/Graphics.js, line 636

getBounds() → {Rectangle}

Retrieves the bounds of the graphic shape as a rectangle object

Returns:

Rectangle -

the rectangular bounding area

Source - pixi/primitives/Graphics.js, line 832

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:

PIXI.DisplayObjectContainer#getChildAt

Source - pixi/display/DisplayObjectContainer.js, line 205

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:

PIXI.DisplayObjectContainer#getChildIndex

Source - pixi/display/DisplayObjectContainer.js, line 170

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:

PIXI.DisplayObjectContainer#getLocalBounds

Source - pixi/display/DisplayObjectContainer.js, line 381

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 - 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 - 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 - pixi/primitives/Graphics.js, line 173

preUpdate()

Empty, to be overridden by classes that require it.

Inherited From:

PIXI.DisplayObject#preUpdate

Source - pixi/display/DisplayObject.js, line 532

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

PIXI.DisplayObjectContainer#removeChild

Source - pixi/display/DisplayObjectContainer.js, line 222

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:

PIXI.DisplayObjectContainer#removeChildAt

Source - pixi/display/DisplayObjectContainer.js, line 237

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:

PIXI.DisplayObjectContainer#removeChildren

Source - pixi/display/DisplayObjectContainer.js, line 255

removeStageReference()

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

Inherited From:

PIXI.DisplayObjectContainer#removeStageReference

Source - pixi/display/DisplayObjectContainer.js, line 426

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