pixi.display.Sprite

type

class

extends

DisplayObjectContainer

subclasses

pixi.display.MovieClip, pixi.extras.TilingSprite, pixi.plugins.input.core.InputObject, pixi.text.Text

metadata

:native: "PIXI.Sprite"

Static Methods

parameters: frameId {String} The frame Id of the texture in the cache
returns: {Sprite} A new Sprite using a texture from the texture cache matching the frameId

Helper function that creates a sprite that will contain a texture from the TextureCache based on the frameId The frame ids are created when a Texture packer file has been loaded

parameters: imageId {String}; [crossorigin] {Bool}; [scaleMode] {Int}
returns: {Sprite} A new Sprite using a texture from the texture cache matching the imageId

A short hand way of creating a movieclip from an array of image ids

Constructor

parameters: texture {Texture} The texture for this sprite A sprite can be created directly from an image like this : var sprite = new PIXI.Sprite.fromImage('assets/image.png'); yourStage.addChild(sprite); then obviously don't forget to add it to the stage you have already created

The Sprite object is the base for all textured objects that are rendered to the screen

Instance Variables hide inherited show inherited

The opacity of the object.

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. Set to PIXI.blendModes.NORMAL to remove any blend mode.

This is used to indicate if the displayObject should display a mouse hand cursor on rollover

Set weather or not a the display objects is 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 filters simply set this property to 'null'

read-only The array of children of this container.

A callback that is used when the users clicks on the displayObject with their mouse's left button

This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true

The area the filter is applied to like the hitArea this is used as more of an optimisation rather than figuring out the dimensions of the displayObject each frame you can set this rectangle

Sets the filters for the displayObject. * IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer. To remove filters simply set this property to 'null'

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

This is the defined area that will pick up mouse / touch events. It is null by default. Setting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)

Indicates if the sprite will have touch and mouse interactivity. It is false by default

Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it. In PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping. To remove a mask, set this property to null.

A callback that is used when the user clicks the mouse's left button down over the sprite

Is called when mouse is moved across the renderer element

A callback that is used when the users mouse leaves the displayObject

A callback that is used when the users mouse rolls over the displayObject

A callback that is used when the user releases the mouse's left button that was over the displayObject for this callback to be fired, the mouse's left button must have been pressed down over the displayObject

A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject for this callback to be fired, the mouse's left button must have been pressed down over the displayObject

read-only The display object container that contains this display object.

The pivot point of the displayObject that it rotates around

The coordinate of the object relative to the local coordinates of the parent.

Can this object be rendered

A callback that is used when the users clicks on the displayObject with their mouse's right button

A callback that is used when the user clicks the mouse's right button down over the sprite

A callback that is used when the user releases the mouse's right button that was over the displayObject for this callback to be fired the mouse's right button must have been pressed down over the displayObject

A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject for this callback to be fired, the mouse's right button must have been pressed down over the displayObject

The rotation of the object in radians.

The scale factor of the object.

The shader that will be used to render the texture to the stage. Set to null to remove a current shader.

read-only The stage the display object is connected to, or undefined if it is not connected to the stage.

A callback that is used when the users taps on the sprite with their finger basically a touch version of click

The texture that the sprite is using

The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.

A callback that is used when the user releases a touch over the displayObject

A callback that is used when the user releases the touch that was over the displayObject for this callback to be fired, The touch must have started over the sprite

Is called when a touch is moved across the renderer element

A callback that is used when the user touches over the displayObject

The visibility of the object.

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

read-only The multiplied alpha of the displayObject

read-only Indicates if the sprite is globaly visible.

The position of the displayObject on the x axis relative to the local coordinates of the parent.

The position of the displayObject on the y axis relative to the local coordinates of the parent.

Instance Methods hide inherited show inherited

parameters: child {DisplayObject} The DisplayObject to add to the container

Adds a child to the container.

parameters: child {DisplayObject} The child to add; index {Int} The index to place the child in

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown

parameters: resolution {Float} The resolution of the texture being generated; scaleMode {Int} Should be one of the PIXI.scaleMode consts; [renderer] {CanvasRenderer|WebGLRenderer} The renderer used to generate the texture.
returns: {Texture} a texture of the graphics object

Useful function that returns a texture of the displayObject object that can then be used to create sprites This can be quite useful if your displayObject is static / complicated and needs to be reused multiple times.

parameters: [matrix] {Matrix}
returns: {Rectangle} the rectangular bounding area

Retrieves the bounds of the displayObject as a rectangle object

parameters: index {Int} The index to get the child from
returns: {DisplayObject}

Returns the child at the specified index

parameters

