Class: BitmapText

PIXI.BitmapText

A BitmapText object will create a line or multiple lines of text using bitmap font.

The primary advantage of this class over Text is that all of your textures are pre-generated and loading, meaning that rendering is fast, and changing text has no performance implications.

Supporting character sets other than latin, such as CJK languages, may be impractical due to the number of characters.

To split a line you can use '\n', '\r' or '\r\n' in your string.

PixiJS can auto-generate fonts on-the-fly using BitmapFont or use fnt files provided by: http://www.angelcode.com/products/bmfont/ for Windows or http://www.bmglyph.com/ for Mac.

A BitmapText can only be created when the font is loaded.

// in this case the font is in a file called 'desyrel.fnt'
let bitmapText = new PIXI.BitmapText("text using a fancy font!", {
  fontName: "Desyrel",
  fontSize: 35,
  align: "right"
});

new PIXI.BitmapText (text, style)

BitmapText.ts:90
Name Type Attributes Default Description
text string

A string that you would like the text to display.

style object

The style parameters.

style.fontName string

The installed BitmapFont name.

style.fontSize number <optional>

The size of the font in pixels, e.g. 24. If undefined, . this will default to the BitmapFont size.

style.align string <optional>
'left'

Alignment for multiline text ('left', 'center', 'right' or 'justify'), does not affect single line text.

style.tint number <optional>
0xFFFFFF

The tint color.

style.letterSpacing number <optional>
0

The amount of spacing between letters.

style.maxWidth number <optional>
0

The max width of the text before line wrapping.

Extends

Members

_roundPixels boolean

If true PixiJS will Math.floor() x/y values when rendering

Default Value:
  • PIXI.settings.ROUND_PIXELS

align string

The alignment of the BitmapText object.

Default Value:
  • 'left'

anchor PIXI.Point | number

The anchor sets the origin point of the text.

The default is (0,0), this means the text's origin is the top left.

Setting the anchor to (0.5,0.5) means the text's origin is centered.

Setting the anchor to (1,1) would mean the text's origin point will be the bottom right corner.

dirty boolean

Set to true if the BitmapText needs to be redrawn.

Default Value:
  • true

fontName string

The name of the BitmapFont.

fontSize number

The size of the font to display.

letterSpacing number

Additional space between characters.

maxLineHeight number readonly

The max line height. This is useful when trying to use the total height of the Text, i.e. when trying to vertically align.

maxWidth number

The max width of this bitmap text in pixels. If the text provided is longer than the value provided, line breaks will be automatically inserted in the last whitespace. Disable by setting the value to 0.

roundPixels boolean

If true PixiJS will Math.floor() x/y values when rendering, stopping pixel interpolation. Advantages can include sharper image quality (like text) and faster rendering on canvas. The main disadvantage is movement of objects may appear less smooth. To set the global default, change PIXI.settings.ROUND_PIXELS

Default Value:
  • PIXI.settings.ROUND_PIXELS

text string

The text of the BitmapText object.

textHeight number readonly

The height of the overall text, different from fontSize, which is defined in the style object.

textWidth number readonly

The width of the overall text, different from fontSize, which is defined in the style object.

tint number

The tint of the BitmapText object.

Default Value:
  • 0xffffff

Methods

getLocalBounds () PIXI.Rectangle overrides

BitmapText.ts:612

Validates text before calling parent's getLocalBounds

Returns:
Type Description
PIXI.Rectangle The rectangular bounding area

updateText () void

BitmapText.ts:236

Renders text and updates it when needed. This should only be called if the BitmapFont is regenerated.

Inherited Properties

From class PIXI.Container

children Array<PIXI.DisplayObject> readonly inherited

The array of children of this container.

height number inherited

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

interactiveChildren boolean inherited

Determines if the children to the displayObject can be clicked/touched Setting this to false allows PixiJS to bypass a recursive hitTest function

Default Value:
  • true

sortableChildren boolean inherited

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

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

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

See:

sortDirty boolean inherited

Should children be sorted by zIndex at the next updateTransform call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

Default Value:
  • false

width number inherited

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

From class PIXI.DisplayObject

_accessibleActive boolean inherited

Default Value:
  • false
TODO
  • Needs docs.

_accessibleDiv boolean inherited

Default Value:
  • undefined
TODO
  • Needs docs.

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.

buttonMode boolean inherited

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

Example

 const sprite = new PIXI.Sprite(texture);
 sprite.interactive = true;
 sprite.buttonMode = true;

