gpu-curtains
    Preparing search index...

    Interface GetPBRShadingParams

    Defines the basic parameters available for the PBR shading getter function.

    interface GetPBRShadingParams {
        environmentMap?: EnvironmentMap;
        transmissionBackgroundTexture?: ShaderTextureDescriptor;
        extensionsUsed?: GLTFExtensionsUsed;
        addUtils?: boolean;
        receiveShadows?: boolean;
        toneMapping?: ToneMappings;
        outputColorSpace?: ColorSpace;
        useOcclusion?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    environmentMap? transmissionBackgroundTexture? extensionsUsed? addUtils? receiveShadows? toneMapping? outputColorSpace? useOcclusion?

    Properties

    environmentMap?: EnvironmentMap

    EnvironmentMap to use for IBL shading.

    transmissionBackgroundTexture?: ShaderTextureDescriptor

    Transmission scene background texture descriptor to use if any.

    extensionsUsed?: GLTFExtensionsUsed

    The glTF extensions used to generate this fragment shader.

    addUtils?: boolean

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

    receiveShadows?: boolean

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

    toneMapping?: ToneMappings

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

    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.

    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