PIXI

Class: Graphics

PIXI. Graphics

new PIXI.Graphics()

core/graphics/Graphics.js, line 18

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.

Extends

Members

alphanumber

The opacity of the object.

blendModenumber

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:

boundsPaddingnumber

The bounds' padding used for bounds calculation.

cacheAsBitmapboolean

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'

readonlychildrenArray.<PIXI.DisplayObject>

The array of children of this container.

fillAlphanumber

The alpha value used when filling the Graphics object.

Default Value:
  • 1

filterAreaPIXI.Rectangle

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

filtersArray.<PIXI.AbstractFilter>

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'

heightnumber

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

isMaskboolean

Whether this shape is being used as a mask.

lineColorstring

The color of any lines drawn.

Default Value:
  • 0

lineWidthnumber

The width (thickness) of any lines drawn.

Default Value:
  • 0

maskPIXI.Graphics PIXI.Sprite

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.

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

readonlyparentPIXI.Container

The display object container that contains this display object.

pivotPIXI.Point

The pivot point of the displayObject that it rotates around

positionPIXI.Point

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

renderableboolean

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

rotationnumber

The rotation of the object in radians.

scalePIXI.Point

The scale factor of the object.

skewPIXI.Point

The skew factor for the object in radians.

tintnumber

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

Default Value:
  • 0xFFFFFF

visibleboolean

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

widthnumber

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

readonlyworldAlphanumber

The multiplied alpha of the displayObject

readonlyworldTransformPIXI.Matrix

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

readonlyworldVisibleboolean

Indicates if the sprite is globally visible.

xnumber

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

ynumber

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

Methods

inherited addChild(child){PIXI.DisplayObject}

core/display/Container.js, line 112

Adds a child to the container.

You can also add multple items like so: myContainer.addChild(thinkOne, thingTwo, thingThree)

Name Type Description
child PIXI.DisplayObject

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

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

core/display/Container.js, line 153

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.

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

core/graphics/Graphics.js, line 459

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

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:
Type Description
PIXI.Graphics

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

core/graphics/Graphics.js, line 392

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

beginFill(color, alpha){PIXI.Graphics}

core/graphics/Graphics.js, line 536

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

Name Type Description
color number

the color of the fill
alpha number

the alpha of the fill
Returns:
Type Description
PIXI.Graphics

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

core/graphics/Graphics.js, line 333

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

clear(){PIXI.Graphics}

core/graphics/Graphics.js, line 675

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

Returns:
Type Description
PIXI.Graphics

clone(){PIXI.Graphics}

core/graphics/Graphics.js, line 172

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

containsPoint(point){boolean}

core/graphics/Graphics.js, line 921

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

core/graphics/Graphics.js, line 1163

Destroys the Graphics object.

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

core/graphics/Graphics.js, line 607

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

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

core/graphics/Graphics.js, line 623

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

drawPolygon(path){PIXI.Graphics}

core/graphics/Graphics.js, line 636

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

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

core/graphics/Graphics.js, line 576
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

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

core/graphics/Graphics.js, line 592
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

drawShape(shape){PIXI.GraphicsData}

core/graphics/Graphics.js, line 1132

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.Rectangle | PIXI.Ellipse | PIXI.Line | PIXI.Polygon

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

endFill(){Graphics}

core/graphics/Graphics.js, line 559

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

Returns:
Type Description
Graphics

generateTexture(resolution, scaleMode){PIXI.Texture}

core/graphics/Graphics.js, line 695

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.

Name Type Description
resolution number

The resolution of the texture being generated
scaleMode number

Should be one of the scaleMode consts
Returns:
Type Description
PIXI.Texture a texture of the graphics object

getBounds(matrix){PIXI.Rectangle}

core/graphics/Graphics.js, line 832

Retrieves the bounds of the graphic shape as a rectangle object

Name Type Description
matrix PIXI.Matrix optional

The world transform matrix to use, defaults to this
object's worldTransform.
Returns:
Type Description
PIXI.Rectangle the rectangular bounding area

inherited getChildAt(index){PIXI.DisplayObject}

core/display/Container.js, line 248

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 210

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(){PIXI.Rectangle}

core/display/Container.js, line 486

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

Returns:
Type Description
PIXI.Rectangle The rectangular bounding area

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

core/graphics/Graphics.js, line 209

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

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:
Type Description
PIXI.Graphics

lineTo(x, y){PIXI.Graphics}

core/graphics/Graphics.js, line 260

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

moveTo(x, y){PIXI.Graphics}

core/graphics/Graphics.js, line 243

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

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

core/graphics/Graphics.js, line 278

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

inherited removeChild(child){PIXI.DisplayObject}

core/display/Container.js, line 264

Removes a child from the container.

Name Type Description
child PIXI.DisplayObject

The DisplayObject to remove
Returns:
Type Description
PIXI.DisplayObject The child that was removed.

inherited removeChildAt(index){PIXI.DisplayObject}

core/display/Container.js, line 304

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)

core/display/Container.js, line 324

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

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

core/display/Container.js, line 601

Renders the object using the Canvas renderer

Name Type Description
renderer PIXI.CanvasRenderer

The renderer

inherited renderWebGL(renderer)

core/display/Container.js, line 509

Renders the object using the WebGL renderer

Name Type Description
renderer PIXI.WebGLRenderer

The renderer

inherited setChildIndex(child, index)

core/display/Container.js, line 228

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){Container}

core/display/DisplayObject.js, line 505

Set the parent Container of this DisplayObject

Name Type Description
container Container

The Container to add this DisplayObject to
Returns:
Type Description
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 530

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

inherited swapChildren(child, child2)

core/display/Container.js, line 184

Swaps the position of 2 Display Objects within this container.

Name Type Description
child PIXI.DisplayObject
child2 PIXI.DisplayObject

inherited toGlobal(position){PIXI.Point}

core/display/DisplayObject.js, line 402

Calculates the global position of the display object

Name Type Description
position PIXI.Point

The world origin to calculate from
Returns:
Type Description
PIXI.Point A point object representing the position of this object

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

core/display/DisplayObject.js, line 430

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

Name Type 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)
Returns:
Type Description
PIXI.Point A point object representing the position of this object

updateLocalBounds()

core/graphics/Graphics.js, line 953

Update the bounds of the object