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

Name Type Default Description
geometry PIXI.GraphicsGeometry null optional

Geometry to use, if omitted will create a new GraphicsGeometry instance.

Extends

Members

_accessibleActive boolean inherited

TODO
  • Needs docs.

_accessibleDiv boolean inherited

TODO
  • Needs docs.

_bounds PIXI.Bounds protected inherited

The bounds object, this is used to calculate and store the bounds of the displayObject.

_destroyed boolean protected inherited

If the object has been destroyed via destroy(). If true, it should not be used.

_fillStyle PIXI.FillStyle protected

Current fill style

_holeMode boolean protected

Current hole mode is enabled.

Default Value:
  • false

_lastSortedIndex number protected inherited

Which index in the children array the display component was before the previous zIndex sort. Used by containers to help sort objects with the same zIndex, by using previous array index as the decider.

_lineStyle PIXI.LineStyle protected

Current line style

_mask PIXI.Graphics | PIXI.Sprite protected inherited

The original, cached mask of the object.

_matrix PIXI.Matrix protected

Current shape transform matrix.

_tempDisplayObjectParent PIXI.DisplayObject protected inherited

_zIndex number protected inherited

The zIndex of the displayObject. A higher value will mean it will be rendered on top of other displayObjects within the same container.

accessible boolean inherited

Flag for if the object is accessible. If true AccessibilityManager will overlay a shadow div with attributes set

accessibleHint string inherited

Sets the aria-label attribute of the shadow div

accessibleTitle string nullable inherited

Sets the title attribute of the shadow div If accessibleTitle AND accessibleHint has not been this will default to 'displayObject [tabIndex]'

alpha number inherited

The opacity of the object.

angle number inherited

The angle of the object in degrees. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

batches Array.<object> protected

A collections of batches! These can be drawn by the renderer batch system.

batchTint number protected

Update dirty for limiting calculating tints for batches.

Default Value:
  • -1

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:

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 overrides

When cacheAsBitmap is set to true the graphics object will 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 in exchange for taking up texture memory. It is also useful if you need the graphics object to be anti-aliased, because it will be rendered using canvas. This is not recommended if you are constantly redrawing the graphics element.

Default Value:
  • false

children Array.<PIXI.DisplayObject> readonly inherited

The array of children of this container.

currentPath PIXI.Polygon protected

Current path

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

fill PIXI.FillStyle readonly

The current fill style.

filterArea PIXI.Rectangle nullable inherited

The area the filter is applied to. This is used as more of an optimization 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> nullable 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'.

geometry PIXI.Geometry readonly

Includes vertex positions, face indices, normals, colors, UVs, and custom attributes within buffers, reducing the cost of passing all this data to the GPU. Can be shared between multiple Mesh or Graphics objects.

height number inherited

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

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

isSprite boolean inherited

used to fast check if a sprite is.. a sprite!

line PIXI.LineStyle readonly

The current line style.

localTransform PIXI.Matrix readonly inherited

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

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 PixiJS a regular mask must be a PIXI.Graphics or a PIXI.Sprite object. This allows for much faster masking in canvas as it utilities 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
  • At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
Example
const graphics = new PIXI.Graphics();
graphics.beginFill(0xFF3300);
graphics.drawRect(50, 250, 100, 100);
graphics.endFill();

const sprite = new PIXI.Sprite(texture);
sprite.mask = graphics;

name string inherited

The instance name of the object.

parent PIXI.Container readonly inherited

The display object container that contains this display object.

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

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. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

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

shader PIXI.Shader

Represents the vertex and fragment shaders that processes the geometry and runs on the GPU. Can be shared between multiple Graphics objects.

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

sortableChildren boolean inherited

If set to true, the container will sort its children by zIndex value when updateTransform() is called, or manually if sortChildren() is called.

This actually changes the order of elements in the array, so should be treated as a basic solution that is not performant compared to other solutions, such as @link https://github.com/pixijs/pixi-display

Also be aware of that this may not work nicely with the addChildAt() function, as the zIndex sorting may cause the child to automatically sorted to another position.

See:

sortDirty boolean inherited

Should children be sorted by zIndex at the next updateTransform call. Will get automatically set to true if a new child is added, or if a child's zIndex changes.

state PIXI.State

Represents the WebGL state the Graphics required to render, excludes shader and geometry. E.g., blend mode, culling, depth testing, direction of rendering triangles, backface, etc.

tint number

The tint applied to the graphic shape. This is a hex value. A value of 0xFFFFFF will remove any tint effect.

Default Value:
  • 0xFFFFFF

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.

vertexData Float32Array protected

Copy of the object vertex data.

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

zIndex number inherited

The zIndex of the displayObject. If a container has the sortableChildren property set to true, children will be automatically sorted by zIndex value; a higher value will mean it will be moved towards the end of the array, and thus rendered on top of other displayObjects within the same container.

Methods

_calculateBounds () protected overrides

Retrieves the bounds of the graphic shape as a rectangle object

_initCurve (x, y) protected

Initialize the curve

Name Type Default Description
x number 0 optional
y number 0 optional

_recursivePostUpdateTransform () inherited

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

_render (renderer) protected overrides

Renders the object using the WebGL renderer

Name Type Description
renderer PIXI.Renderer

The renderer

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

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

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

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

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

Begin adding holes to the last draw shape IMPORTANT: holes must be fully inside a shape to work Also weirdness ensues if holes overlap!

Returns:
Type Description
PIXI.Graphics Returns itself.

beginTextureFill (texture, color, alpha, matrix)PIXI.Graphics

Begin the texture fill

Name Type Default Description
texture PIXI.Texture PIXI.Texture.WHITE optional

Texture to fill

color number 0xffffff optional

Background to fill behind texture

alpha number 1 optional

Alpha of fill

matrix PIXI.Matrix null optional

Transform matrix

Returns:
Type Description
PIXI.Graphics This Graphics object. Good for chaining method calls

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

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

Recalculates the bounds of the container.

calculateTints () protected

Recalcuate the tint by applying tin to batches using Graphics tint.

calculateVertices () protected

If there's a transform update or a change to the shape of the geometry, recaculate the vertices.

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

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

Closes the current path.

Returns:
Type Description
PIXI.Graphics Returns itself.

containsPoint (point)boolean

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

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

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

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

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

Draws a rectangle shape.

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

Draw a rectangle shape with rounded/beveled corners.

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

Draw any shape.

Name Type Description
shape PIXI.Circle | PIXI.Ellipse | PIXI.Polygon | PIXI.Rectangle | PIXI.RoundedRectangle

Shape to draw

Returns:
Type Description
PIXI.Graphics This Graphics object. Good for chaining method calls

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

Draw a star shape with an arbitrary 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

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

End adding holes to the last draw shape

Returns:
Type Description
PIXI.Graphics Returns itself.

finishPoly () protected

Finish the polygon object.

generateCanvasTexture (scaleMode, resolution)PIXI.Texture

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

Retrieves the bounds of the displayObject as a rectangle object.

Name Type Description
skipUpdate boolean optional

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

Optional rectangle to store the result of the bounds calculation.

Returns:
Type Description
PIXI.Rectangle The rectangular bounding area.

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.

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

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

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.

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

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 (width, color, alpha, alignment, native)PIXI.Graphics

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

Name Type Default Description
width 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

alignment number 1 optional

alignment of the line to draw, (0 = inner, 0.5 = middle, 1 = outter)

native boolean false optional

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

Returns:
Type Description
PIXI.Graphics This Graphics object. Good for chaining method calls

lineTextureStyle (width, texture, color, alpha, matrix, alignment, native)PIXI.Graphics

Like line style but support texture for line fill.

Name Type Default Description
width number 0 optional

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

texture PIXI.Texture PIXI.Texture.WHITE optional

Texture to use

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

matrix PIXI.Matrix null optional

Texture matrix to transform texture

alignment number 0.5 optional

alignment of the line to draw, (0 = inner, 0.5 = middle, 1 = outter)

native boolean false optional

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

Returns:
Type Description
PIXI.Graphics This Graphics object. Good for chaining method calls

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

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

onChildrenChange () protected inherited

Overridable method that can be used by Container subclasses whenever the children array is modified

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

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

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.

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

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

Renders the object using the WebGL renderer

Name Type Description
renderer PIXI.Renderer

The renderer

renderAdvanced (renderer) protected inherited

Render the object using the WebGL renderer and advanced features.

Name Type Description
renderer PIXI.Renderer

The renderer

renderAdvancedWebGL (renderer) Deprecated : since 5.0.0 inherited

Name Type Description
renderer PIXI.Renderer

Instance of renderer

See:

renderCanvas (renderer) inherited overrides

Renders the object using the Canvas renderer

Name Type Description
renderer PIXI.CanvasRenderer

The renderer

renderWebGL (renderer) Deprecated : since 5.0.0 inherited

Name Type Description
renderer PIXI.Renderer

Instance of renderer

See:

setChildIndex (child, index) inherited

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

setMatrix (matrix)PIXI.Graphics

Apply a matrix to the positional data.

Name Type Description
matrix PIXI.Matrix

Matrix to use for transform current shape.

Returns:
Type Description
PIXI.Graphics Returns itself.

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

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

sortChildren () inherited

Sorts children by zIndex. Previous order is mantained for 2 children with the same zIndex.

startPoly () protected

Start a polygon object internally

swapChildren (child, child2) inherited

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.IPoint inherited

Calculates the global position of the display object.

Name Type Default Description
position PIXI.IPoint

The world origin to calculate from.

point PIXI.IPoint 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.IPoint A point object representing the position of this object.

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

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

Name Type Default Description
position PIXI.IPoint

The world origin to calculate from.

from PIXI.DisplayObject optional

The DisplayObject to calculate the global position from.

point PIXI.IPoint 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.IPoint A point object representing the position of this object

updateTransform () inherited

Updates the transform on all children of this container for rendering

Events

Fired when this DisplayObject is added to a Container.

Name Type Description
container PIXI.Container

The container added to.

Fired when a pointer device button (usually a mouse left-button) is pressed and released on the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a pointer device button (usually a mouse left-button) is pressed on the display. object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a pointer device (usually a mouse) is moved while over the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a pointer device (usually a mouse) is moved off the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a pointer device (usually a mouse) is moved onto the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a pointer device button (usually a mouse left-button) is released over the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a pointer device button (usually a mouse left-button) is released outside the display object that initially registered a mousedown. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when the operating system cancels a pointer event. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a pointer device button is pressed on the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a pointer device is moved while over the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a pointer device is moved off the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a pointer device is moved onto the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a pointer device button is pressed and released on the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a pointer device button is released over the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a pointer device button is released outside the display object that initially registered a pointerdown. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when this DisplayObject is removed from a Container.

Name Type Description
container PIXI.Container

The container removed from.

Fired when a pointer device secondary button (usually a mouse right-button) is pressed and released on the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a pointer device secondary button (usually a mouse right-button) is pressed on the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a pointer device secondary button (usually a mouse right-button) is released over the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a pointer device secondary button (usually a mouse right-button) is released outside the display object that initially registered a rightdown. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a touch point is placed and removed from the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when the operating system cancels a touch. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a touch point is removed from the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a touch point is removed outside of the display object that initially registered a touchstart. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a touch point is moved along the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event

Fired when a touch point is placed on the display object. DisplayObject's interactive property must be set to true to fire event.

Name Type Description
event PIXI.interaction.InteractionEvent

Interaction event