Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-27 07:01:20 +00:00
Code Issues Projects Releases Packages Wiki Activity

Updated BitmapData get/set pixel docs to make it clear you need to pass integer values.

Browse source
This commit is contained in:
photonstorm 2016-12-21 14:12:55 +00:00
parent 2c41814496
commit 5696dd1d47
1 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
v2-community/src/gameobjects/BitmapData.js
View file

@ -929,8 +929,8 @@ Phaser.BitmapData.prototype = {
* Sets the color of the given pixel to the specified red, green, blue and alpha values. * Sets the color of the given pixel to the specified red, green, blue and alpha values.
* *
* @method Phaser.BitmapData#setPixel32 * @method Phaser.BitmapData#setPixel32
* @param {number} x - The x coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData. * @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.
* @param {number} y - The y coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData. * @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.
* @param {number} red - The red color value, between 0 and 0xFF (255). * @param {number} red - The red color value, between 0 and 0xFF (255).
* @param {number} green - The green color value, between 0 and 0xFF (255). * @param {number} green - The green color value, between 0 and 0xFF (255).
* @param {number} blue - The blue color value, between 0 and 0xFF (255). * @param {number} blue - The blue color value, between 0 and 0xFF (255).
@ -968,8 +968,8 @@ Phaser.BitmapData.prototype = {
* Sets the color of the given pixel to the specified red, green and blue values. * Sets the color of the given pixel to the specified red, green and blue values.
* *
* @method Phaser.BitmapData#setPixel * @method Phaser.BitmapData#setPixel
* @param {number} x - The x coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData. * @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.
* @param {number} y - The y coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData. * @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.
* @param {number} red - The red color value, between 0 and 0xFF (255). * @param {number} red - The red color value, between 0 and 0xFF (255).
* @param {number} green - The green color value, between 0 and 0xFF (255). * @param {number} green - The green color value, between 0 and 0xFF (255).
* @param {number} blue - The blue color value, between 0 and 0xFF (255). * @param {number} blue - The blue color value, between 0 and 0xFF (255).
@ -988,8 +988,8 @@ Phaser.BitmapData.prototype = {
* 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. * 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.
* *
* @method Phaser.BitmapData#getPixel * @method Phaser.BitmapData#getPixel
* @param {number} x - The x coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData. * @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.
* @param {number} y - The y coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData. * @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.
* @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. * @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.
* @return {object} An object with the red, green, blue and alpha values set in the r, g, b and a properties. * @return {object} An object with the red, green, blue and alpha values set in the r, g, b and a properties.
*/ */
@ -1020,8 +1020,8 @@ Phaser.BitmapData.prototype = {
* Note that on little-endian systems the format is 0xAABBGGRR and on big-endian the format is 0xRRGGBBAA. * Note that on little-endian systems the format is 0xAABBGGRR and on big-endian the format is 0xRRGGBBAA.
* *
* @method Phaser.BitmapData#getPixel32 * @method Phaser.BitmapData#getPixel32
* @param {number} x - The x coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData. * @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.
* @param {number} y - The y coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData. * @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.
* @return {number} A native color value integer (format: 0xAARRGGBB) * @return {number} A native color value integer (format: 0xAARRGGBB)
*/ */
getPixel32: function (x, y) { getPixel32: function (x, y) {
@ -1039,8 +1039,8 @@ Phaser.BitmapData.prototype = {
* 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. * 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.
* *
* @method Phaser.BitmapData#getPixelRGB * @method Phaser.BitmapData#getPixelRGB
* @param {number} x - The x coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData. * @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.
* @param {number} y - The y coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData. * @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.
* @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. * @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.
* @param {boolean} [hsl=false] - Also convert the rgb values into hsl? * @param {boolean} [hsl=false] - Also convert the rgb values into hsl?
* @param {boolean} [hsv=false] - Also convert the rgb values into hsv? * @param {boolean} [hsv=false] - Also convert the rgb values into hsv?