Class: TilingSprite

Extends

• PIXI.Sprite

Members

alpha number inherited

The opacity of the object.

anchor PIXI.ObservablePoint inherited

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 the anchor to 0.5,0.5 means the texture's origin is centered Setting the anchor to 1,1 would mean the texture's origin point will be the bottom right corner

blendMode number inherited

The blend mode to be applied to the sprite. Apply a value of PIXI.BLEND_MODES.NORMAL to reset the blend mode.

Default Value:

• PIXI.BLEND_MODES.NORMAL

See:

• PIXI.BLEND_MODES

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.

children Array.<PIXI.DisplayObject> readonly inherited

The array of children of this container.

clampMargin number

Changes frame clamping in corresponding textureTransform, shortcut Change to -0.5 to add a pixel to the edge, recommended for transparent trimmed textures in atlas

Default Value:

• 0.5

cursor string inherited

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

See:

• https://developer.mozilla.org/en/docs/Web/CSS/cursor

Example

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

filterArea PIXI.Rectangle inherited

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

Also works as an interaction mask

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'

height number overrides

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

hitArea PIXI.Rectangle | PIXI.Circle | PIXI.Ellipse | PIXI.Polygon | PIXI.RoundedRectangle inherited

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.

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.

Example

const sprite = new PIXI.Sprite(texture);
sprite.interactive = true;
sprite.on('tap', (event) => {
   //handle event
});

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

localTransform PIXI.Matrix readonly inherited

Current transform of the object based on local factors: position, scale, other stuff

mask PIXI.Graphics | PIXI.Sprite inherited

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

TODO

• For the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.

name string inherited

The instance name of the object.

parent PIXI.Container readonly inherited

The display object container that contains this display object.

pivot PIXI.Point | PIXI.ObservablePoint inherited

The pivot point of the displayObject that it rotates around Assignment by value since pixi-v4.

pluginName string overrides

Plugin that is responsible for rendering this element. Allows to customize the rendering process without overriding '_renderWebGL' method.

Default Value:

• 'tilingSprite'

position PIXI.Point | PIXI.ObservablePoint inherited

The coordinate of the object relative to the local coordinates of the parent. Assignment by value since pixi-v4.

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

rotation number inherited

The rotation of the object in radians.

scale PIXI.Point | PIXI.ObservablePoint inherited

The scale factor of the object. Assignment by value since pixi-v4.

shader PIXI.Filter | PIXI.Shader inherited

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

skew PIXI.ObservablePoint inherited

The skew factor for the object in radians. Assignment by value since pixi-v4.

texture PIXI.Texture inherited

The texture that the sprite is using

tilePosition PIXI.ObservablePoint

The offset of the image that is being tiled

tileScale PIXI.ObservablePoint

The scaling of the image that is being tiled

tileTransform PIXI.TransformStatic

Tile transform

tint number inherited

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

Default Value:

• 0xFFFFFF

transform PIXI.TransformBase inherited

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

uvRespectAnchor boolean

Whether or not anchor affects uvs

Default Value:

• false

uvTransform PIXI.TextureMatrix

transform that is applied to UV to get the texture coords

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

width number overrides

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

worldAlpha number readonly inherited

The multiplied alpha of the displayObject

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

Methods

PIXI.extras.TilingSprite.from (source, width, height)PIXI.Texture static

TilingSprite.js:353

Helper function that creates a new tiling sprite based on the source you provide. The source can be - frame id, image url, video url, canvas element, video element, base texture

Name	Type	Description
source	number | string | PIXI.BaseTexture | HTMLCanvasElement | HTMLVideoElement	Source to create texture from
width	number	the width of the tiling sprite
height	number	the height of the tiling sprite

Returns:

Type	Description
PIXI.Texture	The newly created texture

PIXI.extras.TilingSprite.fromFrame (frameId, width, height)PIXI.extras.TilingSprite static

TilingSprite.js:368

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

Name	Type	Description
frameId	string	The frame Id of the texture in the cache
width	number	the width of the tiling sprite
height	number	the height of the tiling sprite

Returns:

Type	Description
PIXI.extras.TilingSprite	A new TilingSprite using a texture from the texture cache matching the frameId

PIXI.extras.TilingSprite.fromImage (imageId, width, height, crossorigin, scaleMode)PIXI.extras.TilingSprite static

TilingSprite.js:393

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

Name	Type	Default	Description
imageId	string		The image url of the texture
width	number		the width of the tiling sprite
height	number		the height of the tiling sprite
crossorigin	boolean		optional if you want to specify the cross-origin parameter
scaleMode	number	PIXI.settings.SCALE_MODE	optional if you want to specify the scale mode, see PIXI.SCALE_MODES for possible values

Returns:

Type	Description
PIXI.extras.TilingSprite	A new TilingSprite using a texture from the texture cache matching the image id

_recursivePostUpdateTransform () inherited

DisplayObject.js:174

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

addChild (child)PIXI.DisplayObject inherited

Container.js:55

Adds one or more children to the container.

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

Name	Type	Description
child	PIXI.DisplayObject	repeatable 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.js:101

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 () inherited

Container.js:345

Recalculates the bounds of the container.

calculateTrimmedVertices () inherited

Sprite.js:246

calculates worldTransform * vertices for a non texture with a trim. store it in vertexTrimmedData This is used to ensure that the true width and height of a trimmed texture is respected

calculateVertices () inherited

Sprite.js:176

calculates worldTransform * vertices, store it in vertexData

containsPoint (point)boolean overrides

TilingSprite.js:304

Checks if a point is inside this tiling sprite.

Name	Type	Description
point	PIXI.Point	the point to check

Returns:

Type	Description
boolean	Whether or not the sprite contains the point.

destroy (options) overrides

TilingSprite.js:335

Destroys this sprite and optionally its texture and children

Name	Type	Description
options	object | boolean	optional Options parameter. A boolean will act as if all options have been set to that value Name Type Default Description children boolean false optional if set to true, all the children will have their destroy method called as well. 'options' will be passed on to those calls. texture boolean false optional Should it destroy the current texture of the sprite as well baseTexture boolean false optional Should it destroy the base texture of the sprite as well

getBounds (skipUpdate, rect)PIXI.Rectangle inherited

DisplayObject.js:196

Retrieves the bounds of the displayObject as a rectangle object.

Name	Type	Description
skipUpdate	boolean	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 rectangle to store the result of the bounds calculation

Returns:

Type	Description
PIXI.Rectangle	the rectangular bounding area

getChildAt (index)PIXI.DisplayObject inherited

Container.js:195

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)PIXI.DisplayObject inherited

getChildByName.js:11

Returns the display object in the container

Name	Type	Description
name	string	instance name

Returns:

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

getChildIndex (child)number inherited

Container.js:156

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

getGlobalPosition (point, skipUpdate)Point inherited

getGlobalPosition.js:3

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

Name	Type	Description
point	Point	the point to write the global value to. If null a new point will be returned
skipUpdate	boolean	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
Point	The updated point

getLocalBounds (rect)PIXI.Rectangle overrides

TilingSprite.js:272

Gets the local bounds of the sprite object.

Name	Type	Description
rect	PIXI.Rectangle	The output rectangle.

Returns:

Type	Description
PIXI.Rectangle	The bounds.

removeChild (child)PIXI.DisplayObject inherited

Container.js:211

Removes one or more children from the container.

Name	Type	Description
child	PIXI.DisplayObject	repeatable The DisplayObject(s) to remove

Returns:

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

removeChildAt (index)PIXI.DisplayObject inherited

Container.js:253

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.<DisplayObject> inherited

Container.js:279

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

Name	Type	Default	Description
beginIndex	number	0	optional The beginning position.
endIndex	number	this.children.length	optional The ending position. Default value is size of the container.

Returns:

Type	Description
Array.<DisplayObject>	List of removed children

renderCanvas (renderer) inherited

Container.js:512

Renders the object using the Canvas renderer

Name	Type	Description
renderer	PIXI.CanvasRenderer	The renderer

renderWebGL (renderer) inherited

Container.js:396

Renders the object using the WebGL renderer

Name	Type	Description
renderer	PIXI.WebGLRenderer	The renderer

setChildIndex (child, index) inherited

Container.js:174

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

setParent (container)PIXI.Container inherited

DisplayObject.js:363

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.js:389

Convenience function to set the position, scale, skew and pivot at once.

Name	Type	Default	Description
x	number	0	optional The X position
y	number	0	optional The Y position
scaleX	number	1	optional The X scale value
scaleY	number	1	optional The Y scale value
rotation	number	0	optional The rotation
skewX	number	0	optional The X skew value
skewY	number	0	optional The Y skew value
pivotX	number	0	optional The X pivot value
pivotY	number	0	optional The Y pivot value

Returns:

Type	Description
PIXI.DisplayObject	The DisplayObject instance

swapChildren (child, child2) inherited

Container.js:135

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

toGlobal (position, point, skipUpdate)PIXI.Point inherited

DisplayObject.js:272

Calculates the global position of the display object

Name	Type	Default	Description
position	PIXI.Point		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	false	optional 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.js:307

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

Name	Type	Default	Description
position	PIXI.Point		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	false	optional Should we skip the update transform

Returns:

Type	Description
PIXI.Point	A point object representing the position of this object

updateTransform () inherited

Container.js:321

Updates the transform on all children of this container for rendering

Events

added inherited

DisplayObject.js:127

Fired when this DisplayObject is added to a Container.

Name	Type	Description
container	PIXI.Container	The container added to.

click inherited

InteractionManager.js:476

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.

Name	Type	Description
event	PIXI.interaction.InteractionEvent	Interaction event

mousedown inherited

InteractionManager.js:444

Fired when a pointer device button (usually a mouse left-button) is pressed on the display. object. DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
event	PIXI.interaction.InteractionEvent	Interaction event

mousemove inherited

InteractionManager.js:512

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.

Name	Type	Description
event	PIXI.interaction.InteractionEvent	Interaction event

mouseout inherited

InteractionManager.js:528

Fired when a pointer device (usually a mouse) is moved off the display object. DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
event	PIXI.interaction.InteractionEvent	Interaction event

mouseover inherited

InteractionManager.js:520

Fired when a pointer device (usually a mouse) is moved onto the display object. DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
event	PIXI.interaction.InteractionEvent	Interaction event

mouseup inherited

InteractionManager.js:460

Fired when a pointer device button (usually a mouse left-button) is released over the display object. DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
event	PIXI.interaction.InteractionEvent	Interaction event

mouseupoutside inherited

InteractionManager.js:492

Fired when a pointer device button (usually a mouse left-button) is released outside the display object that initially registered a mousedown. DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
event	PIXI.interaction.InteractionEvent	Interaction event

pointercancel inherited

InteractionManager.js:552

Fired when the operating system cancels a pointer event. DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
event	PIXI.interaction.InteractionEvent	Interaction event

pointerdown inherited

InteractionManager.js:536

Fired when a pointer device button is pressed on the display object. DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
event	PIXI.interaction.InteractionEvent	Interaction event

pointermove inherited

InteractionManager.js:577

Fired when a pointer device is moved while over the display object. DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
event	PIXI.interaction.InteractionEvent	Interaction event

pointerout inherited

InteractionManager.js:593

Fired when a pointer device is moved off the display object. DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
event	PIXI.interaction.InteractionEvent	Interaction event

pointerover inherited

InteractionManager.js:585

Fired when a pointer device is moved onto the display object. DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
event	PIXI.interaction.InteractionEvent	Interaction event

pointertap inherited

InteractionManager.js:560

Fired when a pointer device button is pressed and released on the display object. DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
event	PIXI.interaction.InteractionEvent	Interaction event

pointerup inherited

InteractionManager.js:544

Fired when a pointer device button is released over the display object. DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
event	PIXI.interaction.InteractionEvent	Interaction event

pointerupoutside inherited

InteractionManager.js:568

Fired when a pointer device button is released outside the display object that initially registered a pointerdown. DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
event	PIXI.interaction.InteractionEvent	Interaction event

removed inherited

DisplayObject.js:134

Fired when this DisplayObject is removed from a Container.

Name	Type	Description
container	PIXI.Container	The container removed from.

rightclick inherited

InteractionManager.js:484

Fired when a pointer device secondary button (usually a mouse right-button) is pressed and released on the display object. DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
event	PIXI.interaction.InteractionEvent	Interaction event

rightdown inherited

InteractionManager.js:452

Fired when a pointer device secondary button (usually a mouse right-button) is pressed on the display object. DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
event	PIXI.interaction.InteractionEvent	Interaction event

rightup inherited

InteractionManager.js:468

Fired when a pointer device secondary button (usually a mouse right-button) is released over the display object. DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
event	PIXI.interaction.InteractionEvent	Interaction event

rightupoutside inherited

InteractionManager.js:502

Fired when a pointer device secondary button (usually a mouse right-button) is released outside the display object that initially registered a rightdown. DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
event	PIXI.interaction.InteractionEvent	Interaction event

tap inherited

InteractionManager.js:625

Fired when a touch point is placed and removed from the display object. DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
event	PIXI.interaction.InteractionEvent	Interaction event

touchcancel inherited

InteractionManager.js:617

Fired when the operating system cancels a touch. DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
event	PIXI.interaction.InteractionEvent	Interaction event

touchend inherited

InteractionManager.js:609

Fired when a touch point is removed from the display object. DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
event	PIXI.interaction.InteractionEvent	Interaction event

touchendoutside inherited

InteractionManager.js:633

Fired when a touch point is removed outside of the display object that initially registered a touchstart. DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
event	PIXI.interaction.InteractionEvent	Interaction event

touchmove inherited

InteractionManager.js:642

Fired when a touch point is moved along the display object. DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
event	PIXI.interaction.InteractionEvent	Interaction event

touchstart inherited

InteractionManager.js:601

Fired when a touch point is placed on the display object. DisplayObject's interactive property must be set to true to fire event.

Name	Type	Description
event	PIXI.interaction.InteractionEvent	Interaction event