## PIXI. TilingSprite

#### new TilingSprite(texture, width, height)

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

  ##### Parameters:

  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

  Source - pixi/extras/TilingSprite.js, line 5

### Extends

- PIXI.Sprite

### Members

#### 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

  Inherited From:
    - PIXI.Sprite#anchor
  Source - pixi/display/Sprite.js, line 17

#### blendMode :Number

  The blend mode to be applied to the sprite

  Default Value:
    - PIXI.blendModes.NORMAL;
  Source - pixi/extras/TilingSprite.js, line 86

#### canvasBuffer :PIXICanvasBuffer

  The CanvasBuffer object that the tiled texture is drawn to.

  Source - pixi/extras/TilingSprite.js, line 95

#### <readonly> children :Array.<DisplayObject>

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

  ##### Type:

  - Array.<DisplayObject>
  Inherited From:
    - PIXI.DisplayObjectContainer#children
  Source - pixi/display/DisplayObjectContainer.js, line 17

#### exists :Boolean

  Controls if this Sprite is processed by the core Phaser game loops and Group loops.

  Inherited From:
    - PIXI.Sprite#exists
  Default Value:
    - true
  Source - pixi/display/Sprite.js, line 103

#### height :Number

  The height of the tiling sprite

  Source - pixi/extras/TilingSprite.js, line 27

#### height :Number

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

  Source - pixi/extras/TilingSprite.js, line 535

#### ignoreChildInput :Boolean

  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.

  Inherited From:
    - PIXI.DisplayObjectContainer#ignoreChildInput
  Source - pixi/display/DisplayObjectContainer.js, line 26

#### refreshTexture :Boolean

  If true the TilingSprite will run generateTexture on its next render pass.
  This is set by the likes of Phaser.LoadTexture.setFrame.

  Default Value:
    - true
  Source - pixi/extras/TilingSprite.js, line 119

#### renderable :Boolean

  Whether this sprite is renderable or not

  Default Value:
    - true
  Source - pixi/extras/TilingSprite.js, line 59

#### shader :PIXI.AbstractFilter

  The shader that will be used to render this Sprite.
  Set to null to remove a current shader.

  Inherited From:
    - PIXI.Sprite#shader
  Default Value:
    - null
  Source - pixi/display/Sprite.js, line 93

#### texture :PIXI.Texture

  The texture that the sprite is using

  Inherited From:
    - PIXI.Sprite#texture
  Source - pixi/display/Sprite.js, line 28

#### textureDebug :Boolean

  If enabled a green rectangle will be drawn behind the generated tiling texture, allowing you to visually
  debug the texture being used.

  Source - pixi/extras/TilingSprite.js, line 77

#### tilePattern :PIXITexture

  The Context fill pattern that is used to draw the TilingSprite in Canvas mode only (will be null in WebGL).

  Source - pixi/extras/TilingSprite.js, line 111

#### tilePosition :Point

  The offset position of the image that is being tiled

  Source - pixi/extras/TilingSprite.js, line 51

#### tileScale :Point

  The scaling of the image that is being tiled

  Source - pixi/extras/TilingSprite.js, line 35

#### tileScaleOffset :Point

  A point that represents the scale of the texture object

  Source - pixi/extras/TilingSprite.js, line 43

#### tilingTexture :PIXITexture

  An internal Texture object that holds the tiling texture that was generated from TilingSprite.texture.

  Source - pixi/extras/TilingSprite.js, line 103

#### tint :Number

  The tint applied to the sprite. This is a hex value

  Default Value:
    - 0xFFFFFF
  Source - pixi/extras/TilingSprite.js, line 68

#### tintedTexture :Canvas

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

  Inherited From:
    - PIXI.Sprite#tintedTexture
  Default Value:
    - null
  Source - pixi/display/Sprite.js, line 73

#### width :Number

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

  Source - pixi/extras/TilingSprite.js, line 517

