PixiJS

Class: Graphics

PIXI.Graphics

The Graphics class is primarily used to render primitive shapes such as lines, circles and rectangles to the display, and to color and fill them. However, you can also use a Graphics object to build a list of primitives to use as a mask, or as a complex hitArea.

Please note that due to legacy naming conventions, the behavior of some functions in this class can be confusing. Each call to drawRect(), drawPolygon(), etc. actually stores that primitive in the Geometry class's GraphicsGeometry object for later use in rendering or hit testing - the functions do not directly draw anything to the screen. Similarly, the clear() function doesn't change the screen, it simply resets the list of primitives, which can be useful if you want to rebuild the contents of an existing Graphics object.

Once a GraphicsGeometry list is built, you can re-use it in other Geometry objects as an optimization, by passing it into a new Geometry object's constructor. Because of this ability, it's important to call destroy() on Geometry objects once you are done with them, to properly dereference each GraphicsGeometry and prevent memory leaks.

new PIXI.Graphics (geometry)

Graphics.ts:153
Name Type Default Description
geometry PIXI.GraphicsGeometry undefined

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

Extends

Members

blendMode PIXI.BLEND_MODES

The blend mode to be applied to the graphic shape. Apply a value of PIXI.BLEND_MODES.NORMAL to reset the blend mode. Note that, since each primitive in the GraphicsGeometry list is rendered sequentially, modes such as PIXI.BLEND_MODES.ADD and PIXI.BLEND_MODES.MULTIPLY will be applied per-primitive.

Default Value:
  • PIXI.BLEND_MODES.NORMAL

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

currentPath PIXI.Polygon readonly

Current path

Default Value:
  • undefined

fill PIXI.FillStyle readonly

The current fill style.

geometry PIXI.GraphicsGeometry 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.

line PIXI.LineStyle readonly

The current line style.

pluginName string

Renderer plugin for batching

Default Value:
  • "batch"

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.

Default Value:
  • undefined

tint number

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

Default Value:
  • 0xFFFFFF

_fillStyle PIXI.FillStyle protected

Current fill style.

_holeMode boolean protected

Current hole mode is enabled.

Default Value:
  • false

_lineStyle PIXI.LineStyle protected

Current line style.

_matrix PIXI.Matrix protected

Current shape transform matrix.

Default Value:
  • undefined

batchDirty number protected

Update dirty for limiting calculating batches.

Default Value:
  • -1

batches Array<IGraphicsBatchElement> 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

vertexData Float32Array protected

Copy of the object vertex data.

Default Value:
  • undefined

Methods

arc (cx, cy, radius, startAngle, endAngle, anticlockwise) this

Graphics.ts:526

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

Specifies whether the drawing should be counter-clockwise or clockwise. False is default, and indicates clockwise, while true indicates counter-clockwise.
Returns:
Type Description
this
  • This Graphics object. Good for chaining method calls

arcTo (x1, y1, x2, y2, radius) this

Graphics.ts:497

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 first tangent point of the arc
y1 number

The y-coordinate of the first tangent point 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
this
  • This Graphics object. Good for chaining method calls

beginFill (color, alpha) this

Graphics.ts:598

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

the color of the fill
alpha number 1

the alpha of the fill
Returns:
Type Description
this
  • This Graphics object. Good for chaining method calls

beginHole () this

Graphics.ts:1147

Begin adding holes to the last draw shape IMPORTANT: holes must be fully inside a shape to work Also weirdness ensues if holes overlap! Ellipses, Circles, Rectangles and Rounded Rectangles cannot be holes or host for holes in CanvasRenderer, please use moveTo lineTo, quadraticCurveTo if you rely on pixi-legacy bundle.

Returns:
Type Description
this
  • Returns itself.

beginTextureFill (options) PIXI.Graphics

Graphics.ts:610

Begin the texture fill

Name Type Attributes Default Description
options IFillStyleOptions <optional>

Object object.
options.texture PIXI.Texture <optional>
 PIXI.Texture.WHITE

Texture to fill
options.color number <optional>
 0xffffff

Background to fill behind texture
options.alpha number <optional>
 1

Alpha of fill
options.matrix PIXI.Matrix <optional>
 null

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

bezierCurveTo (cpX, cpY, cpX2, cpY2, toX, toY) this

Graphics.ts:478

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
this This Graphics object. Good for chaining method calls

clear () this

Graphics.ts:783

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

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

clone () PIXI.Graphics

Graphics.ts:182

Creates a new Graphics object with the same values as this one. Note that only the geometry of the object is cloned, not its transform (position,scale,etc)

Returns:
Type Description
PIXI.Graphics
  • A clone of the graphics object

closePath () this

Graphics.ts:1115

Closes the current path.

Returns:
Type Description
this
  • Returns itself.

