PIXI.DisplayObject

class DisplayObject extends PIXI.utils.EventEmitter

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 = -x*cot⍺) and the line y = 0 will be rotated by β (y = x*tanβ). 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 communtative 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(): void
{
    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.

It is recommended that applications use the renderable property for culling. See @pixi-essentials/cull or pixi-cull for more details.

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.

Summary


Properties from DisplayObject

boolean
_accessibleActive = false
boolean
_accessibleDiv = undefined
PIXI.Bounds
_bounds

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

PIXI.Bounds
_localBounds = undefined

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

boolean
accessible = false
boolean
accessibleChildren = true
string
accessibleHint = undefined

Sets the aria-label attribute of the shadow div

string
accessiblePointerEvents = 'auto'
?string
accessibleTitle = undefined
string
accessibleType = 'button'
number
alpha = 1

The opacity of the object.

number
angle
boolean
buttonMode
boolean
cacheAsBitmap
number
cacheAsBitmapMultisample = PIXI.MSAA_QUALITY.NONE
number
cacheAsBitmapResolution = null
string
cursor = undefined
boolean
destroyed

Readonly flag for destroyed display objects.

?PIXI.Rectangle
filterArea = undefined
Array<PIXI.Filter>
filters = undefined
PIXI.IHitArea
hitArea = undefined
boolean
interactive = false
boolean
isMask = false
boolean
isSprite = false
PIXI.Matrix
localTransform

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

PIXI.Container | PIXI.MaskData | unknown
mask
string
name = undefined

The instance name of the object.

PIXI.Container
parent = undefined

The display object container that contains this display object.

PIXI.ObservablePoint
pivot
PIXI.ObservablePoint
position

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

boolean
renderable = true
number
rotation
PIXI.ObservablePoint
scale

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

PIXI.ObservablePoint
skew

The skew factor for the object in radians.

PIXI.DisplayObject
smartMask = undefined
PIXI.Transform
transform
boolean
visible = true
number
worldAlpha = 1

The multiplied alpha of the displayObject.

PIXI.Matrix
worldTransform

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

boolean
worldVisible

Indicates if the object is globally visible.

number
x
number
y
number
zIndex

The zIndex of the displayObject.

number
protected _boundsID = 0

Flags the cached bounds as dirty.

PIXI.Bounds
protected _boundsRect = undefined

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

boolean
protected _destroyed = false

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

Array<PIXI.Filter>
protected _enabledFilters = undefined
number
protected _lastSortedIndex = 0
PIXI.Bounds
protected _localBoundsRect = undefined

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

PIXI.Container | PIXI.MaskData | unknown
protected _mask = undefined

The original, cached mask of the object.

PIXI.Container
protected _tempDisplayObjectParent
number
protected _zIndex = 0
Group
parentGroup

The group in which this display object should be rendered.

Layer
parentLayer
number
zOrder

Methods from DisplayObject

void
static mixin(source: object)

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

addEventListener(type: string, listener: EventListenerOrEventListenerObject, options: boolean | AddEventListenerOptions)
void
calculateBounds()

Recalculates the bounds of the display object.

void
destroy(_options: IDestroyOptions | boolean)
void
disableTempParent(cacheParent: PIXI.Container)

Pair method for enableTempParent

boolean
dispatchEvent(e: Event)

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

displayObjectUpdateTransform
PIXI.Container
enableTempParent()

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

PIXI.Rectangle
getBounds(skipUpdate: boolean, rect: PIXI.Rectangle)

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

PIXI.Point
getGlobalPosition(point: PIXI.Point, skipUpdate: boolean)

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

PIXI.Rectangle
getLocalBounds(rect: PIXI.Rectangle)

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

removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options: boolean | AddEventListenerOptions)
void
render(renderer: PIXI.Renderer)

Renders the object using the WebGL renderer.

PIXI.Container
setParent(container: PIXI.Container)

Set the parent Container of this DisplayObject.

PIXI.DisplayObject
setTransform(x: number, y: number, scaleX: number, scaleY: number, rotation: number, skewX: number, skewY: number, pivotX: number, pivotY: number)

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

