Skip to content
Shapemetry

Model - Params

API reference for src/lanes/textures/params on @huukhanhnguyen/model, reachable from ..

See the Guide for the ModelJSON / evaluate pipeline.

API reference

Signatures are generated from the live package .d.ts - not hand-written.

TEXTURE_BUILTIN_PARAMS

const

Builtin parameter keys every texture chain has — the values slice of the ONE lane-builtin table (schema/vocabulary/builtinParams.ts, which also carries each key's type + tooltip for docs), re-exported here where every texture consumer already looks. Fixed names, referenced from any formula/value arg; a chain DECLARES them in parameters to set its own values, a consumer rebinds them per call via argsOverride:

  • lengthX/lengthY: physical mm of one tile (default 1000). DECLARING them attaches the size to the output stream (TextureData tileWidth/ tileHeight) — undeclared, the material record's fallback applies.
  • imageWidth/imageHeight: output pixel resolution — source ops default to them, and when DECLARED (or overridden) the final buffer is resampled to exactly that size (draw small and upscale, or draw big for free AA). imageHeight 0 = derive from the physical aspect (imageWidth × lengthY/lengthX — square physical pixels without thinking about it).
  • wrap / filter / uvSet: sampling contract (declare-to-activate — undeclared keeps the default REPEAT + LINEAR + TEXCOORD_0 exactly). wrap: 'repeat' | 'clamp' | 'mirror'; filter: 'linear' | 'nearest'; uvSet: 0 | 1 (see TextureData.uvSet for the chain-vs-slot trade-off).
const TEXTURE_BUILTIN_PARAMS: BuiltinValues<{ readonly lengthX: { readonly default: 1000
Last updated: 📖 1 min readEdit on GitHub