docs.unity3d.com
    Show / Hide Table of Contents

    Class UniversalRenderPipelineAsset

    Inheritance
    Object
    Object
    ScriptableObject
    RenderPipelineAsset
    UniversalRenderPipelineAsset
    Inherited Members
    RenderPipelineAsset.terrainBrushPassIndex
    RenderPipelineAsset.renderingLayerMaskNames
    RenderPipelineAsset.autodeskInteractiveShader
    RenderPipelineAsset.autodeskInteractiveTransparentShader
    RenderPipelineAsset.autodeskInteractiveMaskedShader
    RenderPipelineAsset.terrainDetailLitShader
    RenderPipelineAsset.terrainDetailGrassShader
    RenderPipelineAsset.terrainDetailGrassBillboardShader
    RenderPipelineAsset.defaultSpeedTree7Shader
    RenderPipelineAsset.defaultSpeedTree8Shader
    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, Boolean)
    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, Boolean)
    Object.Destroy(Object, Single)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, Boolean)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, Boolean)
    Object.DontDestroyOnLoad(Object)
    Object.FindObjectsOfType<T>()
    UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
    Object.FindObjectOfType<T>()
    UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
    Object.FindObjectOfType(Type)
    Object.FindObjectOfType(Type, Boolean)
    Object.ToString()
    Object.name
    Object.hideFlags
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: UnityEngine.Rendering.Universal
    Syntax
    [ExcludeFromPreset]
    public class UniversalRenderPipelineAsset : RenderPipelineAsset, ISerializationCallbackReceiver

    Fields

    AdditionalLightsDefaultShadowResolutionTierHigh

    Declaration
    public static readonly int AdditionalLightsDefaultShadowResolutionTierHigh
    Field Value
    Type Description
    Int32

    AdditionalLightsDefaultShadowResolutionTierLow

    Declaration
    public static readonly int AdditionalLightsDefaultShadowResolutionTierLow
    Field Value
    Type Description
    Int32

    AdditionalLightsDefaultShadowResolutionTierMedium

    Declaration
    public static readonly int AdditionalLightsDefaultShadowResolutionTierMedium
    Field Value
    Type Description
    Int32

    k_MaxLutSize

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

    k_MinLutSize

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

    Properties

    additionalLightsRenderingMode

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

    additionalLightsShadowmapResolution

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

    additionalLightsShadowResolutionTierHigh

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

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

    additionalLightsShadowResolutionTierLow

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

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

    additionalLightsShadowResolutionTierMedium

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

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

    cascade2Split

    Returns the split value.

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

    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.

    colorGradingLutSize

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

    colorGradingMode

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

    default2DMaterial

    Declaration
    public override Material default2DMaterial { get; }
    Property Value
    Type Description
    Material
    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

    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

    mainLightRenderingMode

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

    mainLightShadowmapResolution

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

    maxAdditionalLightsCount

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

    msaaSampleCount

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

    opaqueDownsampling

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

    renderScale

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

    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
    Int32

    shadowDepthBias

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

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

    shadowDistance

    Controls the maximum distance at which shadows are visible.

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

    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
    Single

    supportsAdditionalLightShadows

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

    supportsCameraDepthTexture

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

    supportsCameraOpaqueTexture

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

    supportsDynamicBatching

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

    supportsHDR

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

    supportsMainLightShadows

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

    supportsMixedLighting

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

    supportsSoftShadows

    Returns true Soft Shadows are supported, false otherwise.

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

    supportsTerrainHoles

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

    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
    Boolean

    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
    Boolean

    useSRPBatcher

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

    volumeFrameworkUpdateMode

    Returns the selected update mode for volumes.

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

    Methods

    CreatePipeline()

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

    GetRenderer(Int32)

    Returns a renderer from the current pipeline asset

    Declaration
    public ScriptableRenderer GetRenderer(int index)
    Parameters
    Type Name Description
    Int32 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()
    Implements
    ISerializationCallbackReceiver.OnAfterDeserialize()

    OnBeforeSerialize()

    Declaration
    public void OnBeforeSerialize()
    Implements
    ISerializationCallbackReceiver.OnBeforeSerialize()

    OnDisable()

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

    OnValidate()

    Declaration
    protected override void OnValidate()
    Overrides
    RenderPipelineAsset.OnValidate()
    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