Class AmbientOcclusion | Post Processing | 2.3.0
docs.unity3d.com
    Show / Hide Table of Contents

    Class AmbientOcclusion

    This class holds settings for the Ambient Occlusion effect.

    Inheritance
    Object
    PostProcessEffectSettings
    AmbientOcclusion
    Inherited Members
    PostProcessEffectSettings.active
    PostProcessEffectSettings.enabled
    PostProcessEffectSettings.SetAllOverridesTo(Boolean, Boolean)
    PostProcessEffectSettings.GetHash()
    Namespace: UnityEngine.Rendering.PostProcessing
    Syntax
    [Serializable]
    public sealed class AmbientOcclusion : PostProcessEffectSettings

    Fields

    ambientOnly

    Only affects ambient lighting. This mode is only available with the Deferred rendering path and HDR rendering. Objects rendered with the Forward rendering path won't get any ambient occlusion.

    Declaration
    public BoolParameter ambientOnly
    Field Value
    Type Description
    BoolParameter

    blurTolerance

    The tolerance of the bilateral blur filter to depth changes.

    Declaration
    public FloatParameter blurTolerance
    Field Value
    Type Description
    FloatParameter

    color

    A custom color to use for the ambient occlusion.

    Declaration
    public ColorParameter color
    Field Value
    Type Description
    ColorParameter

    directLightingStrength

    Modifies he influence of direct lighting on ambient occlusion. This is only used in the HD Render Pipeline currently.

    Declaration
    public FloatParameter directLightingStrength
    Field Value
    Type Description
    FloatParameter

    intensity

    The degree of darkness added by ambient occlusion.

    Declaration
    public FloatParameter intensity
    Field Value
    Type Description
    FloatParameter

    mode

    The ambient occlusion method to use.

    Declaration
    public AmbientOcclusionModeParameter mode
    Field Value
    Type Description
    AmbientOcclusionModeParameter

    noiseFilterTolerance

    The tolerance of the noise filter to changes in the depth pyramid.

    Declaration
    public FloatParameter noiseFilterTolerance
    Field Value
    Type Description
    FloatParameter

    quality

    The number of sample points, which affects quality and performance. Lowest, Low and Medium passes are downsampled. High and Ultra are not and should only be used on high-end hardware.

    Declaration
    public AmbientOcclusionQualityParameter quality
    Field Value
    Type Description
    AmbientOcclusionQualityParameter

    radius

    Radius of sample points, which affects extent of darkened areas.

    Declaration
    public FloatParameter radius
    Field Value
    Type Description
    FloatParameter

    thicknessModifier

    Modifies the thickness of occluders. This increases dark areas but also introduces dark halo around objects.

    Declaration
    public FloatParameter thicknessModifier
    Field Value
    Type Description
    FloatParameter

    upsampleTolerance

    The tolerance of the upsampling pass to depth changes.

    Declaration
    public FloatParameter upsampleTolerance
    Field Value
    Type Description
    FloatParameter

    Methods

    IsEnabledAndSupported(PostProcessRenderContext)

    Returns true if the effect is currently enabled and supported.

    Declaration
    public override bool IsEnabledAndSupported(PostProcessRenderContext context)
    Parameters
    Type Name Description
    PostProcessRenderContext context

    The current post-processing render context

    Returns
    Type Description
    Boolean

    true if the effect is currently enabled and supported

    Overrides
    PostProcessEffectSettings.IsEnabledAndSupported(PostProcessRenderContext)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023