Skip to content

Commit 5696dd1

Browse files
committed
Updated BitmapData get/set pixel docs to make it clear you need to pass integer values.
1 parent 2c41814 commit 5696dd1

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

v2-community/src/gameobjects/BitmapData.js

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -929,8 +929,8 @@ Phaser.BitmapData.prototype = {
929929
* Sets the color of the given pixel to the specified red, green, blue and alpha values.
930930
*
931931
* @method Phaser.BitmapData#setPixel32
932-
* @param {number} x - The x coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.
933-
* @param {number} y - The y coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.
932+
* @param {integer} x - The x coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData and be an integer, not a float.
933+
* @param {integer} y - The y coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData and be an integer, not a float.
934934
* @param {number} red - The red color value, between 0 and 0xFF (255).
935935
* @param {number} green - The green color value, between 0 and 0xFF (255).
936936
* @param {number} blue - The blue color value, between 0 and 0xFF (255).
@@ -968,8 +968,8 @@ Phaser.BitmapData.prototype = {
968968
* Sets the color of the given pixel to the specified red, green and blue values.
969969
*
970970
* @method Phaser.BitmapData#setPixel
971-
* @param {number} x - The x coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.
972-
* @param {number} y - The y coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.
971+
* @param {integer} x - The x coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData and be an integer, not a float.
972+
* @param {integer} y - The y coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData and be an integer, not a float.
973973
* @param {number} red - The red color value, between 0 and 0xFF (255).
974974
* @param {number} green - The green color value, between 0 and 0xFF (255).
975975
* @param {number} blue - The blue color value, between 0 and 0xFF (255).
@@ -988,8 +988,8 @@ Phaser.BitmapData.prototype = {
988988
* otherwise this may return out of date color values, or worse - throw a run-time error as it tries to access an array element that doesn't exist.
989989
*
990990
* @method Phaser.BitmapData#getPixel
991-
* @param {number} x - The x coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.
992-
* @param {number} y - The y coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.
991+
* @param {integer} x - The x coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData and be an integer, not a float.
992+
* @param {integer} y - The y coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData and be an integer, not a float.
993993
* @param {object} [out] - An object into which 4 properties will be created: r, g, b and a. If not provided a new object will be created.
994994
* @return {object} An object with the red, green, blue and alpha values set in the r, g, b and a properties.
995995
*/
@@ -1020,8 +1020,8 @@ Phaser.BitmapData.prototype = {
10201020
* Note that on little-endian systems the format is 0xAABBGGRR and on big-endian the format is 0xRRGGBBAA.
10211021
*
10221022
* @method Phaser.BitmapData#getPixel32
1023-
* @param {number} x - The x coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.
1024-
* @param {number} y - The y coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.
1023+
* @param {integer} x - The x coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData and be an integer, not a float.
1024+
* @param {integer} y - The y coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData and be an integer, not a float.
10251025
* @return {number} A native color value integer (format: 0xAARRGGBB)
10261026
*/
10271027
getPixel32: function (x, y) {
@@ -1039,8 +1039,8 @@ Phaser.BitmapData.prototype = {
10391039
* otherwise this may return out of date color values, or worse - throw a run-time error as it tries to access an array element that doesn't exist.
10401040
*
10411041
* @method Phaser.BitmapData#getPixelRGB
1042-
* @param {number} x - The x coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.
1043-
* @param {number} y - The y coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.
1042+
* @param {integer} x - The x coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData and be an integer, not a float.
1043+
* @param {integer} y - The y coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData and be an integer, not a float.
10441044
* @param {object} [out] - An object into which 3 properties will be created: r, g and b. If not provided a new object will be created.
10451045
* @param {boolean} [hsl=false] - Also convert the rgb values into hsl?
10461046
* @param {boolean} [hsv=false] - Also convert the rgb values into hsv?

0 commit comments

Comments
 (0)