StandardMaterial.getLayoutPlan¶

Summary¶

StandardMaterial.getLayoutPlan returns the immutable texture/sampler binding plan derived from the material's active texture features.

Syntax¶

StandardMaterial.getLayoutPlan(): StandardMaterialLayoutPlan

Parameters¶

This method does not take parameters.

Returns¶

type StandardMaterialLayoutPlan = Readonly<{
    featureKey: string;
    bindings: readonly StandardMaterialLayoutBinding[];
    sampledTextureCount: number;
    samplerCount: number;
    usesTransmission: boolean;
}>;

type StandardMaterialLayoutBinding = Readonly<{
    slot: StandardMaterialTextureSlot;
    samplerBinding: number;
    textureBinding: number;
    colorSpace: "srgb" | "linear";
}>;

The renderer validates the plan against device sampling limits before creating its layout. Treat numeric binding assignments as an implementation detail unless integrating directly with the material shader contract.

Type Details¶

The plan is derived from the material's active texture feature mask and cached until a binding-affecting feature changes. featureKey identifies that layout feature set, bindings maps texture slots to group-1 sampler and texture bindings, the count fields support device-limit validation, and usesTransmission signals the extra transmission-source path.

Example¶

const canvas = document.querySelector("canvas");
const wgpu = await WasmGPU.create(canvas);
const material = wgpu.material.standard();

const plan = material.getLayoutPlan();
console.log(plan.featureKey, plan.sampledTextureCount);
for (const binding of plan.bindings) {
  console.log(binding.slot, binding.samplerBinding, binding.textureBinding);
}