PIXI.Point
toGlobal(position: PIXI.IPointData, point: PIXI.Point, skipUpdate: boolean)

Calculates the global position of the display object.

PIXI.Point
toLocal(position: PIXI.IPointData, from: PIXI.DisplayObject, point: PIXI.Point, skipUpdate: boolean)

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

PIXI.Rectangle
updateSmartMask(recursive, skipUpdate)
void
updateTransform()

Updates the object transform for rendering.

void
protected _recursivePostUpdateTransform()

Events from DisplayObject

added

Fired when this DisplayObject is added to a Container.

click
click
clickcapture

Capture phase equivalent of click.

destroyed

Fired when this DisplayObject is destroyed.

mousedown
mousedown
mousedowncapture

Capture phase equivalent of mousedown.

mouseenter

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

mouseentercapture

Capture phase equivalent of mouseenter

mouseleave

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

mouseleavecapture

Capture phase equivalent of mouseleave.

mousemove
mousemove
mousemovecature

Capture phase equivalent of mousemove.

mouseout
mouseout
mouseoutcapture

Capture phase equivalent of mouseout.

mouseover
mouseover
mouseovercapture

Capture phase equivalent of mouseover.

mouseup
mouseup
mouseupcature

Capture phase equivalent of mouseup.

mouseupoutside
mouseupoutside
mouseupoutsidecapture

Capture phase equivalent of mouseupoutside.

pointercancel
pointercancel
pointercancelcapture

Capture phase equivalent of pointercancel.

pointerdown
pointerdown
pointerdowncapture

Capture phase equivalent of pointerdown.

pointerenter

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

pointerentercapture

Capture phase equivalent of pointerenter

pointerleave

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

pointerleavecapture

Capture phase equivalent of pointerleave.

pointermove
pointermove
pointermovecapture

Capture phase equivalent of pointermove.

pointerout
pointerout
pointeroutcapture

Capture phase equivalent of pointerout.

pointerover
pointerover
pointerovercapture

Capture phase equivalent of pointerover.

pointertap
pointertap
pointertapcapture

Capture phase equivalent of pointertap.

pointerup
pointerup
pointerupcapture

Capture phase equivalent of pointerup.

pointerupoutside
pointerupoutside
pointerupoutsidecapture

Capture phase equivalent of pointerupoutside.

removed

Fired when this DisplayObject is removed from a Container.

removedFrom

Fired when a DisplayObject is removed from this Container.

rightclick
rightclick
rightclickcapture

Capture phase equivalent of rightclick.

rightdown
rightdown
rightdowncapture

Capture phase equivalent of rightdown.

rightup
rightup
rightupcapture

Capture phase equivalent of rightup.

rightupoutside
rightupoutside
rightupoutsidecapture

Capture phase equivalent of rightupoutside.

tap
tap
tapcapture

Capture phase equivalent of tap.

touchcancel
touchcancel
touchcancelcapture

Capture phase equivalent of touchcancel.

touchend
touchend
touchendcapture

Capture phase equivalent of touchend.

touchendoutside
touchendoutside
touchendoutsidecapture

Capture phase equivalent of touchendoutside.

touchmove
touchmove
touchmovecapture

Capture phase equivalent of touchmove.

touchstart
touchstart
touchstartcapture

Capture phase equivalent of touchstart.

PIXI.FederatedWheelEvent
wheel

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

PIXI.FederatedWheelEvent
wheelcapture

Capture phase equivalent of wheel.

Public Properties


_accessibleActive accessibleTarget.ts:84
_accessibleActive: boolean = false
_accessibleDiv accessibleTarget.ts:91
_accessibleDiv: boolean = undefined
_bounds DisplayObject.ts:364
_bounds: PIXI.Bounds

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

_localBounds DisplayObject.ts:371
_localBounds: PIXI.Bounds = undefined

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

accessible accessibleTarget.ts:50
accessible: boolean = false

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

accessibleChildren accessibleTarget.ts:118
accessibleChildren: boolean = true

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

