From bd30181a2a01c99e879bb9bd5fc361fa3fbe461e Mon Sep 17 00:00:00 2001 From: photonstorm Date: Mon, 20 Jun 2016 12:18:34 +0100 Subject: [PATCH] Docs update. --- src/gameobjects/BitmapData.js | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/gameobjects/BitmapData.js b/src/gameobjects/BitmapData.js index 2291ae85c..890e1d246 100644 --- a/src/gameobjects/BitmapData.js +++ b/src/gameobjects/BitmapData.js @@ -1551,7 +1551,13 @@ Phaser.BitmapData.prototype = { /** * Draws the given Phaser.Sprite, Phaser.Image or Phaser.Text to this BitmapData at the coordinates specified. * You can use the optional width and height values to 'stretch' the sprite as it is drawn. This uses drawImage stretching, not scaling. - * When drawing it will take into account the Sprites rotation, scale and alpha values. + * + * The children will be drawn at their `x` and `y` world space coordinates. If this is outside the bounds of the BitmapData they won't be visible. + * When drawing it will take into account the rotation, scale, scaleMode, alpha and tint values. + * + * Note: You should ensure that at least 1 full update has taken place before calling this, + * otherwise the objects are likely to render incorrectly, if at all. + * You can trigger an update yourself by calling `stage.updateTransform()` before calling `draw`. * * @method Phaser.BitmapData#draw * @param {Phaser.Sprite|Phaser.Image|Phaser.Text|Phaser.RenderTexture} source - The Sprite, Image or Text object to draw onto this BitmapData. @@ -1582,7 +1588,7 @@ Phaser.BitmapData.prototype = { * * Note: You should ensure that at least 1 full update has taken place before calling this, * otherwise the objects are likely to render incorrectly, if at all. - * You can trigger an update yourself by calling `stage.updateTransform()` before calling `drawGroup`. + * You can trigger an update yourself by calling `stage.updateTransform()` before calling `drawGroup`. * * @method Phaser.BitmapData#drawGroup * @param {Phaser.Group} group - The Group to draw onto this BitmapData. Can also be Phaser.World.