Extends

• PIXI.DisplayObjectContainer

Public Properties

alpha : number

The opacity of the object.

Inherited From

• PIXI.DisplayObject#alpha

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

anchor :Point

The anchor sets the origin point of the texture. The default is 0,0 this means the texture's origin is the top left Setting than anchor to 0.5,0.5 means the textures origin is centered Setting the anchor to 1,1 would mean the textures origin points will be the bottom right corner

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

blendMode : number

The blend mode to be applied to the sprite. Set to PIXI.blendModes.NORMAL to remove any blend mode.

Warning: You cannot have a blend mode and a filter active on the same Sprite. Doing so will render the sprite invisible.

Default Value

• PIXI.blendModes.NORMAL;

Source code: pixi/display/Sprite.js (Line 87)

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'

Inherited From

• PIXI.DisplayObject#cacheAsBitmap

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

[readonly] children : Array.<DisplayObject>

[read-only] The array of children of this container.

Type

• Array.<DisplayObject>

Inherited From

• PIXI.DisplayObjectContainer#children

Source code: pixi/display/DisplayObjectContainer.js (Line 17)

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

Inherited From

• PIXI.DisplayObject#filterArea

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

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

You cannot have a filter and a multiply blend mode active at the same time. Setting a filter will reset this objects blend mode to NORMAL.

Type

• Array.<Filter>

Inherited From

• PIXI.DisplayObject#filters

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

height : number

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

Source code: pixi/display/Sprite.js (Line 139)

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

Inherited From

• PIXI.DisplayObject#hitArea

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

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.

Inherited From

• PIXI.DisplayObject#mask

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

[readonly] parent : PIXI.DisplayObjectContainer

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

Inherited From

• PIXI.DisplayObject#parent

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

pivot :Point

The pivot point of the displayObject that it rotates around

Inherited From

• PIXI.DisplayObject#pivot

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

position :Point

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

Inherited From

• PIXI.DisplayObject#position

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

renderable : boolean

Can this object be rendered

Inherited From

• PIXI.DisplayObject#renderable

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

rotation : number

The rotation of the object in radians.

Inherited From

• PIXI.DisplayObject#rotation

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

scale :Point

The scale factor of the object.

Inherited From

• PIXI.DisplayObject#scale

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

shader : PIXI.AbstractFilter

The shader that will be used to render the texture to the stage. Set to null to remove a current shader.

Default Value

• null

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

[readonly] stage :Stage

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

Inherited From

• PIXI.DisplayObject#stage

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

texture : PIXI.Texture

The texture that the sprite is using

Source code: pixi/display/Sprite.js (Line 33)

tint : number

The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.

Default Value

• 0xFFFFFF

Source code: pixi/display/Sprite.js (Line 59)

tintedTexture :Canvas

A canvas that contains the tinted version of the Sprite (in Canvas mode, WebGL doesn't populate this)

Default Value

• null

Source code: pixi/display/Sprite.js (Line 78)

visible : boolean

The visibility of the object.

Inherited From

• PIXI.DisplayObject#visible

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

width : number

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

Source code: pixi/display/Sprite.js (Line 120)

[readonly] worldAlpha : number

[read-only] The multiplied alpha of the displayObject

Inherited From

• PIXI.DisplayObject#worldAlpha

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

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

Inherited From

• PIXI.DisplayObject#worldPosition

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

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

Inherited From

• PIXI.DisplayObject#worldRotation

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

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

Inherited From

• PIXI.DisplayObject#worldScale

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

worldVisible : boolean

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

Inherited From

• PIXI.DisplayObject#worldVisible

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

x : number

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

Inherited From

• PIXI.DisplayObject#x

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

y : number

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

Inherited From

• PIXI.DisplayObject#y

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

Public Methods

<static> fromFrame(frameId) → {PIXI.Sprite}

Helper function that creates a sprite that will contain a texture from the TextureCache based on the frameId The frame ids are created when a Texture packer file has been loaded

Parameters

Name	Type	Description
frameId	String	The frame Id of the texture in the cache

Returns

PIXI.Sprite -

A new Sprite using a texture from the texture cache matching the frameId

Source code: pixi/display/Sprite.js (Line 473)

<static> fromImage(imageId) → {PIXI.Sprite}

Helper function that creates a sprite that will contain a texture based on an image url If the image is not in the texture cache it will be loaded

Parameters

Name	Type	Description
imageId	String	The image url of the texture

Returns

PIXI.Sprite -

A new Sprite using a texture from the texture cache matching the image id

Source code: pixi/display/Sprite.js (Line 492)

addChild(child) → {PIXI.DisplayObject}

Adds a child to the container.

Parameters

Name	Type	Description
child	PIXI.DisplayObject	The DisplayObject to add to the container

Returns

PIXI.DisplayObject -

The child that was added.

Inherited From

• PIXI.DisplayObjectContainer#addChild

Source code: pixi/display/DisplayObjectContainer.js (Line 91)

addChildAt(child, index) → {PIXI.DisplayObject}

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

Parameters

Name	Type	Description
child	PIXI.DisplayObject	The child to add
index	Number	The index to place the child in

Returns

PIXI.DisplayObject -

The child that was added.

Inherited From

• PIXI.DisplayObjectContainer#addChildAt

Source code: pixi/display/DisplayObjectContainer.js (Line 103)

destroy()

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

Inherited From

• PIXI.DisplayObject#destroy

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

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

Inherited From

• PIXI.DisplayObject#generateTexture

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

getBounds(matrix) → {Rectangle}

Returns the bounds of the Sprite as a rectangle. The bounds calculation takes the worldTransform into account.

Parameters

Name	Type	Description
matrix	Matrix	the transformation matrix of the sprite

Returns

Rectangle -

the framing rectangle

Source code: pixi/display/Sprite.js (Line 191)

getChildAt(index) → {PIXI.DisplayObject}

Returns the child at the specified index

Parameters

Name	Type	Description
index	Number	The index to get the child from

Returns

PIXI.DisplayObject -

The child at the given index, if any.

Inherited From

• PIXI.DisplayObjectContainer#getChildAt

Source code: pixi/display/DisplayObjectContainer.js (Line 194)

getChildIndex(child) → {Number}

Returns the index position of a child DisplayObject instance

Parameters

Name	Type	Description
child	PIXI.DisplayObject	The DisplayObject instance to identify

Returns

Number -

The index position of the child display object to identify

Inherited From

• PIXI.DisplayObjectContainer#getChildIndex

Source code: pixi/display/DisplayObjectContainer.js (Line 159)

getLocalBounds() → {Rectangle}

Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.

Returns

Rectangle -

The rectangular bounding area

Inherited From

• PIXI.DisplayObjectContainer#getLocalBounds

Source code: pixi/display/DisplayObjectContainer.js (Line 367)

preUpdate()

Empty, to be overridden by classes that require it.

Inherited From

• PIXI.DisplayObject#preUpdate

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

removeChild(child) → {PIXI.DisplayObject}

Removes a child from the container.

Parameters

Name	Type	Description
child	PIXI.DisplayObject	The DisplayObject to remove

Returns

PIXI.DisplayObject -

The child that was removed.

Inherited From

• PIXI.DisplayObjectContainer#removeChild

Source code: pixi/display/DisplayObjectContainer.js (Line 211)

removeChildAt(index) → {PIXI.DisplayObject}

Removes a child from the specified index position.

Parameters

Name	Type	Description
index	Number	The index to get the child from

Returns

PIXI.DisplayObject -

The child that was removed.

Inherited From

• PIXI.DisplayObjectContainer#removeChildAt

Source code: pixi/display/DisplayObjectContainer.js (Line 226)

removeChildren(beginIndex, endIndex)

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

Parameters

Name	Type	Description
beginIndex	Number	The beginning position. Default value is 0.
endIndex	Number	The ending position. Default value is size of the container.

Inherited From

• PIXI.DisplayObjectContainer#removeChildren

Source code: pixi/display/DisplayObjectContainer.js (Line 244)

removeStageReference()

Removes the current stage reference from the container and all of its children.

Inherited From

• PIXI.DisplayObjectContainer#removeStageReference

Source code: pixi/display/DisplayObjectContainer.js (Line 407)

setChildIndex(child, index)

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

Parameters

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

Inherited From

• PIXI.DisplayObjectContainer#setChildIndex

Source code: pixi/display/DisplayObjectContainer.js (Line 176)

setStageReference(stage)

Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.

Parameters

Name	Type	Description
stage	Stage	the stage that the container will have as its current stage reference

Inherited From

• PIXI.DisplayObjectContainer#setStageReference

Source code: pixi/display/DisplayObjectContainer.js (Line 391)

setTexture(texture, destroy)

Sets the texture of the sprite. Be warned that this doesn't remove or destroy the previous texture this Sprite was using.

Parameters

Name	Type	Argument	Default	Description
texture	PIXI.Texture			The PIXI texture that is displayed by the sprite
destroy	Boolean	<optional>	false	Call Texture.destroy on the current texture before replacing it with the new one?

Source code: pixi/display/Sprite.js (Line 158)

swapChildren(child, child2)

Swaps the position of 2 Display Objects within this container.

Parameters

Name	Type	Description
child	PIXI.DisplayObject	-
child2	PIXI.DisplayObject	-

Inherited From

• PIXI.DisplayObjectContainer#swapChildren

Source code: pixi/display/DisplayObjectContainer.js (Line 134)

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

Inherited From

• PIXI.DisplayObject#toGlobal

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

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

Inherited From

• PIXI.DisplayObject#toLocal

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

updateCache()

Generates and updates the cached sprite for this object.

Inherited From

• PIXI.DisplayObject#updateCache

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