containsPoint (point) boolean

Graphics.ts:1039

Tests if a point is inside this graphics object

Name Type Description
point IPointData

the point to test
Returns:
Type Description
boolean
  • the result of the test

destroy (options) void overrides

Graphics.ts:1175

Destroys the Graphics object.

Name Type Attributes Default Description
options IDestroyOptions | boolean <optional>

Options parameter. A boolean will act as if all options have been set to that value
options.children boolean <optional>
 false

if set to true, all the children will have their destroy method called as well. 'options' will be passed on to those calls.
options.texture boolean <optional>
 false

Only used for child Sprites if options.children is set to true Should it destroy the texture of the child sprite
options.baseTexture boolean <optional>
 false

Only used for child Sprites if options.children is set to true Should it destroy the base texture of the child sprite

drawChamferRect (this, x, y, width, height, chamfer) PIXI.Graphics

drawChamferRect.ts:3

Draw Rectangle with chamfer corners. These are angled corners.

Note: Only available with @pixi/graphics-extras.

Name Type Description
this PIXI.Graphics
x number

Upper left corner of rect
y number

Upper right corner of rect
width number

Width of rect
height number

Height of rect
chamfer number

non-zero real number, size of corner cutout
Returns:
Type Description
PIXI.Graphics Returns self.

drawCircle (x, y, radius) this

Graphics.ts:694

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
this
  • This Graphics object. Good for chaining method calls

drawEllipse (x, y, width, height) this

Graphics.ts:706

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
this
  • This Graphics object. Good for chaining method calls

drawFilletRect (this, x, y, width, height, fillet) PIXI.Graphics

drawFilletRect.ts:3

Draw Rectangle with fillet corners. This is much like rounded rectangle however it support negative numbers as well for the corner radius.

Note: Only available with @pixi/graphics-extras.

Name Type Description
this PIXI.Graphics
x number

Upper left corner of rect
y number

Upper right corner of rect
width number

Width of rect
height number

Height of rect
fillet number

accept negative or positive values
Returns:
Type Description
PIXI.Graphics Returns self.

drawPolygon (…path) this

Graphics.ts:722

Draws a polygon using the given path.

Name Type Description
path Array<number> | Array<PIXI.IPointData> | PIXI.Polygon

The path data used to construct the polygon.
Returns:
Type Description
this
  • This Graphics object. Good for chaining method calls

drawRect (x, y, width, height) this

Graphics.ts:667

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
this
  • This Graphics object. Good for chaining method calls

drawRegularPolygon (this, x, y, radius, sides, rotation) PIXI.Graphics

drawRegularPolygon.ts:3

Draw a regular polygon where all sides are the same length.

Note: Only available with @pixi/graphics-extras.

Name Type Default Description
this PIXI.Graphics
x number

X position
y number

Y position
radius number

Polygon radius
sides number

Minimum value is 3
rotation number 0

Starting rotation values in radians..
Returns:
Type Description
PIXI.Graphics This Graphics object. Good for chaining method calls

drawRoundedPolygon (this, x, y, radius, sides, corner, rotation) PIXI.Graphics

drawRoundedPolygon.ts:3

Draw a regular polygon with rounded corners.

Note: Only available with @pixi/graphics-extras.

Name Type Default Description
this PIXI.Graphics
x number

X position
y number

Y position
radius number

Polygon radius
sides number

Minimum value is 3
corner number

Corner size in pixels.
rotation number 0

Starting rotation values in radians..
Returns:
Type Description
PIXI.Graphics This Graphics object. Good for chaining method calls

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

Graphics.ts:680

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
this
  • This Graphics object. Good for chaining method calls

drawShape (shape) this

Graphics.ts:759

Draw any shape.

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

Shape to draw
Returns:
Type Description
this
  • This Graphics object. Good for chaining method calls

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

drawStar.ts:42

Draw a star shape with an arbitrary number of points.

Note: Only available with @pixi/graphics-extras.

Name Type Default Description
this PIXI.Graphics
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

The inner radius between points, default half radius
rotation number 0

The rotation of the star in radians, where 0 is vertical
Returns:
Type Description
PIXI.Graphics
  • This Graphics object. Good for chaining method calls

drawTorus (this, x, y, innerRadius, outerRadius, startArc, endArc) PIXI.Graphics

drawTorus.ts:3

Draw a torus shape, like a donut. Can be used for something like a circle loader.

Note: Only available with @pixi/graphics-extras.

Name Type Attributes Default Description
this PIXI.Graphics
x number

X position
y number

Y position
innerRadius number

Inner circle radius
outerRadius number

Outer circle radius
startArc number <optional>
 0

Where to begin sweep, in radians, 0.0 = to the right
endArc number <optional>
 Math.PI*2

