Class: TemporaryDisplayObject

TemporaryDisplayObject

new TemporaryDisplayObject

Extends

Inherited Properties

From class PIXI.DisplayObject

_accessibleActive boolean inherited

Default Value:
  • false
TODO
  • Needs docs.

_accessibleDiv boolean inherited

Default Value:
  • undefined
TODO
  • Needs docs.

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

_localBounds PIXI.Bounds inherited

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

Default Value:
  • undefined

accessible boolean inherited

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

Default Value:
  • false

accessibleChildren boolean inherited

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

Default Value:
  • true

accessibleHint string inherited

Sets the aria-label attribute of the shadow div

Default Value:
  • undefined

accessiblePointerEvents string inherited

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

Default Value:
  • 'auto'

accessibleTitle ?string inherited

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

Default Value:
  • undefined

accessibleType string inherited

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

Default Value:
  • 'button'

alpha number inherited

The opacity of the object.

Default Value:
  • 1

angle number inherited

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

cacheAsBitmap boolean inherited

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 number inherited

The number of samples to use for cacheAsBitmap. If cacheAsBitmap is set to true, this will re-render with the new number of samples.

Default Value:
  • PIXI.MSAA_QUALITY.NONE

cacheAsBitmapResolution number inherited

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

Default Value:
  • null

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.

Default Value:
  • undefined

filters Array<PIXI.Filter> inherited

Sets the filters for the displayObject.

  • IMPORTANT: This is a WebGL only feature and will be ignored by the canvas renderer. To remove filters simply set this property to 'null'.
Default Value:
  • undefined

hitArea PIXI.IHitArea inherited

Interaction shape. Children will be hit first, then this shape will be checked. Setting this will cause this shape to be checked in hit tests rather than the displayObject's bounds.

Default Value:
  • undefined
Example

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

interactive boolean inherited

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

Default Value:
  • false
Example

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

isMask boolean inherited

Does any other displayObject use this object as a mask?

Default Value:
  • false

isSprite boolean inherited

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

Default Value:
  • false

localTransform PIXI.Matrix readonly inherited

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

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

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

Example

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

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

name string inherited

The instance name of the object.

Default Value:
  • undefined

The display object container that contains this display object.

Default Value:
  • undefined

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:
  • PixiJS 4

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

Since:
  • PixiJS 4

renderable boolean inherited

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

Only affects recursive calls from parent. You can ask for bounds manually.

Default Value:
  • true

rotation number inherited

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

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

The default scale is (1, 1).

Since:
  • PixiJS 4

The skew factor for the object in radians.

Since:
  • PixiJS 4

World transform and local transform of this object. This will become read-only later, please do not assign anything there unless you know what are you doing.

visible boolean inherited

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

Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually.

Default Value:
  • true

worldAlpha number readonly inherited

The multiplied alpha of the displayObject.

Default Value:
  • 1

worldTransform PIXI.Matrix readonly inherited

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

worldVisible boolean readonly inherited

Indicates if the object is globally visible.

x number inherited

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

y number inherited

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

zIndex number inherited

The zIndex of the displayObject.

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

See:

_boundsID number protected inherited

Flags the cached bounds as dirty.

Default Value:
  • 0

_boundsRect PIXI.Bounds protected inherited

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

Default Value:
  • undefined

_destroyed boolean protected inherited

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

Default Value:
  • false

_enabledFilters Array<PIXI.Filter> protected inherited

Currently enabled filters

Default Value:
  • undefined

_lastSortedIndex number protected inherited

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

Default Value:
  • 0

_localBoundsRect PIXI.Bounds protected inherited

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

Default Value:
  • undefined

_mask PIXI.Container | PIXI.MaskData | unknown protected inherited

The original, cached mask of the object.

Default Value:
  • undefined

_tempDisplayObjectParent PIXI.Container protected inherited

_zIndex number protected inherited

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

Default Value:
  • 0

Inherited Methods

From class PIXI.DisplayObject

addEventListener (type, listener, options) inherited

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

Name Type Attributes Description
type string

The type of event to listen to.

listener EventListenerOrEventListenerObject

The listener callback or object.

options boolean | AddEventListenerOptions <optional>

Listener options, used for capture phase.

Example

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

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

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

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

calculateBounds () void abstract inherited

Recalculates the bounds of the display object.

destroy (_options) void inherited

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 inherited

Pair method for enableTempParent

Name Type Description
cacheParent PIXI.Container

Actual parent of element

dispatchEvent (e) boolean inherited

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

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

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

Name Type Description
e Event

The event to dispatch.

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

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

displayObjectUpdateTransform inherited

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

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

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

getBounds (skipUpdate, rect) PIXI.Rectangle inherited

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

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

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

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

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

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

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

