docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class UniversalRenderPipelineAsset

    Inheritance
    object
    Object
    ScriptableObject
    RenderPipelineAsset
    UniversalRenderPipelineAsset
    Implements
    ISerializationCallbackReceiver
    Inherited Members
    RenderPipelineAsset.terrainBrushPassIndex
    ScriptableObject.CreateInstance(string)
    ScriptableObject.CreateInstance(Type)
    ScriptableObject.CreateInstance<T>()
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, bool)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, bool)
    Object.Destroy(Object, float)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, bool)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, bool)
    Object.FindObjectsByType(Type, FindObjectsSortMode)
    Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)
    Object.DontDestroyOnLoad(Object)
    Object.FindObjectsOfType<T>()
    Object.FindObjectsByType<T>(FindObjectsSortMode)
    Object.FindObjectsOfType<T>(bool)
    Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
    Object.FindObjectOfType<T>()
    Object.FindObjectOfType<T>(bool)
    Object.FindFirstObjectByType<T>()
    Object.FindAnyObjectByType<T>()
    Object.FindFirstObjectByType<T>(FindObjectsInactive)
    Object.FindAnyObjectByType<T>(FindObjectsInactive)
    Object.FindObjectOfType(Type)
    Object.FindFirstObjectByType(Type)
    Object.FindAnyObjectByType(Type)
    Object.FindObjectOfType(Type, bool)
    Object.FindFirstObjectByType(Type, FindObjectsInactive)
    Object.FindAnyObjectByType(Type, FindObjectsInactive)
    Object.ToString()
    Object.name
    Object.hideFlags
    object.Equals(object, object)
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: UnityEngine.Rendering.Universal
    Assembly: Unity.RenderPipelines.Universal.Runtime.dll
    Syntax
    [ExcludeFromPreset]
    [ApplyRulesIfTagsEqual(new string[] { "RenderPipeline", "UniversalPipeline" })]
    public class UniversalRenderPipelineAsset : RenderPipelineAsset, ISerializationCallbackReceiver

    Fields

    AdditionalLightsDefaultShadowResolutionTierHigh

    Declaration
    public static readonly int AdditionalLightsDefaultShadowResolutionTierHigh
    Field Value
    Type Description
    int

    AdditionalLightsDefaultShadowResolutionTierLow

    Declaration
    public static readonly int AdditionalLightsDefaultShadowResolutionTierLow
    Field Value
    Type Description
    int

    AdditionalLightsDefaultShadowResolutionTierMedium

    Declaration
    public static readonly int AdditionalLightsDefaultShadowResolutionTierMedium
    Field Value
    Type Description
    int

    editorResourcesGUID

    Declaration
    public static readonly string editorResourcesGUID
    Field Value
    Type Description
    string

    k_MaxLutSize

    Declaration
    public const int k_MaxLutSize = 65
    Field Value
    Type Description
    int

    k_MinLutSize

    Declaration
    public const int k_MinLutSize = 16
    Field Value
    Type Description
    int

    packagePath

    Declaration
    public static readonly string packagePath
    Field Value
    Type Description
    string

    Properties

    additionalLightsRenderingMode

    Declaration
    public LightRenderingMode additionalLightsRenderingMode { get; }
    Property Value
    Type Description
    LightRenderingMode

    additionalLightsShadowResolutionTierHigh

    Returns the additional light shadow resolution defined for tier "High" in the UniversalRenderPipeline asset.

    Declaration
    public int additionalLightsShadowResolutionTierHigh { get; }
    Property Value
    Type Description
    int

    additionalLightsShadowResolutionTierLow

    Returns the additional light shadow resolution defined for tier "Low" in the UniversalRenderPipeline asset.

    Declaration
    public int additionalLightsShadowResolutionTierLow { get; }
    Property Value
    Type Description
    int

    additionalLightsShadowResolutionTierMedium

    Returns the additional light shadow resolution defined for tier "Medium" in the UniversalRenderPipeline asset.

    Declaration
    public int additionalLightsShadowResolutionTierMedium { get; }
    Property Value
    Type Description
    int

    additionalLightsShadowmapResolution

    Declaration
    public int additionalLightsShadowmapResolution { get; }
    Property Value
    Type Description
    int

    autodeskInteractiveMaskedShader

    Declaration
    public override Shader autodeskInteractiveMaskedShader { get; }
    Property Value
    Type Description
    Shader
    Overrides
    RenderPipelineAsset.autodeskInteractiveMaskedShader

    autodeskInteractiveShader

    Declaration
    public override Shader autodeskInteractiveShader { get; }
    Property Value
    Type Description
    Shader
    Overrides
    RenderPipelineAsset.autodeskInteractiveShader

    autodeskInteractiveTransparentShader

    Declaration
    public override Shader autodeskInteractiveTransparentShader { get; }
    Property Value
    Type Description
    Shader
    Overrides
    RenderPipelineAsset.autodeskInteractiveTransparentShader

    cascade2Split

    Returns the split value.

    Declaration
    public float cascade2Split { get; }
    Property Value
    Type Description
    float

    Returns a Float with the split value.

    cascade3Split

    Returns the split values.

    Declaration
    public Vector2 cascade3Split { get; }
    Property Value
    Type Description
    Vector2

    Returns a Vector2 with the split values.

    cascade4Split

    Returns the split values.

    Declaration
    public Vector3 cascade4Split { get; }
    Property Value
    Type Description
    Vector3

    Returns a Vector3 with the split values.

    cascadeBorder

    Last cascade fade distance in percentage.

    Declaration
    public float cascadeBorder { get; set; }
    Property Value
    Type Description
    float

    colorGradingLutSize

    Declaration
    public int colorGradingLutSize { get; set; }
    Property Value
    Type Description
    int

    colorGradingMode

    Declaration
    public ColorGradingMode colorGradingMode { get; set; }
    Property Value
    Type Description
    ColorGradingMode

    conservativeEnclosingSphere

    Set to true to enable a conservative method for calculating the size and position of the minimal enclosing sphere around the frustum cascade corner points for shadow culling.

    Declaration
    public bool conservativeEnclosingSphere { get; set; }
    Property Value
    Type Description
    bool

    decalMaterial

    Declaration
    public Material decalMaterial { get; }
    Property Value
    Type Description
    Material

    default2DMaskMaterial

    Returns the default sprite mask material for the 2D renderer.

    Declaration
    public override Material default2DMaskMaterial { get; }
    Property Value
    Type Description
    Material

    Returns the material containing the default shader pass for sprite mask in the 2D renderer.

    Overrides
    RenderPipelineAsset.default2DMaskMaterial

    default2DMaterial

    Returns the default material for the 2D renderer.

    Declaration
    public override Material default2DMaterial { get; }
    Property Value
    Type Description
    Material

    Returns the material containing the default lit and unlit shader passes for sprites in the 2D renderer.

    Overrides
    RenderPipelineAsset.default2DMaterial

    defaultLineMaterial

    Declaration
    public override Material defaultLineMaterial { get; }
    Property Value
    Type Description
    Material
    Overrides
    RenderPipelineAsset.defaultLineMaterial

    defaultMaterial

    Declaration
    public override Material defaultMaterial { get; }
    Property Value
    Type Description
    Material
    Overrides
    RenderPipelineAsset.defaultMaterial

    defaultParticleMaterial

    Declaration
    public override Material defaultParticleMaterial { get; }
    Property Value
    Type Description
    Material
    Overrides
    RenderPipelineAsset.defaultParticleMaterial

    defaultShader

    Declaration
    public override Shader defaultShader { get; }
    Property Value
    Type Description
    Shader
    Overrides
    RenderPipelineAsset.defaultShader

    defaultSpeedTree7Shader

    Declaration
    public override Shader defaultSpeedTree7Shader { get; }
    Property Value
    Type Description
    Shader
    Overrides
    RenderPipelineAsset.defaultSpeedTree7Shader

    defaultSpeedTree8Shader

    Declaration
    public override Shader defaultSpeedTree8Shader { get; }
    Property Value
    Type Description
    Shader
    Overrides
    RenderPipelineAsset.defaultSpeedTree8Shader

    defaultTerrainMaterial

    Declaration
    public override Material defaultTerrainMaterial { get; }
    Property Value
    Type Description
    Material
    Overrides
    RenderPipelineAsset.defaultTerrainMaterial

    defaultUIETC1SupportedMaterial

    Declaration
    public override Material defaultUIETC1SupportedMaterial { get; }
    Property Value
    Type Description
    Material
    Overrides
    RenderPipelineAsset.defaultUIETC1SupportedMaterial

    defaultUIMaterial

    Declaration
    public override Material defaultUIMaterial { get; }
    Property Value
    Type Description
    Material
    Overrides
    RenderPipelineAsset.defaultUIMaterial

    defaultUIOverdrawMaterial

    Declaration
    public override Material defaultUIOverdrawMaterial { get; }
    Property Value
    Type Description
    Material
    Overrides
    RenderPipelineAsset.defaultUIOverdrawMaterial

    fsrOverrideSharpness

    If this property is set to true, the value from the fsrSharpness property will control the intensity of the sharpening filter associated with FidelityFX Super Resolution.

    Declaration
    public bool fsrOverrideSharpness { get; set; }
    Property Value
    Type Description
    bool

    fsrSharpness

    Controls the intensity of the sharpening filter associated with FidelityFX Super Resolution. A value of 1.0 produces maximum sharpness while a value of 0.0 disables the sharpening filter entirely.

    Note: This value only has an effect when the fsrOverrideSharpness property is set to true.

    Declaration
    public float fsrSharpness { get; set; }
    Property Value
    Type Description
    float

    lightLayerMaskNames

    Names used for display of light layers.

    Declaration
    public string[] lightLayerMaskNames { get; }
    Property Value
    Type Description
    string[]

    mainLightRenderingMode

    Declaration
    public LightRenderingMode mainLightRenderingMode { get; }
    Property Value
    Type Description
    LightRenderingMode

    mainLightShadowmapResolution

    Declaration
    public int mainLightShadowmapResolution { get; }
    Property Value
    Type Description
    int

    maxAdditionalLightsCount

    Declaration
    public int maxAdditionalLightsCount { get; set; }
    Property Value
    Type Description
    int

    msaaSampleCount

    Declaration
    public int msaaSampleCount { get; set; }
    Property Value
    Type Description
    int

    numIterationsEnclosingSphere

    Set the number of iterations to reduce the cascade culling enlcosing sphere to be closer to the absolute minimun enclosing sphere, but will also require more CPU computation for increasing values. This parameter is used only when conservativeEnclosingSphere is set to true. Default value is 64.

    Declaration
    public int numIterationsEnclosingSphere { get; set; }
    Property Value
    Type Description
    int

    opaqueDownsampling

    Declaration
    public Downsampling opaqueDownsampling { get; }
    Property Value
    Type Description
    Downsampling

    prefixedRenderingLayerMaskNames

    Names used for display of rendering layer masks with prefix.

    Declaration
    public override string[] prefixedRenderingLayerMaskNames { get; }
    Property Value
    Type Description
    string[]
    Overrides
    RenderPipelineAsset.prefixedRenderingLayerMaskNames

    reflectionProbeBlending

    Declaration
    public bool reflectionProbeBlending { get; }
    Property Value
    Type Description
    bool

    reflectionProbeBoxProjection

    Declaration
    public bool reflectionProbeBoxProjection { get; }
    Property Value
    Type Description
    bool

    renderScale

    Declaration
    public float renderScale { get; set; }
    Property Value
    Type Description
    float

    renderingLayerMaskNames

    Names used for display of rendering layer masks.

    Declaration
    public override string[] renderingLayerMaskNames { get; }
    Property Value
    Type Description
    string[]
    Overrides
    RenderPipelineAsset.renderingLayerMaskNames

    scriptableRenderer

    Returns the default renderer being used by this pipeline.

    Declaration
    public ScriptableRenderer scriptableRenderer { get; }
    Property Value
    Type Description
    ScriptableRenderer

    shaderVariantLogLevel

    Declaration
    public ShaderVariantLogLevel shaderVariantLogLevel { get; set; }
    Property Value
    Type Description
    ShaderVariantLogLevel

    shadowCascadeCount

    Returns the number of shadow cascades.

    Declaration
    public int shadowCascadeCount { get; set; }
    Property Value
    Type Description
    int

    shadowDepthBias

    The Shadow Depth Bias, controls the offset of the lit pixels.

    Declaration
    public float shadowDepthBias { get; set; }
    Property Value
    Type Description
    float

    shadowDistance

    Controls the maximum distance at which shadows are visible.

    Declaration
    public float shadowDistance { get; set; }
    Property Value
    Type Description
    float

    shadowNormalBias

    Controls the distance at which the shadow casting surfaces are shrunk along the surface normal.

    Declaration
    public float shadowNormalBias { get; set; }
    Property Value
    Type Description
    float

    storeActionsOptimization

    Returns the active store action optimization value.

    Declaration
    public StoreActionsOptimization storeActionsOptimization { get; set; }
    Property Value
    Type Description
    StoreActionsOptimization

    Returns the active store action optimization value.

    supportsAdditionalLightShadows

    Declaration
    public bool supportsAdditionalLightShadows { get; }
    Property Value
    Type Description
    bool

    supportsCameraDepthTexture

    Declaration
    public bool supportsCameraDepthTexture { get; set; }
    Property Value
    Type Description
    bool

    supportsCameraOpaqueTexture

    Declaration
    public bool supportsCameraOpaqueTexture { get; set; }
    Property Value
    Type Description
    bool

    supportsDynamicBatching

    Declaration
    public bool supportsDynamicBatching { get; set; }
    Property Value
    Type Description
    bool

    supportsHDR

    Declaration
    public bool supportsHDR { get; set; }
    Property Value
    Type Description
    bool

    supportsLightLayers

    Returns true if the Render Pipeline Asset supports light layers, false otherwise.

    Declaration
    public bool supportsLightLayers { get; }
    Property Value
    Type Description
    bool

    supportsMainLightShadows

    Declaration
    public bool supportsMainLightShadows { get; }
    Property Value
    Type Description
    bool

    supportsMixedLighting

    Declaration
    public bool supportsMixedLighting { get; }
    Property Value
    Type Description
    bool

    supportsSoftShadows

    Supports Soft Shadows controls the Soft Shadows.

    Declaration
    public bool supportsSoftShadows { get; }
    Property Value
    Type Description
    bool

    supportsTerrainHoles

    Declaration
    public bool supportsTerrainHoles { get; }
    Property Value
    Type Description
    bool

    terrainDetailGrassBillboardShader

    Returns the terrain detail grass billboard shader that this asset uses.

    Declaration
    public override Shader terrainDetailGrassBillboardShader { get; }
    Property Value
    Type Description
    Shader
    Overrides
    RenderPipelineAsset.terrainDetailGrassBillboardShader

    terrainDetailGrassShader

    Returns the terrain detail grass shader that this asset uses.

    Declaration
    public override Shader terrainDetailGrassShader { get; }
    Property Value
    Type Description
    Shader
    Overrides
    RenderPipelineAsset.terrainDetailGrassShader

    terrainDetailLitShader

    Returns the terrain detail lit shader that this asset uses.

    Declaration
    public override Shader terrainDetailLitShader { get; }
    Property Value
    Type Description
    Shader
    Overrides
    RenderPipelineAsset.terrainDetailLitShader

    upscalingFilter

    Returns the upscaling filter desired by the user Note: Filter selections differ from actual filters in that they may include "meta-filters" such as "Automatic" which resolve to an actual filter at a later time.

    Declaration
    public UpscalingFilterSelection upscalingFilter { get; set; }
    Property Value
    Type Description
    UpscalingFilterSelection

    useAdaptivePerformance

    Set to true to allow Adaptive performance to modify graphics quality settings during runtime. Only applicable when Adaptive performance package is available.

    Declaration
    public bool useAdaptivePerformance { get; set; }
    Property Value
    Type Description
    bool

    useFastSRGBLinearConversion

    Returns true if fast approximation functions are used when converting between the sRGB and Linear color spaces, false otherwise.

    Declaration
    public bool useFastSRGBLinearConversion { get; }
    Property Value
    Type Description
    bool

    useSRPBatcher

    Declaration
    public bool useSRPBatcher { get; set; }
    Property Value
    Type Description
    bool

    volumeFrameworkUpdateMode

    Returns the selected update mode for volumes.

    Declaration
    public VolumeFrameworkUpdateMode volumeFrameworkUpdateMode { get; }
    Property Value
    Type Description
    VolumeFrameworkUpdateMode

    Methods

    Create(ScriptableRendererData)

    Declaration
    public static UniversalRenderPipelineAsset Create(ScriptableRendererData rendererData = null)
    Parameters
    Type Name Description
    ScriptableRendererData rendererData
    Returns
    Type Description
    UniversalRenderPipelineAsset

    CreatePipeline()

    Declaration
    protected override RenderPipeline CreatePipeline()
    Returns
    Type Description
    RenderPipeline
    Overrides
    RenderPipelineAsset.CreatePipeline()

    GetRenderer(int)

    Returns a renderer from the current pipeline asset

    Declaration
    public ScriptableRenderer GetRenderer(int index)
    Parameters
    Type Name Description
    int index

    Index to the renderer. If invalid index is passed, the default renderer is returned instead.

    Returns
    Type Description
    ScriptableRenderer

    LoadBuiltinRendererData(RendererType)

    Declaration
    public ScriptableRendererData LoadBuiltinRendererData(RendererType type = RendererType.ForwardRenderer)
    Parameters
    Type Name Description
    RendererType type
    Returns
    Type Description
    ScriptableRendererData

    OnAfterDeserialize()

    Declaration
    public void OnAfterDeserialize()

    OnBeforeSerialize()

    Declaration
    public void OnBeforeSerialize()

    OnDisable()

    Declaration
    protected override void OnDisable()
    Overrides
    RenderPipelineAsset.OnDisable()

    OnValidate()

    Declaration
    protected override void OnValidate()
    Overrides
    RenderPipelineAsset.OnValidate()

    Implements

    ISerializationCallbackReceiver
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)