Where to end sweep, in radians
Returns:
Type Description
PIXI.Graphics This Graphics object. Good for chaining method calls

endFill () this

Graphics.ts:654

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

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

endHole () this

Graphics.ts:1163

End adding holes to the last draw shape.

Returns:
Type Description
this
  • Returns itself.

generateCanvasTexture (scaleMode, resolution) PIXI.Texture

Graphics.ts:10

Generates a canvas texture. Only available with pixi.js-legacy bundle or the @pixi/canvas-graphics package.

Name Type Attributes Default Description
scaleMode PIXI.SCALE_MODES <optional>

The scale mode of the texture.
resolution number 1

The resolution of the texture.
Returns:
Type Description
PIXI.Texture The new texture.

isFastRect () boolean

Graphics.ts:801

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

Graphics.ts:245

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

Name Type Attributes Default Description
width ILineStyleOptions | number <optional>
 0

width of the line to draw, will update the objects stored style
color number <optional>
 0x0

color of the line to draw, will update the objects stored style
alpha number <optional>
 1

alpha of the line to draw, will update the objects stored style
alignment number <optional>
 0.5

alignment of the line to draw, (0 = inner, 0.5 = middle, 1 = outer). WebGL only.
native boolean <optional>
 false

If true the lines will be draw using LINES instead of TRIANGLE_STRIP
Returns:
Type Description
this
  • This Graphics object. Good for chaining method calls

lineStyle (options) PIXI.Graphics

Graphics.ts:258

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

Name Type Attributes Default Description
options ILineStyleOptions <optional>

Line style options
options.width number <optional>
 0

width of the line to draw, will update the objects stored style
options.color number <optional>
 0x0

color of the line to draw, will update the objects stored style
options.alpha number <optional>
 1

alpha of the line to draw, will update the objects stored style
options.alignment number <optional>
 0.5

alignment of the line to draw, (0 = inner, 0.5 = middle, 1 = outer). WebGL only.
options.native boolean <optional>
 false

If true the lines will be draw using LINES instead of TRIANGLE_STRIP
options.cap PIXI.LINE_CAP <optional>
 PIXI.LINE_CAP.BUTT

line cap style
options.join PIXI.LINE_JOIN <optional>
 PIXI.LINE_JOIN.MITER

line join style
options.miterLimit number <optional>
 10

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

lineTextureStyle (options) PIXI.Graphics

Graphics.ts:287

Like line style but support texture for line fill.

Name Type Attributes Default Description
options ILineStyleOptions <optional>

Collection of options for setting line style.
options.width number <optional>
 0

width of the line to draw, will update the objects stored style
options.texture PIXI.Texture <optional>
 PIXI.Texture.WHITE

Texture to use
options.color number <optional>
 0x0

color of the line to draw, will update the objects stored style. Default 0xFFFFFF if texture present.
options.alpha number <optional>
 1

alpha of the line to draw, will update the objects stored style
options.matrix PIXI.Matrix <optional>
 null

Texture matrix to transform texture
options.alignment number <optional>
 0.5

alignment of the line to draw, (0 = inner, 0.5 = middle, 1 = outer). WebGL only.
options.native boolean <optional>
 false

If true the lines will be draw using LINES instead of TRIANGLE_STRIP
options.cap PIXI.LINE_CAP <optional>
 PIXI.LINE_CAP.BUTT

line cap style
options.join PIXI.LINE_JOIN <optional>
 PIXI.LINE_JOIN.MITER

line join style
options.miterLimit number <optional>
 10

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

lineTo (x, y) this

Graphics.ts:406

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
this
  • This Graphics object. Good for chaining method calls

moveTo (x, y) this

Graphics.ts:391

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
this
  • This Graphics object. Good for chaining method calls

quadraticCurveTo (cpX, cpY, toX, toY) this

Graphics.ts:453

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
this
  • This Graphics object. Good for chaining method calls

setMatrix (matrix) this

Graphics.ts:1135

Apply a matrix to the positional data.

Name Type Description
matrix PIXI.Matrix

Matrix to use for transform current shape.
Returns:
Type Description
this
  • Returns itself.

_calculateBounds () void protected overrides

Graphics.ts:1021

Retrieves the bounds of the graphic shape as a rectangle object.

_initCurve (x, y) void protected

Graphics.ts:433

Initialize the curve

Name Type Default Description
x number 0
y number 0

_populateBatches () void protected

Graphics.ts:849

Populating batches for rendering.

_render (renderer) void protected overrides

Graphics.ts:817

Renders the object using the WebGL renderer

Name Type Description
renderer PIXI.Renderer

The renderer

_renderBatched (renderer) void protected

Graphics.ts:894

Renders the batches using the BathedRenderer plugin

Name Type Description
renderer PIXI.Renderer

The renderer

