Skip to content

Latest commit

 

History

History
77 lines (57 loc) · 2.11 KB

File metadata and controls

77 lines (57 loc) · 2.11 KB

ImageTextureArrayLoader

A loader for texture arrays described by a JSON manifest.

Loader Characteristic
File Format JSON manifest
File Extension .json
File Type Text
Data Format (ImageType | ImageType[])[]
Supported APIs load, parse

Usage

import {load} from '@loaders.gl/core';
import {ImageTextureArrayLoader} from '@loaders.gl/textures';

const images = await load('texture-array.image-texture-array.json', ImageTextureArrayLoader);

Member images are parsed with ImageLoader by default. If you pass a loader array to load(), those additional loaders are also available for array layers and mip levels.

Manifest

Texture array:

{
  "shape": "image-texture-array",
  "layers": ["layer-0.png", "layer-1.png"]
}

Texture array with mipmaps:

{
  "shape": "image-texture-array",
  "layers": [
    ["layer-0-0.png", "layer-0-1.png"],
    ["layer-1-0.png", "layer-1-1.png"]
  ]
}

Each entry in layers can be either:

  • a single image path
  • an array of image paths representing mip levels
  • a template source object

Template source example:

{
  "shape": "image-texture-array",
  "layers": [
    {"mipLevels": "auto", "template": "layer-{index}-{lod}.png"},
    {"mipLevels": "auto", "template": "layer-{index}-{lod}.png"}
  ]
}

Supported template placeholders are {lod} and {index}. Use \\{ and \\} to include literal braces in filenames.

Options

Option Type Default Description
core.baseUrl string - Base URL used to resolve relative member paths when parsing an in-memory manifest.

Output

  • single-image layers return parsed images
  • mipmapped layers return arrays of parsed images