TextureSpec ​

Contract 2.0.0 · package sha256 a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e · generated from configurator-runtime.d.ts by services/onsite-scripter/scripts/build-contract-docs.mjs; edit the source, not this file.

Interface · import type { TextureSpec } from '@holostep-configurators/runtime-client/contract'; · stable · since 2.0.0 · section 8. Materials and textures

At most one of url and image. With neither, inside a partial MaterialSpec, the spec changes only placement and sampling (uv, scale, offset, rotationDeg, sizeM, wrap, sampling) of the texture the slot shows now, whether it comes from the GLB, the scene model or an earlier rule. It never pins the image, so a later select() or undo changes the image and keeps your placement. On a slot that shows no texture it does nothing. With url or image it is a new texture, placed by its own fields: every field it omits (uv, scale, offset, rotationDeg, sizeM, wrap, sampling, colorSpace, enabled) takes its default below, never the value of the texture it covers (its texCoord, KHR_texture_transform or a stored …TextureEnabled: false), and only a URL-less spec above it lays fields over it, while the GLB's own image keeps its authored placement. Successive writes to one rule merge first (spec section 6.10, R10), so a scale an earlier write to that rule gave stays. Every texture, url, optimizedUrl and image alike, is sampled with the glTF convention: row 0 of the image is v = 0, never flipped.

Members ​

Declaration ​

export interface TextureSpec {
  url?: string;
  image?: HTMLCanvasElement | OffscreenCanvas | ImageBitmap | ImageRef;
  optimizedUrl?: string;
  enabled?: boolean;
  uv?: 0 | 1 | 2 | 3;
  scale?: number | Point2;
  offset?: Point2;
  rotationDeg?: number;
  sizeM?: number | Point2;
  wrap?: Wrap | readonly [
    Wrap,
    Wrap
  ];
  sampling?: TextureSampling;
  colorSpace?: 'srgb' | 'linear';
}

Example ​

Imports: values (has, validate, the Holo*Error classes, the pure helpers) from @holostep-configurators/runtime-client, types from @holostep-configurators/runtime-client/contract, /math and /testing names from those entries; boot from the runtime module the root's loadRuntimeAtFloor resolves to. A type your page defines is your app's: declare it there, never import it from the package.

Compiled under the contract's strict settings (examples/declaration/08-TextureSpec.ts):

import type { Session } from '@holostep-configurators/runtime-client/contract';
declare const session: Session;
declare const signal: AbortSignal;
declare const fabricGroup: string;
// Tile whatever fabric the shopper picks: no url, so only the placement is written.
await session.find({ slot: 'fabric' }).set({ material: { maps: {
  baseColor: { scale: 16 }, normal: { scale: 16 }, roughness: { scale: 16 },
} } });
// the image changes; the tiling stays
await session.select(fabricGroup, 'linen', { actor: 'shopper' });

Generic-API test (spec 3.1) ​