Skip to main content

Function: summarizeMaterialX()

summarizeMaterialX(path, document): MaterialXSummary

Summarizes a parsed document: version, colorspace, materials, referenced textures, and nodes. Powers the CLI's info command and the VS Code extension's stats panel.

Example:

const summary = summarizeMaterialX('material.mtlx', document);
console.log(summary.materials.map((material) => material.name));

Parameters​

path​

string

document​

MaterialXDocument

Returns​

MaterialXSummary