doc: add a note about calling getImageData() and setting the `willR…

…eadFrequently` attribute
melonjs · Dec 28, 2022 · 2bd4c54 · 2bd4c54
1 parent 5300602
commit 2bd4c54
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/video/texture/canvas_texture.js b/src/video/texture/canvas_texture.js
@@ -99,7 +99,8 @@ class CanvasTexture {
     }
 
     /**
-     * Returns an ImageData object representing the underlying pixel data for a specified portion of this canvas texture
+     * Returns an ImageData object representing the underlying pixel data for a specified portion of this canvas texture.
+     * (Note: when using getImageData(), it is highly recommended to use the `willReadFrequently` attribute when creatimg the corresponding canvas texture)
      * @param {number} x - The x-axis coordinate of the top-left corner of the rectangle from which the ImageData will be extracted
      * @param {number} y - The y-axis coordinate of the top-left corner of the rectangle from which the ImageData will be extracted
      * @param {number} width - The width of the rectangle from which the ImageData will be extracted. Positive values are to the right, and negative to the left