Stage.js Docs

Appearance

Class: ImageTexture ​

Textures are used to clip and resize image objects.

Extends ​

Extended by ​

Constructors ​

Constructor ​

new ImageTexture(source?, pixelRatio?): ImageTexture

Parameters ​

source? ​

TextureImageSource

pixelRatio? ​

number

Returns ​

ImageTexture

Overrides ​

Texture.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 ​

Texture.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 ​

Texture.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 ​

Texture.draw

getHeight() ​

getHeight(): number

Returns ​

number

Overrides ​

Texture.getHeight

getWidth() ​

getWidth(): number

Returns ​

number

Overrides ​

Texture.getWidth

setDestinationCoordinate() ​

setDestinationCoordinate(x, y): void

Parameters ​

x ​

number

y ​

number

Returns ​

void

Inherited from ​

Texture.setDestinationCoordinate

setDestinationDimension() ​

setDestinationDimension(w, h): void

Parameters ​

w ​

number

h ​

number

Returns ​

void

Inherited from ​

Texture.setDestinationDimension

setPadding() ​

setPadding(padding): void

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

Parameters ​

padding ​

number

Returns ​

void

setSourceCoordinate() ​

setSourceCoordinate(x, y): void

Parameters ​

x ​

number

y ​

number

Returns ​

void

Inherited from ​

Texture.setSourceCoordinate

setSourceDimension() ​

setSourceDimension(w, h): void

Parameters ​

w ​

number

h ​

number

Returns ​

void

Inherited from ​

Texture.setSourceDimension

setSourceImage() ​

setSourceImage(image, pixelRatio?): void

Parameters ​

image ​

TextureImageSource

pixelRatio? ​

number = 1

Returns ​

void