Interface PostProcessModuleOptions

interface PostProcessModuleOptions {
    autoAddBloomPass?: boolean;
    autoAddCopyPass?: boolean;
    autoAddOutlinePass?: boolean;
    autoAddRenderPass?: boolean;
    autoAddSelectedPass?: boolean;
    autoClear?: boolean;
    bloomPass?: {
        blendFunction?: BlendFunction;
        disableMergeEffect?: boolean;
        height?: number;
        ignoreBackground?: boolean;
        intensity?: number;
        inverted?: boolean;
        kernelSize?: KernelSize;
        levels?: number;
        luminancePassEnabled?: boolean;
        luminanceSmoothing?: number;
        luminanceThreshold?: number;
        mipmapBlur?: boolean;
        radius?: number;
        resolutionScale?: number;
        resolutionX?: number;
        resolutionY?: number;
        width?: number;
    };
    depthPickMinZ?: number;
    depthPickingPass?: boolean;
    disableBloomPassWhenIdle?: boolean;
    disableCacheEffectPass?: boolean;
    disableDepthPickTime?: number;
    disableDepthPickWhenlogDepthBuffer?: boolean;
    disableMergeEffect?: boolean;
    disableOutlinePassWhenIdle?: boolean;
    disableSelectedPassWhenIdle?: boolean;
    disableWhenIdle?: boolean;
    enable?: boolean;
    outlinePass?: {
        blendFunction?: BlendFunction;
        blur?: boolean;
        blurriness?: number;
        disableMergeEffect?: boolean;
        edgeStrength?: number;
        height?: number;
        hiddenEdgeColor?: number;
        multisampling?: number;
        patternScale?: number;
        patternTexture?: Texture;
        pulseSpeed?: number;
        resolutionScale?: number;
        resolutionX?: number;
        resolutionY?: number;
        visibleEdgeColor?: number;
        width?: number;
        xRay?: boolean;
    };
    renderTargetOptions?: {
        alpha?: boolean;
        depthBuffer?: boolean;
        frameBufferType?: number;
        multisampling?: number;
        stencilBuffer?: boolean;
    };
    renderUpdate?: boolean;
    selectedPass?: {
        blendFunction?: BlendFunction;
        blur?: boolean;
        blurriness?: number;
        disableMergeEffect?: boolean;
        edgeStrength?: number;
        height?: number;
        hiddenEdgeColor?: number;
        multisampling?: number;
        patternScale?: number;
        patternTexture?: Texture;
        pulseSpeed?: number;
        resolutionScale?: number;
        resolutionX?: number;
        resolutionY?: number;
        visibleEdgeColor?: number;
        width?: number;
        xRay?: boolean;
    };
    useFXAA?: boolean;
    useSMAA?: boolean;
    workaroundEnabled?: boolean;
}

Properties

autoAddBloomPass?: boolean

自动增加辉光通道

autoAddCopyPass?: boolean

自动增加copypass通道

autoAddOutlinePass?: boolean

自动增加Outline通道

autoAddRenderPass?: boolean

自动增加渲染通道

autoAddSelectedPass?: boolean

自动增加Selected Outline通道

autoClear?: boolean

自动清除

bloomPass?: {
    blendFunction?: BlendFunction;
    disableMergeEffect?: boolean;
    height?: number;
    ignoreBackground?: boolean;
    intensity?: number;
    inverted?: boolean;
    kernelSize?: KernelSize;
    levels?: number;
    luminancePassEnabled?: boolean;
    luminanceSmoothing?: number;
    luminanceThreshold?: number;
    mipmapBlur?: boolean;
    radius?: number;
    resolutionScale?: number;
    resolutionX?: number;
    resolutionY?: number;
    width?: number;
}

Type declaration

  • Optional blendFunction?: BlendFunction
  • Optional disableMergeEffect?: boolean

    禁止自动合并通道 默认true

  • Optional height?: number
  • Optional ignoreBackground?: boolean
  • Optional intensity?: number
  • Optional inverted?: boolean
  • Optional kernelSize?: KernelSize
  • Optional levels?: number
  • Optional luminancePassEnabled?: boolean
  • Optional luminanceSmoothing?: number
  • Optional luminanceThreshold?: number
  • Optional mipmapBlur?: boolean
  • Optional radius?: number
  • Optional resolutionScale?: number
  • Optional resolutionX?: number
  • Optional resolutionY?: number
  • Optional width?: number
