Interface MToonMaterialParameters

interface MToonMaterialParameters {
    alphaHash?: boolean;
    alphaTest?: number;
    alphaToCoverage?: boolean;
    blendAlpha?: number;
    blendColor?: ColorRepresentation;
    blendDst?: BlendingDstFactor;
    blendDstAlpha?: number;
    blendEquation?: BlendingEquation;
    blendEquationAlpha?: number;
    blending?: Blending;
    blendSrc?:
        | 200
        | 201
        | 202
        | 203
        | 204
        | 205
        | 206
        | 207
        | 208
        | 209
        | 210
        | 211
        | 212
        | 213
        | 214;
    blendSrcAlpha?: number;
    clipIntersection?: boolean;
    clipping?: boolean;
    clippingPlanes?: Plane[];
    clipShadows?: boolean;
    color?: Color;
    colorWrite?: boolean;
    debugMode?: MToonMaterialDebugMode;
    defines?: any;
    depthFunc?: DepthModes;
    depthTest?: boolean;
    depthWrite?: boolean;
    dithering?: boolean;
    emissive?: Color;
    emissiveIntensity?: number;
    emissiveMap?: Texture;
    extensions?: { clipCullDistance?: boolean; multiDraw?: boolean };
    fog?: boolean;
    forceSinglePass?: boolean;
    format?: PixelFormat;
    fragmentShader?: string;
    giEqualizationFactor?: number;
    glslVersion?: GLSLVersion;
    ignoreVertexColor?: boolean;
    isOutline?: boolean;
    lights?: boolean;
    linewidth?: number;
    map?: Texture;
    matcapFactor?: Color;
    matcapTexture?: Texture;
    name?: string;
    normalMap?: Texture;
    normalScale?: Vector2;
    opacity?: number;
    outlineColorFactor?: Color;
    outlineLightingMixFactor?: number;
    outlineWidthFactor?: number;
    outlineWidthMode?: MToonMaterialOutlineWidthMode;
    outlineWidthMultiplyTexture?: Texture;
    parametricRimColorFactor?: Color;
    parametricRimFresnelPowerFactor?: number;
    parametricRimLiftFactor?: number;
    polygonOffset?: boolean;
    polygonOffsetFactor?: number;
    polygonOffsetUnits?: number;
    precision?: null | "highp" | "mediump" | "lowp";
    premultipliedAlpha?: boolean;
    rimLightingMixFactor?: number;
    rimMultiplyTexture?: Texture;
    shadeColorFactor?: Color;
    shadeMultiplyTexture?: Texture;
    shadingShiftFactor?: number;
    shadingShiftTexture?: Texture;
    shadingShiftTextureScale?: number;
    shadingToonyFactor?: number;
    shadowSide?: Side;
    side?: Side;
    stencilFail?: StencilOp;
    stencilFunc?: StencilFunc;
    stencilFuncMask?: number;
    stencilRef?: number;
    stencilWrite?: boolean;
    stencilWriteMask?: number;
    stencilZFail?: StencilOp;
    stencilZPass?: StencilOp;
    toneMapped?: boolean;
    transparent?: boolean;
    transparentWithZWrite?: boolean;
    uniforms?: { [uniform: string]: IUniform<any> };
    uniformsGroups?: UniformsGroup[];
    userData?: Record<string, any>;
    uvAnimationMaskTexture?: Texture;
    uvAnimationRotationSpeedFactor?: number;
    uvAnimationScrollXSpeedFactor?: number;
    uvAnimationScrollYSpeedFactor?: number;
    v0CompatShade?: boolean;
    vertexColors?: boolean;
    vertexShader?: string;
    visible?: boolean;
    wireframe?: boolean;
    wireframeLinewidth?: number;
}

Hierarchy

  • ShaderMaterialParameters
    • MToonMaterialParameters

Properties

