studio(what: string) → string

pane(what: string, across: string) → string

gem(what: string) → string

photo(what: string) → string

toon(what: string) → string

get(id: string) → Entry

The definition of one material, or nil.

ids( ) → void

Every material id, in catalog order.

texRef(name: string) → string

hasTexture(name: string) → boolean

texName(s: Entry, slot: string) → string

The texture name a material uses for a slot ("albedo", "normal" or "mask").

galleryLayout(list: { any }, minSize: number) → void

The gallery page size and page that show every material of this collection, and nothing else, on one ring of materialLibraryKit's "all" view. Mirrors the core Gallery's pagination. After syntheticsMaterials' SyntheticCatalog.galleryLayout (MIT).

pageAt(size: number) → number

materialDoc(s: Entry) → void

The mat.yaml document for one material.

flowLists(text: string) → string

Collapse YAML block lists of plain numbers into flow lists (`[a, b, c, d]`). The engine's material loader reads a colour property only in flow form.

writeMaterial(s: Entry) → void

Write materials/<id>.material/mat.yaml for one material (creating the asset the first time).

round(x: number, d: number) → number

costWord(kb: number) → string

The texture-cost tag: textures-none (0 KB), textures-tiny (under 128 KB), textures-light (under 1.5 MB), textures-medium (under 2.5 MB) or textures-heavy.

finishWord(r: number) → string

The finish tag from the roughness range: glossy (under 0.25), satin (under 0.6) or rough.

metalWord(m: { number }) → string

The metal tag from a metallic range: non-metallic, metallic or part-metallic.

tileWord(s: Entry) → string

The `tile-<metres>m` tag; "tile-uniform" for a material with no texture and no repeating pattern.

featureWords(s: Entry) → void

The engine see-through features a material relies on, as tags (and as README words).

add(w: string) → void

mipBytes(size: number) → number

GPU bytes of one square block-compressed texture (1 byte per pixel, BC7 / ASTC 4x4) with its full mip chain.

roughnessRange(s: Entry) → void

The roughness range of a material: its base roughness, widened by the mask's G channel (added roughness) where it has one, and the painted parts' roughness.

metalRange(s: Entry) → void

The metallic range of a material: every material in this collection is non-metallic (the lead came and wire included).

r2(x: number) → string

rgbText(c: { number }) → string

distanceText(m: number) → string

A distance in metres as the README writes it: millimetres under 0.1 m, else metres.

optics(s: Entry) → Optics

The optical numbers of one material: index of refraction, and what white light looks like after `absorbDistance` metres inside it (Beer–Lambert), with one line saying so.

textureNames( ) → void

Every texture name this package's materials bind, each once.

tags(s: Entry, kb: number, rough: { number }, metal: { number }) → void

The tags of one entry, in the order the README lists them.

add(w: string) → void

build( ) → void

Write every material and the collection.yaml, measuring texture memory from what each material binds. Returns { count, path, totalKB } (totalKB counts every texture once).

compactReferences( ) → void

Keep every reference picture as a JPEG source (quality 90, about a sixth of the generated PNG) loaded at 512 px. Returns { count, bytes } of the sources kept.

writeBoards( ) → number

Write boards/<id>.material for every material: its reference picture on the engine's unlit shader, which the showcase hangs beside the material. Returns the count.