docs.unity3d.com
    Show / Hide Table of Contents

    Enum FrameSettingsField

    Collection of settings used for rendering the frame.

    Namespace: UnityEngine.Rendering.HighDefinition
    Syntax
    public enum FrameSettingsField : int

    Fields

    Name Description Value
    AfterPostprocess

    When enabled, HDRP processes a post-processing render pass for Cameras using these Frame Settings.

    Shadowmask

    When enabled, Cameras using these Frame Settings render shadows from Shadow Masks.

    ShadowMaps

    When enabled, Cameras using these Frame Settings render shadows.

    ScreenSpaceShadows

    When enabled, Cameras using these Frame Settings render Screen Space Shadows.

    RoughRefraction

    When enabled, HDRP processes a refraction render pass for Cameras using these Frame Settings. This add a resolve of ColorBuffer after the drawing of opaque materials to be use for Refraction effect during transparent pass.

    RoughDistortion

    When enabled, HDRP processes a distortion render pass for Cameras using these Frame Settings.

    ReprojectionForVolumetrics

    When enabled, Cameras using these Frame Settings use several previous frames to calculate volumetric effects which increases their overall quality at run time.

    ReplaceDiffuseForIndirect

    When enabled, Cameras that use these Frame Settings render Materials with base color as diffuse. This is a useful Frame Setting to use for real-time Reflection Probes because it renders metals as diffuse Materials to stop them appearing black when Unity can't calculate several bounces of specular lighting.

    Refraction

    When enabled, HDRP processes a refraction render pass for Cameras using these Frame Settings. This add a resolve of ColorBuffer after the drawing of opaque materials to be use for Refraction effect during transparent pass.

    ReflectionProbe

    When enabled, Cameras that use these Frame Settings calculate reflection from Reflection Probes.

    RayTracing

    When enabled, HDRP updates ray tracing for Cameras using these Frame Settings.

    ProbeVolume

    When enabled, HDRP uses probe volumes for baked lighting.

    Postprocess

    When enabled, HDRP processes a post-processing render pass for Cameras using these Frame Settings.

    PlanarProbe

    When enabled, Cameras that use these Frame Settings calculate reflection from Planar Reflection Probes.

    PaniniProjection

    When enabled, HDRP adds panini projection to Cameras affected by a Volume containing the Panini Projection override.

    OpaqueObjects

    When enabled, Cameras using these Frame Settings render opaque GameObjects.

    ObjectMotionVectors

    When enabled, HDRP processes an object motion vector pass for Cameras using these Frame Settings.

    None

    No Frame Settings.

    SkyReflection

    When enabled, the Sky affects specular lighting for Cameras that use these Frame Settings.

    MSAA

    When enabled, Cameras using these Frame Settings calculate MSAA when they render the Scene. Set Lit Shader Mode to Forward to access this option.

    SSAO

    When enabled, Cameras using these Frame Settings calculate Screen Space Ambient Occlusion.

    SSGI

    When enabled, Cameras using these Frame Settings calculate Transparent Screen Space Global Illumination.

    Volumetrics

    When enabled, Cameras using these Frame Settings render volumetric effects such as volumetric fog and lighting.

    VirtualTexturing

    When enabled, HDRP can use virtual texturing.

    Vignette

    When enabled, HDRP adds vignette to Cameras affected by a Volume containing the Vignette override.

    TransparentsWriteMotionVector

    When enabled, transparent GameObjects use Motion Vectors. You must also enable TransparentWritesVelocity for Materials that you want to use motion vectors with.

    TransparentSSR

    When enabled, Cameras using these Frame Settings calculate Screen Space Reflections on transparent objects.

    TransparentPrepass

    When enabled, HDRP processes a transparent prepass for Cameras using these Frame Settings.

    TransparentPostpass

    When enabled, HDRP processes a transparent postpass for Cameras using these Frame Settings.

    TransparentObjects

    When enabled, Cameras using these Frame Settings render Transparent GameObjects.

    Transmission

    When enabled, Cameras using these Frame Settings render subsurface scattering (SSS) Materials with an added transmission effect (only if you enable Transmission on the SSS Material in the Material's Inspector).

    Tonemapping

    When enabled, HDRP processes tonemapping for Cameras using these Frame Settings.

    SubsurfaceScattering

    When enabled, Cameras using these Frame Settings render subsurface scattering (SSS) effects for GameObjects that use a SSS Material.

    StopNaN

    When enabled, HDRP replace NaN values with black pixels for Cameras using these Frame Settings.

    SssQualityMode

    Configures the sample budget of the Subsurface Scattering algorithm using Quality Levels. You can either pick from one of the existing values in the Quality Settings, or request a custom number of samples.

    SssQualityLevel

    Sets the Quality Level of the Subsurface Scattering algorithm.

    SssCustomSampleBudget

    Sets the custom sample budget of the Subsurface Scattering algorithm.

    SSRAsync

    When enabled, HDRP calculates screen space reflection asynchronously.

    SSR

    When enabled, Cameras using these Frame Settings calculate Screen Space Reflections.

    SSAOAsync

    When enabled, HDRP calculates screen space ambient occlusion asynchronously.

    VolumeVoxelizationsAsync

    When enabled, HDRP calculates volumetric voxelization asynchronously.

    MotionVectors

    When enabled, HDRP processes a motion vector pass for Cameras using these Frame Settings.

    MaximumLODLevelQualityLevel

    The quality level to use when fetching the value from the quality settings.

    DecalLayers

    When enabled, Cameras that use these Frame Settings make use of DecalLayers.

    CustomPostProcess

    When enabled, HDRP render user written post processes.

    CustomPass

    When enabled, HDRP renders custom passes contained in CustomPassVolume components.

    ContactShadowsAsync

    When enabled, HDRP calculates Contact Shadows asynchronously.

    ContactShadows

    When enabled, Cameras using these Frame Settings render Contact Shadows.

    ComputeMaterialVariants

    When enabled, HDRP uses material variant classification to compute lighting.

    ComputeLightVariants

    When enabled, HDRP uses light variant classification to compute lighting.

    ComputeLightEvaluation

    When enabled, HDRP uses a compute shader to compute deferred lighting.

    ColorGrading

    When enabled, HDRP processes color grading for Cameras using these Frame Settings.

    ClearGBuffers

    When enabled, HDRP clear GBuffers for Cameras using these Frame Settings. Set Lit Shader Mode to Deferred to access this option.

    ChromaticAberration

    When enabled, HDRP adds chromatic aberration to Cameras affected by a Volume containing the Chromatic Aberration override.

    Bloom

    When enabled, HDRP adds bloom to Cameras affected by a Volume containing the Bloom override.

    BigTilePrepass

    When enabled, HDRP uses a big tile prepass for light visibility.

    AtmosphericScattering

    When enabled, Cameras using these Frame Settings render fog effects.

    AsyncCompute

    When enabled, HDRP executes certain Compute Shader commands in parallel. This only has an effect if the target platform supports async compute.

    Antialiasing

    When enabled, HDRP processes anti-aliasing for camera using these Frame Settings.

    AlphaToMask

    When enabled, Cameras using these Frame Settings use Alpha To Mask. Activate MSAA to access this option.

    Decals

    When enabled, HDRP processes a decal render pass for Cameras using these Frame Settings.

    MotionBlur

    When enabled, HDRP adds motion blur to Cameras affected by a Volume containing the Blur override.

    DeferredTile

    When enabled, HDRP uses tiles to compute deferred lighting.

    DepthPrepassWithDeferredRendering

    When enabled, HDRP processes a depth prepass for Cameras using these Frame Settings. Set Lit Shader Mode to Deferred to access this option.

    MaximumLODLevelMode

    Specifies the Maximum Level Of Detail Mode for Cameras using these Frame Settings to use to render the Scene. Offset allows you to add an offset factor while Override allows you to set a specific value.

    MaximumLODLevel

    Set the LOD Bias with the value in maximumLODLevel.

    MaterialQualityLevel

    The quality level to use when fetching the value from the quality settings.

    LowResTransparent

    When enabled, HDRP processes a transparent pass in a lower resolution for Cameras using these Frame Settings.

    LODBiasQualityLevel

    The quality level to use when fetching the value from the quality settings.

    LODBiasMode

    Specifies the Level Of Detail Mode for Cameras using these Frame Settings use to render the Scene. Scale will allow to add a scale factor while Override will allow to set a specific value.

    LODBias

    Set the LOD Bias with the value in lodBias.

    LitShaderMode

    Specifies the Lit Shader Mode for Cameras using these Frame Settings use to render the Scene.

    LightListAsync

    When enabled, HDRP builds the Light List asynchronously.

    LightLayers

    When enabled, Cameras that use these Frame Settings make use of LightLayers.

    LensDistortion

    When enabled, HDRP adds lens distortion to Cameras affected by a Volume containing the Lens Distortion override.

    FPTLForForwardOpaque

    When enabled, HDRP uses FPTL for forward opaque.

    FilmGrain

    When enabled, HDRP adds film grain to Cameras affected by a Volume containing the Film Grain override.

    ExposureControl

    When enabled, Cameras that use these Frame Settings use exposure values defined in relevant components.

    Dithering

    When enabled, HDRP processes dithering for Cameras using these Frame Settings.

    Distortion

    When enabled, HDRP processes a distortion render pass for Cameras using these Frame Settings.

    DirectSpecularLighting

    When enabled, Cameras that use these Frame Settings render Direct Specular lighting. This is a useful Frame Setting to use for baked Reflection Probes to remove view dependent lighting.

    DepthOfField

    When enabled, HDRP adds depth of field to Cameras affected by a Volume containing the Depth Of Field override.

    ZTestAfterPostProcessTAA

    When enabled, Cameras that don't use TAA process a depth test for Materials in the AfterPostProcess rendering pass.

    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