accessibleHint accessibleTarget.ts:68
accessibleHint: string = undefined

Sets the aria-label attribute of the shadow div

accessiblePointerEvents accessibleTarget.ts:108
accessiblePointerEvents: string = 'auto'

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

accessibleTitle accessibleTarget.ts:59
accessibleTitle: ?string = undefined

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

accessibleType accessibleTarget.ts:98
accessibleType: string = 'button'

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

alpha DisplayObject.ts:278
alpha: number = 1

The opacity of the object.

angle DisplayObject.ts:967
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.

buttonMode interactiveTarget.ts:99
buttonMode: boolean

If enabled, the mouse cursor use the pointer behavior when hovered over the displayObject if it is interactive Setting this changes the 'cursor' property to 'pointer'.

Parameters:
Name Type Description
value boolean
cacheAsBitmap index.ts:128
cacheAsBitmap: boolean

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

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 index.ts:96
cacheAsBitmapMultisample: number = PIXI.MSAA_QUALITY.NONE

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.

cacheAsBitmapResolution index.ts:63
cacheAsBitmapResolution: number = null

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.

cursor interactiveTarget.ts:126
cursor: string = undefined

This defines what cursor mode is used when the mouse cursor is hovered over the displayObject.

See: https://developer.mozilla.org/en/docs/Web/CSS/cursor
destroyed DisplayObject.ts:462
destroyed: boolean

Readonly flag for destroyed display objects.

filterArea DisplayObject.ts:338
filterArea: ?PIXI.Rectangle = undefined

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 DisplayObject.ts:348
filters: Array<PIXI.Filter> = undefined

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 FederatedEventTarget.ts:102
hitArea: PIXI.IHitArea = undefined

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.

interactive FederatedEventTarget.ts:80
interactive: boolean = false

Enable interaction events for the DisplayObject. Touch, pointer and mouse events will not be emitted unless interactive is set to true.

isMask DisplayObject.ts:432
isMask: boolean = false

Does any other displayObject use this object as a mask?

isSprite DisplayObject.ts:426
isSprite: boolean = false

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

localTransform DisplayObject.ts:871
localTransform: PIXI.Matrix

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

mask DisplayObject.ts:1030
mask: PIXI.Container | PIXI.MaskData | unknown

Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it. In PixiJS a regular mask must be a PIXI.Graphics or a PIXI.Sprite object. This allows for much faster masking in canvas as it utilities shape clipping. To remove a mask, set this property to null.

For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask.

name index.ts:3
name: string = undefined

The instance name of the object.

parent DisplayObject.ts:305
parent: PIXI.Container = undefined

The display object container that contains this display object.

pivot DisplayObject.ts:916
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).

position DisplayObject.ts:882
position: PIXI.ObservablePoint

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

renderable DisplayObject.ts:295
renderable: boolean = true

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 DisplayObject.ts:951
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 DisplayObject.ts:898
scale: PIXI.ObservablePoint

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

The default scale is (1, 1).

skew DisplayObject.ts:935
skew: PIXI.ObservablePoint

The skew factor for the object in radians.

smartMask index.ts:17
smartMask: PIXI.DisplayObject = undefined

It enable smart-masking, set this property. Before rendering the scene graph, you must invoke updateSmartMask on each display-object to enable masking.

transform DisplayObject.ts:270
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 DisplayObject.ts:285
visible: boolean = true

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 DisplayObject.ts:312
worldAlpha: number = 1

The multiplied alpha of the displayObject.

worldTransform DisplayObject.ts:860
worldTransform: PIXI.Matrix

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

worldVisible DisplayObject.ts:1007
worldVisible: boolean

Indicates if the object is globally visible.

x DisplayObject.ts:828
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 DisplayObject.ts:844
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 DisplayObject.ts:983
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
parentGroup index.ts:18
parentGroup: Group

The group in which this display object should be rendered.

This is provided by @pixi/layers.

parentLayer index.ts:28
parentLayer: Layer

The layer in which this display object should be rendered; don't set this if you're using PIXI.DisplayObject#parentLayer.

This is provided by @pixi/layers.

