W3cubDocs

/Phaser

Class: Phaser.BitmapData

Constructor

new BitmapData(game, key, width, height, skipPool)

A BitmapData object contains a Canvas element to which you can draw anything you like via normal Canvas context operations.
A single BitmapData can be used as the texture for one or many Images / Sprites.
So if you need to dynamically create a Sprite texture then they are a good choice.

Important note: Every BitmapData creates its own Canvas element. Because BitmapData's are now Game Objects themselves, and don't
live on the display list, they are NOT automatically cleared when you change State. Therefore you must call BitmapData.destroy
in your State's shutdown method if you wish to free-up the resources the BitmapData used, it will not happen for you.

Parameters

Name	Type	Argument	Default	Description
`game`	Phaser.Game			A reference to the currently running game.
`key`	string			Internal Phaser reference key for the BitmapData.
`width`	number	<optional>	256	The width of the BitmapData in pixels. If undefined or zero it's set to a default value.
`height`	number	<optional>	256	The height of the BitmapData in pixels. If undefined or zero it's set to a default value.
`skipPool`	boolean	<optional>	false	When this BitmapData generates its internal canvas to use for rendering, it will get the canvas from the CanvasPool if false, or create its own if true.

Source code: gameobjects/BitmapData.js (Line 24)

Public Properties

baseTexture : PIXI.BaseTexture

The PIXI.BaseTexture.

Source code: gameobjects/BitmapData.js (Line 124)

canvas :HTMLCanvasElement

The canvas to which this BitmapData draws.

Source code: gameobjects/BitmapData.js (Line 54)

context :CanvasRenderingContext2D

The 2d context of the canvas.

Source code: gameobjects/BitmapData.js (Line 60)

ctx :CanvasRenderingContext2D

A reference to BitmapData.context.

Source code: gameobjects/BitmapData.js (Line 65)

data :Uint8ClampedArray

A Uint8ClampedArray view into BitmapData.buffer.
Note that this is unavailable in some browsers (such as Epic Browser due to its security restrictions)

Source code: gameobjects/BitmapData.js (Line 84)

dirty : boolean

If dirty this BitmapData will be re-rendered.

Source code: gameobjects/BitmapData.js (Line 159)

disableTextureUpload : boolean

If disableTextureUpload is true this BitmapData will never send its image data to the GPU when its dirty flag is true.

Source code: gameobjects/BitmapData.js (Line 154)

frameData : Phaser.FrameData

The FrameData container this BitmapData uses for rendering.

Source code: gameobjects/BitmapData.js (Line 135)

game : Phaser.Game

A reference to the currently running game.

Source code: gameobjects/BitmapData.js (Line 33)

height : number

The height of the BitmapData in pixels.

Source code: gameobjects/BitmapData.js (Line 48)

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.

Source code: gameobjects/BitmapData.js (Line 77)

key : string

The key of the BitmapData in the Cache, if stored there.

Source code: gameobjects/BitmapData.js (Line 38)

pixels :Uint32Array

An Uint32Array view into BitmapData.buffer.

Source code: gameobjects/BitmapData.js (Line 94)

smoothProperty : string

The context property needed for smoothing this Canvas.

Source code: gameobjects/BitmapData.js (Line 70)

texture : PIXI.Texture

The PIXI.Texture.

Source code: gameobjects/BitmapData.js (Line 130)

textureFrame : Phaser.Frame

The Frame this BitmapData uses for rendering.

Source code: gameobjects/BitmapData.js (Line 141)

type : number

The const type of this object.

Source code: gameobjects/BitmapData.js (Line 149)

width : number

The width of the BitmapData in pixels.

Source code: gameobjects/BitmapData.js (Line 43)

Public Methods

<static> getTransform(translateX, translateY, scaleX, scaleY, skewX, skewY) → {object}

Gets a JavaScript object that has 6 properties set that are used by BitmapData in a transform.

Parameters

Name	Type	Description
`translateX`	number	The x translate value.
`translateY`	number	The y translate value.
`scaleX`	number	The scale x value.
`scaleY`	number	The scale y value.
`skewX`	number	The skew x value.
`skewY`	number	The skew y value.

Returns

object -

A JavaScript object containing all of the properties BitmapData needs for transforms.

