Skip to content

Class: WrappedImage ​

Defined in: packages/minerender/src/WrappedImage.ts:5

Provides pixel and frame access to a canvas-backed image. Simple frame helpers assume a vertical strip of squares.

Constructors ​

Constructor ​

ts
new WrappedImage(dta): WrappedImage;

Defined in: packages/minerender/src/WrappedImage.ts:9

Parameters ​

ParameterType
dtaExtractableImageData

Returns ​

WrappedImage

Properties ​

PropertyModifierTypeDefined in
dtareadonlyExtractableImageDatapackages/minerender/src/WrappedImage.ts:9

Accessors ​

animated ​

Get Signature ​

ts
get animated(): boolean;

Defined in: packages/minerender/src/WrappedImage.ts:55

Whether the dimensions form a vertical strip of square frames, without consulting .mcmeta.

Returns ​

boolean


data ​

Get Signature ​

ts
get data(): ImageData;

Defined in: packages/minerender/src/WrappedImage.ts:12

Returns ​

ImageData


dataArray ​

Get Signature ​

ts
get dataArray(): Uint8ClampedArray;

Defined in: packages/minerender/src/WrappedImage.ts:16

Returns ​

Uint8ClampedArray


frameCount ​

Get Signature ​

ts
get frameCount(): number;

Defined in: packages/minerender/src/WrappedImage.ts:67

Returns ​

number


frameHeight ​

Get Signature ​

ts
get frameHeight(): number;

Defined in: packages/minerender/src/WrappedImage.ts:63

Returns ​

number


frameWidth ​

Get Signature ​

ts
get frameWidth(): number;

Defined in: packages/minerender/src/WrappedImage.ts:59

Returns ​

number


hasTranslucency ​

Get Signature ​

ts
get hasTranslucency(): boolean;

Defined in: packages/minerender/src/WrappedImage.ts:33

Whether any pixel has partial alpha. Binary alpha renders as cutout, not blended.

Returns ​

boolean


hasTransparency ​

Get Signature ​

ts
get hasTransparency(): boolean;

Defined in: packages/minerender/src/WrappedImage.ts:28

Returns ​

boolean


height ​

Get Signature ​

ts
get height(): number;

Defined in: packages/minerender/src/WrappedImage.ts:24

Returns ​

number


width ​

Get Signature ​

ts
get width(): number;

Defined in: packages/minerender/src/WrappedImage.ts:20

Returns ​

number

Methods ​

getFrameSectionData() ​

ts
getFrameSectionData(frame): ImageData;

Defined in: packages/minerender/src/WrappedImage.ts:83

Parameters ​

ParameterType
framenumber

Returns ​

ImageData


getFrameY() ​

ts
getFrameY(frame): number;

Defined in: packages/minerender/src/WrappedImage.ts:71

Parameters ​

ParameterType
framenumber

Returns ​

number


getPixel() ​

ts
getPixel(x, y): Uint8ClampedArray;

Defined in: packages/minerender/src/WrappedImage.ts:79

Parameters ​

ParameterType
xnumber
ynumber

Returns ​

Uint8ClampedArray


getSectionData() ​

ts
getSectionData(
   sx, 
   sy, 
   sw, 
   sh
): ImageData;

Defined in: packages/minerender/src/WrappedImage.ts:75

Parameters ​

ParameterType
sxnumber
synumber
swnumber
shnumber

Returns ​

ImageData