depthPickMinZ?: number

拾取深度时,有效最小值,默认0

depthPickingPass?: boolean
disableBloomPassWhenIdle?: boolean

当bloom空闲时,自动禁用,有数据时才启用,默认true

disableCacheEffectPass?: boolean

合并道道时禁止缓存 默认false

disableDepthPickTime?: number

当深度拾取空闲时,自动停止,时间秒,0表示不自动停止。默认3

disableDepthPickWhenlogDepthBuffer?: boolean

当logarithmicDepthBuffer为true时禁止深度拾取,默认false

disableMergeEffect?: boolean

禁止自动合并通道 默认false

disableOutlinePassWhenIdle?: boolean

当bloom空闲时,自动禁用,有数据时才启用,默认true

disableSelectedPassWhenIdle?: boolean

当selected空闲时,自动禁用,有数据时才启用,默认true

disableWhenIdle?: boolean

当无需后期处理时自动禁止后期处理,默认false

enable?: boolean
outlinePass?: {
    blendFunction?: BlendFunction;
    blur?: boolean;
    blurriness?: number;
    disableMergeEffect?: boolean;
    edgeStrength?: number;
    height?: number;
    hiddenEdgeColor?: number;
    multisampling?: number;
    patternScale?: number;
    patternTexture?: Texture;
    pulseSpeed?: number;
    resolutionScale?: number;
    resolutionX?: number;
    resolutionY?: number;
    visibleEdgeColor?: number;
    width?: number;
    xRay?: boolean;
}

Type declaration

  • Optional blendFunction?: BlendFunction
  • Optional blur?: boolean
  • Optional blurriness?: number
  • Optional disableMergeEffect?: boolean

    禁止自动合并通道 默认false

  • Optional edgeStrength?: number
  • Optional height?: number
  • Optional hiddenEdgeColor?: number
  • Optional multisampling?: number
  • Optional patternScale?: number
  • Optional patternTexture?: Texture
  • Optional pulseSpeed?: number
  • Optional resolutionScale?: number
  • Optional resolutionX?: number
  • Optional resolutionY?: number
  • Optional visibleEdgeColor?: number
  • Optional width?: number
  • Optional xRay?: boolean
renderTargetOptions?: {
    alpha?: boolean;
    depthBuffer?: boolean;
    frameBufferType?: number;
    multisampling?: number;
    stencilBuffer?: boolean;
}

Type declaration

  • Optional alpha?: boolean
  • Optional depthBuffer?: boolean
  • Optional frameBufferType?: number
  • Optional multisampling?: number

    默认4

  • Optional stencilBuffer?: boolean
renderUpdate?: boolean

是否允许渲染更新

selectedPass?: {
    blendFunction?: BlendFunction;
    blur?: boolean;
    blurriness?: number;
    disableMergeEffect?: boolean;
    edgeStrength?: number;
    height?: number;
    hiddenEdgeColor?: number;
    multisampling?: number;
    patternScale?: number;
    patternTexture?: Texture;
    pulseSpeed?: number;
    resolutionScale?: number;
    resolutionX?: number;
    resolutionY?: number;
    visibleEdgeColor?: number;
    width?: number;
    xRay?: boolean;
}

Type declaration

  • Optional blendFunction?: BlendFunction
  • Optional blur?: boolean
  • Optional blurriness?: number
  • Optional disableMergeEffect?: boolean

    禁止自动合并通道 默认false

  • Optional edgeStrength?: number
  • Optional height?: number
  • Optional hiddenEdgeColor?: number
  • Optional multisampling?: number
  • Optional patternScale?: number
  • Optional patternTexture?: Texture
  • Optional pulseSpeed?: number
  • Optional resolutionScale?: number
  • Optional resolutionX?: number
  • Optional resolutionY?: number
  • Optional visibleEdgeColor?: number
  • Optional width?: number
  • Optional xRay?: boolean
useFXAA?: boolean

使用fxaa反锯齿

useSMAA?: boolean

使用smaa反锯齿

workaroundEnabled?: boolean

workaroundEnabled