zOrder index.ts:39
zOrder: number

Objects in a group are sorted by z-order. This can be used alongside PixiJS' built-in zIndex.

If you use both zIndex and zOrder, objects will first be sorted by z-index and then @pixi/layers will sort by z-order.

This is provided by @pixi/layers.

Protected Properties


_boundsID DisplayObject.ts:378
protected _boundsID: number = 0

Flags the cached bounds as dirty.

_boundsRect DisplayObject.ts:386
protected _boundsRect: PIXI.Bounds = undefined

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

_destroyed DisplayObject.ts:418
protected _destroyed: boolean = false

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

_enabledFilters DisplayObject.ts:357
protected _enabledFilters: Array<PIXI.Filter> = undefined

Currently enabled filters

_lastSortedIndex DisplayObject.ts:320
protected _lastSortedIndex: number = 0

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 DisplayObject.ts:394
protected _localBoundsRect: PIXI.Bounds = undefined

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

_mask DisplayObject.ts:402
protected _mask: PIXI.Container | PIXI.MaskData | unknown = undefined

The original, cached mask of the object.

_tempDisplayObjectParent DisplayObject.ts:783
protected _tempDisplayObjectParent: PIXI.Container
_zIndex DisplayObject.ts:329
protected _zIndex: number = 0

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

Public Methods


mixin DisplayObject.ts:236
static mixin(source: object) → {void}

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

Parameters:
Name Type Description
source object

The source of properties and methods to mix in.

Returns:
Type Description
void
addEventListener FederatedEventTarget.ts:115
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options: boolean | AddEventListenerOptions) → {}

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.

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

calculateBounds DisplayObject.ts:470
calculateBounds() → {void}

Recalculates the bounds of the display object.

Returns:
Type Description
void
destroy DisplayObject.ts:752
destroy(_options: IDestroyOptions | boolean) → {void}

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

Parameters:
Name Type Attributes Description
_options IDestroyOptions | boolean

<optional>

Returns:
Type Description
void
disableTempParent DisplayObject.ts:818
disableTempParent(cacheParent: PIXI.Container) → {void}

Pair method for enableTempParent

Parameters:
Name Type Description
cacheParent PIXI.Container

Actual parent of element

Returns:
Type Description
void
dispatchEvent FederatedEventTarget.ts:189
dispatchEvent(e: Event) → {boolean}

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.

Parameters:
Name Type Description
e Event

The event to dispatch.

Returns:
Type Description
boolean

Whether the preventDefault() method was not invoked.

displayObjectUpdateTransform DisplayObject.ts:1103
displayObjectUpdateTransform

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

enableTempParent DisplayObject.ts:798
enableTempParent() → {PIXI.Container}

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 DisplayObject.ts:515
getBounds(skipUpdate: boolean, rect: PIXI.Rectangle) → {PIXI.Rectangle}

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.

Parameters:
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 index.ts:4
getGlobalPosition(point: PIXI.Point, skipUpdate: boolean) → {PIXI.Point}

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

Parameters:
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 DisplayObject.ts:586
getLocalBounds(rect: PIXI.Rectangle) → {PIXI.Rectangle}

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

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

removeEventListener FederatedEventTarget.ts:164
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options: boolean | AddEventListenerOptions) → {}

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.

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

render DisplayObject.ts:477
render(renderer: PIXI.Renderer) → {void}

Renders the object using the WebGL renderer.

Parameters:
Name Type Description
renderer PIXI.Renderer

The renderer.

Returns:
Type Description
void
setParent DisplayObject.ts:705
setParent(container: PIXI.Container) → {PIXI.Container}

Set the parent Container of this DisplayObject.

Parameters:
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 DisplayObject.ts:723
setTransform(x: number, y: number, scaleX: number, scaleY: number, rotation: number, skewX: number, skewY: number, pivotX: number, pivotY: number) → {PIXI.DisplayObject}

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

Parameters:
Name Type Attributes Default Description
x number

<optional>

0

The X position

y number

<optional>

0

The Y position

scaleX number

<optional>

1

The X scale value