_renderDirect (renderer) void protected

Graphics.ts:920

Renders the graphics direct

Name Type Description
renderer PIXI.Renderer

The renderer

_renderDrawCallDirect (renderer, drawCall) void protected

Graphics.ts:961

Renders specific DrawCall

Name Type Description
renderer PIXI.Renderer
drawCall PIXI.BatchDrawCall

_resolveDirectShader (renderer) PIXI.Shader protected

Graphics.ts:979

Resolves shader for direct rendering

Name Type Description
renderer PIXI.Renderer

The renderer
Returns:
Type Description
PIXI.Shader

calculateTints () void protected

Graphics.ts:1051

Recalculate the tint by applying tint to batches using Graphics tint.

calculateVertices () void protected

Graphics.ts:1080

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

finishPoly () void protected

Graphics.ts:371

Finish the polygon object.

startPoly () void protected

Graphics.ts:345

Start a polygon object internally.

Inherited Properties

From class PIXI.Container

children T[] readonly inherited

The array of children of this container.

height number inherited

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

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

Default Value:
  • true

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.

width number inherited

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

From class PIXI.DisplayObject

_accessibleActive boolean inherited

Default Value:
  • false
TODO
  • Needs docs.

_accessibleDiv boolean inherited

Default Value:
  • undefined
TODO
  • Needs docs.

_bounds PIXI.Bounds inherited

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

_localBounds PIXI.Bounds inherited

Local bounds object, swapped with _bounds when using getLocalBounds().

accessible boolean inherited

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

Default Value:
  • false

accessibleChildren boolean inherited

Setting to false will prevent any children inside this container to be accessible. Defaults to true.

Default Value:
  • true

accessibleHint string inherited

Sets the aria-label attribute of the shadow div

Default Value:
  • undefined

accessiblePointerEvents string inherited

Specify the pointer-events the accessible div will use Defaults to auto.

Default Value:
  • 'auto'

accessibleTitle ?string inherited

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

Default Value:
  • undefined

accessibleType string inherited

Specify the type of div the accessible layer is. Screen readers treat the element differently depending on this type. Defaults to button.

Default Value:
  • 'button'

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.

cacheAsBitmapMultisample number inherited

The number of samples to use for cacheAsBitmap. If set to null, the renderer's sample count is used. If cacheAsBitmap is set to true, this will re-render with the new number of samples.

Default Value:
  • PIXI.MSAA_QUALITY.NONE

cacheAsBitmapResolution number inherited

The resolution to use for cacheAsBitmap. By default this will use the renderer's resolution but can be overriden for performance. Lower values will reduce memory usage at the expense of render quality. A falsey value of null or 0 will default to the renderer's resolution. If cacheAsBitmap is set to true, this will re-render with the new resolution.

Default Value:
  • null

cullable boolean inherited

Should this object be rendered if the bounds of this object are out of frame?

Culling has no effect on whether updateTransform is called.

cullArea PIXI.Rectangle inherited

If set, this shape is used for culling instead of the bounds of this object. It can improve the culling performance of objects with many children. The culling area is defined in local space.

destroyed boolean inherited

Readonly flag for destroyed display objects.

filterArea PIXI.Rectangle 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 PIXI.Filter[] | null 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'.

hitArea PIXI.IHitArea inherited

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.

Default Value:
  • undefined
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.

Default Value:
  • false
Example

 const sprite = new PIXI.Sprite(texture);
 sprite.interactive = true;
 sprite.on('tap', (event) => {
    //handle event
 });

isMask boolean inherited

Does any other displayObject use this object as a mask?

isSprite boolean inherited

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

localTransform PIXI.Matrix readonly inherited

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

mask PIXI.Container | PIXI.MaskData | null inherited

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. Furthermore, a mask of an object must be in the subtree of its parent. Otherwise, getLocalBounds may calculate incorrect bounds, which makes the container's width and height wrong. 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.

Default Value:
  • undefined

parent PIXI.Container inherited

The display object container that contains this display object.

pivot PIXI.ObservablePoint inherited

The center of rotation, scaling, and skewing for this display object in its local space. The position is the projection of pivot in the parent's local space.

By default, the pivot is the origin (0, 0).

Since:
  • 4.0.0

position PIXI.ObservablePoint inherited

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

Since:
  • 4.0.0

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.

scale PIXI.ObservablePoint inherited

The scale factors of this object along the local coordinate axes.

The default scale is (1, 1).

Since:
  • 4.0.0

skew PIXI.ObservablePoint inherited

The skew factor for the object in radians.

Since:
  • 4.0.0

transform PIXI.Transform inherited

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.

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.

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 display objects within the same container.

See:

_boundsID number protected inherited

Flags the cached bounds as dirty.

_boundsRect PIXI.Rectangle protected inherited

