Interface LitMeshMaterialParams

Define the material parameters of a LitMesh.

interface LitMeshMaterialParams {
    toneMapping?: ToneMappings;
    additionalVaryings?: { type: string; name: string }[];
    environmentMap?: EnvironmentMap;
    colorSpace?: ColorSpace;
    color?: Vec3;
    opacity?: number;
    alphaCutoff?: number;
    metallic?: number;
    roughness?: number;
    normalScale?: Vec2;
    occlusionIntensity?: number;
    emissiveIntensity?: number;
    emissiveColor?: Vec3;
    specularIntensity?: number;
    specularColor?: Vec3;
    shininess?: number;
    transmission?: number;
    ior?: number;
    dispersion?: number;
    thickness?: number;
    attenuationDistance?: number;
    attenuationColor?: Vec3;
    sheenColor?: Vec3;
    sheenRoughness?: number;
    anisotropy?: number;
    anisotropyVector?: Vec2;
    clearcoat?: number;
    clearcoatRoughness?: number;
    clearcoatNormalScale?: Vec2;
    iridescence?: number;
    iridescenceIOR?: number;
    iridescenceThicknessRange?: Vec2;
    baseColorTexture?: ShaderTextureDescriptor;
    emissiveTexture?: ShaderTextureDescriptor;
    occlusionTexture?: ShaderTextureDescriptor;
    normalTexture?: ShaderTextureDescriptor;
    metallicRoughnessTexture?: ShaderTextureDescriptor;
    specularTexture?: ShaderTextureDescriptor;
    specularFactorTexture?: ShaderTextureDescriptor;
    specularColorTexture?: ShaderTextureDescriptor;
    transmissionTexture?: ShaderTextureDescriptor;
    thicknessTexture?: ShaderTextureDescriptor;
    sheenTexture?: ShaderTextureDescriptor;
    sheenColorTexture?: ShaderTextureDescriptor;
    sheenRoughnessTexture?: ShaderTextureDescriptor;
    anisotropyTexture?: ShaderTextureDescriptor;
    clearcoatTexture?: ShaderTextureDescriptor;
    clearcoatRoughnessTexture?: ShaderTextureDescriptor;
    clearcoatNormalTexture?: ShaderTextureDescriptor;
    iridescenceTexture?: ShaderTextureDescriptor;
    iridescenceFactorTexture?: ShaderTextureDescriptor;
    iridescenceThicknessTexture?: ShaderTextureDescriptor;
    shading?: ShadingModels;
    outputColorSpace?: ColorSpace;
    vertexChunks?: AdditionalChunks;
    fragmentChunks?: AdditionalChunks;
    fragmentOutput?: FragmentOutput;
}

Hierarchy (View Summary)

Properties

toneMapping? additionalVaryings? environmentMap? colorSpace? color? opacity? alphaCutoff? metallic? roughness? normalScale? occlusionIntensity? emissiveIntensity? emissiveColor? specularIntensity? specularColor? shininess? transmission? ior? dispersion? thickness? attenuationDistance? attenuationColor? sheenColor? sheenRoughness? anisotropy? anisotropyVector? clearcoat? clearcoatRoughness? clearcoatNormalScale? iridescence? iridescenceIOR? iridescenceThicknessRange? baseColorTexture? emissiveTexture? occlusionTexture? normalTexture? metallicRoughnessTexture? specularTexture? specularFactorTexture? specularColorTexture? transmissionTexture? thicknessTexture? sheenTexture? sheenColorTexture? sheenRoughnessTexture? anisotropyTexture? clearcoatTexture? clearcoatRoughnessTexture? clearcoatNormalTexture? iridescenceTexture? iridescenceFactorTexture? iridescenceThicknessTexture? shading? outputColorSpace? vertexChunks? fragmentChunks? fragmentOutput?

Properties

OptionaltoneMapping

toneMapping?: ToneMappings

Whether the shading function should apply tone mapping to the resulting color and if so, which one. Default to 'Khronos'.

OptionaladditionalVaryings

additionalVaryings?: { type: string; name: string }[]

Optional additional varyings to pass from the vertex shader to the fragment shader.

Type declaration

  • type: string

    type of the varying.

  • name: string

    name of the varying.

OptionalenvironmentMap

environmentMap?: EnvironmentMap

EnvironmentMap to use for IBL shading.

OptionalcolorSpace

colorSpace?: ColorSpace

ColorSpace to use for material uniform colors. All lighting calculations must be done in linear space. Default to srgb (which means the uniform colors are converted to linear space), but glTF internally use linear.

Optionalcolor

color?: Vec3