scaleY number

<optional>

1

The Y scale value

rotation number

<optional>

0

The rotation

skewX number

<optional>

0

The X skew value

skewY number

<optional>

0

The Y skew value

pivotX number

<optional>

0

The X pivot value

pivotY number

<optional>

0

The Y pivot value

Returns:
Type Description
PIXI.DisplayObject

The DisplayObject instance

toGlobal DisplayObject.ts:631
toGlobal(position: PIXI.IPointData, point: PIXI.Point, skipUpdate: boolean) → {PIXI.Point}

Calculates the global position of the display object.

Parameters:
Name Type Attributes Default Description
position PIXI.IPointData

The world origin to calculate from.

point PIXI.Point

<optional>

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

skipUpdate boolean

<optional>

false

Should we skip the update transform.

Returns:
Type Description
PIXI.Point

A point object representing the position of this object.

toLocal DisplayObject.ts:665
toLocal(position: PIXI.IPointData, from: PIXI.DisplayObject, point: PIXI.Point, skipUpdate: boolean) → {PIXI.Point}

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

Parameters:
Name Type Attributes Default Description
position PIXI.IPointData

The world origin to calculate from.

from PIXI.DisplayObject

<optional>

The DisplayObject to calculate the global position from.

point PIXI.Point

<optional>

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

skipUpdate boolean

<optional>

false

Should we skip the update transform

Returns:
Type Description
PIXI.Point

A point object representing the position of this object

updateSmartMask index.ts:25
updateSmartMask(recursive, skipUpdate) → {PIXI.Rectangle}

Update the mask of the display-object based on whether its unmasked bounds are not a subset of the smart-mask's bounds or are.

NOTE: Setting the smart-mask to null will not remove the mask on the display-object, if it has already been enabled.

Parameters:
Name Type Description
recursive

whether to update the smart-masks of the children as well. Traversing the scene graph on your own is less optimized due to bounds recalculations.

skipUpdate

whether to not recalculate the transforms of each display-object. This is false by default because it is expected you will do this on your own.

Returns:
Type Description
PIXI.Rectangle
updateTransform DisplayObject.ts:501
updateTransform() → {void}

Updates the object transform for rendering.

TODO - Optimization pass!

Returns:
Type Description
void

Protected Methods


_recursivePostUpdateTransform DisplayObject.ts:484
protected _recursivePostUpdateTransform() → {void}

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

Returns:
Type Description
void

Events


added DisplayObject.ts:439

Fired when this DisplayObject is added to a Container.

Parameters:
Name Type Description
container PIXI.Container

The container added to.

click EventBoundary.ts:1428

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.

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

click InteractionManager.ts:573

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.

This comes from the @pixi/interaction package.

Parameters:
Name Type Description
event PIXI.InteractionEvent

Interaction event

clickcapture EventBoundary.ts:1445

Capture phase equivalent of click.

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

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

destroyed DisplayObject.ts:455

Fired when this DisplayObject is destroyed.

mousedown EventBoundary.ts:1352

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.

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

The mousedown event.

mousedown InteractionManager.ts:533

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

This comes from the @pixi/interaction package.

Parameters:
Name Type Description
event PIXI.InteractionEvent

Interaction event

mousedowncapture EventBoundary.ts:1362

Capture phase equivalent of mousedown.

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

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

The capture phase mousedown.

mouseenter EventBoundary.ts:1559

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.

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

mouseentercapture EventBoundary.ts:1568

Capture phase equivalent of mouseenter

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

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

mouseleave EventBoundary.ts:1599

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

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

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent
mouseleavecapture EventBoundary.ts:1608

Capture phase equivalent of mouseleave.

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

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

mousemove EventBoundary.ts:1521

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.

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

mousemove InteractionManager.ts:617

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.

This comes from the @pixi/interaction package.

Parameters:
Name Type Description
event PIXI.InteractionEvent

Interaction event

mousemovecature EventBoundary.ts:1531

Capture phase equivalent of mousemove.

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

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

mouseout EventBoundary.ts:1577

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.

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

