Interface CanonicalMaterial

A canonical material represents the internal material type we pass around and support wiring up to gltf like properties.

interface CanonicalMaterial {
    baseColor: ColorRGBA;
    blend: BlendMode;
    doubleSided: boolean;
    ior?: number;
    legacyColor: ColorRGBA;
    metalness?: number;
    name: string;
    roughness?: number;
    specular?: ColorRGBA;
}

Properties

baseColor blend doubleSided ior? legacyColor metalness? name roughness? specular?

Properties

ReadonlybaseColor

baseColor: ColorRGBA

The base color of this material (in PBR terms)

Readonlyblend

blend: BlendMode

The blend mode for this surface (should probably be opaque).

ReadonlydoubleSided

doubleSided: boolean

Is this material double sided or is it back face culled?

Optional Readonlyior

ior?: number

The index of refraction of this surface.

ReadonlylegacyColor

legacyColor: ColorRGBA

Legacy color to match web-ifc display

Optional Readonlymetalness

metalness?: number

How metallic is this surface? 0 for dialletric, 1 for metal.

Readonlyname

name: string

The name of this material, which may be procedurally generated.

Optional Readonlyroughness

roughness?: number

How rough is this surface vs how shiny (1 for maximum rougness, 0 for full specular)

Optional Readonlyspecular

specular?: ColorRGBA

The specular color of this surface (F0, overrides the F0 that would be produced by baseColor, metalness and index of refraction).

Settings

Member Visibility

On This Page

Properties