Base color of the LitMesh as a Vec3. Default to new Vec3(1).

Optionalopacity

opacity?: number

Opacity of the LitMesh. If different than 1, consider setting the transparent parameter to true. Default to 1.

OptionalalphaCutoff

alphaCutoff?: number

Alpha cutoff threshold value of the LitMesh. Default to 0.5.

Optionalmetallic

metallic?: number

The metallic factor of the LitMesh. Default to 1.

Optionalroughness

roughness?: number

The roughness factor of the LitMesh. Default to 1.

OptionalnormalScale

normalScale?: Vec2

How much the normal map affects the material normal texture if any. Typical ranges are [0-1]. Default to new Vec2(1).

OptionalocclusionIntensity

occlusionIntensity?: number

A scalar multiplier controlling the amount of occlusion applied to the occlusion texture if any. Default to 1.

OptionalemissiveIntensity

emissiveIntensity?: number

Emissive intensity to apply to the emissive color of the LitMesh. Default to 1.

OptionalemissiveColor

emissiveColor?: Vec3

Emissive color of the LitMesh as a Vec3. Default to new Vec3(0) (no emissive color).

OptionalspecularIntensity

specularIntensity?: number

The strength of the specular reflections applied to the LitMesh (not applicable to Lambert shading). Default to 1.

OptionalspecularColor

specularColor?: Vec3

Specular color to use for the specular reflections of the LitMesh as a Vec3 (not applicable to Lambert shading). Default to new Vec3(1).

Optionalshininess

shininess?: number

Shininess of the LitMesh when using Phong shading. Default to 30.

Optionaltransmission

transmission?: number

The base percentage of light that is transmitted through the surface of the LitMesh. Only applicable to PBR shading if transmissive parameter is set to true. Default to 0.

Optionalior

ior?: number

The index of refraction of the LitMesh. Default to 1.5.

Optionaldispersion

dispersion?: number

The strength of the dispersion effect, specified as 20/Abbe number. Only applicable to PBR shading if transmissive parameter is set to true. Default to 0.

Optionalthickness

thickness?: number

The thickness of the volume beneath the surface. The value is given in the coordinate space of the mesh. If the value is 0 the material is thin-walled. Only applicable to PBR shading if transmissive parameter is set to true. Default to 0.

OptionalattenuationDistance

attenuationDistance?: number

Density of the medium given as the average distance that light travels in the medium before interacting with a particle. The value is given in world space. Only applicable to PBR shading if transmissive parameter is set to true. Default to Infinity.

OptionalattenuationColor

attenuationColor?: Vec3

The color as a Vec3 that white light turns into due to absorption when reaching the attenuation distance. Only applicable to PBR shading if transmissive parameter is set to true. Default to new Vec3(1).

OptionalsheenColor

sheenColor?: Vec3

Sheen color to use. Default to new Vec3(0), but sheen is not taken into account if this and sheenRoughness are not set.

OptionalsheenRoughness

sheenRoughness?: number

Sheen roughness to use. Default to 0, but sheen is not taken into account if this and sheenColor are not set.

Optionalanisotropy

anisotropy?: number

Anisotropy strength. Default to 0, but anisotropy is not taken into account if not set or equal to 0.

OptionalanisotropyVector

anisotropyVector?: Vec2

Anisotropy vector based on a rotation value, where x component is cos(rotation) and y component is sin(rotation). Default to new Vec2(1, 0).

Optionalclearcoat

clearcoat?: number

Clearcoat layer intensity. Default to 0, but clearcoat is not taken into account if not set or equal to 0.

OptionalclearcoatRoughness

clearcoatRoughness?: number

Clearcoat layer roughness. Default to 0.

OptionalclearcoatNormalScale

clearcoatNormalScale?: Vec2

Clearcoat normal map scale if any clearcoat normal texture is defined. Default to new Vec2(1).

Optionaliridescence

iridescence?: number

Iridescence intensity factor. Default to 0, but iridescence is not taken into account if not set or equal to 0.

OptionaliridescenceIOR

iridescenceIOR?: number

Index of refraction of the dielectric thin-film layer. Default to 1.3.

OptionaliridescenceThicknessRange

iridescenceThicknessRange?: Vec2

Minimum and maximum thickness of the iridescence layer. Default to new Vec2(100, 400).

OptionalbaseColorTexture

baseColorTexture?: ShaderTextureDescriptor

Base color texture descriptor to use if any.

OptionalemissiveTexture

emissiveTexture?: ShaderTextureDescriptor

Emissive texture descriptor to use if any.

OptionalocclusionTexture