mouseout InteractionManager.ts:637

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 comes from the @pixi/interaction package.

Parameters:
Name Type Description
event PIXI.InteractionEvent

Interaction event

mouseoutcapture EventBoundary.ts:1590

Capture phase equivalent of mouseout.

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

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

mouseover EventBoundary.ts:1540

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.

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

mouseover InteractionManager.ts:627

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.

This comes from the @pixi/interaction package.

Parameters:
Name Type Description
event PIXI.InteractionEvent

Interaction event

mouseovercapture EventBoundary.ts:1550

Capture phase equivalent of mouseover.

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

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

mouseup EventBoundary.ts:1390

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.

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

mouseup InteractionManager.ts:553

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.

This comes from the @pixi/interaction package.

Parameters:
Name Type Description
event PIXI.InteractionEvent

Interaction event

mouseupcature EventBoundary.ts:1400

Capture phase equivalent of mouseup.

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

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

mouseupoutside EventBoundary.ts:1475

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.

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

mouseupoutside InteractionManager.ts:593

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 comes from the @pixi/interaction package.

Parameters:
Name Type Description
event PIXI.InteractionEvent

Interaction event

mouseupoutsidecapture EventBoundary.ts:1491

Capture phase equivalent of mouseupoutside.

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

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

pointercancel EventBoundary.ts:1655

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.

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

pointercancel InteractionManager.ts:667

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

This comes from the @pixi/interaction package.

Parameters:
Name Type Description
event PIXI.InteractionEvent

Interaction event

pointercancelcapture EventBoundary.ts:1665

Capture phase equivalent of pointercancel.

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

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerdown EventBoundary.ts:1617

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.

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerdown InteractionManager.ts:647

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

This comes from the @pixi/interaction package.

Parameters:
Name Type Description
event PIXI.InteractionEvent

Interaction event

pointerdowncapture EventBoundary.ts:1627

Capture phase equivalent of pointerdown.

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

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerenter EventBoundary.ts:1755

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.

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerentercapture EventBoundary.ts:1764

Capture phase equivalent of pointerenter

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

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerleave EventBoundary.ts:1792

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.

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

The pointerleave event.

pointerleavecapture EventBoundary.ts:1803

Capture phase equivalent of pointerleave.

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

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

pointermove EventBoundary.ts:1717

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.

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

pointermove InteractionManager.ts:698

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

This comes from the @pixi/interaction package.

Parameters:
Name Type Description
event PIXI.InteractionEvent

Interaction event

pointermovecapture EventBoundary.ts:1727

Capture phase equivalent of pointermove.

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

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerout EventBoundary.ts:1773

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.

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerout InteractionManager.ts:718

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

This comes from the @pixi/interaction package.

Parameters:
Name Type Description
event PIXI.InteractionEvent

Interaction event

pointeroutcapture EventBoundary.ts:1783

Capture phase equivalent of pointerout.

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

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerover EventBoundary.ts:1736

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.

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerover InteractionManager.ts:708

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

This comes from the @pixi/interaction package.

Parameters:
Name Type Description
event PIXI.InteractionEvent

Interaction event

pointerovercapture EventBoundary.ts:1746

Capture phase equivalent of pointerover.

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

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

pointertap EventBoundary.ts:1674

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.

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

pointertap InteractionManager.ts:677

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.

This comes from the @pixi/interaction package.

Parameters:
Name Type Description
event PIXI.InteractionEvent

Interaction event

pointertapcapture EventBoundary.ts:1684

Capture phase equivalent of pointertap.

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

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerup EventBoundary.ts:1636

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.

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerup InteractionManager.ts:657

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

This comes from the @pixi/interaction package.

Parameters:
Name Type Description
event PIXI.InteractionEvent

Interaction event

pointerupcapture EventBoundary.ts:1646

Capture phase equivalent of pointerup.

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

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerupoutside EventBoundary.ts:1693

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.

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerupoutside InteractionManager.ts:687

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 comes from the @pixi/interaction package.

Parameters:
Name Type Description
event PIXI.InteractionEvent

Interaction event

