Skip to content

MaterialLoader: Introduce registerMaterial(). #32879

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Mugen87 wants to merge 4 commits into
base: dev
Choose a base branch
from
Open

MaterialLoader: Introduce registerMaterial(). #32879

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
81032a3
MaterialLoader: Introduce `registerMaterial()`.
Mugen87 Jan 28, 2026
2ea8443
Three.js: Remove shader material setup.
Mugen87 Mar 6, 2026
73a73ad
MaterialLoader: Improve feedback in `createMaterialFromType()`.
Mugen87 Mar 6, 2026
d11a0aa
Editor: Register shader materials.
Mugen87 Mar 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions editor/js/Loader.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ function Loader( editor ) {

this.texturePath = '';

THREE.MaterialLoader.registerMaterial( 'ShaderMaterial', THREE.ShaderMaterial );
THREE.MaterialLoader.registerMaterial( 'RawShaderMaterial', THREE.RawShaderMaterial );

this.loadItemList = function ( items ) {

LoaderUtils.getFilesFromItemList( items, function ( files, filesMap ) {
Expand Down
2 changes: 2 additions & 0 deletions src/Three.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,6 @@ export { UniformsLib } from './renderers/shaders/UniformsLib.js';
export { UniformsUtils } from './renderers/shaders/UniformsUtils.js';
export { ShaderChunk } from './renderers/shaders/ShaderChunk.js';
export { PMREMGenerator } from './extras/PMREMGenerator.js';
export { ShaderMaterial } from './materials/ShaderMaterial.js';
export { RawShaderMaterial } from './materials/RawShaderMaterial.js';
export { WebGLUtils } from './renderers/webgl/WebGLUtils.js';
42 changes: 35 additions & 7 deletions src/loaders/MaterialLoader.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ import { Loader } from './Loader.js';
import {
ShadowMaterial,
SpriteMaterial,
RawShaderMaterial,
ShaderMaterial,
PointsMaterial,
MeshPhysicalMaterial,
MeshStandardMaterial,
Expand All @@ -26,7 +24,9 @@ import {
LineBasicMaterial,
Material,
} from '../materials/Materials.js';
import { error, warn } from '../utils.js';
import { error, warn, warnOnce } from '../utils.js';

const _customMaterials = {};

/**
* Class for loading materials. The files are internally
Expand Down Expand Up @@ -412,8 +412,6 @@ class MaterialLoader extends Loader {
const materialLib = {
ShadowMaterial,
SpriteMaterial,
RawShaderMaterial,
ShaderMaterial,
PointsMaterial,
MeshPhysicalMaterial,
MeshStandardMaterial,
Expand All @@ -427,10 +425,40 @@ class MaterialLoader extends Loader {
MeshMatcapMaterial,
LineDashedMaterial,
LineBasicMaterial,
Material
Material,
... _customMaterials
};

return new materialLib[ type ]();
const MaterialType = materialLib[ type ];

let materialInstance;

if ( MaterialType === undefined ) {

warnOnce( `MaterialLoader: Unknown material type "${ type }". Use .registerMaterial() before starting the deserialization process.` );
materialInstance = new Material();

} else {

materialInstance = new MaterialType();

}

return materialInstance;

}

/**
* Registers the given material at the internal
* material library.
*
* @static
* @param {string} type - The material type.
* @param {Material} materialClass - The material class.
*/
static registerMaterial( type, materialClass ) {

_customMaterials[ type ] = materialClass;

}

Expand Down
4 changes: 0 additions & 4 deletions src/materials/Materials.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
import { ShadowMaterial } from './ShadowMaterial.js';
import { SpriteMaterial } from './SpriteMaterial.js';
import { RawShaderMaterial } from './RawShaderMaterial.js';
import { ShaderMaterial } from './ShaderMaterial.js';
import { PointsMaterial } from './PointsMaterial.js';
import { MeshPhysicalMaterial } from './MeshPhysicalMaterial.js';
import { MeshStandardMaterial } from './MeshStandardMaterial.js';
Expand All @@ -20,8 +18,6 @@ import { Material } from './Material.js';
export {
ShadowMaterial,
SpriteMaterial,
RawShaderMaterial,
ShaderMaterial,
PointsMaterial,
MeshPhysicalMaterial,
MeshStandardMaterial,
Expand Down