occlusionTexture?: ShaderTextureDescriptor

Occlusion texture descriptor to use if any.

OptionalnormalTexture

normalTexture?: ShaderTextureDescriptor

Normal texture descriptor to use if any.

OptionalmetallicRoughnessTexture

metallicRoughnessTexture?: ShaderTextureDescriptor

Metallic roughness texture descriptor to use if any.

OptionalspecularTexture

specularTexture?: ShaderTextureDescriptor

Specular texture descriptor (mixing both specular color in the RGB channels and specular intensity in the A channel) to use if any.

OptionalspecularFactorTexture

specularFactorTexture?: ShaderTextureDescriptor

Specular intensity texture descriptor (using the A channel) to use if any.

OptionalspecularColorTexture

specularColorTexture?: ShaderTextureDescriptor

Specular color texture descriptor (using the RGB channels) to use if any.

OptionaltransmissionTexture

transmissionTexture?: ShaderTextureDescriptor

Transmission texture descriptor to use if any.

OptionalthicknessTexture

thicknessTexture?: ShaderTextureDescriptor

Thickness texture descriptor to use if any.

OptionalsheenTexture

sheenTexture?: ShaderTextureDescriptor

Sheen texture descriptor (mixing both sheen color in the RGB channels and roughness in the A channel) to use if any.

OptionalsheenColorTexture

sheenColorTexture?: ShaderTextureDescriptor

Sheen color texture descriptor (using the RGB channels) to use if any.

OptionalsheenRoughnessTexture

sheenRoughnessTexture?: ShaderTextureDescriptor

Sheen roughness texture descriptor (using the A channel) to use if any.

OptionalanisotropyTexture

anisotropyTexture?: ShaderTextureDescriptor

Anisotropy texture descriptor to use if any.

OptionalclearcoatTexture

clearcoatTexture?: ShaderTextureDescriptor

Clearcoat texture descriptor (using the R channel) to use if any.

OptionalclearcoatRoughnessTexture

clearcoatRoughnessTexture?: ShaderTextureDescriptor

Clearcoat roughness texture descriptor (using the G channel) to use if any.

OptionalclearcoatNormalTexture

clearcoatNormalTexture?: ShaderTextureDescriptor

Clearcoat normal texture descriptor to use if any.

OptionaliridescenceTexture

iridescenceTexture?: ShaderTextureDescriptor

Iridescence texture descriptor (using the R channel for intensity and G channel for thickness) to use if any.

OptionaliridescenceFactorTexture

iridescenceFactorTexture?: ShaderTextureDescriptor

Iridescence texture descriptor (using the R channel) to use if any.

OptionaliridescenceThicknessTexture

iridescenceThicknessTexture?: ShaderTextureDescriptor

Iridescence thickness texture descriptor (using the G channel) to use if any.

Optionalshading

shading?: ShadingModels

ShadingModels to use for lighting. Default to PBR.

OptionaloutputColorSpace

outputColorSpace?: ColorSpace

In which ColorSpace the output should be done. srgb should be used most of the time, except for some post processing effects that need input colors in linear space (such as bloom). Default to srgb.

OptionalvertexChunks

vertexChunks?: AdditionalChunks

Additional WGSL chunks to add to the vertex shaders.

OptionalfragmentChunks

fragmentChunks?: AdditionalChunks

Additional WGSL chunks to add to the fragment shaders.

OptionalfragmentOutput

fragmentOutput?: FragmentOutput

Custom fragment shader output structure members and returned values to use if needed. Useful when rendering to a Multiple Render Target for example.

Settings

Member Visibility

On This Page

Properties
toneMappingadditionalVaryingsenvironmentMapcolorSpacecoloropacityalphaCutoffmetallicroughnessnormalScaleocclusionIntensityemissiveIntensityemissiveColorspecularIntensityspecularColorshininesstransmissioniordispersionthicknessattenuationDistanceattenuationColorsheenColorsheenRoughnessanisotropyanisotropyVectorclearcoatclearcoatRoughnessclearcoatNormalScaleiridescenceiridescenceIORiridescenceThicknessRangebaseColorTextureemissiveTextureocclusionTexturenormalTexturemetallicRoughnessTexturespecularTexturespecularFactorTexturespecularColorTexturetransmissionTexturethicknessTexturesheenTexturesheenColorTexturesheenRoughnessTextureanisotropyTextureclearcoatTextureclearcoatRoughnessTextureclearcoatNormalTextureiridescenceTextureiridescenceFactorTextureiridescenceThicknessTextureshadingoutputColorSpacevertexChunksfragmentChunksfragmentOutput