Class MToonMaterialLoaderPlugin

A loader plugin of GLTFLoader for the extension VRMC_materials_mtoon.

This plugin is for uses with WebGLRenderer by default. To use MToon in WebGPURenderer, set materialType to MToonNodeMaterial.

Example: to use with WebGPURenderer

import { MToonMaterialLoaderPlugin } from '@pixiv/three-vrm-materials-mtoon';
import { MToonNodeMaterial } from '@pixiv/three-vrm-materials-mtoon/nodes';

// ...

// Register a MToonMaterialLoaderPlugin with MToonNodeMaterial
loader.register((parser) => {

  // create a WebGPU compatible MToonMaterialLoaderPlugin
  return new MToonMaterialLoaderPlugin(parser, {

    // set the material type to MToonNodeMaterial
    materialType: MToonNodeMaterial,

  });

});

Implements

  • GLTFLoaderPlugin

Constructors

constructor

Properties

debugMode materialType parser renderOrderOffset v0CompatShade EXTENSION_NAME

Accessors

name

Methods

_getMToonExtension afterRoot beforeRoot extendMaterialParams getMaterialType loadMesh

Constructors

constructor

Properties

debugMode

debugMode: MToonMaterialDebugMode

Debug mode for the material. You can visualize several components for diagnosis using debug mode.

See: MToonMaterialDebugMode

Default

'none'

materialType

materialType: typeof Material

The type of the material that this plugin will generate.

If you are using this plugin with WebGPU, set this to MToonNodeMaterial.

Default

MToonMaterial

Readonlyparser

parser: GLTFParser

renderOrderOffset

renderOrderOffset: number

This value will be added to renderOrder of every meshes who have MaterialsMToon. The final renderOrder will be sum of this renderOrderOffset and renderQueueOffsetNumber for each materials.

Default

0

v0CompatShade

v0CompatShade: boolean

There is a line of the shader called "comment out if you want to PBR absolutely" in VRM0.0 MToon. When this is true, the material enables the line to make it compatible with the legacy rendering of VRM. Usually not recommended to turn this on.

Default

false

StaticEXTENSION_NAME

EXTENSION_NAME: string

Accessors

name

  • get name(): string

    Returns string

Methods

Protected_getMToonExtension

  • _getMToonExtension(materialIndex: number): undefined | VRMCMaterialsMToon

    Parameters

    • materialIndex: number

    Returns undefined | VRMCMaterialsMToon

afterRoot

  • afterRoot(gltf: GLTF): Promise<void>

    Parameters

    • gltf: GLTF

    Returns Promise<void>

beforeRoot

  • beforeRoot(): Promise<void>

    Returns Promise<void>

extendMaterialParams

  • extendMaterialParams(
        materialIndex: number,
        materialParams: MToonMaterialParameters,
    ): null | Promise<any>

    Parameters

    Returns null | Promise<any>

getMaterialType

  • getMaterialType(materialIndex: number): null | typeof Material

    Parameters

    • materialIndex: number

    Returns null | typeof Material

loadMesh

  • loadMesh(
        meshIndex: number,
    ): Promise<
        | Group<Object3DEventMap>
        | Mesh<
            BufferGeometry<NormalBufferAttributes>,
            Material | Material[],
            Object3DEventMap,
        >
        | SkinnedMesh<
            BufferGeometry<NormalBufferAttributes>,
            Material | Material[],
            Object3DEventMap,
        >,
    >

    Parameters

    • meshIndex: number

    Returns Promise<
        | Group<Object3DEventMap>
        | Mesh<
            BufferGeometry<NormalBufferAttributes>,
            Material | Material[],
            Object3DEventMap,
        >
        | SkinnedMesh<
            BufferGeometry<NormalBufferAttributes>,
            Material | Material[],
            Object3DEventMap,
        >,
    >

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods