Merge pull request phaserjs#1985 from yahiko00/master

Extra documentation and TypeScript definition file update

Author: photonstorm

docs/Phaser.BitmapData.html

@@ -1886,7 +1886,8 @@ <h3 class="subsection-title">Members</h3>
 
 
     <div class="description">
-        <p>The context image data.</p>
+        <p>The context image data.
+Please note that a call to BitmapData.draw() or BitmapData.copy() does not update this property for performance reason. Use BitmapData.update() to do so.</p>
     </div>
 
 

src/gameobjects/BitmapData.js

@@ -61,6 +61,8 @@ Phaser.BitmapData = function (game, key, width, height) {
 
     /**
     * @property {ImageData} imageData - The context image data.
+    * Please note that a call to BitmapData.draw() or BitmapData.copy() does not update immediately this property for performance reason. Use BitmapData.update() to do so.
+    * This property is updated automatically after the first game loop, according to the dirty flag property.
     */
     this.imageData = this.context.getImageData(0, 0, width, height);
 

typescript/phaser.d.ts

@@ -422,7 +422,7 @@ declare module Phaser {
         addBitmapFont(key: string, url: string, data: any, atlasData: any, atlasType: string, xSpacing?: number, ySpacing?: number): void;
         addCanvas(key: string, canvas: HTMLCanvasElement, context?: CanvasRenderingContext2D): void;
         addDefaultImage(): void;
-        addImage(key: string, url: string, data: any): void;
+        addImage(key: string, url: string, data: any): Phaser.CachedImage;
         addJSON(key: string, urL: string, data: any): void;
         addMissingImage(): void;
         addPhysicsData(key: string, url: string, JSONData: any, format: number): void;
@@ -466,7 +466,7 @@ declare module Phaser {
         getFrameByName(key: string, name: string, cache?: number): Phaser.Frame;
         getFrameCount(key: string, cache?: number): number;
         getFrameData(key: string, cache?: number): Phaser.FrameData;
-        getImage(key: string, full?: boolean): Phaser.Image;
+        getImage(key: string, full?: boolean): Phaser.CachedImage;
         getItem(key: string, cache: number, method?: string, property?: string): any;
         getJSON(key: string, clone?: boolean): any;
         getKeys(cache: number): string[];
@@ -514,6 +514,17 @@ declare module Phaser {
         updateSound(key: string, property: string, value: Phaser.Sound): void;
 
     }
+    
+    interface CachedImage {
+
+            key: string,
+            url: string,
+            data: HTMLImageElement,
+            base: PIXI.BaseTexture,
+            frame: Phaser.Frame,
+            frameData: Phaser.FrameData
+
+    }
 
     class Camera {