Class: PIXI.Sprite
Constructor
new Sprite(texture)
The Sprite object is the base for all textured objects that are rendered to the screen
Parameters
Name | Type | Description |
---|---|---|
texture | PIXI.Texture | The texture for this sprite |
- Source code: pixi/display/Sprite.js (Line 5)
Extends
Public Properties
- Source code: pixi/display/Sprite.js (Line 17)
- Default Value
- PIXI.blendModes.NORMAL;
- Source code: pixi/display/Sprite.js (Line 82)
- Array.<DisplayObject>
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 17)
- Default Value
- true
- Source code: pixi/display/Sprite.js (Line 103)
- Source code: pixi/display/Sprite.js (Line 144)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 26)
- Default Value
- null
- Source code: pixi/display/Sprite.js (Line 93)
- Source code: pixi/display/Sprite.js (Line 28)
- Default Value
- 0xFFFFFF
- Source code: pixi/display/Sprite.js (Line 54)
- Default Value
- null
- Source code: pixi/display/Sprite.js (Line 73)
- Source code: pixi/display/Sprite.js (Line 125)
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
blendMode : number
The blend mode to be applied to the sprite. Set to PIXI.blendModes.NORMAL to remove any blend mode.
Warning: You cannot have a blend mode and a filter active on the same Sprite. Doing so will render the sprite invisible.
[readonly] children : Array.<DisplayObject>
[read-only] The array of children of this container.
Type
exists : boolean
Controls if this Sprite is processed by the core Phaser game loops and Group loops.
height : number
The height of the sprite, setting this will actually modify the scale to achieve the value set
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.
shader : PIXI.AbstractFilter
The shader that will be used to render this Sprite.
Set to null to remove a current shader.
texture : PIXI.Texture
The texture that the sprite is using
tint : number
The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.
tintedTexture :Canvas
A canvas that contains the tinted version of the Sprite (in Canvas mode, WebGL doesn't populate this)
width : number
The width of the sprite, setting this will actually modify the scale to achieve the value set
Public Methods
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 42)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 55)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 449)
- Source code: pixi/display/Sprite.js (Line 199)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 153)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 112)
- Source code: pixi/display/Sprite.js (Line 315)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 171)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 191)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 213)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 132)
- Source code: pixi/display/Sprite.js (Line 163)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 85)
addChild(child) → {DisplayObject}
Adds a child to the container.
Parameters
Name | Type | Description |
---|---|---|
child | DisplayObject | The DisplayObject to add to the container |
Returns
The child that was added.
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
The child that was added.
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
getBounds(matrix) → {Rectangle}
Returns the bounds of the Sprite as a rectangle.
The bounds calculation takes the worldTransform into account.
It is important to note that the transform is not updated when you call this method.
So if this Sprite is the child of a Display Object which has had its transform
updated since the last render pass, those changes will not yet have been applied
to this Sprites worldTransform. If you need to ensure that all parent transforms
are factored into this getBounds operation then you should call updateTransform
on the root most object in this Sprites display list first.
Parameters
Name | Type | Description |
---|---|---|
matrix | Matrix | the transformation matrix of the sprite |
Returns
the framing rectangle
getChildAt(index) → {DisplayObject}
Returns the child at the specified index
Parameters
Name | Type | Description |
---|---|---|
index | Number | The index to get the child from |
Returns
The child at the given index, if any.
getChildIndex(child) → {Number}
Returns the index position of a child DisplayObject instance
Parameters
Name | Type | Description |
---|---|---|
child | DisplayObject | The DisplayObject instance to identify |
Returns
The index position of the child display object to identify
getLocalBounds() → {Rectangle}
Retrieves the non-global local bounds of the Sprite as a rectangle. The calculation takes all visible children into consideration.
Returns
The rectangular bounding area
removeChild(child) → {DisplayObject}
Removes a child from the container.
Parameters
Name | Type | Description |
---|---|---|
child | DisplayObject | The DisplayObject to remove |
Returns
The child that was removed.
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
The child that was removed.
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. |
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 |
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? |
swapChildren(child, child2)
Swaps the position of 2 Display Objects within this container.
Parameters
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.Sprite.html