new PIXI.extras.TilingSprite(texture, width, height)
| Name | Type | Default | Description |
|---|---|---|---|
texture |
PIXI.Texture |
the texture of the tiling sprite |
|
width |
number | 100 |
optional
the width of the tiling sprite |
height |
number | 100 |
optional
the height of the tiling sprite |
Extends
Members
-
anchor
-
Copies the anchor to the sprite.
-
cacheAsBitmapboolean
-
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' -
clampMargin
-
setter for clampMargin
-
filters
-
Shallow copies the array to the filters of the object.
-
height
-
Sets the width.
-
mask
-
Sets the mask.
-
pivot
-
Copies the point to the pivot of the object.
-
position
-
Copies the point to the position of the object.
-
rotation
-
Sets the rotation of the object.
-
scale
-
Copies the point to the scale of the object.
-
skew
-
Copies the point to the skew of the object.
-
texture
-
Sets the texture of the sprite.
-
tilePosition
-
Copies the point to the position of the tiled image.
-
tileScale
-
Copies the point to the scale of the tiled image.
-
tint
-
Sets the tint of the sprite.
-
width
-
Sets the width.
-
x
-
Sets the X position of the object.
-
y
-
Sets the Y position of the object.
Methods
-
staticPIXI.extras.TilingSprite.from(source, width, height){PIXI.Texture}
-
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 textureName Type Description sourcenumber | string | PIXI.BaseTexture | HTMLCanvasElement | HTMLVideoElement Source to create texture from
widthnumber the width of the tiling sprite
heightnumber the height of the tiling sprite
Returns:
Type Description PIXI.Texture The newly created texture -
staticPIXI.extras.TilingSprite.fromFrame(frameId, width, height){PIXI.extras.TilingSprite}
-
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 loadedName Type Description frameIdstring The frame Id of the texture in the cache
widthnumber the width of the tiling sprite
heightnumber 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 -
staticPIXI.extras.TilingSprite.fromImage(imageId, width, height, crossorigin, scaleMode){PIXI.extras.TilingSprite}
-
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 loadedName Type Default Description imageIdstring The image url of the texture
widthnumber the width of the tiling sprite
heightnumber the height of the tiling sprite
crossoriginboolean optional if you want to specify the cross-origin parameter
scaleModenumber PIXI.settings.SCALE_MODE optional if you want to specify the scale mode,
see PIXI.SCALE_MODES for possible valuesReturns:
Type Description PIXI.extras.TilingSprite A new TilingSprite using a texture from the texture cache matching the image id -
inherited _recursivePostUpdateTransform()
-
recursively updates transform of all objects from the root to this one
internal function for toLocal() -
inherited addChild(child){PIXI.DisplayObject}
-
Adds one or more children to the container.
Multiple items can be added like so:
myContainer.addChild(thingOne, thingTwo, thingThree)Name Type Description childPIXI.DisplayObject repeatable The DisplayObject(s) to add to the container
Returns:
Type Description PIXI.DisplayObject The first child that was added. -
inherited 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
Name Type Description childPIXI.DisplayObject The child to add
indexnumber The index to place the child in
Returns:
Type Description PIXI.DisplayObject The child that was added. -
inherited calculateBounds()
-
Recalculates the bounds of the container.
-
inherited calculateTrimmedVertices()
-
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 -
inherited calculateVertices()
-
calculates worldTransform * vertices, store it in vertexData
-
containsPoint(point){boolean}
-
Checks if a point is inside this tiling sprite.
Name Type Description pointPIXI.Point the point to check
Returns:
Type Description boolean Whether or not the sprite contains the point. -
destroy()
-
Destroys this tiling sprite
-
inherited getBounds(skipUpdate, rect){PIXI.Rectangle}
-
Retrieves the bounds of the displayObject as a rectangle object.
Name Type Description skipUpdateboolean 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 boostrectPIXI.Rectangle Optional rectangle to store the result of the bounds calculation
Returns:
Type Description PIXI.Rectangle the rectangular bounding area -
inherited getChildAt(index){PIXI.DisplayObject}
-
Returns the child at the specified index
Name Type Description indexnumber The index to get the child at
Returns:
Type Description PIXI.DisplayObject The child at the given index, if any. -
inherited getChildIndex(child){number}
-
Returns the index position of a child DisplayObject instance
Name Type Description childPIXI.DisplayObject The DisplayObject instance to identify
Returns:
Type Description number The index position of the child display object to identify -
getLocalBounds(rect){PIXI.Rectangle}
-
Gets the local bounds of the sprite object.
Name Type Description rectPIXI.Rectangle The output rectangle.
Returns:
Type Description PIXI.Rectangle The bounds. -
inherited removeChild(child){PIXI.DisplayObject}
-
Removes one or more children from the container.
Name Type Description childPIXI.DisplayObject repeatable The DisplayObject(s) to remove
Returns:
Type Description PIXI.DisplayObject The first child that was removed. -
inherited removeChildAt(index){PIXI.DisplayObject}
-
Removes a child from the specified index position.
Name Type Description indexnumber The index to get the child from
Returns:
Type Description PIXI.DisplayObject The child that was removed. -
inherited removeChildren(beginIndex, endIndex){Array.<DisplayObject>}
-
Removes all children from this container that are within the begin and end indexes.
Name Type Default Description beginIndexnumber 0 optional The beginning position.
endIndexnumber this.children.length optional The ending position. Default value is size of the container.
Returns:
Type Description Array.<DisplayObject> List of removed children -
inherited renderCanvas(renderer)
-
Renders the object using the Canvas renderer
Name Type Description rendererPIXI.CanvasRenderer The renderer
-
inherited renderWebGL(renderer)
-
Renders the object using the WebGL renderer
Name Type Description rendererPIXI.WebGLRenderer The renderer
-
inherited setChildIndex(child, index)
-
Changes the position of an existing child in the display object container
Name Type Description childPIXI.DisplayObject The child DisplayObject instance for which you want to change the index number
indexnumber The resulting index number for the child display object
-
inherited setParent(container){PIXI.Container}
-
Set the parent Container of this DisplayObject
Name Type Description containerPIXI.Container The Container to add this DisplayObject to
Returns:
Type Description PIXI.Container The Container that this DisplayObject was added to -
inherited setTransform(x, y, scaleX, scaleY, rotation, skewX, skewY, pivotX, pivotY){PIXI.DisplayObject}
-
Convenience function to set the position, scale, skew and pivot at once.
Name Type Default Description xnumber 0 optional The X position
ynumber 0 optional The Y position
scaleXnumber 1 optional The X scale value
scaleYnumber 1 optional The Y scale value
rotationnumber 0 optional The rotation
skewXnumber 0 optional The X skew value
skewYnumber 0 optional The Y skew value
pivotXnumber 0 optional The X pivot value
pivotYnumber 0 optional The Y pivot value
Returns:
Type Description PIXI.DisplayObject The DisplayObject instance -
inherited swapChildren(child, child2)
-
Swaps the position of 2 Display Objects within this container.
Name Type Description childPIXI.DisplayObject First display object to swap
child2PIXI.DisplayObject Second display object to swap
-
inherited toGlobal(position, point, skipUpdate){PIXI.Point}
-
Calculates the global position of the display object
Name Type Default Description positionPIXI.Point The world origin to calculate from
pointPIXI.Point optional A Point object in which to store the value, optional
(otherwise will create a new Point)skipUpdateboolean false optional Should we skip the update transform.
Returns:
Type Description PIXI.Point A point object representing the position of this object -
inherited toLocal(position, from, point, skipUpdate){PIXI.Point}
-
Calculates the local position of the display object relative to another point
Name Type Default Description positionPIXI.Point The world origin to calculate from
fromPIXI.DisplayObject optional The DisplayObject to calculate the global position from
pointPIXI.Point optional A Point object in which to store the value, optional
(otherwise will create a new Point)skipUpdateboolean false optional Should we skip the update transform
Returns:
Type Description PIXI.Point A point object representing the position of this object