Cache of this display-object's bounds-rectangle.

_destroyed boolean protected inherited

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

_enabledFilters PIXI.Filter[] protected inherited

Currently enabled filters.

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

_localBoundsRect PIXI.Rectangle protected inherited

Cache of this display-object's local-bounds rectangle.

_mask PIXI.Container | PIXI.MaskData protected inherited

The original, cached mask of the object.

_tempDisplayObjectParent PIXI.Container 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.

Inherited Methods

From class PIXI.Container

addChild (…children) PIXI.DisplayObject inherited

Container.ts:121

Adds one or more children to the container.

Multiple items can be added like so: myContainer.addChild(thingOne, thingTwo, thingThree)

Name Type Description
children PIXI.DisplayObject

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

Container.ts:170

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.

calculateBounds () void inherited

Container.ts:441

Recalculates the bounds of the container.

This implementation will automatically fit the children's bounds into the calculation. Each child's bounds is limited to its mask's bounds or filterArea, if any is applied.

containerUpdateTransform () inherited

Container.ts:811

Container default updateTransform, does update children of container. Will crash if there's no parent element.

getChildAt (index) T inherited

Container.ts:264

Returns the child at the specified index

Name Type Description
index number

The index to get the child at
Returns:
Type Description
T
  • The child at the given index, if any.

getChildByName (name, deep) PIXI.DisplayObject inherited

index.ts:10

Returns the display object in the container.

Recursive searches are done in a preorder traversal.

Name Type Attributes Default Description
name string

Instance name.
deep boolean <optional>
 false

Whether to search recursively
Returns:
Type Description
PIXI.DisplayObject The child with the specified name.

getChildIndex (child) number inherited

Container.ts:227

Returns the index position of a child DisplayObject instance

Name Type Description
child T

The DisplayObject instance to identify
Returns:
Type Description
number
  • The index position of the child display object to identify

getLocalBounds (rect, skipChildrenUpdate) PIXI.Rectangle inherited

Container.ts:493

Retrieves the local bounds of the displayObject as a rectangle object.

Calling getLocalBounds may invalidate the _bounds of the whole subtree below. If using it inside a render() call, it is advised to call getBounds() immediately after to recalculate the world bounds of the subtree.

Name Type Attributes Default Description
rect PIXI.Rectangle <optional>

Optional rectangle to store the result of the bounds calculation.
skipChildrenUpdate boolean false

Setting to true will stop re-calculation of children transforms, it was default behaviour of pixi 4.0-5.2 and caused many problems to users.
Returns:
Type Description
PIXI.Rectangle
  • The rectangular bounding area.

removeChild (…children) PIXI.DisplayObject inherited

Container.ts:279

Removes one or more children from the container.

Name Type Description
children PIXI.DisplayObject

The DisplayObject(s) to remove
Returns:
Type Description
PIXI.DisplayObject The first child that was removed.

removeChildAt (index) T inherited

Container.ts:319

Removes a child from the specified index position.

Name Type Description
index number

The index to get the child from
Returns:
Type Description
T The child that was removed.

removeChildren (beginIndex, endIndex) T[] inherited

Container.ts:344

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

Name Type Default Description
beginIndex number 0

The beginning position.
endIndex

The ending position. Default value is size of the container.
Returns:
Type Description
T[]
  • List of removed children

render (renderer) void inherited

Container.ts:597

Renders the object using the WebGL renderer.

The _render method is be overriden for rendering the contents of the container itself. This render method will invoke it, and also invoke the render methods of all children afterward.

If renderable or visible is false or if worldAlpha is not positive or if cullable is true and the bounds of this object are out of frame, this implementation will entirely skip rendering. See PIXI.DisplayObject for choosing between renderable or visible. Generally, setting alpha to zero is not recommended for purely skipping rendering.

When your scene becomes large (especially when it is larger than can be viewed in a single screen), it is advised to employ culling to automatically skip rendering objects outside of the current screen. See cullable and cullArea. Other culling methods might be better suited for a large number static objects; see @pixi-essentials/cull and pixi-cull.

The renderAdvanced method is internally used when when masking or filtering is applied on a container. This does, however, break batching and can affect performance when masking and filtering is applied extensively throughout the scene graph.

Name Type Description
renderer PIXI.Renderer

The renderer

renderCanvas (renderer) void inherited overrides

Container.ts:17

Renders the object using the Canvas renderer

Name Type Description
renderer PIXI.CanvasRenderer

The renderer

setChildIndex (child, index) void inherited

Container.ts:244

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

Name Type Description
child T

The child DisplayObject instance for which you want to change the index number
index number

The resulting index number for the child display object

sortChildren () void inherited

Container.ts:390

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

swapChildren (child, child2) void inherited

Container.ts:207