Source code: gameobjects/BitmapData.js (Line 2419)

add(object) → {Phaser.BitmapData}

Updates the given objects so that they use this BitmapData as their texture.
This will replace any texture they will currently have set.

Parameters

Name	Type	Description
`object`	Phaser.Sprite \| Array.<Phaser.Sprite> \| Phaser.Image \| Array.<Phaser.Image>	Either a single Sprite/Image or an Array of Sprites/Images.

Name	Type	Argument	Default	Description
`x`	number	<optional>	0	The x coordinate to place the Image at.
`y`	number	<optional>	0	The y coordinate to place the Image at.
`anchorX`	number	<optional>	0	Set the x anchor point of the Image. A value between 0 and 1, where 0 is the top-left and 1 is bottom-right.
`anchorY`	number	<optional>	0	Set the y anchor point of the Image. A value between 0 and 1, where 0 is the top-left and 1 is bottom-right.
`scaleX`	number	<optional>	1	The horizontal scale factor of the Image. A value of 1 means no scaling. 2 would be twice the size, and so on.
`scaleY`	number	<optional>	1	The vertical scale factor of the Image. A value of 1 means no scaling. 2 would be twice the size, and so on.

Name	Type	Argument	Description
`source`	Phaser.Sprite \| Phaser.Image \| Phaser.Text \| Phaser.BitmapData \| Image \| HTMLCanvasElement \| string		The source to copy from. If you give a string it will try and find the Image in the Game.Cache first. This is quite expensive so try to provide the image itself.
`mask`	Phaser.Sprite \| Phaser.Image \| Phaser.Text \| Phaser.BitmapData \| Image \| HTMLCanvasElement \| string	<optional>	The object to be used as the mask. If you give a string it will try and find the Image in the Game.Cache first. This is quite expensive so try to provide the image itself. If you don't provide a mask it will use this BitmapData as the mask.
`sourceRect`	Phaser.Rectangle	<optional>	A Rectangle where x/y define the coordinates to draw the Source image to and width/height define the size.
`maskRect`	Phaser.Rectangle	<optional>	A Rectangle where x/y define the coordinates to draw the Mask image to and width/height define the size.

Name	Type	Argument	Description
`x`	number		The x coordinate to draw the Circle at. This is the center of the circle.
`y`	number		The y coordinate to draw the Circle at. This is the center of the circle.
`radius`	number		The radius of the Circle in pixels. The radius is half the diameter.
`fillStyle`	string	<optional>	If set the context fillStyle will be set to this value before the circle is drawn.

Name	Type	Argument	Default	Description
`x`	number	<optional>	0	The x coordinate of the top-left of the area to clear.
`y`	number	<optional>	0	The y coordinate of the top-left of the area to clear.
`width`	number	<optional>		The width of the area to clear. If undefined it will use BitmapData.width.
`height`	number	<optional>		The height of the area to clear. If undefined it will use BitmapData.height.

Name	Type	Argument	Default	Description
`source`	Phaser.Sprite \| Phaser.Image \| Phaser.Text \| Phaser.BitmapData \| Phaser.RenderTexture \| Image \| string			The Image to copy from. If you give a string it will try and find the Image in the Game.Cache.
`area`	Phaser.Rectangle			The Rectangle region to copy from the source image.
`x`	number			The destination x coordinate to copy the image to.
`y`	number			The destination y coordinate to copy the image to.
`alpha`	number	<optional>	1	The alpha that will be set on the context before drawing. A value between 0 (fully transparent) and 1, opaque.
`blendMode`	string	<optional>	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'.
`roundPx`	boolean	<optional>	false	Should the x and y values be rounded to integers before drawing? This prevents anti-aliasing in some instances.

Name	Type	Argument	Default	Description
`source`	Phaser.Sprite \| Phaser.Image \| Phaser.Text \| Phaser.RenderTexture			The Sprite, Image or Text object to draw onto this BitmapData.
`x`	number	<optional>	0	The x coordinate to translate to before drawing. If not specified it will default to `source.x`.
`y`	number	<optional>	0	The y coordinate to translate to before drawing. If not specified it will default to `source.y`.
`width`	number	<optional>		The new width of the Sprite being copied. If not specified it will default to `source.width`.
`height`	number	<optional>		The new height of the Sprite being copied. If not specified it will default to `source.height`.
`blendMode`	string	<optional>	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'.
`roundPx`	boolean	<optional>	false	Should the x and y values be rounded to integers before drawing? This prevents anti-aliasing in some instances.

Name	Type	Argument	Default	Description
`parent`	Phaser.World \| Phaser.Group \| Phaser.Sprite \| Phaser.Image \| Phaser.Text \| Phaser.BitmapText			The Game Object to draw onto this BitmapData and then recursively draw all of its children.
`blendMode`	string	<optional>	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'.
`roundPx`	boolean	<optional>	false	Should the x and y values be rounded to integers before drawing? This prevents anti-aliasing in some instances.

Name	Type	Argument	Default	Description
`group`	Phaser.Group			The Group to draw onto this BitmapData. Can also be Phaser.World.
`blendMode`	string	<optional>	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'.
`roundPx`	boolean	<optional>	false	Should the x and y values be rounded to integers before drawing? This prevents anti-aliasing in some instances.

Name	Type	Argument	Default	Description
`destination`	Phaser.BitmapData			The BitmapData that the extracted pixels will be drawn to.
`r`	number			The red color component, in the range 0 - 255.
`g`	number			The green color component, in the range 0 - 255.
`b`	number			The blue color component, in the range 0 - 255.
`a`	number	<optional>	255	The alpha color component, in the range 0 - 255 that the new pixel will be drawn at.
`resize`	boolean	<optional>	false	Should the destination BitmapData be resized to match this one before the pixels are copied?
`r2`	number	<optional>		An alternative red color component to be written to the destination, in the range 0 - 255.
`g2`	number	<optional>		An alternative green color component to be written to the destination, in the range 0 - 255.
`b2`	number	<optional>		An alternative blue color component to be written to the destination, in the range 0 - 255.

Name	Type	Argument	Default	Description
`r`	number			The red color value, between 0 and 0xFF (255).
`g`	number			The green color value, between 0 and 0xFF (255).
`b`	number			The blue color value, between 0 and 0xFF (255).
`a`	number	<optional>	1	The alpha color value, between 0 and 1.

Name	Type	Argument	Description
`x`	number		The x coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.
`y`	number		The y coordinate of the pixel to be set. Must lay within the dimensions of this BitmapData.
`out`	object	<optional>	An object into which 4 properties will be created: r, g, b and a. If not provided a new object will be created.

Name	Type	Argument	Default	Description
`x1`	number			The x coordinate to start the line from.
`y1`	number			The y coordinate to start the line from.
`x2`	number			The x coordinate to draw the line to.
`y2`	number			The y coordinate to draw the line to.
`color`	string	<optional>	'#fff'	The stroke color that the line will be drawn in.
`width`	number	<optional>	1	The line thickness.

Name	Type	Argument	Default	Description
`x`	integer			The amount of pixels to horizontally shift the canvas by. Use a negative value to shift to the left, positive to the right.
`y`	integer			The amount of pixels to vertically shift the canvas by. Use a negative value to shift up, positive to shift down.
`wrap`	boolean	<optional>	true	Wrap the content of the BitmapData.

Name	Type	Argument	Default	Description
`distance`	integer			The amount of pixels to horizontally shift the canvas by. Use a negative value to shift to the left, positive to the right.
`wrap`	boolean	<optional>	true	Wrap the content of the BitmapData.

Name	Type	Argument	Default	Description
`callback`	function			The callback that will be sent each pixel color to be processed.
`callbackContext`	object			The context under which the callback will be called.
`x`	number	<optional>	0	The x coordinate of the top-left of the region to process from.
`y`	number	<optional>	0	The y coordinate of the top-left of the region to process from.
`width`	number	<optional>		The width of the region to process.
`height`	number	<optional>		The height of the region to process.

Name	Type	Argument	Description
`r1`	number		The red color value to be replaced. Between 0 and 255.
`g1`	number		The green color value to be replaced. Between 0 and 255.
`b1`	number		The blue color value to be replaced. Between 0 and 255.
`a1`	number		The alpha color value to be replaced. Between 0 and 255.
`r2`	number		The red color value that is the replacement color. Between 0 and 255.
`g2`	number		The green color value that is the replacement color. Between 0 and 255.
`b2`	number		The blue color value that is the replacement color. Between 0 and 255.
`a2`	number		The alpha color value that is the replacement color. Between 0 and 255.
`region`	Phaser.Rectangle	<optional>	The area to perform the search over. If not given it will replace over the whole BitmapData.

