Interface FragmentShaderInputParams

Parameters used to build a lit fragment shader.

interface FragmentShaderInputParams {
    toneMapping?: ToneMappings;
    outputColorSpace?: ColorSpace;
    additionalVaryings?: { type: string; name: string }[];
    fragmentOutput?: FragmentOutput;
    chunks?: AdditionalChunks;
    geometry: Geometry;
    materialUniform?: BufferBindingBaseParams;
    materialUniformName?: string;
    receiveShadows?: boolean;
    extensionsUsed?: GLTFExtensionsUsed;
    environmentMap?: EnvironmentMap;
    shadingModel?: ShadingModels;
    baseColorTexture?: ShaderTextureDescriptor;
    emissiveTexture?: ShaderTextureDescriptor;
    occlusionTexture?: ShaderTextureDescriptor;
    normalTexture?: ShaderTextureDescriptor;
    metallicRoughnessTexture?: ShaderTextureDescriptor;
    specularTexture?: ShaderTextureDescriptor;
    specularFactorTexture?: ShaderTextureDescriptor;
    specularColorTexture?: ShaderTextureDescriptor;
    transmissionTexture?: ShaderTextureDescriptor;
    thicknessTexture?: ShaderTextureDescriptor;
    transmissionBackgroundTexture?: ShaderTextureDescriptor;
    sheenTexture?: ShaderTextureDescriptor;
    sheenColorTexture?: ShaderTextureDescriptor;
    sheenRoughnessTexture?: ShaderTextureDescriptor;
    anisotropyTexture?: ShaderTextureDescriptor;
    clearcoatTexture?: ShaderTextureDescriptor;
    clearcoatRoughnessTexture?: ShaderTextureDescriptor;
    clearcoatNormalTexture?: ShaderTextureDescriptor;
    iridescenceTexture?: ShaderTextureDescriptor;
    iridescenceFactorTexture?: ShaderTextureDescriptor;
    iridescenceThicknessTexture?: ShaderTextureDescriptor;
}

Hierarchy (View Summary)

Properties

toneMapping? outputColorSpace? additionalVaryings? fragmentOutput? chunks? geometry materialUniform? materialUniformName? receiveShadows? extensionsUsed? environmentMap? shadingModel? baseColorTexture? emissiveTexture? occlusionTexture? normalTexture? metallicRoughnessTexture? specularTexture? specularFactorTexture? specularColorTexture? transmissionTexture? thicknessTexture? transmissionBackgroundTexture? sheenTexture? sheenColorTexture? sheenRoughnessTexture? anisotropyTexture? clearcoatTexture? clearcoatRoughnessTexture? clearcoatNormalTexture? iridescenceTexture? iridescenceFactorTexture? iridescenceThicknessTexture?

Properties

OptionaltoneMapping

toneMapping?: ToneMappings

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

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.

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.

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.

Optionalchunks

chunks?: AdditionalChunks

Additional WGSL chunks to add to the shaders.

geometry

geometry: Geometry

Geometry used to create the fragment shader. Can use the vertexBuffers properties for vertex colors or tangent/bitangent computations.

OptionalmaterialUniform

materialUniform?: BufferBindingBaseParams

The BufferBindingBaseParams holding the material uniform values. Will use default values if not provided.

OptionalmaterialUniformName

materialUniformName?: string

The BufferBindingBaseParams name to use for variables declarations. Default to 'material'.

OptionalreceiveShadows

receiveShadows?: boolean

Whether the shading function should account for current shadows. Default to false.

OptionalextensionsUsed

extensionsUsed?: GLTFExtensionsUsed

The glTF extensions used to generate this fragment shader.

OptionalenvironmentMap

environmentMap?: EnvironmentMap

EnvironmentMap to use for IBL shading.

OptionalshadingModel

shadingModel?: ShadingModels

Shading model to use. Default to 'PBR'.

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.

OptionaltransmissionBackgroundTexture

transmissionBackgroundTexture?: ShaderTextureDescriptor

Transmission scene background 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.

Settings

Member Visibility

On This Page

Properties