cacheAsBitmap boolean 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 set to null, the renderer's sample count is used. If cacheAsBitmap is set to true, this will re-render with the new number of samples.

Default Value:
  • PIXI.MSAA_QUALITY.NONE

cacheAsBitmapResolution number inherited

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

Default Value:
  • null

cursor string inherited

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

Default Value:
  • undefined
See:
Example

 const sprite = new PIXI.Sprite(texture);
 sprite.interactive = true;
 sprite.cursor = 'wait';

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

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.

TODO
  • At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
Example

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

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

name string inherited

The instance name of the object.

Default Value:
  • undefined

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

addChild (…children) PIXI.DisplayObject inherited

Container.ts:136

Adds one or more children to the container.

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

Name Type Description
children PIXI.DisplayObject

The DisplayObject(s) to add to the container

Returns:
Type Description
PIXI.DisplayObject The first child that was added.

addChildAt (child, index) PIXI.DisplayObject inherited

Container.ts:186

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown

Name Type Description
child PIXI.DisplayObject

The child to add

index number

The index to place the child in

Returns:
Type Description
PIXI.DisplayObject The child that was added.

calculateBounds () void inherited

Container.ts:469

Recalculates the bounds of the container.

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

containerUpdateTransform inherited

Container.ts:762

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

destroy (options) void inherited

Container.ts:677

Removes all internal references and listeners as well as removes children from the display list. Do not use a Container after calling destroy.

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

Options parameter. A boolean will act as if all options have been set to that value

options.children boolean <optional>
false

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

options.texture boolean <optional>
false

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

options.baseTexture boolean <optional>
false

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

getChildAt (index) PIXI.DisplayObject inherited

Container.ts:284

Returns the child at the specified index

Name Type Description
index number

The index to get the child at

Returns:
Type Description
PIXI.DisplayObject The child at the given index, if any.

getChildByName (name, deep) PIXI.DisplayObject inherited

index.ts:11

Returns the display object in the container.

Recursive searches are done in a preorder traversal.

Name Type Attributes Default Description
name string

Instance name.

deep boolean <optional>
false

Whether to search recursively

Returns:
Type Description
PIXI.DisplayObject The child with the specified name.

getChildIndex (child) number inherited

Container.ts:245

Returns the index position of a child DisplayObject instance

Name Type Description
child PIXI.DisplayObject

The DisplayObject instance to identify

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

removeChild (…children) PIXI.DisplayObject inherited

Container.ts:300

Removes one or more children from the container.

Name Type Description
children PIXI.DisplayObject

The DisplayObject(s) to remove

Returns:
Type Description
PIXI.DisplayObject The first child that was removed.

removeChildAt (index) PIXI.DisplayObject inherited

Container.ts:341

Removes a child from the specified index position.

Name Type Description
index number

The index to get the child from

Returns:
Type Description
PIXI.DisplayObject The child that was removed.

removeChildren (beginIndex, endIndex) Array<PIXI.DisplayObject> inherited

Container.ts:367

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

Name Type Attributes Default Description
beginIndex number <optional>
0

The beginning position.

endIndex number <optional>
this.children.length

The ending position. Default value is size of the container.

Returns:
Type Description
Array<PIXI.DisplayObject> List of removed children

render (renderer) void inherited

Container.ts:555

Renders the object using the WebGL renderer.

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

If renderable or visible is false or if worldAlpha is not positive, this implementation will entirely skip rendering. See PIXI.DisplayObject for choosing between renderable or visible. Generally, setting alpha to zero is not recommended for purely skipping rendering.

When your scene becomes large (especially when it is larger than can be viewed in a single screen), it is advised to employ culling to automatically skip rendering objects outside of the current screen. The @pixi-essentials/cull and pixi-cull packages do this out of the box.

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

Name Type Description
renderer PIXI.Renderer

The renderer

renderCanvas (renderer) void inherited

Container.ts:17

Renders the object using the Canvas renderer

Name Type Description
renderer PIXI.CanvasRenderer

The renderer

setChildIndex (child, index) void inherited

Container.ts:263

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

Name Type Description
child PIXI.DisplayObject

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

index number

The resulting index number for the child display object

sortChildren () void inherited

Container.ts:414

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

swapChildren (child, child2) void inherited

Container.ts:224

Swaps the position of 2 Display Objects within this container.

Name Type Description
child PIXI.DisplayObject

First display object to swap

child2 PIXI.DisplayObject

Second display object to swap

_calculateBounds () void protected inherited

Container.ts:544

