A tiling sprite is a fast way of rendering a tiling image
| Name | Type | Description |
|---|---|---|
texture | PIXI.Texture | the texture of the tiling sprite |
width | Number | the width of the tiling sprite |
height | Number | the height of the tiling sprite |
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
The blend mode to be applied to the sprite
The CanvasBuffer object that the tiled texture is drawn to.
[read-only] The array of children of this container.
Controls if this Sprite is processed by the core Phaser game loops and Group loops.
The height of the tiling sprite
The height of the TilingSprite, setting this will actually modify the scale to achieve the value set
If ignoreChildInput is false it will allow this objects children to be considered as valid for Input events.
If this property is true then the children will not be considered as valid for Input events.
Note that this property isn't recursive: only immediate children are influenced, it doesn't scan further down.
If true the TilingSprite will run generateTexture on its next render pass.
This is set by the likes of Phaser.LoadTexture.setFrame.
Whether this sprite is renderable or not
The shader that will be used to render this Sprite.
Set to null to remove a current shader.
The texture that the sprite is using
If enabled a green rectangle will be drawn behind the generated tiling texture, allowing you to visually
debug the texture being used.
The Context fill pattern that is used to draw the TilingSprite in Canvas mode only (will be null in WebGL).
The offset position of the image that is being tiled
The scaling of the image that is being tiled
A point that represents the scale of the texture object
An internal Texture object that holds the tiling texture that was generated from TilingSprite.texture.
The tint applied to the sprite. This is a hex value
A canvas that contains the tinted version of the Sprite (in Canvas mode, WebGL doesn't populate this)
The width of the sprite, setting this will actually modify the scale to achieve the value set
The width of the tiling sprite
Adds a child to the container.
| Name | Type | Description |
|---|---|---|
child | DisplayObject | The DisplayObject to add to the container |
The child that was added.
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 | DisplayObject | The child to add |
index | Number | The index to place the child in |
The child that was added.
Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.
| Name | Type | Description |
|---|---|---|
child | DisplayObject | - |
| Name | Type | Description |
|---|---|---|
forcePowerOfTwo | Boolean | Whether we want to force the texture to be a power of two |
renderSession | RenderSession | - |
Returns the framing rectangle of the sprite as a PIXI.Rectangle object
the framing rectangle
Returns the child at the specified index
| Name | Type | Description |
|---|---|---|
index | Number | The index to get the child from |
The child at the given index, if any.
Returns the index position of a child DisplayObject instance
| Name | Type | Description |
|---|---|---|
child | DisplayObject | The DisplayObject instance to identify |
The index position of the child display object to identify
Retrieves the non-global local bounds of the Sprite as a rectangle. The calculation takes all visible children into consideration.
The rectangular bounding area
Removes a child from the container.
| Name | Type | Description |
|---|---|---|
child | DisplayObject | The DisplayObject to remove |
The child that was removed.
Removes a child from the specified index position.
| Name | Type | Description |
|---|---|---|
index | Number | The index to get the child from |
The child that was removed.
Removes all children from this container that are within the begin and end indexes.
| Name | Type | Description |
|---|---|---|
beginIndex | Number | The beginning position. Default value is 0. |
endIndex | Number | The ending position. Default value is size of the container. |
Changes the position of an existing child in the display object container
| Name | Type | Description |
|---|---|---|
child | 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 |
Sets the texture of the sprite. Be warned that this doesn't remove or destroy the previous
texture this Sprite was using.
| 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? |
Swaps the position of 2 Display Objects within this container.
| Name | Type | Description |
|---|---|---|
child | DisplayObject | - |
child2 | DisplayObject | - |
© 2016 Richard Davey, Photon Storm Ltd.
Licensed under the MIT License.
http://phaser.io/docs/2.6.2/PIXI.TilingSprite.html