Skip to content

Class: CanvasImage ​

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

Wraps a browser or Node canvas for pixel reads and writes. All coordinates and dimensions use pixels.

Implements ​

Constructors ​

Constructor ​

ts
new CanvasImage(width, height): CanvasImage;

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

Parameters ​

ParameterType
widthnumber
heightnumber

Returns ​

CanvasImage

Constructor ​

ts
new CanvasImage(data): CanvasImage;

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

Parameters ​

ParameterType
dataImageData

Returns ​

CanvasImage

Properties ​

PropertyModifierTypeDefined in
canvasreadonlyCompatCanvaspackages/minerender/src/canvas/CanvasImage.ts:8
contextreadonlyCanvasRenderingContext2Dpackages/minerender/src/canvas/CanvasImage.ts:9

Accessors ​

dataUrl ​

Get Signature ​

ts
get dataUrl(): string;

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

Returns ​

string


height ​

Get Signature ​

ts
get height(): number;

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

Returns ​

number

Set Signature ​

ts
set height(height): void;

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

Parameters ​
ParameterType
heightnumber
Returns ​

void


width ​

Get Signature ​

ts
get width(): number;

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

Returns ​

number

Set Signature ​

ts
set width(width): void;

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

Parameters ​
ParameterType
widthnumber
Returns ​

void

Methods ​

dispose() ​

ts
dispose(): void;

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

Returns ​

void

Implementation of ​

Disposable.dispose


getData() ​

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

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

Parameters ​

ParameterTypeDefault value
sxnumber0
synumber0
swnumber...
shnumber...

Returns ​

ImageData


putData() ​

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

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

Parameters ​

ParameterTypeDefault value
dataImageDataundefined
dxnumber0
dynumber0
dirtyXnumber0
dirtyYnumber0
dirtyWidthnumberdata.width
dirtyHeightnumberdata.height

Returns ​

void


test() ​

ts
test(): void;

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

Returns ​

void


toDataURL() ​

ts
toDataURL(): string;

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

Returns ​

string