Updated jsdocs for getBounds (#2406)

This commit is contained in:
photonstorm 2016-04-05 21:13:04 +01:00
parent b3e6381a9e
commit 7b803135c8

View file

@ -192,7 +192,15 @@ PIXI.Sprite.prototype.onTextureUpdate = function()
};
/**
* Returns the bounds of the Sprite as a rectangle. The bounds calculation takes the worldTransform into account.
* 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.
*
* @method getBounds
* @param matrix {Matrix} the transformation matrix of the sprite