---

title: MaterialXLoader category: Addons layout: docs

MaterialXLoader

A loader for the MaterialX format.

The node materials loaded with this loader can only be used with WebGPURenderer.

Code Example

const loader = new MaterialXLoader().setPath( SAMPLE_PATH );
const materials = await loader.loadAsync( 'standard_surface_brass_tiled.mtlx' );

Import

MaterialXLoader is an addon, and must be imported explicitly, see Installation#Addons.

import { MaterialXLoader } from 'three/addons/loaders/MaterialXLoader.js';

Constructor

new MaterialXLoader( manager : LoadingManager )

Constructs a new MaterialX loader.

manager | The loading manager.
---|---

Methods

.load( url : string, onLoad : function, onProgress : onProgressCallback, onError : onErrorCallback ) : MaterialXLoader

Starts loading from the given URL and passes the loaded MaterialX asset to the onLoad() callback.

url | The path/URL of the file to be loaded. This can also be a data URI.
---|---
onLoad | Executed when the loading process has been finished.
onProgress | Executed while the loading is in progress.
onError | Executed when errors occur.

Overrides: Loader#load

Returns: A reference to this loader.

.parse( text : string ) : Object.<string, NodeMaterial>

Parses the given MaterialX data and returns the resulting materials.

Supported standard_surface inputs:

• base, base_color: Base color/albedo
• opacity: Alpha/transparency
• specular_roughness: Surface roughness
• metalness: Metallic property
• specular: Specular reflection intensity
• specular_color: Specular reflection color
• ior: Index of refraction
• specular_anisotropy, specular_rotation: Anisotropic reflection
• transmission, transmission_color: Transmission properties
• thin_film_thickness, thin_film_ior: Thin film interference
• sheen, sheen_color, sheen_roughness: Sheen properties
• normal: Normal map
• coat, coat_roughness, coat_color: Clearcoat properties
• emission, emissionColor: Emission properties

text | The raw MaterialX data as a string.
---|---

Overrides: Loader#parse

Returns: A dictionary holding the parse node materials.

Source

examples/jsm/loaders/MaterialXLoader.js