Interface GetShadingParams

Defines the basic parameters available for the various shading getter functions.

interface GetShadingParams {
    addUtils?: boolean;
    receiveShadows?: boolean;
    toneMapping?: ToneMappings;
    outputColorSpace?: ColorSpace;
    useOcclusion?: boolean;
}

Hierarchy (View Summary)

Properties

addUtils? receiveShadows? toneMapping? outputColorSpace? useOcclusion?

Properties

OptionaladdUtils

addUtils?: boolean

Whether to add the utils functions such as constants or helper functions. Default to true.

OptionalreceiveShadows

receiveShadows?: boolean

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

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.

OptionaluseOcclusion

useOcclusion?: boolean

Whether ambient occlusion should be accounted when calculating the shading. Default to false. If set to true, a float f32 ambient occlusion value should be passed as the last shading function parameter.

Settings

Member Visibility

On This Page

Properties