Class: DisplayObject

PIXI.DisplayObject

The base class for all objects that are rendered on the screen.

This is an abstract class and can not be used on its own; rather it should be extended.

Display objects implemented in PixiJS

Display Object	Description
PIXI.Container	Adds support for `children` to DisplayObject
PIXI.Graphics	Shape-drawing display object similar to the Canvas API
PIXI.Sprite	Draws textures (i.e. images)
PIXI.Text	Draws text using the Canvas API internally
PIXI.BitmapText	More scaleable solution for text rendering, reusing glyph textures
PIXI.TilingSprite	Draws textures/images in a tiled fashion
PIXI.AnimatedSprite	Draws an animation of multiple images
PIXI.Mesh	Provides a lower-level API for drawing meshes with custom data
PIXI.NineSlicePlane	Mesh-related
PIXI.SimpleMesh	v4-compatible mesh
PIXI.SimplePlane	Mesh-related
PIXI.SimpleRope	Mesh-related

Transforms

The transform of a display object describes the projection from its local coordinate space to its parent's local coordinate space. The following properties are derived from the transform:

Property	Description
pivot	Invariant under rotation, scaling, and skewing. The projection of into the parent's space of the pivot is equal to position, regardless of the other three transformations. In other words, It is the center of rotation, scaling, and skewing.
position	Translation. This is the position of the pivot in the parent's local space. The default value of the pivot is the origin (0,0). If the top-left corner of your display object is (0,0) in its local space, then the position will be its top-left corner in the parent's local space.
scale	Scaling. This will stretch (or compress) the display object's projection. The scale factors are along the local coordinate axes. In other words, the display object is scaled before rotated or skewed. The center of scaling is the pivot.
rotation	Rotation. This will rotate the display object's projection by this angle (in radians).
skew	Skewing. This can be used to deform a rectangular display object into a parallelogram. In PixiJS, skew has a slightly different behaviour than the conventional meaning. It can be thought of the net rotation applied to the coordinate axes (separately). For example, if "skew.x" is ⍺ and "skew.y" is β, then the line x = 0 will be rotated by ⍺ (y = -xcot⍺) and the line y = 0 will be rotated by β (y = xtanβ). A line y = x*tanϴ (i.e. a line at angle ϴ to the x-axis in local-space) will be rotated by an angle between ⍺ and β. It can be observed that if skew is applied equally to both axes, then it will be equivalent to applying a rotation. Indeed, if "skew.x" = -ϴ and "skew.y" = ϴ, it will produce an equivalent of "rotation" = ϴ. Another quite interesting observation is that "skew.x", "skew.y", rotation are commutative operations. Indeed, because rotation is essentially a careful combination of the two.
angle	Rotation. This is an alias for rotation, but in degrees.
x	Translation. This is an alias for position.x!
y	Translation. This is an alias for position.y!
width	Implemented in Container. Scaling. The width property calculates scale.x by dividing the "requested" width by the local bounding box width. It is indirectly an abstraction over scale.x, and there is no concept of user-defined width.
height	Implemented in Container. Scaling. The height property calculates scale.y by dividing the "requested" height by the local bounding box height. It is indirectly an abstraction over scale.y, and there is no concept of user-defined height.

Bounds

The bounds of a display object is defined by the minimum axis-aligned rectangle in world space that can fit around it. The abstract calculateBounds method is responsible for providing it (and it should use the worldTransform to calculate in world space).

There are a few additional types of bounding boxes:

