Members

alpha :Number

The opacity of the object.

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

buttonMode :Boolean

This is used to indicate if the displayObject should display a mouse hand cursor on rollover

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

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 436

defaultCursor :String

This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true

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

filterArea :PIXI.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 180

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 400

hitArea :PIXI.Rectangle|PIXI.Circle|PIXI.Ellipse|PIXI.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:

• PIXI.Rectangle | PIXI.Circle | PIXI.Ellipse | PIXI.Polygon

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

interactive :Boolean

Indicates if the sprite will have touch and mouse interactivity. It is false by default

Default Value:

• false

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

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 380

<readonly> parent :PIXI.DisplayObjectContainer

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

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

pivot :PIXI.Point

The pivot point of the displayObject that it rotates around

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

position :PIXI.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 98

rotation :Number

The rotation of the object in radians.

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

scale :PIXI.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 115

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 124

worldVisible :Boolean

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

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

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 761

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 776

Methods

click(interactionData)

A callback that is used when the users clicks on the displayObject with their mouse's left button

Parameters:

Name	Type	Description
interactionData	PIXI.InteractionData	-

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

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:

PIXI.Texture -

a texture of the graphics object

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

getBounds(matrix) → {PIXI.Rectangle}

Retrieves the bounds of the displayObject as a rectangle object

Parameters:

Name	Type	Description
matrix	PIXI.Matrix	-

Returns:

PIXI.Rectangle -

the rectangular bounding area

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

getLocalBounds() → {PIXI.Rectangle}

Retrieves the local bounds of the displayObject as a rectangle object

Returns:

PIXI.Rectangle -

the rectangular bounding area

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

mousedown(interactionData)

A callback that is used when the user clicks the mouse's left button down over the sprite

Parameters:

Name	Type	Description
interactionData	PIXI.InteractionData	-

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

mouseout(interactionData)

A callback that is used when the users mouse leaves the displayObject

Parameters:

Name	Type	Description
interactionData	PIXI.InteractionData	-

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

mouseover(interactionData)

A callback that is used when the users mouse rolls over the displayObject

Parameters:

Name	Type	Description
interactionData	PIXI.InteractionData	-

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

mouseup(interactionData)

A callback that is used when the user releases the mouse's left button that was over the displayObject for this callback to be fired, the mouse's left button must have been pressed down over the displayObject

Parameters:

Name	Type	Description
interactionData	PIXI.InteractionData	-

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

mouseupoutside(interactionData)

A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject for this callback to be fired, the mouse's left button must have been pressed down over the displayObject

Parameters:

Name	Type	Description
interactionData	PIXI.InteractionData	-

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

rightclick(interactionData)

A callback that is used when the users clicks on the displayObject with their mouse's right button

Parameters:

Name	Type	Description
interactionData	PIXI.InteractionData	-

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

rightdown(interactionData)

A callback that is used when the user clicks the mouse's right button down over the sprite

Parameters:

Name	Type	Description
interactionData	PIXI.InteractionData	-

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

rightup(interactionData)

A callback that is used when the user releases the mouse's right button that was over the displayObject for this callback to be fired the mouse's right button must have been pressed down over the displayObject

Parameters:

Name	Type	Description
interactionData	PIXI.InteractionData	-

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

rightupoutside(interactionData)

A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject for this callback to be fired, the mouse's right button must have been pressed down over the displayObject

Parameters:

Name	Type	Description
interactionData	PIXI.InteractionData	-

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

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

tap(interactionData)

A callback that is used when the users taps on the sprite with their finger basically a touch version of click

Parameters:

Name	Type	Description
interactionData	PIXI.InteractionData	-

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

toGlobal(position) → {PIXI.Point}

Calculates the global position of the display object

Parameters:

Name	Type	Description
position	PIXI.Point	The world origin to calculate from

Returns:

PIXI.Point -

A point object representing the position of this object

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

toLocal(position, from) → {PIXI.Point}

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

Parameters:

Name	Type	Argument	Description
position	PIXI.Point		The world origin to calculate from
from	PIXI.DisplayObject	<optional>	The DisplayObject to calculate the global position from

Returns:

PIXI.Point -

A point object representing the position of this object

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

touchend(interactionData)

A callback that is used when the user releases a touch over the displayObject

Parameters:

Name	Type	Description
interactionData	PIXI.InteractionData	-

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

touchendoutside(interactionData)

A callback that is used when the user releases the touch that was over the displayObject for this callback to be fired, The touch must have started over the sprite

Parameters:

Name	Type	Description
interactionData	PIXI.InteractionData	-

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

touchstart(interactionData)

A callback that is used when the user touches over the displayObject

Parameters:

Name	Type	Description
interactionData	PIXI.InteractionData	-

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

updateCache()

Generates and updates the cached sprite for this object.

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