Members

baseTexturePIXI.BaseTexturereadonly

The base texture that holds the image

canvasHTMLCanvasElementreadonly

The bitmap canvas

contextCanvasRenderingContext2Dreadonly

The 2d context of the bitmap canvas

fontBoldboolean

Whether the font is bold.

fontFacestring

The face name of the font.

fontItalicboolean

Whether the font is italic.

fontSizenumber

The size of the font in pixels.

heightnumberreadonly

The height of the bitmap

imageHTMLImageElementreadonly

The bitmap image

outlineColorstring

The color of the outline of the text in CSS format.

outlineWidthnumber

The width of the outline of the text.

paintOpacitynumber

The opacity of the drawing object in the range (0, 255)

rectRectanglereadonly

The rectangle of the bitmap

smoothboolean

Whether smooth scaling is applied.

textColorstring

The color of the text in CSS format.

urlstringreadonly

The url of the image file

widthnumberreadonly

The width of the bitmap

Methods

addLoadListener(listner)

Bitmap.js:544

Adds a callback function that will be called when the bitmap is done loading

Name	Type	Description
listner	function	The callback function

blt(source, sx, sy, sw, sh, dx, dy, dw, dh)

Bitmap.js:335

Performs a block transfer

Name	Type	Default	Description
source	Bitmap		The bitmap to draw
sx	number		The x coordinate in the source to start transfer from
sy	number		The y coordinate in the source to start transfer from
sw	number		The width to use from the source image
sh	number		The height to use from the source image
dx	number		The x coordinate in the destination
dy	number		The y coordinate in the destination
dw	number	sw	optionalThe width to draw the image in the destination
dh	number	sh	optionalThe height to draw the image in the destination

clear()

Bitmap.js:392

Clears the entire bitmap

clearRect(x, y, width, height)

Bitmap.js:384

Clears the specified rectangle

Name	Type	Description
x	number	The x coordinate for the upper-left corner
y	number	The y coordinate for the upper-left corner
width	number	The width of the rectangle to clear
height	number	The height of the rectangle to clear

destroy()

Bitmap.js:299

Destroys the bitmap

drawCircle(x, y, radius, color)

Bitmap.js:477

Draws a circle on the bitmap

Name	Type	Description
x	number	The x coordinate based on the circle center
y	number	The y coordinate based on the circle center
radius	number	The radius of the circle
color	string	The color of the circle in CSS format

drawText(text, x, y, maxWidth, lineHeight, align)

Bitmap.js:498

Draws the given text to the bitmap

Name	Type	Description
text	string	The text that will be drawn
x	number	The x coordinate for the left of the text
y	number	The y coordinate for the top of the text
maxWidth	number	The maximum allowed width of the text
lineHeight	number	The height of the text line
align	string	The alignment of the text

fillAll(color)

Bitmap.js:419

Fills the entire bitmap

Name	Type	Description
color	string	The color of the rectangle in CSS format

fillRect(x, y, width, height, color)

Bitmap.js:405

Fills the specified rectangle

Name	Type	Description
x	number	The x coordinate for the upper-left corner
y	number	The y coordinate for the upper-left corner
width	number	The width of the rectangle to fill
height	number	The height of the rectangle to fill
color	string	The color of the rectangle in CSS format

getAlphaPixel(x, y)string

Bitmap.js:371

Returns the alpha value of the pixel at the given x/y coordinates

Name	Type	Description
x	number	The x coordinate of the pixel
y	number	The y coordinate of the pixel

Returns:

Type	Description
string	The alpha value

getPixel(x, y)string

Bitmap.js:355

Returns the color in hex format of the pixel at the given x/y coordinates

Name	Type	Description
x	number	The x coordinate of the pixel
y	number	The y coordinate of the pixel

Returns:

Type	Description
string	The pixel color (hex format)

gradientFillRect(x, y, width, height, color1, color2, vertical)

Bitmap.js:453

Draws the rectangle with a gradient color fill

Name	Type	Description
x	number	The x coordinate for the upper-left corner
y	number	The y coordinate for the upper-left corner
width	number	The width of the rectangle
height	number	The height of the rectangle
color1	string	The gradient starting color
color2	string	The gradient ending color
vertical	boolean	Whether the gradient should be drawn as vertical or not

initialize(width, height)

Bitmap.js:18

Initializes the bitmap object

Name	Type	Description
width	number	The width of the bitmap
height	number	The height of the bitmap

isError()boolean

Bitmap.js:138

Checks whether a loading error has occurred

Returns:

Type	Description
boolean	True if a loading error has occurred

isReady()boolean

Bitmap.js:129

Checks whether the bitmap is ready to render (it is done loading)

Returns:

Type	Description
boolean	True if the bitmap is ready to render

measureTextWidth(text)number

Bitmap.js:530

Gets the width of the given text

Name	Type	Description
text	string	The text to be measured

Returns:

Type	Description
number	The width of the text in pixels

resize(width, height)

Bitmap.js:313

Resizes the bitmap

Name	Type	Description
width	number	The new width of the bitmap
height	number	The new height of the bitmap

retry()

Bitmap.js:555

Tries to load the image again

strokeRect(x, y, width, height, color)

Bitmap.js:432

Draws the specified rectangular frame

Name	Type	Description
x	number	The x coordinate for the upper-left corner
y	number	The y coordinate for the upper-left corner
width	number	The width of the rectangle to fill
height	number	The height of the rectangle to fill
color	string	The color of the rectangle in CSS format

Bitmap.load(url)Bitmapstatic

Bitmap.js:91

Loads an image file from the given url

Name	Type	Description
url	string	The file path of the image file

Returns:

Type	Description
Bitmap	The created bitmap object

Bitmap.snap(stage)Bitmapstatic

Bitmap.js:105

Takes a snapshot of the game screen

Name	Type	Description
stage	Stage	The stage object

Returns:

Type	Description
Bitmap	The created bitmap object