Name	Type	Description
`width`	integer	The new width of the BitmapData.
`height`	integer	The new height of the BitmapData.

Name	Type	Argument	Default	Description
`color`	string			The color of the shadow, given in a CSS format, i.e. `#000000` or `rgba(0,0,0,1)`. If `null` or `undefined` the shadow will be reset.
`blur`	number	<optional>	5	The amount the shadow will be blurred by. Low values = a crisp shadow, high values = a softer shadow.
`x`	number	<optional>	10	The horizontal offset of the shadow in pixels.
`y`	number	<optional>	10	The vertical offset of the shadow in pixels.

Name	Type	Argument	Default	Description
`text`	string			The text to write to the BitmapData.
`x`	number			The x coordinate of the top-left of the text string.
`y`	number			The y coordinate of the top-left of the text string.
`font`	string	<optional>	'14px Courier'	The font. This is passed directly to Context.font, so anything that can support, this can.
`color`	string	<optional>	'rgb(255,255,255)'	The color the text will be drawn in.
`shadow`	boolean	<optional>	true	Draw a single pixel black shadow below the text (offset by text.x/y + 1)

Name	Type	Argument	Default	Description
`line`	Phaser.Line			A Phaser.Line object that will be used to plot the start and end of the line.
`image`	string \| Image			The key of an image in the Phaser.Cache to use as the texture for this line, or an actual Image.
`repeat`	string	<optional>	'repeat-x'	The pattern repeat mode to use when drawing the line. Either `repeat`, `repeat-x` or `no-repeat`.

Class: Phaser.BitmapData

Constructor

new BitmapData(game, key, width, height, skipPool)

Parameters

Public Properties

baseTexture : PIXI.BaseTexture

canvas :HTMLCanvasElement

context :CanvasRenderingContext2D

ctx :CanvasRenderingContext2D

data :Uint8ClampedArray

dirty : boolean

disableTextureUpload : boolean

frameData : Phaser.FrameData

game : Phaser.Game

height : number

imageData :ImageData

key : string

pixels :Uint32Array

smoothProperty : string

texture : PIXI.Texture

textureFrame : Phaser.Frame

type : number

width : number

Public Methods

<static> getTransform(translateX, translateY, scaleX, scaleY, skewX, skewY) → {object}

Parameters

Returns

add(object) → {Phaser.BitmapData}

Parameters

Returns

addToWorld(x, y, anchorX, anchorY, scaleX, scaleY) → {Phaser.Image}

Parameters

Returns

alphaMask(source, mask, sourceRect, maskRect) → {Phaser.BitmapData}

Parameters

Returns

blendAdd() → {Phaser.BitmapData}

Returns

blendColor() → {Phaser.BitmapData}

Returns

blendColorBurn() → {Phaser.BitmapData}

Returns

blendColorDodge() → {Phaser.BitmapData}

Returns

blendDarken() → {Phaser.BitmapData}

Returns

blendDestinationAtop() → {Phaser.BitmapData}

Returns

blendDestinationIn() → {Phaser.BitmapData}

Returns

blendDestinationOut() → {Phaser.BitmapData}

Returns

blendDestinationOver() → {Phaser.BitmapData}

Returns

blendDifference() → {Phaser.BitmapData}

Returns

blendExclusion() → {Phaser.BitmapData}

Returns

blendHardLight() → {Phaser.BitmapData}

Returns

blendHue() → {Phaser.BitmapData}

Returns

blendLighten() → {Phaser.BitmapData}

Returns

blendLuminosity() → {Phaser.BitmapData}

Returns

blendMultiply() → {Phaser.BitmapData}

Returns

blendOverlay() → {Phaser.BitmapData}

Returns

blendReset() → {Phaser.BitmapData}

Returns

blendSaturation() → {Phaser.BitmapData}

Returns

blendScreen() → {Phaser.BitmapData}

Returns

blendSoftLight() → {Phaser.BitmapData}

Returns

blendSourceAtop() → {Phaser.BitmapData}

Returns