Class: Atlas

Textures are used to clip and resize image objects.

Extends

• ImageTexture

Constructors

Constructor

new Atlas(def?): Atlas

Parameters

def?

AtlasDefinition = {}

Returns

Atlas

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

---

getHeight()

getHeight(): number

Returns

number

Inherited from

ImageTexture.getHeight

---

getWidth()

getWidth(): number

Returns

number

Inherited from

ImageTexture.getWidth

---

load()

load(): Promise<void>

Returns

Promise<void>

---

select()

select(query?): TextureSelection

Parameters

query?

string

Returns

TextureSelection

---

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

---

setPadding()

setPadding(padding): void

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

Parameters

padding

number

Returns

void

Inherited from

ImageTexture.setPadding

---

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