Name Type Attributes Description
skipUpdate boolean <optional>

Setting to true will stop the transforms of the scene graph from being updated. This means the calculation returned MAY be out of date BUT will give you a nice performance boost.

rect PIXI.Rectangle <optional>

Optional rectangle to store the result of the bounds calculation.

Returns:
Type Description
PIXI.Rectangle The minimum axis-aligned rectangle in world space that fits around this object.

getGlobalPosition (point, skipUpdate) PIXI.Point inherited

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.

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.

removeEventListener (type, listener, options) inherited

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

Name Type Attributes Description
type string

The type of event the listener is bound to.

listener EventListenerOrEventListenerObject

The listener callback or object.

options boolean | AddEventListenerOptions <optional>

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

render (renderer) void abstract inherited

Renders the object using the WebGL renderer.

Name Type Description
renderer PIXI.Renderer

The renderer.

Set the parent Container of this DisplayObject.

Name Type Description
container PIXI.Container

The Container to add this DisplayObject to.

Returns:
Type Description
PIXI.Container The Container that this DisplayObject was added to.

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

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

Name Type 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 (position, point, skipUpdate) PIXI.Point inherited

Calculates the global position of the display object.

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 (position, from, point, skipUpdate) PIXI.Point inherited

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

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

updateTransform () void inherited

Updates the object transform for rendering.

TODO - Optimization pass!

_recursivePostUpdateTransform () void protected inherited

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

Inherited Events

From class PIXI.DisplayObject

Fired when this DisplayObject is added to a Container.

Name Type Description
container PIXI.Container

The container added to.

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

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

Capture phase equivalent of click.

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

Fired when this DisplayObject is destroyed.

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

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

Name Type Description
event PIXI.FederatedPointerEvent

The mousedown event.

mousedowncapture inherited

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.

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

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

mouseentercapture inherited

Capture phase equivalent of mouseenter

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

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

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

Name Type Description
event PIXI.FederatedPointerEvent

mouseleavecapture inherited

Capture phase equivalent of mouseleave.

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

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

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

Capture phase equivalent of mousemove.

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

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

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

Capture phase equivalent of mouseout.

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

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

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

mouseovercapture inherited

Capture phase equivalent of mouseover.

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

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

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

Capture phase equivalent of mouseup.

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

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

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

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

mouseupoutsidecapture inherited

Capture phase equivalent of mouseupoutside.

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

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

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointercancelcapture inherited

Capture phase equivalent of pointercancel.

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

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

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerdowncapture inherited

Capture phase equivalent of pointerdown.

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

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

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerentercapture inherited

Capture phase equivalent of pointerenter

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

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

This event notifies only the target and does not bubble.

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

Name Type Description
event PIXI.FederatedPointerEvent

The pointerleave event.

pointerleavecapture inherited

Capture phase equivalent of pointerleave.

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

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

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointermovecapture inherited

Capture phase equivalent of pointermove.

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

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

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointeroutcapture inherited

Capture phase equivalent of pointerout.

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

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

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerovercapture inherited

Capture phase equivalent of pointerover.

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

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

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointertapcapture inherited

Capture phase equivalent of pointertap.

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

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

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerupcapture inherited

Capture phase equivalent of pointerup.

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerupoutside inherited

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

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

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

pointerupoutsidecapture inherited

Capture phase equivalent of pointerupoutside.

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

Fired when this DisplayObject is removed from a Container.

Name Type Description
container PIXI.Container

The container removed from.

Fired when a DisplayObject is removed from this Container.

Name Type Description
child PIXI.DisplayObject

The child removed from the Container.

container PIXI.Container

The container that removed removed the child.

index number

The former children's index of the removed child

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

This event follows the semantics of click.

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

rightclickcapture inherited

Capture phase equivalent of rightclick.

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

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

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

rightdowncapture inherited

Capture phase equivalent of rightdown.

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

Name Type Description
event PIXI.FederatedPointerEvent

The rightdowncapture event.

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

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

Capture phase equivalent of rightup.

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

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

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

rightupoutsidecapture inherited

Capture phase equivalent of rightupoutside.

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

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

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

Capture phase equivalent of tap.

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

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

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

touchcancelcapture inherited

Capture phase equivalent of touchcancel.

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

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

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

Capture phase equivalent of touchend.

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

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

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

touchendoutsidecapture inherited

Capture phase equivalent of touchendoutside.

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

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

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

touchmovecapture inherited

Capture phase equivalent of touchmove.

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

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

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

touchstartcapture inherited

Capture phase equivalent of touchstart.

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

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

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

Type:

Capture phase equivalent of wheel.

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

Type: