Skip to content

Commit b0e1b8f

Browse files
committed
jsdoc fixes.
1 parent 9f49304 commit b0e1b8f

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

src/gameobjects/BitmapData.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -829,7 +829,7 @@ Phaser.BitmapData.prototype = {
829829

830830
/**
831831
* Scans the BitmapData, pixel by pixel, until it encounters a pixel that isn't transparent (i.e. has an alpha value > 0).
832-
* It then stops scanning and returns an object containing the colour of the pixel in r, g and b properties and the location in the x and y properties.
832+
* It then stops scanning and returns an object containing the color of the pixel in r, g and b properties and the location in the x and y properties.
833833
*
834834
* The direction parameter controls from which direction it should start the scan:
835835
*
@@ -840,7 +840,7 @@ Phaser.BitmapData.prototype = {
840840
*
841841
* @method Phaser.BitmapData#getFirstPixel
842842
* @param {number} [direction=0] - The direction in which to scan for the first pixel. 0 = top to bottom, 1 = bottom to top, 2 = left to right and 3 = right to left.
843-
* @return {object} Returns an object containing the colour of the pixel in the `r`, `g` and `b` properties and the location in the `x` and `y` properties.
843+
* @return {object} Returns an object containing the color of the pixel in the `r`, `g` and `b` properties and the location in the `x` and `y` properties.
844844
*/
845845
getFirstPixel: function (direction) {
846846

@@ -912,7 +912,7 @@ Phaser.BitmapData.prototype = {
912912

913913
/**
914914
* Scans the BitmapData and calculates the bounds. This is a rectangle that defines the extent of all non-transparent pixels.
915-
* The rectangle returned will extend from the top-left of the image to the bottom-right, exluding transparent pixels.
915+
* The rectangle returned will extend from the top-left of the image to the bottom-right, excluding transparent pixels.
916916
*
917917
* @method Phaser.BitmapData#getBounds
918918
* @param {Phaser.Rectangle} [rect] - If provided this Rectangle object will be populated with the bounds, otherwise a new object will be created.
@@ -989,7 +989,7 @@ Phaser.BitmapData.prototype = {
989989
* @param {number} [scaleX=1] - The horizontal scale factor of the block. A value of 1 means no scaling. 2 would be twice the size, and so on.
990990
* @param {number} [scaleY=1] - The vertical scale factor of the block. A value of 1 means no scaling. 2 would be twice the size, and so on.
991991
* @param {number} [alpha=1] - The alpha that will be set on the context before drawing. A value between 0 (fully transparent) and 1, opaque.
992-
* @param {number} [blendMode=null] - The composite blend mode that will be used when drawing. The default is no blend mode at all.
992+
* @param {string} [blendMode=null] - The composite blend mode that will be used when drawing. The default is no blend mode at all. This is a Canvas globalCompositeOperation value such as 'lighter' or 'xor'.
993993
* @param {boolean} [roundPx=false] - Should the x and y values be rounded to integers before drawing? This prevents anti-aliasing in some instances.
994994
* @return {Phaser.BitmapData} This BitmapData object for method chaining.
995995
*/
@@ -1169,7 +1169,7 @@ Phaser.BitmapData.prototype = {
11691169
* @param {number} x - The destination x coordinate to copy the image to.
11701170
* @param {number} y - The destination y coordinate to copy the image to.
11711171
* @param {number} [alpha=1] - The alpha that will be set on the context before drawing. A value between 0 (fully transparent) and 1, opaque.
1172-
* @param {number} [blendMode=null] - The composite blend mode that will be used when drawing. The default is no blend mode at all.
1172+
* @param {string} [blendMode=null] - The composite blend mode that will be used when drawing. The default is no blend mode at all. This is a Canvas globalCompositeOperation value such as 'lighter' or 'xor'.
11731173
* @param {boolean} [roundPx=false] - Should the x and y values be rounded to integers before drawing? This prevents anti-aliasing in some instances.
11741174
* @return {Phaser.BitmapData} This BitmapData object for method chaining.
11751175
*/
@@ -1190,7 +1190,7 @@ Phaser.BitmapData.prototype = {
11901190
* @param {number} [y=0] - The y coordinate to translate to before drawing. If not specified it will default to `source.y`.
11911191
* @param {number} [width] - The new width of the Sprite being copied. If not specified it will default to `source.width`.
11921192
* @param {number} [height] - The new height of the Sprite being copied. If not specified it will default to `source.height`.
1193-
* @param {number} [blendMode=null] - The composite blend mode that will be used when drawing the Sprite. The default is no blend mode at all.
1193+
* @param {string} [blendMode=null] - The composite blend mode that will be used when drawing. The default is no blend mode at all. This is a Canvas globalCompositeOperation value such as 'lighter' or 'xor'.
11941194
* @param {boolean} [roundPx=false] - Should the x and y values be rounded to integers before drawing? This prevents anti-aliasing in some instances.
11951195
* @return {Phaser.BitmapData} This BitmapData object for method chaining.
11961196
*/
@@ -1210,7 +1210,7 @@ Phaser.BitmapData.prototype = {
12101210
*
12111211
* @method Phaser.BitmapData#drawGroup
12121212
* @param {Phaser.Group} group - The Group to draw onto this BitmapData.
1213-
* @param {number} [blendMode=null] - The composite blend mode that will be used when drawing the Group children. The default is no blend mode at all.
1213+
* @param {string} [blendMode=null] - The composite blend mode that will be used when drawing. The default is no blend mode at all. This is a Canvas globalCompositeOperation value such as 'lighter' or 'xor'.
12141214
* @param {boolean} [roundPx=false] - Should the x and y values be rounded to integers before drawing? This prevents anti-aliasing in some instances.
12151215
* @return {Phaser.BitmapData} This BitmapData object for method chaining.
12161216
*/

0 commit comments

Comments
 (0)