alphaHash? alphaTest? alphaToCoverage? blendAlpha? blendColor? blendDst? blendDstAlpha? blendEquation? blendEquationAlpha? blending? blendSrc? blendSrcAlpha? clipIntersection? clipping? clippingPlanes? clipShadows? color? colorWrite? debugMode? defines? depthFunc? depthTest? depthWrite? dithering? emissive? emissiveIntensity? emissiveMap? extensions? fog? forceSinglePass? format? fragmentShader? giEqualizationFactor? glslVersion? ignoreVertexColor? isOutline? lights? linewidth? map? matcapFactor? matcapTexture? name? normalMap? normalScale? opacity? outlineColorFactor? outlineLightingMixFactor? outlineWidthFactor? outlineWidthMode? outlineWidthMultiplyTexture? parametricRimColorFactor? parametricRimFresnelPowerFactor? parametricRimLiftFactor? polygonOffset? polygonOffsetFactor? polygonOffsetUnits? precision? premultipliedAlpha? rimLightingMixFactor? rimMultiplyTexture? shadeColorFactor? shadeMultiplyTexture? shadingShiftFactor? shadingShiftTexture? shadingShiftTextureScale? shadingToonyFactor? shadowSide? side? stencilFail? stencilFunc? stencilFuncMask? stencilRef? stencilWrite? stencilWriteMask? stencilZFail? stencilZPass? toneMapped? transparent? transparentWithZWrite? uniforms? uniformsGroups? userData? uvAnimationMaskTexture? uvAnimationRotationSpeedFactor? uvAnimationScrollXSpeedFactor? uvAnimationScrollYSpeedFactor? v0CompatShade? vertexColors? vertexShader? visible? wireframe? wireframeLinewidth?

Properties

OptionalalphaHash

alphaHash?: boolean

OptionalalphaTest

alphaTest?: number

OptionalalphaToCoverage

alphaToCoverage?: boolean

OptionalblendAlpha

blendAlpha?: number

OptionalblendColor

blendColor?: ColorRepresentation

OptionalblendDst

blendDst?: BlendingDstFactor

OptionalblendDstAlpha

blendDstAlpha?: number

OptionalblendEquation

blendEquation?: BlendingEquation

OptionalblendEquationAlpha

blendEquationAlpha?: number

Optionalblending

blending?: Blending

OptionalblendSrc

blendSrc?:
    | 200
    | 201
    | 202
    | 203
    | 204
    | 205
    | 206
    | 207
    | 208
    | 209
    | 210
    | 211
    | 212
    | 213
    | 214

OptionalblendSrcAlpha

blendSrcAlpha?: number

OptionalclipIntersection

clipIntersection?: boolean

Optionalclipping

clipping?: boolean

OptionalclippingPlanes

clippingPlanes?: Plane[]

OptionalclipShadows

clipShadows?: boolean

Optionalcolor

color?: Color

OptionalcolorWrite

colorWrite?: boolean

OptionaldebugMode

debugMode?: MToonMaterialDebugMode

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

See: MToonMaterialDebugMode

Optionaldefines

defines?: any

OptionaldepthFunc

depthFunc?: DepthModes

OptionaldepthTest

depthTest?: boolean

OptionaldepthWrite

depthWrite?: boolean

Optionaldithering

dithering?: boolean

Optionalemissive

emissive?: Color

OptionalemissiveIntensity

emissiveIntensity?: number

OptionalemissiveMap

emissiveMap?: Texture

Optionalextensions

extensions?: { clipCullDistance?: boolean; multiDraw?: boolean }

Optionalfog

fog?: boolean

Whether the material is affected by fog. true by default.

OptionalforceSinglePass

forceSinglePass?: boolean

Optionalformat

format?: PixelFormat

OptionalfragmentShader

fragmentShader?: string

OptionalgiEqualizationFactor

giEqualizationFactor?: number

OptionalglslVersion

glslVersion?: GLSLVersion

OptionalignoreVertexColor

ignoreVertexColor?: boolean

When this is true, vertex colors will be ignored. true by default.

OptionalisOutline

isOutline?: boolean

It will draw its outline instead when it's true.

Optionallights

lights?: boolean

Optionallinewidth

linewidth?: number

Optionalmap

map?: Texture

OptionalmatcapFactor

matcapFactor?: Color

OptionalmatcapTexture

matcapTexture?: Texture

Optionalname

name?: string

OptionalnormalMap

normalMap?: Texture

OptionalnormalScale

normalScale?: Vector2

Optionalopacity

opacity?: number

OptionaloutlineColorFactor

outlineColorFactor?: Color

OptionaloutlineLightingMixFactor

outlineLightingMixFactor?: number

OptionaloutlineWidthFactor

outlineWidthFactor?: number

OptionaloutlineWidthMode

outlineWidthMode?: MToonMaterialOutlineWidthMode

OptionaloutlineWidthMultiplyTexture

outlineWidthMultiplyTexture?: Texture

OptionalparametricRimColorFactor

parametricRimColorFactor?: Color

OptionalparametricRimFresnelPowerFactor

