Interface PhongFragmentShaderInputParams

Parameters used to build a phong fragment shader.

interface PhongFragmentShaderInputParams {
    toneMapping?: ToneMappings;
    outputColorSpace?: ColorSpace;
    additionalVaryings?: { type: string; name: string }[];
    fragmentOutput?: FragmentOutput;
    chunks?: AdditionalChunks;
    geometry: Geometry;
    materialUniform?: BufferBindingBaseParams;
    materialUniformName?: string;
    receiveShadows?: boolean;
    baseColorTexture?: ShaderTextureDescriptor;
    normalTexture?: ShaderTextureDescriptor;
    emissiveTexture?: ShaderTextureDescriptor;
    occlusionTexture?: ShaderTextureDescriptor;
    metallicRoughnessTexture?: ShaderTextureDescriptor;
    specularTexture?: ShaderTextureDescriptor;
    specularFactorTexture?: ShaderTextureDescriptor;
    specularColorTexture?: ShaderTextureDescriptor;
}

Hierarchy (View Summary)

Properties

toneMapping? outputColorSpace? additionalVaryings? fragmentOutput? chunks? geometry materialUniform? materialUniformName? receiveShadows? baseColorTexture? normalTexture? emissiveTexture? occlusionTexture? metallicRoughnessTexture? specularTexture? specularFactorTexture? specularColorTexture?

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.

OptionalbaseColorTexture

baseColorTexture?: ShaderTextureDescriptor

Base color texture descriptor to use if any.

OptionalnormalTexture

normalTexture?: ShaderTextureDescriptor

Normal 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.

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.

Settings

Member Visibility

On This Page

Properties