Swaps the position of 2 Display Objects within this container.

Name Type Description
child T

First display object to swap
child2 T

Second display object to swap

updateTransform () void inherited

Container.ts:415

Updates the transform on all children of this container for rendering.

_renderWithCulling (renderer) void protected inherited

Container.ts:533

Renders this object and its children with culling.

Name Type Description
renderer PIXI.Renderer

The renderer

onChildrenChange (_length) void protected inherited

Container.ts:112

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

Name Type Attributes Description
_length number <optional>

renderAdvanced (renderer) void protected inherited

Container.ts:649

Render the object using the WebGL renderer and advanced features.

Name Type Description
renderer PIXI.Renderer

The renderer

From class PIXI.DisplayObject

addEventListener (type, listener, options) inherited

FederatedEventTarget.ts:110

Unlike on or addListener which are methods from EventEmitter, addEventListener seeks to be compatible with the DOM's addEventListener with support for options. IMPORTANT: Only available if using the @pixi/events package.

Name Type Attributes Description
type string

The type of event to listen to.
listener EventListenerOrEventListenerObject

The listener callback or object.
options boolean | AddEventListenerOptions <optional>

Listener options, used for capture phase.
Example

 // Tell the user whether they did a single, double, triple, or nth click.
 button.addEventListener('click', {
   handleEvent(e): {
     let prefix;

     switch (e.detail) {
       case 1: prefix = 'single'; break;
       case 2: prefix = 'double'; break;
       case 3: prefix = 'triple'; break;
       default: prefix = e.detail + 'th'; break;
     }

     console.log('That was a ' + prefix + 'click');
   }
 });

 // But skip the first click!
 button.parent.addEventListener('click', function blockClickOnce(e) {
   e.stopImmediatePropagation();
   button.parent.removeEventListener('click', blockClickOnce, true);
 }, {
   capture: true,
 })

disableTempParent (cacheParent) void inherited

DisplayObject.ts:745

Pair method for enableTempParent

Name Type Description
cacheParent PIXI.Container

Actual parent of element

dispatchEvent (e) boolean inherited

FederatedEventTarget.ts:184

Dispatch the event on this PIXI.DisplayObject using the event's PIXI.EventBoundary.

The target of the event is set to this and the defaultPrevented flag is cleared before dispatch.

IMPORTANT: Only available if using the @pixi/events package.

Name Type Description
e Event

The event to dispatch.
Returns:
Type Description
boolean Whether the preventDefault() method was not invoked.
Example

 // Reuse a click event!
 button.dispatchEvent(clickEvent);

displayObjectUpdateTransform () inherited

DisplayObject.ts:1012

DisplayObject default updateTransform, does not update children of container. Will crash if there's no parent element.

enableTempParent () PIXI.Container inherited

DisplayObject.ts:726

Used in Renderer, cacheAsBitmap and other places where you call an updateTransform on root

const cacheParent = elem.enableTempParent();
elem.updateTransform();
elem.disableTempParent(cacheParent);
Returns:
Type Description
PIXI.Container
  • current parent

getBounds (skipUpdate, rect) PIXI.Rectangle inherited

DisplayObject.ts:448

Calculates and returns the (world) bounds of the display object as a Rectangle.

This method is expensive on containers with a large subtree (like the stage). This is because the bounds of a container depend on its children's bounds, which recursively causes all bounds in the subtree to be recalculated. The upside, however, is that calling getBounds once on a container will indeed update the bounds of all children (the whole subtree, in fact). This side effect should be exploited by using displayObject._bounds.getRectangle() when traversing through all the bounds in a scene graph. Otherwise, calling getBounds on each object in a subtree will cause the total cost to increase quadratically as its height increases.

The transforms of all objects in a container's subtree and of all ancestors are updated. The world bounds of all display objects in a container's subtree will also be recalculated.

The _bounds object stores the last calculation of the bounds. You can use to entirely skip bounds calculation if needed.

const lastCalculatedBounds = displayObject._bounds.getRectangle(optionalRect);

Do know that usage of getLocalBounds can corrupt the _bounds of children (the whole subtree, actually). This is a known issue that has not been solved. See getLocalBounds for more details.

getBounds should be called with skipUpdate equal to true in a render() call. This is because the transforms are guaranteed to be update-to-date. In fact, recalculating inside a render() call may cause corruption in certain cases.

Name Type Attributes 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 minimum axis-aligned rectangle in world space that fits around this object.

getGlobalPosition (point, skipUpdate) PIXI.Point inherited

index.ts:4

Returns the global position of the displayObject. Does not depend on object scale, rotation and pivot.

Name Type Attributes Default Description
point PIXI.Point <optional>
 new PIXI.Point()

The point to write the global value to.
skipUpdate boolean <optional>
 false

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
PIXI.Point The updated point.