Bounds	Description
World Bounds	This is synonymous is the regular bounds described above. See `getBounds()`.
Local Bounds	This the axis-aligned bounding box in the parent's local space. See `getLocalBounds()`.
Render Bounds	The bounds, but including extra rendering effects like filter padding.
Projected Bounds	The bounds of the projected display object onto the screen. Usually equals world bounds.
Relative Bounds	The bounds of a display object when projected onto a ancestor's (or parent's) space.
Natural Bounds	The bounds of an object in its own local space (not parent's space, like in local bounds)
Content Bounds	The natural bounds when excluding all children of a `Container`.

calculateBounds

Container already implements calculateBounds in a manner that includes children.

But for a non-Container display object, the calculateBounds method must be overridden in order for getBounds and getLocalBounds to work. This method must write the bounds into this._bounds.

Generally, the following technique works for most simple cases: take the list of points forming the "hull" of the object (i.e. outline of the object's shape), and then add them using PIXI.Bounds#addPointMatrix.

calculateBounds()
{
    const points = [...];

    for (let i = 0, j = points.length; i < j; i++)
    {
        this._bounds.addPointMatrix(this.worldTransform, points[i]);
    }
}

You can optimize this for a large number of points by using PIXI.Bounds#addVerticesMatrix to pass them in one array together.

Alpha

This alpha sets a display object's relative opacity w.r.t its parent. For example, if the alpha of a display object is 0.5 and its parent's alpha is 0.5, then it will be rendered with 25% opacity (assuming alpha is not applied on any ancestor further up the chain).

The alpha with which the display object will be rendered is called the worldAlpha.

Renderable vs Visible

The renderable and visible properties can be used to prevent a display object from being rendered to the screen. However, there is a subtle difference between the two. When using renderable, the transforms of the display object (and its children subtree) will continue to be calculated. When using visible, the transforms will not be calculated.

For culling purposes, it is recommended that applications use the cullable property.

Otherwise, to prevent an object from rendering in the general-purpose sense - visible is the property to use. This one is also better in terms of performance.

Members

_accessibleActive boolean

Default Value:

false

TODO

Needs docs.

_accessibleDiv boolean

Default Value:

undefined

TODO

Needs docs.

_bounds PIXI.Bounds

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

_localBounds PIXI.Bounds

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

accessible boolean

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

Default Value:

false

accessibleChildren boolean

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

Default Value:

true

accessibleHint string

Sets the aria-label attribute of the shadow div

Default Value:

undefined

accessiblePointerEvents string

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

Default Value:

'auto'

accessibleTitle ?string

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

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

The opacity of the object.

angle number

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.

cacheAsBitmap boolean

Set this to true if you want this display object to be cached as a bitmap. This basically takes a snapshot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects. To remove simply set this property to false

IMPORTANT GOTCHA - Make sure that all your textures are preloaded BEFORE setting this property to true as it will take a snapshot of what is currently there. If the textures have not loaded then they will not appear.

cacheAsBitmapMultisample number | unknown

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:

null

cacheAsBitmapResolution number | unknown

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

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

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

Readonly flag for destroyed display objects.

filterArea PIXI.Rectangle

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

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

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

 import { Rectangle, Sprite } from 'pixi.js';

 const sprite = new Sprite(texture);
 sprite.interactive = true;
 sprite.hitArea = new Rectangle(0, 0, 100, 100);

isMask boolean

Does any other displayObject use this object as a mask?

isSprite boolean

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

localTransform PIXI.Matrix readonly

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

mask PIXI.Container | PIXI.MaskData | null

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, CanvasRenderer doesn't support Sprite as mask.

Example

 import { Graphics, Sprite } from 'pixi.js';

 const graphics = new Graphics();
 graphics.beginFill(0xFF3300);
 graphics.drawRect(50, 250, 100, 100);
 graphics.endFill();

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

name string

The instance name of the object.

Default Value:

undefined

onclick

Property-based event handler for the click event.

Default Value:

null

Example

this.onclick = (event) => {
 //some function here that happens on click
}

onglobalmousemove

Property-based event handler for the globalmousemove event.

Default Value:

null

Example

this.onglobalmousemove = (event) => {
 //some function here that happens on globalmousemove
}

onglobalpointermove

Property-based event handler for the globalpointermove event.

Default Value:

null

Example

this.onglobalpointermove = (event) => {
 //some function here that happens on globalpointermove
}

onglobaltouchmove

Property-based event handler for the globaltouchmove event.

Default Value:

null

Example

this.onglobaltouchmove = (event) => {
 //some function here that happens on globaltouchmove
}

onmousedown

Property-based event handler for the mousedown event.

Default Value:

null

Example

this.onmousedown = (event) => {
 //some function here that happens on mousedown
}

onmouseenter

Property-based event handler for the mouseenter event.

Default Value:

null

Example

this.onmouseenter = (event) => {
 //some function here that happens on mouseenter
}

onmouseleave

Property-based event handler for the mouseleave event.

Default Value:

null

Example

this.onmouseleave = (event) => {
 //some function here that happens on mouseleave
}

onmousemove

Property-based event handler for the mousemove event.

Default Value:

null

Example

this.onmousemove = (event) => {
 //some function here that happens on mousemove
}

onmouseout

Property-based event handler for the mouseout event.

Default Value:

null

Example

this.onmouseout = (event) => {
 //some function here that happens on mouseout
}

onmouseover

Property-based event handler for the mouseover event.

Default Value:

null

Example

this.onmouseover = (event) => {
 //some function here that happens on mouseover
}

onmouseup

Property-based event handler for the mouseup event.

Default Value:

null

Example

this.onmouseup = (event) => {
 //some function here that happens on mouseup
}

onmouseupoutside

Property-based event handler for the mouseupoutside event.

Default Value:

null

Example

this.onmouseupoutside = (event) => {
 //some function here that happens on mouseupoutside
}

onpointercancel

Property-based event handler for the pointercancel event.

Default Value:

null

Example

this.onpointercancel = (event) => {
 //some function here that happens on pointercancel
}

onpointerdown

Property-based event handler for the pointerdown event.

Default Value:

null

Example

this.onpointerdown = (event) => {
 //some function here that happens on pointerdown
}

onpointerenter

Property-based event handler for the pointerenter event.

Default Value:

null

Example

this.onpointerenter = (event) => {
 //some function here that happens on pointerenter
}

onpointerleave

Property-based event handler for the pointerleave event.

Default Value:

null

Example

this.onpointerleave = (event) => {
 //some function here that happens on pointerleave
}

onpointermove

Property-based event handler for the pointermove event.

Default Value:

null

Example

this.onpointermove = (event) => {
 //some function here that happens on pointermove
}

onpointerout

Property-based event handler for the pointerout event.

Default Value:

null

Example

this.onpointerout = (event) => {
 //some function here that happens on pointerout
}

onpointerover

Property-based event handler for the pointerover event.

Default Value:

null

Example

this.onpointerover = (event) => {
 //some function here that happens on pointerover
}

onpointertap

Property-based event handler for the pointertap event.

Default Value:

null

Example

this.onpointertap = (event) => {
 //some function here that happens on pointertap
}

onpointerup

Property-based event handler for the pointerup event.

Default Value:

null

Example

this.onpointerup = (event) => {
 //some function here that happens on pointerup
}

onpointerupoutside

Property-based event handler for the pointerupoutside event.

Default Value:

null

Example

this.onpointerupoutside = (event) => {
 //some function here that happens on pointerupoutside
}

onrightclick

Property-based event handler for the rightclick event.

Default Value:

null

Example

this.onrightclick = (event) => {
 //some function here that happens on rightclick
}

onrightdown

Property-based event handler for the rightdown event.

Default Value:

null

Example

this.onrightdown = (event) => {
 //some function here that happens on rightdown
}

onrightup

Property-based event handler for the rightup event.

Default Value:

null

Example

this.onrightup = (event) => {
 //some function here that happens on rightup
}

onrightupoutside

Property-based event handler for the rightupoutside event.

Default Value:

null

Example

this.onrightupoutside = (event) => {
 //some function here that happens on rightupoutside
}

ontap

Property-based event handler for the tap event.

Default Value:

null

Example

this.ontap = (event) => {
 //some function here that happens on tap
}

ontouchcancel

Property-based event handler for the touchcancel event.

Default Value:

null

Example

this.ontouchcancel = (event) => {
 //some function here that happens on touchcancel
}

ontouchend

Property-based event handler for the touchend event.

Default Value:

null

Example

this.ontouchend = (event) => {
 //some function here that happens on touchend
}

ontouchendoutside

Property-based event handler for the touchendoutside event.

Default Value:

null

Example

this.ontouchendoutside = (event) => {
 //some function here that happens on touchendoutside
}

ontouchmove

Property-based event handler for the touchmove event.

Default Value:

null

Example

this.ontouchmove = (event) => {
 //some function here that happens on touchmove
}

ontouchstart

Property-based event handler for the touchstart event.

Default Value:

null

Example

this.ontouchstart = (event) => {
 //some function here that happens on touchstart
}

onwheel

Property-based event handler for the wheel event.

Default Value:

null

Example

this.onwheel = (event) => {
 //some function here that happens on wheel
}

parent PIXI.Container

The display object container that contains this display object.

pivot PIXI.ObservablePoint

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

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

Since:

4.0.0

renderable boolean

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

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

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

The default scale is (1, 1).

Since:

4.0.0

skew PIXI.ObservablePoint

The skew factor for the object in radians.

Since:

4.0.0

transform PIXI.Transform

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

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

The multiplied alpha of the displayObject.

worldTransform PIXI.Matrix readonly

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

worldVisible boolean readonly

Indicates if the object is globally visible.

x number

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

y number

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

zIndex number

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:

PIXI.Container#sortableChildren

_boundsID number protected

Flags the cached bounds as dirty.

_boundsRect PIXI.Rectangle protected

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

_destroyed boolean protected

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

_enabledFilters PIXI.Filter[] protected

Currently enabled filters.

_lastSortedIndex number protected

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

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

_mask PIXI.Container | PIXI.MaskData protected

The original, cached mask of the object.

_tempDisplayObjectParent PIXI.Container protected

_zIndex number protected

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

Methods

PIXI.DisplayObject.mixin (source) void static

DisplayObject.ts:332

Mixes all enumerable properties and methods from a source object to DisplayObject.

Name	Type	Description
`source`	utils.Dict<any>	The source of properties and methods to mix in.

addEventListener (type, listener, options)

FederatedEventTarget.ts:683

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`	AddListenerOptions	<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,
 });

calculateBounds () void abstract

DisplayObject.ts:422

Recalculates the bounds of the display object.

destroy (_options) void

DisplayObject.ts:696

Base destroy method for generic display objects. This will automatically remove the display object from its parent Container as well as remove all current event listeners and internal references. Do not use a DisplayObject after calling destroy().

Name	Type	Attributes	Description
`_options`	IDestroyOptions \| boolean	<optional>

disableTempParent (cacheParent) void

DisplayObject.ts:760

Pair method for enableTempParent

Name	Type	Description
`cacheParent`	PIXI.Container	Actual parent of element

dispatchEvent (e) boolean

FederatedEventTarget.ts:776

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

DisplayObject.ts:1034

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

enableTempParent () PIXI.Container

DisplayObject.ts:741

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

eventMode (value)

FederatedEventTarget.ts:602

Enable interaction events for the DisplayObject. Touch, pointer and mouse. This now replaces the interactive property. There are 5 types of interaction settings:

'none': Ignores all interaction events, even on its children.
'passive': Does not emit events and ignores all hit testing on itself and non-interactive children. Interactive children will still emit events.
'auto': Does not emit events but is hit tested if parent is interactive. Same as interactive = false in v7
'static': Emit events and is hit tested. Same as interaction = true in v7
'dynamic': Emits events and is hit tested but will also receive mock interaction events fired from a ticker to allow for interaction when the mouse isn't moving

Name	Type	Description
`value`

Since:

7.2.0

Example

 import { Sprite } from 'pixi.js';

 const sprite = new Sprite(texture);
 sprite.eventMode = 'static';
 sprite.on('tap', (event) => {
     // Handle event
 });

getBounds (skipUpdate, rect) PIXI.Rectangle

DisplayObject.ts:457

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

index.ts:5

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.

getLocalBounds (rect) PIXI.Rectangle

DisplayObject.ts:527

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

Name	Type	Attributes	Description
`rect`	PIXI.Rectangle	<optional>	Optional rectangle to store the result of the bounds calculation.

Returns:

Type	Description
PIXI.Rectangle	The rectangular bounding area.

interactive (value)

FederatedEventTarget.ts:576

Enable interaction events for the DisplayObject. Touch, pointer and mouse

Name	Type	Description
`value`	boolean

isInteractive () boolean

FederatedEventTarget.ts:634

Determines if the displayObject is interactive or not

Since:

7.2.0

Returns:

Type	Description
boolean	Whether the displayObject is interactive or not

Example

 import { Sprite } from 'pixi.js';
 const sprite = new Sprite(texture);
 sprite.eventMode = 'static';
 sprite.isInteractive(); // true

 sprite.eventMode = 'dynamic';
 sprite.isInteractive(); // true

 sprite.eventMode = 'none';
 sprite.isInteractive(); // false

 sprite.eventMode = 'passive';
 sprite.isInteractive(); // false

 sprite.eventMode = 'auto';
 sprite.isInteractive(); // false

removeEventListener (type, listener, options)

FederatedEventTarget.ts:751

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`	RemoveListenerOptions	<optional>	The original listener options. This is required to deregister a capture phase listener.

removeFromParent ()

DisplayObject.ts:662

Remove the DisplayObject from its parent Container. If the DisplayObject has no parent, do nothing.

render (renderer) void abstract

DisplayObject.ts:427

Renders the object using the WebGL renderer.

Name	Type	Description
`renderer`	PIXI.Renderer	The renderer.

setParent (container) PIXI.Container

DisplayObject.ts:645

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

DisplayObject.ts:668

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

DisplayObject.ts:573

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

DisplayObject.ts:606

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

updateTransform () void

DisplayObject.ts:447

Updates the object transform for rendering. TODO - Optimization pass!

_recursivePostUpdateTransform () void protected

DisplayObject.ts:433

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

Events

added

DisplayObject.ts:395

Fired when this DisplayObject is added to a Container.

Name	Type	Description
`container`	PIXI.Container	The container added to.

click

EventBoundaryTypes.ts:120

Fired when a pointer device button (usually a mouse left-button) is pressed and released on the display object. DisplayObject's eventMode property must be set to static or 'dynamic' 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

EventBoundaryTypes.ts:136

Capture phase equivalent of click.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

destroyed

DisplayObject.ts:409

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

globalmousemove

EventBoundaryTypes.ts:206

Fired when a pointer device (usually a mouse) is moved globally over the scene. DisplayObject's eventMode property must be set to static or 'dynamic' to fire event.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

globalpointermove

EventBoundaryTypes.ts:391

Fired when a pointer device is moved globally over the scene. DisplayObject's eventMode property must be set to static or 'dynamic' to fire event.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

globaltouchmove

EventBoundaryTypes.ts:571

Fired when a touch point is moved globally over the scene. DisplayObject's eventMode property must be set to static or 'dynamic' to fire event.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

mousedown

EventBoundaryTypes.ts:52

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

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	The mousedown event.

mousedowncapture

EventBoundaryTypes.ts:61

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

EventBoundaryTypes.ts:249

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

EventBoundaryTypes.ts:257

Capture phase equivalent of mouseenter

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

mouseleave

EventBoundaryTypes.ts:285

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

EventBoundaryTypes.ts:293

Capture phase equivalent of mouseleave.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

mousemove

EventBoundaryTypes.ts:215

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

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

mousemovecapture

EventBoundaryTypes.ts:224

Capture phase equivalent of mousemove.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

mouseout

EventBoundaryTypes.ts:265

Fired when a pointer device (usually a mouse) is moved off the display object. DisplayObject's eventMode property must be set to static or 'dynamic' 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

EventBoundaryTypes.ts:277

Capture phase equivalent of mouseout.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

mouseover

EventBoundaryTypes.ts:232

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

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

mouseovercapture

EventBoundaryTypes.ts:241

Capture phase equivalent of mouseover.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

mouseup

EventBoundaryTypes.ts:86

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

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

mouseupcapture

EventBoundaryTypes.ts:95

Capture phase equivalent of mouseup.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

mouseupoutside

EventBoundaryTypes.ts:164

Fired when a pointer device button (usually a mouse left-button) is released outside the display object that initially registered a mousedown. DisplayObject's eventMode property must be set to static or 'dynamic' 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

EventBoundaryTypes.ts:179

Capture phase equivalent of mouseupoutside.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

pointercancel

EventBoundaryTypes.ts:335

Fired when the operating system cancels a pointer event. DisplayObject's eventMode property must be set to static or 'dynamic' to fire event.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

pointercancelcapture

EventBoundaryTypes.ts:344

Capture phase equivalent of pointercancel.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

pointerdown

EventBoundaryTypes.ts:301

Fired when a pointer device button is pressed on the display object. DisplayObject's eventMode property must be set to static or 'dynamic' to fire event.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

pointerdowncapture

EventBoundaryTypes.ts:310

Capture phase equivalent of pointerdown.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

pointerenter

EventBoundaryTypes.ts:434

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

EventBoundaryTypes.ts:442

Capture phase equivalent of pointerenter

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

pointerleave

EventBoundaryTypes.ts:467

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

EventBoundaryTypes.ts:477

Capture phase equivalent of pointerleave.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

pointermove

EventBoundaryTypes.ts:400

Fired when a pointer device is moved while over the display object. DisplayObject's eventMode property must be set to static or 'dynamic' to fire event.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

pointermovecapture

EventBoundaryTypes.ts:409

Capture phase equivalent of pointermove.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

pointerout

EventBoundaryTypes.ts:450

Fired when a pointer device is moved off the display object. DisplayObject's eventMode property must be set to static or 'dynamic' to fire event.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

pointeroutcapture

EventBoundaryTypes.ts:459

Capture phase equivalent of pointerout.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

pointerover

EventBoundaryTypes.ts:417

Fired when a pointer device is moved onto the display object. DisplayObject's eventMode property must be set to static or 'dynamic' to fire event.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

pointerovercapture

EventBoundaryTypes.ts:426

Capture phase equivalent of pointerover.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

pointertap

EventBoundaryTypes.ts:352

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

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

pointertapcapture

EventBoundaryTypes.ts:361

Capture phase equivalent of pointertap.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

pointerup

EventBoundaryTypes.ts:318

Fired when a pointer device button is released over the display object. DisplayObject's eventMode property must be set to static or 'dynamic' to fire event.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

pointerupcapture

EventBoundaryTypes.ts:327

Capture phase equivalent of pointerup.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

pointerupoutside

EventBoundaryTypes.ts:369

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

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

pointerupoutsidecapture

EventBoundaryTypes.ts:383

Capture phase equivalent of pointerupoutside.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

removed

DisplayObject.ts:402

Fired when this DisplayObject is removed from a Container.

Name	Type	Description
`container`	PIXI.Container	The container removed from.

rightclick

EventBoundaryTypes.ts:144

Fired when a pointer device secondary button (usually a mouse right-button) is pressed and released on the display object. DisplayObject's eventMode property must be set to static or 'dynamic' 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

EventBoundaryTypes.ts:156

Capture phase equivalent of rightclick.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

rightdown

EventBoundaryTypes.ts:69

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

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

rightdowncapture

EventBoundaryTypes.ts:78

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

EventBoundaryTypes.ts:103

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

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

rightupcapture

EventBoundaryTypes.ts:112

Capture phase equivalent of rightup.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

rightupoutside

EventBoundaryTypes.ts:187

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 eventMode property must be set to static or 'dynamic' to fire event.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

rightupoutsidecapture

EventBoundaryTypes.ts:198

Capture phase equivalent of rightupoutside.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

tap

EventBoundaryTypes.ts:536

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

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

tapcapture

EventBoundaryTypes.ts:545

Capture phase equivalent of tap.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

touchcancel

EventBoundaryTypes.ts:519

Fired when the operating system cancels a touch. DisplayObject's eventMode property must be set to static or 'dynamic' to fire event.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

touchcancelcapture

EventBoundaryTypes.ts:528

Capture phase equivalent of touchcancel.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

touchend

EventBoundaryTypes.ts:502

Fired when a touch point is removed from the display object. DisplayObject's eventMode property must be set to static or 'dynamic' to fire event.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

touchendcapture

EventBoundaryTypes.ts:511

Capture phase equivalent of touchend.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

touchendoutside

EventBoundaryTypes.ts:553

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

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

touchendoutsidecapture

EventBoundaryTypes.ts:563

Capture phase equivalent of touchendoutside.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

touchmove

EventBoundaryTypes.ts:580

Fired when a touch point is moved along the display object. DisplayObject's eventMode property must be set to static or 'dynamic' to fire event.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

touchmovecapture

EventBoundaryTypes.ts:589

Capture phase equivalent of touchmove.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

touchstart

EventBoundaryTypes.ts:485

Fired when a touch point is placed on the display object. DisplayObject's eventMode property must be set to static or 'dynamic' to fire event.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

touchstartcapture

EventBoundaryTypes.ts:494

Capture phase equivalent of touchstart.

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

Name	Type	Description
`event`	PIXI.FederatedPointerEvent	Event

wheel

EventBoundaryTypes.ts:597

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

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

Type:

PIXI.FederatedWheelEvent

wheelcapture

EventBoundaryTypes.ts:605

Capture phase equivalent of wheel.

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

Type:

PIXI.FederatedWheelEvent