pointerupoutsidecapture EventBoundary.ts:1708

Capture phase equivalent of pointerupoutside.

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

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

removed DisplayObject.ts:447

Fired when this DisplayObject is removed from a Container.

Parameters:
Name Type Description
container PIXI.Container

The container removed from.

removedFrom Container.ts:117

Fired when a DisplayObject is removed from this Container.

Parameters:
Name Type Description
child PIXI.DisplayObject

The child removed from the Container.

container PIXI.Container

The container that removed removed the child.

index number

The former children's index of the removed child

rightclick EventBoundary.ts:1454

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.

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

rightclick InteractionManager.ts:583

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 comes from the @pixi/interaction package.

Parameters:
Name Type Description
event PIXI.InteractionEvent

Interaction event

rightclickcapture EventBoundary.ts:1466

Capture phase equivalent of rightclick.

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

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

rightdown EventBoundary.ts:1371

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.

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

rightdown InteractionManager.ts:543

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.

This comes from the @pixi/interaction package.

Parameters:
Name Type Description
event PIXI.InteractionEvent

Interaction event

rightdowncapture EventBoundary.ts:1381

Capture phase equivalent of rightdown.

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

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

The rightdowncapture event.

rightup EventBoundary.ts:1409

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.

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

rightup InteractionManager.ts:563

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.

This comes from the @pixi/interaction package.

Parameters:
Name Type Description
event PIXI.InteractionEvent

Interaction event

rightupcapture EventBoundary.ts:1419

Capture phase equivalent of rightup.

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

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

rightupoutside EventBoundary.ts:1500

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.

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

rightupoutside InteractionManager.ts:605

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.

This comes from the @pixi/interaction package.

Parameters:
Name Type Description
event PIXI.InteractionEvent

Interaction event

rightupoutsidecapture EventBoundary.ts:1512

Capture phase equivalent of rightupoutside.

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

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

tap EventBoundary.ts:1869

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.

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

tap InteractionManager.ts:758

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.

This comes from the @pixi/interaction package.

Parameters:
Name Type Description
event PIXI.InteractionEvent

Interaction event

tapcapture EventBoundary.ts:1879

Capture phase equivalent of tap.

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

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

touchcancel EventBoundary.ts:1850

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.

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

touchcancel InteractionManager.ts:748

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

This comes from the @pixi/interaction package.

Parameters:
Name Type Description
event PIXI.InteractionEvent

Interaction event

touchcancelcapture EventBoundary.ts:1860

Capture phase equivalent of touchcancel.

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

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

touchend EventBoundary.ts:1831

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.

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

touchend InteractionManager.ts:738

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

This comes from the @pixi/interaction package.

Parameters:
Name Type Description
event PIXI.InteractionEvent

Interaction event

touchendcapture EventBoundary.ts:1841

Capture phase equivalent of touchend.

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

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

touchendoutside EventBoundary.ts:1888

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.

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

touchendoutside InteractionManager.ts:768

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.

This comes from the @pixi/interaction package.

Parameters:
Name Type Description
event PIXI.InteractionEvent

Interaction event

touchendoutsidecapture EventBoundary.ts:1899

Capture phase equivalent of touchendoutside.

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

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

touchmove EventBoundary.ts:1908

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.

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

touchmove InteractionManager.ts:779

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

This comes from the @pixi/interaction package.

Parameters:
Name Type Description
event PIXI.InteractionEvent

Interaction event

touchmovecapture EventBoundary.ts:1918

Capture phase equivalent of touchmove.

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

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

touchstart EventBoundary.ts:1812

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.

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

touchstart InteractionManager.ts:728

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

This comes from the @pixi/interaction package.

Parameters:
Name Type Description
event PIXI.InteractionEvent

Interaction event

touchstartcapture EventBoundary.ts:1822

Capture phase equivalent of touchstart.

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

Parameters:
Name Type Description
event PIXI.FederatedPointerEvent

Event

wheel EventBoundary.ts:1927
wheel

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

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

wheelcapture EventBoundary.ts:1936
wheelcapture

Capture phase equivalent of wheel.

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