These docs are for Phaser 2.3.0 Phaser 3 docs can be found on GitHub pages.
Phaser CE docs can be found on the Phaser CE Documentation site.

Constructor

PIXI. DisplayObject

new DisplayObject()

The base class for all objects that are rendered on the screen. This is an abstract class and should not be used on its own rather it should be extended.

Source code: pixi/display/DisplayObject.js (Line 5)

Public Properties

alpha : number

The opacity of the object.

Source code: pixi/display/DisplayObject.js (Line 65)

cacheAsBitmap : boolean

Set if this display object is 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 'null'

Source code: pixi/display/DisplayObject.js (Line 336)

filterArea :Rectangle

The area the filter is applied to like the hitArea this is used as more of an optimisation rather than figuring out the dimensions of the displayObject each frame you can set this rectangle

Source code: pixi/display/DisplayObject.js (Line 153)

filters : Array.<Filter>

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'

Type
  • Array.<Filter>
Source code: pixi/display/DisplayObject.js (Line 298)

hitArea :Rectangle | Circle | Ellipse | Polygon

This is the defined area that will pick up mouse / touch events. It is null by default. Setting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)

Type
  • Rectangle | Circle | Ellipse | Polygon
Source code: pixi/display/DisplayObject.js (Line 81)

mask : PIXI.Graphics

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 PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping. To remove a mask, set this property to null.

Source code: pixi/display/DisplayObject.js (Line 273)

[readonly] parent : PIXI.DisplayObjectContainer

[read-only] The display object container that contains this display object.

Source code: pixi/display/DisplayObject.js (Line 98)

pivot :Point

The pivot point of the displayObject that it rotates around

Source code: pixi/display/DisplayObject.js (Line 49)

position :Point

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

Source code: pixi/display/DisplayObject.js (Line 14)

renderable : boolean

Can this object be rendered

Source code: pixi/display/DisplayObject.js (Line 90)

rotation : number

The rotation of the object in radians.

Source code: pixi/display/DisplayObject.js (Line 57)

scale :Point

The scale factor of the object.

Source code: pixi/display/DisplayObject.js (Line 22)

[readonly] stage : PIXI.Stage

[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.

Source code: pixi/display/DisplayObject.js (Line 107)

transformCallback : Function

The transform callback is an optional callback that if set will be called at the end of the updateTransform method and sent two parameters: This Display Objects worldTransform matrix and its parents transform matrix. Both are PIXI.Matrix object types. The matrix are passed by reference and can be modified directly without needing to return them. This ability allows you to check any of the matrix values and perform actions such as clamping scale or limiting rotation, regardless of the parent transforms.

Source code: pixi/display/DisplayObject.js (Line 30)

transformCallbackContext : Object

The context under which the transformCallback is invoked.

Source code: pixi/display/DisplayObject.js (Line 41)

visible : boolean

The visibility of the object.

Source code: pixi/display/DisplayObject.js (Line 73)

[readonly] worldAlpha : number

[read-only] The multiplied alpha of the displayObject

Source code: pixi/display/DisplayObject.js (Line 116)

worldVisible : boolean

[read-only] Indicates if the sprite is globally visible.

Source code: pixi/display/DisplayObject.js (Line 249)

x : number

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

Source code: pixi/display/DisplayObject.js (Line 672)

y : number

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

Source code: pixi/display/DisplayObject.js (Line 690)

Public Methods

destroy()

Destroy this DisplayObject. Removes all references to transformCallbacks, its parent, the stage, filters, bounds, mask and cached Sprites.

Source code: pixi/display/DisplayObject.js (Line 212)

generateTexture(resolution, scaleMode, renderer) → {PIXI.Texture}

Useful function that returns a texture of the displayObject object that can then be used to create sprites This can be quite useful if your displayObject is static / complicated and needs to be reused multiple times.

Parameters
Name Type Description
resolution Number

The resolution of the texture being generated

scaleMode Number

See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values

renderer PIXI.CanvasRenderer | PIXI.WebGLRenderer

The renderer used to generate the texture.

Returns

a texture of the graphics object

Source code: pixi/display/DisplayObject.js (Line 495)

getBounds(matrix) → {Rectangle}

Retrieves the bounds of the displayObject as a rectangle object

Parameters
Name Type Description
matrix Matrix

-

Returns
Rectangle -

the rectangular bounding area

Source code: pixi/display/DisplayObject.js (Line 451)

getLocalBounds() → {Rectangle}

Retrieves the local bounds of the displayObject as a rectangle object

Returns
Rectangle -

the rectangular bounding area

Source code: pixi/display/DisplayObject.js (Line 464)

preUpdate()

Empty, to be overridden by classes that require it.

Source code: pixi/display/DisplayObject.js (Line 486)

setStageReference(stage)

Sets the object's stage reference, the stage this object is connected to

Parameters
Name Type Description
stage PIXI.Stage

the stage that the object will have as its current stage reference

Source code: pixi/display/DisplayObject.js (Line 475)

toGlobal(position) → {Point}

Calculates the global position of the display object

Parameters
Name Type Description
position Point

The world origin to calculate from

Returns
Point -

A point object representing the position of this object

Source code: pixi/display/DisplayObject.js (Line 529)

toLocal(position, from) → {Point}

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

Parameters
Name Type Argument Description
position Point

The world origin to calculate from

from PIXI.DisplayObject <optional>

The DisplayObject to calculate the global position from

Returns
Point -

A point object representing the position of this object

Source code: pixi/display/DisplayObject.js (Line 543)

updateCache()

Generates and updates the cached sprite for this object.

Source code: pixi/display/DisplayObject.js (Line 519)