Recalculates the content bounds of this object. This should be overriden to calculate the bounds of this specific object (not including children).

_render (renderer) void protected inherited

Container.ts:666

To be overridden by the subclasses.

Name Type Description
renderer PIXI.Renderer

The renderer

_renderCanvas (renderer) void protected inherited

Container.ts:5

To be overridden by the subclass

Name Type Description
renderer PIXI.CanvasRenderer

The renderer

onChildrenChange (_length) void protected inherited

Container.ts:126

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

Name Type Attributes Description
_length number <optional>

renderAdvanced (renderer) void protected inherited

Container.ts:602

Render the object using the WebGL renderer and advanced features.

Name Type Description
renderer PIXI.Renderer

The renderer

From class PIXI.DisplayObject

addEventListener (type, listener, options) inherited

FederatedEventTarget.ts:115

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

Name Type Attributes Description
type string

The type of event to listen to.

listener EventListenerOrEventListenerObject

The listener callback or object.

options boolean | AddEventListenerOptions <optional>

Listener options, used for capture phase.

Example

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

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

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

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

disableTempParent (cacheParent) void inherited

DisplayObject.ts:818

Pair method for enableTempParent

Name Type Description
cacheParent PIXI.Container

Actual parent of element

dispatchEvent (e) boolean inherited

FederatedEventTarget.ts:189

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

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

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

Name Type Description
e Event

The event to dispatch.

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

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

displayObjectUpdateTransform inherited

DisplayObject.ts:1103

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

enableTempParent () PIXI.Container inherited

DisplayObject.ts:798

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

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

getBounds (skipUpdate, rect) PIXI.Rectangle inherited

DisplayObject.ts:515

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

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

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

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

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

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

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

Name Type Attributes Description
skipUpdate boolean <optional>

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

rect PIXI.Rectangle <optional>

Optional rectangle to store the result of the bounds calculation.

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

getGlobalPosition (point, skipUpdate) PIXI.Point inherited

index.ts:4

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

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

The point to write the global value to.

skipUpdate boolean <optional>
false

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

Returns:
Type Description
PIXI.Point The updated point.

removeEventListener (type, listener, options) inherited

FederatedEventTarget.ts:164

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

Name Type Attributes Description
type string

The type of event the listener is bound to.

listener EventListenerOrEventListenerObject

The listener callback or object.

options boolean | AddEventListenerOptions <optional>

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

setParent (container) PIXI.Container inherited

DisplayObject.ts:705

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

DisplayObject.ts:723

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

DisplayObject.ts:631

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

DisplayObject.ts:665

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

_recursivePostUpdateTransform () void protected inherited

DisplayObject.ts:484

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

Inherited Events

From class PIXI.Container

childAdded inherited

Container.ts:107

Fired when a DisplayObject is added to this Container.

Name Type Description
child PIXI.DisplayObject

The child added to the Container.

container PIXI.Container

The container that added the child.

index number

The children's index of the added child.

From class PIXI.DisplayObject

added inherited

DisplayObject.ts:439

Fired when this DisplayObject is added to a Container.

Name Type Description
container PIXI.Container

The container added to.

click inherited

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.

Name Type Description
event PIXI.FederatedPointerEvent

Event

clickcapture inherited

EventBoundary.ts:1445

Capture phase equivalent of click.

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

destroyed inherited

DisplayObject.ts:455

Fired when this DisplayObject is destroyed.

mousedown inherited

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.

Name Type Description
event PIXI.FederatedPointerEvent

The mousedown event.

mousedowncapture inherited

EventBoundary.ts:1362

Capture phase equivalent of mousedown.

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

Name Type Description
event PIXI.FederatedPointerEvent

The capture phase mousedown.

mouseenter inherited

EventBoundary.ts: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.

Name Type Description
event PIXI.FederatedPointerEvent

Event

mouseentercapture inherited

EventBoundary.ts:1568

Capture phase equivalent of mouseenter

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

mouseleave inherited

EventBoundary.ts:1599

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

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

Name Type Description
event PIXI.FederatedPointerEvent

mouseleavecapture inherited

EventBoundary.ts:1608

Capture phase equivalent of mouseleave.

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

mousemove inherited

EventBoundary.ts: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.

Name Type Description
event PIXI.FederatedPointerEvent

Event

mousemovecature inherited

EventBoundary.ts:1531

Capture phase equivalent of mousemove.

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

Name Type Description
event PIXI.FederatedPointerEvent

Event

mouseout inherited

EventBoundary.ts:1577

Fired when a pointer device (usually a mouse) is mov