removeEventListener (type, listener, options) inherited

FederatedEventTarget.ts:159

Unlike off or removeListener which are methods from EventEmitter, removeEventListener seeks to be compatible with the DOM's removeEventListener with support for options. IMPORTANT: Only available if using the @pixi/events package.

Name Type Attributes Description
type string

The type of event the listener is bound to.
listener EventListenerOrEventListenerObject

The listener callback or object.
options boolean | AddEventListenerOptions <optional>

The original listener options. This is required to deregister a capture phase listener.

setParent (container) PIXI.Container inherited

DisplayObject.ts:634

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) this inherited

DisplayObject.ts:651

Convenience function to set the position, scale, skew and pivot at once.

Name Type Default Description
x number 0

The X position
y number 0

The Y position
scaleX number 1

The X scale value
scaleY number 1

The Y scale value
rotation number 0

The rotation
skewX number 0

The X skew value
skewY number 0

The Y skew value
pivotX number 0

The X pivot value
pivotY number 0

The Y pivot value
Returns:
Type Description
this
  • The DisplayObject instance

toGlobal (position, point, skipUpdate) P inherited

DisplayObject.ts:562

Calculates the global position of the display object.

Name Type Attributes Default Description
position IPointData

The world origin to calculate from.
point P <optional>

A Point object in which to store the value, optional (otherwise will create a new Point).
skipUpdate boolean false

Should we skip the update transform.
Returns:
Type Description
P
  • A point object representing the position of this object.

toLocal (position, from, point, skipUpdate) P inherited

DisplayObject.ts:595

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

Name Type Attributes Description
position IPointData

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

The DisplayObject to calculate the global position from.
point P <optional>

A Point object in which to store the value, optional (otherwise will create a new Point).
skipUpdate boolean <optional>

Should we skip the update transform
Returns:
Type Description
P
  • A point object representing the position of this object

_recursivePostUpdateTransform () void protected inherited

DisplayObject.ts:424

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

Inherited Events

From class PIXI.Container

childAdded inherited

Container.ts:95

Fired when a DisplayObject is added to this Container.

Name Type Description
child PIXI.DisplayObject

The child added to the Container.
container PIXI.Container

The container that added the child.
index number

The children's index of the added child.

From class PIXI.DisplayObject

added inherited

DisplayObject.ts:386

Fired when this DisplayObject is added to a Container.

Name Type Description
container PIXI.Container

The container added to.

childRemoved inherited

Container.ts:103

Fired when a DisplayObject is removed from this Container.

Name Type Description
child PIXI.DisplayObject

The child removed from the Container.
container PIXI.Container

The container that removed the child.
index number

The former children's index of the removed child

click inherited

EventBoundary.ts:1396

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.

A click event fires after the pointerdown and pointerup events, in that order. If the mouse is moved over another DisplayObject after the pointerdown event, the click event is fired on the most specific common ancestor of the two target DisplayObjects.

The detail property of the event is the number of clicks that occurred within a 200ms window of each other upto the current click. For example, it will be 2 for a double click.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

clickcapture inherited

EventBoundary.ts:1412

Capture phase equivalent of click.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

destroyed inherited

DisplayObject.ts:400

Fired when this DisplayObject is destroyed. This event is emitted once destroy is finished.

mousedown inherited

EventBoundary.ts:1328

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

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

The mousedown event.

mousedowncapture inherited

EventBoundary.ts:1337

Capture phase equivalent of mousedown.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

The capture phase mousedown.

mouseenter inherited

EventBoundary.ts:1515

Fired when the mouse pointer is moved over a DisplayObject and its descendant's hit testing boundaries.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

mouseentercapture inherited

EventBoundary.ts:1523

Capture phase equivalent of mouseenter

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

mouseleave inherited

EventBoundary.ts:1551

Fired when the mouse pointer exits a DisplayObject and its descendants.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

mouseleavecapture inherited

EventBoundary.ts:1559

Capture phase equivalent of mouseleave.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

mousemove inherited

EventBoundary.ts:1481

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.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

mousemovecapture inherited

EventBoundary.ts:1490

Capture phase equivalent of mousemove.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

mouseout inherited

EventBoundary.ts:1531

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.

This may be fired on a DisplayObject that was removed from the scene graph immediately after a mouseover event.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

mouseoutcapture inherited

EventBoundary.ts:1543

Capture phase equivalent of mouseout.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

mouseover inherited

EventBoundary.ts:1498

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.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

mouseovercapture inherited

EventBoundary.ts:1507

Capture phase equivalent of mouseover.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

mouseup inherited

EventBoundary.ts:1362

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.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

mouseupcapture inherited

EventBoundary.ts:1371

Capture phase equivalent of mouseup.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

mouseupoutside inherited

