Skip to content

Class: CanvasTexture ​

A texture with off-screen canvas.

Extends ​

Constructors ​

Constructor ​

new CanvasTexture(): CanvasTexture

Returns ​

CanvasTexture

Overrides ​

ImageTexture.constructor

Methods ​

draw() ​

Call Signature ​

draw(context): void

Defer draw spec to texture config. This is used when a sprite draws its textures.

Parameters ​
context ​

CanvasRenderingContext2D

Returns ​

void

Inherited from ​

ImageTexture.draw

Call Signature ​

draw(context, dx, dy, dw, dh): void

This is probably unused. Note: dx, dy are added to this.dx, this.dy.

Parameters ​
context ​

CanvasRenderingContext2D

dx ​

number

dy ​

number

dw ​

number

dh ​

number

Returns ​

void

Inherited from ​

ImageTexture.draw

Call Signature ​

draw(context, sx, sy, sw, sh, dx, dy, dw, dh): void

This is used when a piped texture passes drawing to it backend. Note: sx, sy, dx, dy are added to this.sx, this.sy, this.dx, this.dy.

Parameters ​
context ​

CanvasRenderingContext2D

sx ​

number

sy ​

number

sw ​

number

sh ​

number

dx ​

number

dy ​

number

dw ​

number

dh ​

number

Returns ​

void

Inherited from ​

ImageTexture.draw


getContext() ​

getContext(type?, attributes?): CanvasRenderingContext2D

Parameters ​

type? ​

string = "2d"

attributes? ​

any

Returns ​

CanvasRenderingContext2D


getHeight() ​

getHeight(): number

Returns ​

number

Inherited from ​

ImageTexture.getHeight


getWidth() ​

getWidth(): number

Returns ​

number

Inherited from ​

ImageTexture.getWidth


setDestinationCoordinate() ​

setDestinationCoordinate(x, y): void

Parameters ​

x ​

number

y ​

number

Returns ​

void

Inherited from ​

ImageTexture.setDestinationCoordinate


setDestinationDimension() ​

setDestinationDimension(w, h): void

Parameters ​

w ​

number

h ​

number

Returns ​

void

Inherited from ​

ImageTexture.setDestinationDimension


setDrawer() ​

setDrawer(drawer): void

Parameters ​

drawer ​

CanvasTextureDrawer

Returns ​

void


setMemoizer() ​

setMemoizer(memoizer): void

Parameters ​

memoizer ​

CanvasTextureMemoizer

Returns ​

void


setPadding() ​

setPadding(padding): void

Add padding to the image texture. Padding can be negative.

Parameters ​

padding ​

number

Returns ​

void

Inherited from ​

ImageTexture.setPadding


setSize() ​

setSize(destWidth, destHeight, pixelRatio?): void

Set texture size to given width and height, and set canvas size to texture size multiply by pixelRatio.

Parameters ​

destWidth ​

number

destHeight ​

number

pixelRatio? ​

number = 1

Returns ​

void


setSourceCoordinate() ​

setSourceCoordinate(x, y): void

Parameters ​

x ​

number

y ​

number

Returns ​

void

Inherited from ​

ImageTexture.setSourceCoordinate


setSourceDimension() ​

setSourceDimension(w, h): void

Parameters ​

w ​

number

h ​

number

Returns ​

void

Inherited from ​

ImageTexture.setSourceDimension


setSourceImage() ​

setSourceImage(image, pixelRatio?): void

Parameters ​

image ​

TextureImageSource

pixelRatio? ​

number = 1

Returns ​

void

Inherited from ​

ImageTexture.setSourceImage