Class: CanvasImage

Defined in: packages/minerender/src/canvas/CanvasImage.ts:5

Implements

• Disposable

Constructors

Constructor

new CanvasImage(width, height): CanvasImage;

Defined in: packages/minerender/src/canvas/CanvasImage.ts:10

Parameters

Parameter	Type
width	number
height	number

Returns

CanvasImage

Constructor

new CanvasImage(data): CanvasImage;

Defined in: packages/minerender/src/canvas/CanvasImage.ts:11

Parameters

Parameter	Type
data	ImageData

Returns

CanvasImage

Properties

Property	Modifier	Type	Defined in
canvas	readonly	CompatCanvas	packages/minerender/src/canvas/CanvasImage.ts:7
context	readonly	CanvasRenderingContext2D	packages/minerender/src/canvas/CanvasImage.ts:8

Accessors

dataUrl

Get Signature

get dataUrl(): string;

Defined in: packages/minerender/src/canvas/CanvasImage.ts:37

Returns

string

---

height

Get Signature

get height(): number;

Defined in: packages/minerender/src/canvas/CanvasImage.ts:29

Returns

number

Set Signature

set height(height): void;

Defined in: packages/minerender/src/canvas/CanvasImage.ts:33

Parameters

Parameter	Type
height	number

Returns

void

---

width

Get Signature

get width(): number;

Defined in: packages/minerender/src/canvas/CanvasImage.ts:21

Returns

number

Set Signature

set width(width): void;

Defined in: packages/minerender/src/canvas/CanvasImage.ts:25

Parameters

Parameter	Type
width	number

Returns

void

Methods

dispose()

dispose(): void;

Defined in: packages/minerender/src/canvas/CanvasImage.ts:56

Returns

void

Implementation of

Disposable.dispose

---

getData()

getData(
   sx?, 
   sy?, 
   sw?, 
   sh?
): ImageData;

Defined in: packages/minerender/src/canvas/CanvasImage.ts:45

Parameters

Parameter	Type	Default value
sx	number	0
sy	number	0
sw	number	...
sh	number	...

Returns

ImageData

---

putData()

putData(
   data, 
   dx?, 
   dy?, 
   dirtyX?, 
   dirtyY?, 
   dirtyWidth?, 
   dirtyHeight?
): void;

Defined in: packages/minerender/src/canvas/CanvasImage.ts:49

Parameters

Parameter	Type	Default value
data	ImageData	undefined
dx	number	0
dy	number	0
dirtyX	number	0
dirtyY	number	0
dirtyWidth	number	data.width
dirtyHeight	number	data.height

Returns

void

---

test()

test(): void;

Defined in: packages/minerender/src/canvas/CanvasImage.ts:53

Returns

void

---

toDataURL()

toDataURL(): string;

Defined in: packages/minerender/src/canvas/CanvasImage.ts:41

Returns

string