MaterialSpec.transmission ​

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.

Property of MaterialSpec · inherited by MaterialInput · stable · since 2.0.0

transmission?: {
  factor?: number;
  thickness?: number;
  attenuationColor?: ColorValue;
  attenuationDistance?: number;
};

KHR_materials_transmission and volume. The runtime draws what a transmissive part shows through it at half the drawing buffer's resolution or less, on every tier (spec Appendix B.4, X17); apps write no transmission setting. A transmissive part, like a 'blend' one, casts a solid shadow unless its shadows.cast is false.

Default:

Fields ​

factor ​

factor?: number;

0..1; 0 is opaque to light.

Default: 0

thickness ​

thickness?: number;

Metres of volume, for refraction.

Default: 0 (thin-walled)

attenuationColor ​

attenuationColor?: ColorValue;

The colour light takes on at attenuationDistance.

Default: '#ffffff'

attenuationDistance ​

attenuationDistance?: number;

Metres, finite: Infinity is invalid input, since look state is canonical JSON (spec section 3.4). To turn a GLB's or an earlier write's attenuation off, write attenuationColor: '#ffffff': white absorbs nothing (KHR_materials_volume).

Default: unset, no attenuation (glTF's Infinity)

Generic-API test (spec 3.1) ​