Class: ImageLoader
Defined in: packages/minerender/src/image/ImageLoader.ts:24
Fetches and decodes images through the active browser or Node environment provider.
Constructors
Constructor
new ImageLoader(): ImageLoader;Returns
ImageLoader
Methods
getCanvasData()
static getCanvasData(src): Promise<ExtractableImageData>;Defined in: packages/minerender/src/image/ImageLoader.ts:104
Returns a cached canvas context and dimensions for an image URL or data URL.
Parameters
| Parameter | Type |
|---|---|
src | string |
Returns
Promise<ExtractableImageData>
getData()
static getData(src): Promise<ImageData>;Defined in: packages/minerender/src/image/ImageLoader.ts:96
Returns cached RGBA pixels for an image URL or data URL. Failed loads can be retried.
Parameters
| Parameter | Type |
|---|---|
src | string |
Returns
Promise<ImageData>
getInfo()
static getInfo(src): Promise<ImageInfo>;Defined in: packages/minerender/src/image/ImageLoader.ts:155
Parameters
| Parameter | Type |
|---|---|
src | string |
Returns
Promise<ImageInfo>
getWrapped()
static getWrapped(src): Promise<WrappedImage>;Defined in: packages/minerender/src/image/ImageLoader.ts:167
Parameters
| Parameter | Type |
|---|---|
src | string |
Returns
Promise<WrappedImage>
infoToCanvasData()
static infoToCanvasData(info): Promise<ExtractableImageData>;Defined in: packages/minerender/src/image/ImageLoader.ts:75
Decodes the supplied bytes into a canvas without fetching the source URL again.
Parameters
| Parameter | Type |
|---|---|
info | ImageInfo |
Returns
Promise<ExtractableImageData>
infoToData()
static infoToData(info): Promise<ImageData>;Defined in: packages/minerender/src/image/ImageLoader.ts:90
Parameters
| Parameter | Type |
|---|---|
info | ImageInfo |
Returns
Promise<ImageData>
loadAsync()
static loadAsync(src): Promise<CompatImage>;Defined in: packages/minerender/src/image/ImageLoader.ts:31
Resolves when an image URL has decoded, or rejects if decoding fails.
Parameters
| Parameter | Type |
|---|---|
src | string |
Returns
Promise<CompatImage>
loadCanvasData()
static loadCanvasData(src): Promise<ExtractableImageData>;Defined in: packages/minerender/src/image/ImageLoader.ts:58
Parameters
| Parameter | Type |
|---|---|
src | string |
Returns
Promise<ExtractableImageData>
loadData()
static loadData(src): Promise<ImageData>;Defined in: packages/minerender/src/image/ImageLoader.ts:52
Parameters
| Parameter | Type |
|---|---|
src | string |
Returns
Promise<ImageData>
loadElement()
static loadElement(
src,
onload?,
onerr?
): CompatImage;Defined in: packages/minerender/src/image/ImageLoader.ts:42
Returns an image immediately. Use the callbacks to observe loading, or await loadAsync.
Parameters
| Parameter | Type |
|---|---|
src | string |
onload? | () => void |
onerr? | (err) => void |
Returns
loadInfo()
static loadInfo(src): Promise<ImageInfo>;Defined in: packages/minerender/src/image/ImageLoader.ts:128
Parameters
| Parameter | Type |
|---|---|
src | string |
Returns
Promise<ImageInfo>
loadWrapped()
static loadWrapped(src): Promise<WrappedImage>;Defined in: packages/minerender/src/image/ImageLoader.ts:162
Parameters
| Parameter | Type |
|---|---|
src | string |
Returns
Promise<WrappedImage>
processResponse()
static processResponse(response): Promise<ImageInfo>;Defined in: packages/minerender/src/image/ImageLoader.ts:111
Parameters
| Parameter | Type |
|---|---|
response | Pick<RequestResponse<ArrayBuffer>, "data" | "url"> |
Returns
Promise<ImageInfo>