name {String} The name of the child

returns

{DisplayObject}

metadata

:keep

Returns the child with the specified name

parameters: child {DisplayObject} The DisplayObject instance to identify
returns: {Int} The index position of the child display object to identify

Returns the index position of a child DisplayObject instance

returns: {Rectangle} the rectangular bounding area

Retrieves the local bounds of the displayObject as a rectangle object

parameters: child {DisplayObject} The DisplayObject to remove

Removes a child from the container.

parameters: index {Int} The index to get the child from

Removes a child from the specified index position in the child list of the container.

parameters: beginIndex {Int} The beginning position. Predefined value is 0.; [endIndex] {Int} The ending position. Predefined value is children's array length.

Removes all child instances from the child list of the container.

Removes the current stage reference from the container and all of its children.

parameters: child {DisplayObject} The child DisplayObject instance for which you want to change the index number; index {Int} The resulting index number for the child display object

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

parameters: stage {Stage} the stage that the object will have as its current stage reference

Sets the object's stage reference, the stage this object is connected to

parameters: texture {Texture} The PIXI texture that is displayed by the sprite

Sets the texture of the sprite

parameters: child1 {DisplayObject}; child2 {DisplayObject}

Swaps the position of 2 Display Objects within this container.

parameters: position {Point} The world origin to calculate from
returns: {Point} A point object representing the position of this object

Calculates the global position of the display object

parameters: position {Point} The world origin to calculate from; [frm] {DisplayObject} The DisplayObject to calculate the global position from
returns: {Point} A point object representing the position of this object

Calculates the local position of the display object relative to another point

Generates and updates the cached sprite for this object.

pixi.display.Sprite

Static Methods

fromFrame(frameId : String) : Sprite

fromImage(imageId : String, ?crossorigin : Bool, ?scaleMode : Int) : Sprite

Constructor

Instance Variables hide inherited show inherited

alpha : Float

anchor : pixi.geom.Point

blendMode : Int

buttonMode : Bool

cacheAsBitmap : Bool

children : Array<DisplayObject>

click : pixi.InteractionData -> Void

defaultCursor : String

filterArea : pixi.geom.Rectangle

filters : Array<Dynamic>

height : Float

hitArea : Dynamic

interactive : Bool

mask : pixi.primitives.Graphics

mousedown : pixi.InteractionData -> Void

mousemove : pixi.InteractionData -> Void

mouseout : pixi.InteractionData -> Void

mouseover : pixi.InteractionData -> Void

mouseup : pixi.InteractionData -> Void

mouseupoutside : pixi.InteractionData -> Void

name : String

parent : DisplayObjectContainer

pivot : pixi.geom.Point

position : pixi.geom.Point

renderable : Bool

rightclick : pixi.InteractionData -> Void

rightdown : pixi.InteractionData -> Void

rightup : pixi.InteractionData -> Void

rightupoutside : pixi.InteractionData -> Void

rotation : Float

scale : pixi.geom.Point

shader : pixi.filters.AbstractFilter

stage : Stage

tap : pixi.InteractionData -> Void

texture : pixi.textures.Texture

tint : Int

touchend : pixi.InteractionData -> Void

touchendoutside : pixi.InteractionData -> Void

touchmove : pixi.InteractionData -> Void

touchstart : pixi.InteractionData -> Void

visible : Bool

width : Float

worldAlpha : Float

worldVisible : Bool

x : Float

y : Float

Instance Methods hide inherited show inherited

addChild(child : DisplayObject) : Void

addChildAt(child : DisplayObject, index : Int) : Void

generateTexture(resolution : Float, scaleMode : Int, ?renderer : pixi.renderers.webgl.WebGLRenderer) : pixi.textures.Texture

getBounds(?matrix : pixi.geom.Matrix) : pixi.geom.Rectangle

getChildAt(index : Int) : DisplayObject

getChildByName(name : String) : DisplayObject

getChildIndex(child : DisplayObject) : Int

getLocalBounds() : pixi.geom.Rectangle

removeChild(child : DisplayObject) : Void

removeChildAt(index : Int) : Void

removeChildren(?beginIndex : Int, ?endIndex : Int) : Void

removeStageReference() : Void

setChildIndex(child : DisplayObject, index : Int) : Void

setStageReference(stage : Stage) : Void

setTexture(texture : pixi.textures.Texture) : Void

swapChildren(child1 : DisplayObject, child2 : DisplayObject) : Void

toGlobal(position : pixi.geom.Point) : pixi.geom.Point

toLocal(position : pixi.geom.Point, ?frm : DisplayObject) : pixi.geom.Point

updateCache() : Void