EventBoundary.ts:1439

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.

This event is specific to the Federated Events API. It does not have a capture phase, unlike most of the other events. It only bubbles to the most specific ancestor of the targets of the corresponding pointerdown and pointerup events, i.e. the target of the click event.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

mouseupoutsidecapture inherited

EventBoundary.ts:1454

Capture phase equivalent of mouseupoutside.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointercancel inherited

EventBoundary.ts:1601

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

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointercancelcapture inherited

EventBoundary.ts:1610

Capture phase equivalent of pointercancel.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerdown inherited

EventBoundary.ts:1567

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

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerdowncapture inherited

EventBoundary.ts:1576

Capture phase equivalent of pointerdown.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerenter inherited

EventBoundary.ts:1691

Fired when the pointer is moved over a DisplayObject and its descendant's hit testing boundaries.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerentercapture inherited

EventBoundary.ts:1699

Capture phase equivalent of pointerenter

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerleave inherited

EventBoundary.ts:1724

Fired when the pointer leaves the hit testing boundaries of a DisplayObject and its descendants.

This event notifies only the target and does not bubble.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

The pointerleave event.

pointerleavecapture inherited

EventBoundary.ts:1734

Capture phase equivalent of pointerleave.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointermove inherited

EventBoundary.ts:1657

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

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointermovecapture inherited

EventBoundary.ts:1666

Capture phase equivalent of pointermove.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerout inherited

EventBoundary.ts:1707

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

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointeroutcapture inherited

EventBoundary.ts:1716

Capture phase equivalent of pointerout.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerover inherited

EventBoundary.ts:1674

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

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerovercapture inherited

EventBoundary.ts:1683

Capture phase equivalent of pointerover.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointertap inherited

EventBoundary.ts:1618

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.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointertapcapture inherited

EventBoundary.ts:1627

Capture phase equivalent of pointertap.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerup inherited

EventBoundary.ts:1584

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

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerupcapture inherited

EventBoundary.ts:1593

Capture phase equivalent of pointerup.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerupoutside inherited

EventBoundary.ts:1635

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.

This event is specific to the Federated Events API. It does not have a capture phase, unlike most of the other events. It only bubbles to the most specific ancestor of the targets of the corresponding pointerdown and pointerup events, i.e. the target of the click event.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerupoutsidecapture inherited

EventBoundary.ts:1649

Capture phase equivalent of pointerupoutside.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

removed inherited

DisplayObject.ts:393

Fired when this DisplayObject is removed from a Container.

Name Type Description
container PIXI.Container

The container removed from.

rightclick inherited

EventBoundary.ts:1420

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.

This event follows the semantics of click.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

rightclickcapture inherited

EventBoundary.ts:1431

Capture phase equivalent of rightclick.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

rightdown inherited

EventBoundary.ts:1345

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.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

rightdowncapture inherited

EventBoundary.ts:1354

Capture phase equivalent of rightdown.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

The rightdowncapture event.

rightup inherited

EventBoundary.ts:1379

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.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

rightupcapture inherited

EventBoundary.ts:1388

Capture phase equivalent of rightup.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

rightupoutside inherited

EventBoundary.ts:1462

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.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

rightupoutsidecapture inherited

EventBoundary.ts:1473

Capture phase equivalent of rightupoutside.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

tap inherited

EventBoundary.ts:1793

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.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

tapcapture inherited

EventBoundary.ts:1802

Capture phase equivalent of tap.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

touchcancel inherited

EventBoundary.ts:1776

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

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

touchcancelcapture inherited

EventBoundary.ts:1785

Capture phase equivalent of touchcancel.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

touchend inherited

EventBoundary.ts:1759

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

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

touchendcapture inherited

EventBoundary.ts:1768

Capture phase equivalent of touchend.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

touchendoutside inherited

EventBoundary.ts:1810

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.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

touchendoutsidecapture inherited

EventBoundary.ts:1820

Capture phase equivalent of touchendoutside.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

touchmove inherited

EventBoundary.ts:1828

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

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

touchmovecapture inherited

EventBoundary.ts:1837

Capture phase equivalent of touchmove.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

touchstart inherited

EventBoundary.ts:1742

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

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

touchstartcapture inherited

EventBoundary.ts:1751

Capture phase equivalent of touchstart.

These events are propagating from the EventSystem in @pixi/events.

Name Type Description
event PIXI.FederatedPointerEvent

Event

wheel inherited

EventBoundary.ts:1845

Fired when a the user scrolls with the mouse cursor over a DisplayObject.

These events are propagating from the EventSystem in @pixi/events.

Type:

wheelcapture inherited

EventBoundary.ts:1853

Capture phase equivalent of wheel.

These events are propagating from the EventSystem in @pixi/events.

Type: