PIXI.TilingSprite

class TilingSprite extends PIXI.Sprite

A tiling sprite is a fast way of rendering a tiling image.

Constructor

new PIXI.TilingSprite(texture: PIXI.Texture, width: number, height: number) → {}

Parameters:
Name	Type	Default	Description
texture	PIXI.Texture		The texture of the tiling sprite.
width	number	100	The width of the tiling sprite.
height	number	100	The height of the tiling sprite.

Summary

Properties from TilingSprite

number	clampMargin = 0.5
number	height The height of the TilingSprite, setting this will actually modify the scale to achieve the value set.
string	pluginName = 'tilingSprite'
PIXI.ObservablePoint	tilePosition The offset of the image that is being tiled.
PIXI.ObservablePoint	tileScale The scaling of the image that is being tiled.
PIXI.Transform	tileTransform Tile transform
PIXI.TextureMatrix	uvMatrix Matrix that is applied to UV to get the coords in Texture normalized space to coords in BaseTexture space.
boolean	uvRespectAnchor = false
number	width The width of the sprite, setting this will actually modify the scale to achieve the value set.

Methods from TilingSprite

PIXI.TilingSprite	static from(source: string \| PIXI.Texture \| HTMLCanvasElement \| HTMLVideoElement, options: object)
boolean	containsPoint(point: IPointData)
void	destroy(options: object \| boolean)
PIXI.Rectangle	getLocalBounds(rect: PIXI.Rectangle)
void	protected _calculateBounds() Updates the bounds of the tiling sprite.
void	protected _onTextureUpdate()
void	protected _render(renderer: PIXI.Renderer)

Properties inherited from Sprite

PIXI.ObservablePoint	anchor
PIXI.BLEND_MODES	blendMode = PIXI.BLEND_MODES.NORMAL
boolean	isSprite = true
boolean	roundPixels = false If true PixiJS will Math.floor() x/y values when rendering, stopping pixel interpolation.
PIXI.Texture	texture The texture that the sprite is using.
number	tint = 0xFFFFFF The tint applied to the sprite. This is a hex value.
PIXI.ObservablePoint	protected _anchor = `this.texture.defaultAnchor`
number	protected _cachedTint = 0xFFFFFF
number	protected _height
HTMLCanvasElement	protected _tintedCanvas = undefined
number	protected _width
Float32Array	protected uvs
Float32Array	protected vertexData

Properties inherited from Container

T[]	children
boolean	interactiveChildren = true
boolean	sortableChildren
boolean	sortDirty Should children be sorted by zIndex at the next updateTransform call.

Properties inherited from DisplayObject

boolean	_accessibleActive = false
boolean	_accessibleDiv = undefined
PIXI.Bounds	_bounds The bounds object, this is used to calculate and store the bounds of the displayObject.
PIXI.Bounds	_localBounds Local bounds object, swapped with `_bounds` when using `getLocalBounds()`.
boolean	accessible = false
boolean	accessibleChildren = true
string	accessibleHint = undefined
string	accessiblePointerEvents = 'auto'
?string	accessibleTitle = undefined
string	accessibleType = 'button'
number	alpha The opacity of the object.
number	angle
boolean	buttonMode
boolean	cacheAsBitmap
number	cacheAsBitmapMultisample = PIXI.MSAA_QUALITY.NONE
number	cacheAsBitmapResolution = null
boolean	cullable Should this object be rendered if the bounds of this object are out of frame?
PIXI.Rectangle	cullArea
string	cursor = undefined
boolean	destroyed Readonly flag for destroyed display objects.
PIXI.Rectangle	filterArea
PIXI.Filter[] \| null	filters
PIXI.IHitArea	hitArea = undefined
boolean	interactive = false
boolean	isMask Does any other displayObject use this object as a mask?
PIXI.Matrix	localTransform
PIXI.Container \| PIXI.MaskData \| null	mask
string	name = undefined
PIXI.Container	parent The display object container that contains this display object.
PIXI.ObservablePoint	pivot
PIXI.ObservablePoint	position
boolean	renderable
number	rotation
PIXI.ObservablePoint	scale The scale factors of this object along the local coordinate axes.
PIXI.ObservablePoint	skew
PIXI.DisplayObject	smartMask = undefined
PIXI.Transform	transform
boolean	visible
number	worldAlpha
PIXI.Matrix	worldTransform
boolean	worldVisible
number	x
number	y
number	zIndex The zIndex of the displayObject.
number	protected _boundsID Flags the cached bounds as dirty.
PIXI.Rectangle	protected _boundsRect Cache of this display-object's bounds-rectangle.
boolean	protected _destroyed If the object has been destroyed via destroy(). If true, it should not be used.
PIXI.Filter[]	protected _enabledFilters
number	protected _lastSortedIndex
PIXI.Rectangle	protected _localBoundsRect Cache of this display-object's local-bounds rectangle.
PIXI.Container \| PIXI.MaskData	protected _mask
PIXI.Container	protected _tempDisplayObjectParent
number	protected _zIndex

Methods inherited from Sprite

void

calculateTrimmedVertices()

Calculates worldTransform * vertices for a non texture with a trim. store it in vertexTrimmedData.

void

calculateVertices()

Calculates worldTransform * vertices, store it in vertexData.

Methods inherited from Container

PIXI.DisplayObject	addChild(children: PIXI.DisplayObject) Adds one or more children to the container.
PIXI.DisplayObject	addChildAt(child: PIXI.DisplayObject, index: number)
void	calculateBounds() Recalculates the bounds of the container.
	containerUpdateTransform()
T	getChildAt(index: number)
PIXI.DisplayObject	getChildByName(name: string, deep: boolean) Returns the display object in the container.
number	getChildIndex(child: T)
PIXI.DisplayObject	removeChild(children: PIXI.DisplayObject)
T	removeChildAt(index: number)
T[]	removeChildren(beginIndex: number, endIndex)
void	render(renderer: PIXI.Renderer) Renders the object using the WebGL renderer.
void	renderCanvas(renderer: PIXI.CanvasRenderer)
void	setChildIndex(child: T, index: number)
void	sortChildren() Sorts children by zIndex. Previous order is maintained for 2 children with the same zIndex.
void	swapChildren(child: T, child2: T)
void	updateTransform() Updates the transform on all children of this container for rendering.
void	protected _renderWithCulling(renderer: PIXI.Renderer)
void	protected onChildrenChange(_length: number)
void	protected renderAdvanced(renderer: PIXI.Renderer)

Methods inherited from DisplayObject

	addEventListener(type: string, listener: EventListenerOrEventListenerObject, options: boolean \| AddEventListenerOptions)
void	disableTempParent(cacheParent: PIXI.Container)
boolean	dispatchEvent(e: Event) Dispatch the event on this PIXI.DisplayObject using the event's PIXI.EventBoundary.
	displayObjectUpdateTransform()
PIXI.Container	enableTempParent() Used in Renderer, cacheAsBitmap and other places where you call an `updateTransform` on root
PIXI.Rectangle	getBounds(skipUpdate: boolean, rect: PIXI.Rectangle) Calculates and returns the (world) bounds of the display object as a Rectangle.
PIXI.Point	getGlobalPosition(point: PIXI.Point, skipUpdate: boolean)
	removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options: boolean \| AddEventListenerOptions)
PIXI.Container	setParent(container: PIXI.Container)
this	setTransform(x: number, y: number, scaleX: number, scaleY: number, rotation: number, skewX: number, skewY: number, pivotX: number, pivotY: number)
P	toGlobal(position: IPointData, point: P, skipUpdate: boolean)
P	toLocal(position: IPointData, from: PIXI.DisplayObject, point: P, skipUpdate: boolean)
PIXI.Rectangle	updateSmartMask(recursive: boolean, skipUpdate: boolean)
void	protected _recursivePostUpdateTransform() Recursively updates transform of all objects from the root to this one internal function for toLocal()

Inherited Events from Container

childAdded

Inherited Events from DisplayObject

	added
	childRemoved
	click
	clickcapture Capture phase equivalent of `click`.
	destroyed
	mousedown
	mousedowncapture Capture phase equivalent of `mousedown`.
	mouseenter Fired when the mouse pointer is moved over a DisplayObject and its descendant's hit testing boundaries.
	mouseentercapture Capture phase equivalent of `mouseenter`
	mouseleave Fired when the mouse pointer exits a DisplayObject and its descendants.
	mouseleavecapture Capture phase equivalent of `mouseleave`.
	mousemove
	mousemovecature Capture phase equivalent of `mousemove`.
	mouseout
	mouseoutcapture Capture phase equivalent of `mouseout`.
	mouseover
	mouseovercapture Capture phase equivalent of `mouseover`.
	mouseup
	mouseupcature Capture phase equivalent of `mouseup`.
	mouseupoutside
	mouseupoutsidecapture Capture phase equivalent of `mouseupoutside`.
	pointercancel
	pointercancelcapture Capture phase equivalent of `pointercancel`.
	pointerdown
	pointerdowncapture Capture phase equivalent of `pointerdown`.
	pointerenter Fired when the pointer is moved over a DisplayObject and its descendant's hit testing boundaries.
	pointerentercapture Capture phase equivalent of `pointerenter`
	pointerleave Fired when the pointer leaves the hit testing boundaries of a DisplayObject and its descendants.
	pointerleavecapture Capture phase equivalent of `pointerleave`.
	pointermove
	pointermovecapture Capture phase equivalent of `pointermove`.
	pointerout
	pointeroutcapture Capture phase equivalent of `pointerout`.
	pointerover
	pointerovercapture Capture phase equivalent of `pointerover`.
	pointertap
	pointertapcapture Capture phase equivalent of `pointertap`.
	pointerup
	pointerupcapture Capture phase equivalent of `pointerup`.
	pointerupoutside
	pointerupoutsidecapture Capture phase equivalent of `pointerupoutside`.
	removed
	rightclick
	rightclickcapture Capture phase equivalent of `rightclick`.
	rightdown
	rightdowncapture Capture phase equivalent of `rightdown`.
	rightup
	rightupcapture Capture phase equivalent of `rightup`.
	rightupoutside
	rightupoutsidecapture Capture phase equivalent of `rightupoutside`.
	tap
	tapcapture Capture phase equivalent of `tap`.
	touchcancel
	touchcancelcapture Capture phase equivalent of `touchcancel`.
	touchend
	touchendcapture Capture phase equivalent of `touchend`.
	touchendoutside
	touchendoutsidecapture Capture phase equivalent of `touchendoutside`.
	touchmove
	touchmovecapture Capture phase equivalent of `touchmove`.
	touchstart
	touchstartcapture Capture phase equivalent of `touchstart`.
PIXI.FederatedWheelEvent	wheel Fired when a the user scrolls with the mouse cursor over a DisplayObject.
PIXI.FederatedWheelEvent	wheelcapture Capture phase equivalent of `wheel`.

Public Properties

clampMargin TilingSprite.ts:63

clampMargin: number = 0.5

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

height TilingSprite.ts:254

height: number

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

pluginName TilingSprite.ts:54

pluginName: string = 'tilingSprite'

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

tilePosition TilingSprite.ts:91

tilePosition: PIXI.ObservablePoint

The offset of the image that is being tiled.

tileScale TilingSprite.ts:80

tileScale: PIXI.ObservablePoint

The scaling of the image that is being tiled.

tileTransform TilingSprite.ts:19

tileTransform: PIXI.Transform

Tile transform

uvMatrix TilingSprite.ts:22

uvMatrix: PIXI.TextureMatrix

Matrix that is applied to UV to get the coords in Texture normalized space to coords in BaseTexture space.

uvRespectAnchor TilingSprite.ts:25

uvRespectAnchor: boolean = false

Flags whether the tiling pattern should originate from the origin instead of the top-left corner in local space.

This will make the texture coordinates assigned to each vertex dependent on the value of the anchor. Without this, the top-left corner always gets the (0, 0) texture coordinate.

width TilingSprite.ts:243

width: number

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

Public Methods

from TilingSprite.ts:220

static from(source: string | PIXI.Texture | HTMLCanvasElement | HTMLVideoElement, options: object) → {PIXI.TilingSprite}

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

Parameters:
Name	Type	Description
source	string \| PIXI.Texture \| HTMLCanvasElement \| HTMLVideoElement	Source to create texture from
options	object	See PIXI.BaseTexture's constructor for options.
options.width	number	required width of the tiling sprite
options.height	number	required height of the tiling sprite

Returns:
Type	Description
PIXI.TilingSprite	The newly created texture

containsPoint TilingSprite.ts:177

containsPoint(point: IPointData) → {boolean}

Checks if a point is inside this tiling sprite.

Parameters:
Name	Type	Description
point	IPointData	The point to check.

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

destroy TilingSprite.ts:203

destroy(options: object | boolean) → {void}

Destroys this sprite and optionally its texture and children

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

Returns:
Type	Description
void

getLocalBounds TilingSprite.ts:146

getLocalBounds(rect: PIXI.Rectangle) → {PIXI.Rectangle}

Gets the local bounds of the sprite object.

Parameters:
Name	Type	Attributes	Description
rect	PIXI.Rectangle	<optional>	Optional output rectangle.

Returns:
Type	Description
PIXI.Rectangle	The bounds.

Protected Methods

_calculateBounds TilingSprite.ts:135

protected _calculateBounds() → {void}

Updates the bounds of the tiling sprite.

Returns:
Type	Description
void

_onTextureUpdate TilingSprite.ts:102

protected _onTextureUpdate() → {void}

Returns:
Type	Description
void

_render TilingSprite.ts:114

protected _render(renderer: PIXI.Renderer) → {void}

Renders the object using the WebGL renderer

Parameters:
Name	Type	Description
renderer	PIXI.Renderer	The renderer

Returns:
Type	Description
void

_renderCanvas TilingSprite.ts:12

protected _renderCanvas(renderer: PIXI.CanvasRenderer) → {void}

Renders the object using the Canvas renderer

Parameters:
Name	Type	Description
renderer	PIXI.CanvasRenderer	a reference to the canvas renderer

Returns:
Type	Description
void