Taos API Reference
    Preparing search index...

    Type Alias MaterialDoc

    MaterialDoc:
        | {
            type: "pbr";
            albedo?: [number, number, number, number];
            roughness?: number;
            metallic?: number;
            emissive?: [number, number, number];
            transparent?: boolean;
        }
        | {
            type: "wgsl";
            shader?: string;
            params?: Record<string, number | number[] | boolean>;
            textures?: (string | null)[];
            transparent?: boolean;
            name?: string;
        }

    Type Declaration

    • {
          type: "pbr";
          albedo?: [number, number, number, number];
          roughness?: number;
          metallic?: number;
          emissive?: [number, number, number];
          transparent?: boolean;
      }
      • type: "pbr"
      • Optionalalbedo?: [number, number, number, number]
      • Optionalroughness?: number
      • Optionalmetallic?: number
      • Optionalemissive?: [number, number, number]

        Linear-space emissive RGB multiplier. Values above 1 push the surface over the bloom threshold for a neon/glow look. Default [0,0,0] (off).

      • Optionaltransparent?: boolean
    • {
          type: "wgsl";
          shader?: string;
          params?: Record<string, number | number[] | boolean>;
          textures?: (string | null)[];
          transparent?: boolean;
          name?: string;
      }
      • type: "wgsl"

        A user-authored WGSL surface shader (see taos CustomShaderMaterial). The shader source lives in a standalone .wgsl asset referenced by guid; the material carries four editor-tunable floats the shader reads as s.params. Deferred (opaque) only.

      • Optionalshader?: string

        Guid of the .wgsl / .shadergraph shader asset (omitted until assigned).

      • Optionalparams?: Record<string, number | number[] | boolean>

        Parameter value overrides by name (a number, number[], or boolean).

      • Optionaltextures?: (string | null)[]

        Guids for the four texture slots tex0..tex3 (null/absent → 1×1 white).

      • Optionaltransparent?: boolean

        Route through the forward transparent (unlit) path with alpha blending.

      • Optionalname?: string

        Display name (Inspector only).