#### width :Number

  The width of the tiling sprite

  Source - pixi/extras/TilingSprite.js, line 19

### Methods

#### addChild(child) → {DisplayObject}

  Adds a child to the container.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `child` | DisplayObject | The DisplayObject to add to the container

  ##### Returns:

  DisplayObject -

  The child that was added.

  Inherited From:
    - PIXI.DisplayObjectContainer#addChild
  Source - pixi/display/DisplayObjectContainer.js, line 42

#### addChildAt(child, index) → {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` | DisplayObject | The child to add
  `index` | Number | The index to place the child in

  ##### Returns:

  DisplayObject -

  The child that was added.

  Inherited From:
    - PIXI.DisplayObjectContainer#addChildAt
  Source - pixi/display/DisplayObjectContainer.js, line 55

#### contains(child) → {Boolean}

  Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `child` | DisplayObject | -

  ##### Returns:

  Boolean -
  Inherited From:
    - PIXI.DisplayObjectContainer#contains
  Source - pixi/display/DisplayObjectContainer.js, line 449

#### generateTilingTexture(forcePowerOfTwo, renderSession)

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `forcePowerOfTwo` | Boolean | Whether we want to force the texture to be a power of two
  `renderSession` | RenderSession | -

  Source - pixi/extras/TilingSprite.js, line 332

#### getBounds() → {Rectangle}

  Returns the framing rectangle of the sprite as a PIXI.Rectangle object

  ##### Returns:

  Rectangle -

  the framing rectangle

  Source - pixi/extras/TilingSprite.js, line 417

#### getChildAt(index) → {DisplayObject}

  Returns the child at the specified index

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `index` | Number | The index to get the child from

  ##### Returns:

  DisplayObject -

  The child at the given index, if any.

  Inherited From:
    - PIXI.DisplayObjectContainer#getChildAt
  Source - pixi/display/DisplayObjectContainer.js, line 153

#### getChildIndex(child) → {Number}

  Returns the index position of a child DisplayObject instance

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `child` | DisplayObject | The DisplayObject instance to identify

  ##### Returns:

  Number -

  The index position of the child display object to identify

  Inherited From:
    - PIXI.DisplayObjectContainer#getChildIndex
  Source - pixi/display/DisplayObjectContainer.js, line 112

#### getLocalBounds() → {Rectangle}

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

  ##### Returns:

  Rectangle -

  The rectangular bounding area

  Inherited From:
    - PIXI.Sprite#getLocalBounds
  Source - pixi/display/Sprite.js, line 315

#### removeChild(child) → {DisplayObject}

  Removes a child from the container.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `child` | DisplayObject | The DisplayObject to remove

  ##### Returns:

  DisplayObject -

  The child that was removed.

  Inherited From:
    - PIXI.DisplayObjectContainer#removeChild
  Source - pixi/display/DisplayObjectContainer.js, line 171

#### removeChildAt(index) → {DisplayObject}

  Removes a child from the specified index position.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `index` | Number | The index to get the child from

  ##### Returns:

  DisplayObject -

  The child that was removed.

  Inherited From:
    - PIXI.DisplayObjectContainer#removeChildAt
  Source - pixi/display/DisplayObjectContainer.js, line 191

#### 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 - pixi/display/DisplayObjectContainer.js, line 213

#### setChildIndex(child, index)

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

  ##### Parameters:

  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

  Inherited From:
    - PIXI.DisplayObjectContainer#setChildIndex
  Source - pixi/display/DisplayObjectContainer.js, line 132

#### 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?

  Inherited From:
    - PIXI.Sprite#setTexture
  Source - pixi/display/Sprite.js, line 163

#### swapChildren(child, child2)

  Swaps the position of 2 Display Objects within this container.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `child` | DisplayObject | -
  `child2` | DisplayObject | -

  Inherited From:
    - PIXI.DisplayObjectContainer#swapChildren
  Source - pixi/display/DisplayObjectContainer.js, line 85