Phaser Class: 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 - pixi/display/DisplayObject.js, line 5

Members

alpha :Number

The opacity of the object.

Source - 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 - pixi/display/DisplayObject.js, line 366

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 - pixi/display/DisplayObject.js, line 183

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 - pixi/display/DisplayObject.js, line 328

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 - 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 - pixi/display/DisplayObject.js, line 303

<readonly> parent :PIXI.DisplayObjectContainer

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

Source - pixi/display/DisplayObject.js, line 98

pivot :Point

The pivot point of the displayObject that it rotates around

Source - pixi/display/DisplayObject.js, line 49

position :Point

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

Source - pixi/display/DisplayObject.js, line 14

renderable :Boolean

Can this object be rendered

Source - pixi/display/DisplayObject.js, line 90

rotation :Number

The rotation of the object in radians.

Source - pixi/display/DisplayObject.js, line 57

scale :Point

The scale factor of the object.

Source - 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 - 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 - pixi/display/DisplayObject.js, line 30

transformCallbackContext :Object

The context under which the transformCallback is invoked.

Source - pixi/display/DisplayObject.js, line 41

visible :Boolean

The visibility of the object.

Source - pixi/display/DisplayObject.js, line 73

<readonly> worldAlpha :Number

[read-only] The multiplied alpha of the displayObject

Source - pixi/display/DisplayObject.js, line 116

<readonly> worldPosition :Point

The position of the Display Object based on the world transform. This value is updated at the end of updateTransform and takes all parent transforms into account.

Source - pixi/display/DisplayObject.js, line 135

<readonly> worldRotation :Number

The rotation of the Display Object, in radians, based on the world transform. This value is updated at the end of updateTransform and takes all parent transforms into account.

Source - pixi/display/DisplayObject.js, line 155

<readonly> worldScale :Point

The scale of the Display Object based on the world transform. This value is updated at the end of updateTransform and takes all parent transforms into account.

Source - pixi/display/DisplayObject.js, line 145

worldVisible :Boolean

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

Source - pixi/display/DisplayObject.js, line 279

x :Number

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

Source - pixi/display/DisplayObject.js, line 726

y :Number

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

Source - pixi/display/DisplayObject.js, line 744

Methods

destroy()

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

Source - pixi/display/DisplayObject.js, line 242

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.