parametricRimFresnelPowerFactor?: number

OptionalparametricRimLiftFactor

parametricRimLiftFactor?: number

OptionalpolygonOffset

polygonOffset?: boolean

OptionalpolygonOffsetFactor

polygonOffsetFactor?: number

OptionalpolygonOffsetUnits

polygonOffsetUnits?: number

Optionalprecision

precision?: null | "highp" | "mediump" | "lowp"

OptionalpremultipliedAlpha

premultipliedAlpha?: boolean

OptionalrimLightingMixFactor

rimLightingMixFactor?: number

OptionalrimMultiplyTexture

rimMultiplyTexture?: Texture

OptionalshadeColorFactor

shadeColorFactor?: Color

OptionalshadeMultiplyTexture

shadeMultiplyTexture?: Texture

OptionalshadingShiftFactor

shadingShiftFactor?: number

OptionalshadingShiftTexture

shadingShiftTexture?: Texture

OptionalshadingShiftTextureScale

shadingShiftTextureScale?: number

OptionalshadingToonyFactor

shadingToonyFactor?: number

OptionalshadowSide

shadowSide?: Side

Optionalside

side?: Side

OptionalstencilFail

stencilFail?: StencilOp

OptionalstencilFunc

stencilFunc?: StencilFunc

OptionalstencilFuncMask

stencilFuncMask?: number

OptionalstencilRef

stencilRef?: number

OptionalstencilWrite

stencilWrite?: boolean

OptionalstencilWriteMask

stencilWriteMask?: number

OptionalstencilZFail

stencilZFail?: StencilOp

OptionalstencilZPass

stencilZPass?: StencilOp

OptionaltoneMapped

toneMapped?: boolean

Optionaltransparent

transparent?: boolean

OptionaltransparentWithZWrite

transparentWithZWrite?: boolean

Enable depth buffer when renderMode is transparent. Will be processed in the constructor.

Optionaluniforms

uniforms?: { [uniform: string]: IUniform<any> }

OptionaluniformsGroups

uniformsGroups?: UniformsGroup[]

OptionaluserData

userData?: Record<string, any>

OptionaluvAnimationMaskTexture

uvAnimationMaskTexture?: Texture

OptionaluvAnimationRotationSpeedFactor

uvAnimationRotationSpeedFactor?: number

OptionaluvAnimationScrollXSpeedFactor

uvAnimationScrollXSpeedFactor?: number

OptionaluvAnimationScrollYSpeedFactor

uvAnimationScrollYSpeedFactor?: number

Optionalv0CompatShade

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. false by default.

OptionalvertexColors

vertexColors?: boolean

OptionalvertexShader

vertexShader?: string

Optionalvisible

visible?: boolean

Optionalwireframe

wireframe?: boolean

OptionalwireframeLinewidth

wireframeLinewidth?: number

Settings

Member Visibility

On This Page

Properties
alphaHashalphaTestalphaToCoverageblendAlphablendColorblendDstblendDstAlphablendEquationblendEquationAlphablendingblendSrcblendSrcAlphaclipIntersectionclippingclippingPlanesclipShadowscolorcolorWritedebugModedefinesdepthFuncdepthTestdepthWriteditheringemissiveemissiveIntensityemissiveMapextensionsfogforceSinglePassformatfragmentShadergiEqualizationFactorglslVersionignoreVertexColorisOutlinelightslinewidthmapmatcapFactormatcapTexturenamenormalMapnormalScaleopacityoutlineColorFactoroutlineLightingMixFactoroutlineWidthFactoroutlineWidthModeoutlineWidthMultiplyTextureparametricRimColorFactorparametricRimFresnelPowerFactorparametricRimLiftFactorpolygonOffsetpolygonOffsetFactorpolygonOffsetUnitsprecisionpremultipliedAlpharimLightingMixFactorrimMultiplyTextureshadeColorFactorshadeMultiplyTextureshadingShiftFactorshadingShiftTextureshadingShiftTextureScaleshadingToonyFactorshadowSidesidestencilFailstencilFuncstencilFuncMaskstencilRefstencilWritestencilWriteMaskstencilZFailstencilZPasstoneMappedtransparenttransparentWithZWriteuniformsuniformsGroupsuserDatauvAnimationMaskTextureuvAnimationRotationSpeedFactoruvAnimationScrollXSpeedFactoruvAnimationScrollYSpeedFactorv0CompatShadevertexColorsvertexShadervisiblewireframewireframeLinewidth