[ExcludeFromPreset]
[ApplyRulesIfTagsEqual(new string[] { "RenderPipeline", "UniversalPipeline" })]
public class UniversalRenderPipelineAsset : RenderPipelineAsset<UniversalRenderPipeline>, ISerializationCallbackReceiver, IProbeVolumeEnabledRenderPipeline, IGPUResidentRenderPipeline, IRenderGraphEnabledRenderPipeline, ISTPEnabledRenderPipeline

Fields

AdditionalLightsDefaultShadowResolutionTierHigh

The default high tier resolution for additional lights shadow texture.

Declaration

public static readonly int AdditionalLightsDefaultShadowResolutionTierHigh

Field Value

Type	Description
int

AdditionalLightsDefaultShadowResolutionTierLow

The default low tier resolution for additional lights shadow texture.

Declaration

public static readonly int AdditionalLightsDefaultShadowResolutionTierLow

Field Value

Type	Description
int

AdditionalLightsDefaultShadowResolutionTierMedium

The default medium tier resolution for additional lights shadow texture.

Declaration

public static readonly int AdditionalLightsDefaultShadowResolutionTierMedium

Field Value

Type	Description
int

k_MaxLutSize

The maximum color grading LUT (lookup table) size.

Declaration

public const int k_MaxLutSize = 65

Field Value

Type	Description
int

k_MinLutSize

The minimum color grading LUT (lookup table) size.

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

Specifies the LightRenderingMode for the additional lights used by this UniversalRenderPipelineAsset.

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

Additional light shadows are rendered into a single shadow map atlas texture. This setting controls the resolution of the shadow map atlas texture.

Declaration

public int additionalLightsShadowmapResolution { get; set; }

Property Value

Type	Description
int

allowPostProcessAlphaOutput

Returns true if post-processing should process and output alpha. Requires the color target to have an alpha channel.

Declaration

public bool allowPostProcessAlphaOutput { get; }

Property Value

Type	Description
bool

autodeskInteractiveMaskedShader

Returns the Autodesk Interactive mask shader that this asset uses.

Declaration

public override Shader autodeskInteractiveMaskedShader { get; }

Property Value

Type	Description
Shader	Returns the Autodesk Interactive mask shader that this asset uses

Overrides

RenderPipelineAsset.autodeskInteractiveMaskedShader

autodeskInteractiveShader

Returns the Autodesk Interactive shader that this asset uses.

Declaration

public override Shader autodeskInteractiveShader { get; }

Property Value

Type	Description
Shader	Returns the Autodesk Interactive shader that this asset uses.

Overrides

RenderPipelineAsset.autodeskInteractiveShader

autodeskInteractiveTransparentShader

Returns the Autodesk Interactive transparent shader that this asset uses.

Declaration

public override Shader autodeskInteractiveTransparentShader { get; }

Property Value

Type	Description
Shader	Returns the Autodesk Interactive transparent shader that this asset uses.

Overrides

RenderPipelineAsset.autodeskInteractiveTransparentShader

cascade2Split

Returns the split value.

Declaration

public float cascade2Split { get; set; }

Property Value

Type	Description
float	Returns a Float with the split value.

cascade3Split

Returns the split values.

Declaration

public Vector2 cascade3Split { get; set; }

Property Value

Type	Description
Vector2	Returns a Vector2 with the split values.

cascade4Split

Returns the split values.

Declaration

public Vector3 cascade4Split { get; set; }

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

Specifies the color grading LUT (lookup table) size in the URP Asset.

Declaration

public int colorGradingLutSize { get; set; }

Property Value

Type	Description
int

colorGradingMode

Returns the selected ColorGradingMode in the URP Asset. 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

Returns the Material that Unity uses to render decals.

Declaration

public Material decalMaterial { get; }

Property Value

Type	Description
Material	Returns the Material containing the Unity decal shader.

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

Returns the default line Material.

Declaration

public override Material defaultLineMaterial { get; }

Property Value

Type	Description
Material	Returns the default line Material.

Overrides

RenderPipelineAsset.defaultLineMaterial

defaultMaterial

Returns the default Material.

Declaration

public override Material defaultMaterial { get; }

Property Value

Type	Description
Material	Returns the default Material.

Overrides

RenderPipelineAsset.defaultMaterial

defaultParticleMaterial

Returns the default particle Material.

Declaration

public override Material defaultParticleMaterial { get; }

Property Value

Type	Description
Material	Returns the default particle Material.

Overrides

RenderPipelineAsset.defaultParticleMaterial

defaultShader

Returns the default shader for the specified renderer. When creating new objects in the editor, the materials of those objects will use the selected default shader.

Declaration

public override Shader defaultShader { get; }

Property Value

Type	Description
Shader	Returns the default shader for the specified renderer.

Overrides

RenderPipelineAsset.defaultShader

defaultSpeedTree7Shader

Returns the default SpeedTree7 shader that this asset uses.

Declaration

public override Shader defaultSpeedTree7Shader { get; }

Property Value

Type	Description
Shader	Returns the default SpeedTree7 shader that this asset uses.

Overrides

RenderPipelineAsset.defaultSpeedTree7Shader

defaultSpeedTree8Shader

Returns the default SpeedTree8 shader that this asset uses.

Declaration

public override Shader defaultSpeedTree8Shader { get; }

Property Value

Type	Description
Shader	Returns the default SpeedTree8 shader that this asset uses.

Overrides

RenderPipelineAsset.defaultSpeedTree8Shader

defaultSpeedTree9Shader

Returns the default SpeedTree9 shader that this asset uses.

Declaration

public override Shader defaultSpeedTree9Shader { get; }

Property Value

Type	Description
Shader	Returns the default SpeedTree9 shader that this asset uses.

Overrides

RenderPipelineAsset.defaultSpeedTree9Shader

defaultTerrainMaterial

Returns the default terrain Material.

Declaration

public override Material defaultTerrainMaterial { get; }

Property Value

Type	Description
Material	Returns the default terrain Material.

Overrides

RenderPipelineAsset.defaultTerrainMaterial

enableLODCrossFade

Returns true if the cross-fade style blending between the current LOD and the next LOD is enabled.

Declaration

public bool enableLODCrossFade { get; }

Property Value

Type	Description
bool

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

gpuResidentDrawerEnableOcclusionCullingInCameras

Determines if the GPU Resident Drawer should perform occlusion culling in camera views

Declaration

public bool gpuResidentDrawerEnableOcclusionCullingInCameras { get; set; }

Property Value

Type	Description
bool

gpuResidentDrawerMode

GPUResidentDrawerMode configured on this pipeline asset

Declaration

public GPUResidentDrawerMode gpuResidentDrawerMode { get; set; }

Property Value

Type	Description
GPUResidentDrawerMode

hdrColorBufferPrecision

Graphics format requested for HDR color buffers.

Declaration

public HDRColorBufferPrecision hdrColorBufferPrecision { get; set; }

Property Value

Type	Description
HDRColorBufferPrecision

isImmediateModeSupported

Declaration

public bool isImmediateModeSupported { get; }

Property Value

Type	Description
bool

isStpUsed

Returns true if the asset is configured to use STP as an upscaling filter

Declaration

public bool isStpUsed { get; }

Property Value

Type	Description
bool

lightProbeSystem

Determines what system to use.

Declaration

public LightProbeSystem lightProbeSystem { get; }

Property Value

Type	Description
LightProbeSystem

lodCrossFadeDitheringType

Returns the type of active LOD cross-fade.

Declaration

public LODCrossFadeDitheringType lodCrossFadeDitheringType { get; }

Property Value

Type	Description
LODCrossFadeDitheringType

mainLightRenderingMode

Specifies the LightRenderingMode for the main light used by this UniversalRenderPipelineAsset.

Declaration

public LightRenderingMode mainLightRenderingMode { get; }

Property Value

Type	Description
LightRenderingMode

mainLightShadowmapResolution

Returns the main light shadowmap resolution used for this UniversalRenderPipelineAsset.

Declaration

public int mainLightShadowmapResolution { get; set; }

Property Value

Type	Description
int

maxAdditionalLightsCount

Specifies the maximum amount of per-object additional lights which can be used by this UniversalRenderPipelineAsset.

Declaration

public int maxAdditionalLightsCount { get; set; }

Property Value

Type	Description
int

maxSHBands

Indicates the maximum number of SH Bands used by this render pipeline instance.

Declaration

public ProbeVolumeSHBands maxSHBands { get; }

Property Value

Type	Description
ProbeVolumeSHBands

msaaSampleCount

Specifies the msaa sample count used by this UniversalRenderPipelineAsset

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

Returns the downsampling method used when copying the camera color texture after rendering opaques.

Declaration

public Downsampling opaqueDownsampling { get; }

Property Value

Type	Description
Downsampling

probeVolumeBlendingMemoryBudget

Probe Volume Blending Memory Budget.

Declaration

public ProbeVolumeBlendingTextureMemoryBudget probeVolumeBlendingMemoryBudget { get; }

Property Value

Type	Description
ProbeVolumeBlendingTextureMemoryBudget

probeVolumeMemoryBudget

Probe Volume Memory Budget.

Declaration

public ProbeVolumeTextureMemoryBudget probeVolumeMemoryBudget { get; }

Property Value

Type	Description
ProbeVolumeTextureMemoryBudget

probeVolumeSHBands

Probe Volumes SH Bands.

Declaration

public ProbeVolumeSHBands probeVolumeSHBands { get; }

Property Value

Type	Description
ProbeVolumeSHBands

reflectionProbeBlending

Specifies if this UniversalRenderPipelineAsset should use Probe blending for the reflection probes in the scene.

Declaration

public bool reflectionProbeBlending { get; }

Property Value

Type	Description
bool

reflectionProbeBoxProjection

Specifies if this UniversalRenderPipelineAsset should allow box projection for the reflection probes in the scene.

Declaration

public bool reflectionProbeBoxProjection { get; }

Property Value

Type	Description
bool

renderPipelineShaderTag

Declaration

public override string renderPipelineShaderTag { get; }

Property Value

Type	Description
string

Overrides

UnityEngine.Rendering.RenderPipelineAsset<UnityEngine.Rendering.Universal.UniversalRenderPipeline>.renderPipelineShaderTag

renderScale

Specifies the render scale which scales the render target resolution used by this UniversalRenderPipelineAsset.

Declaration

public float renderScale { get; set; }

Property Value

Type	Description
float

rendererDataList

The list of renderer data used by this pipeline asset.

Declaration

public ReadOnlySpan<ScriptableRendererData> rendererDataList { get; }

Property Value

Type	Description
ReadOnlySpan<ScriptableRendererData>

renderers

The list of renderers used by this pipeline asset.

Declaration

public ReadOnlySpan<ScriptableRenderer> renderers { get; }

Property Value

Type	Description
ReadOnlySpan<ScriptableRenderer>

scriptableRenderer

Returns the default renderer being used by this pipeline.

Declaration

public ScriptableRenderer scriptableRenderer { get; }

Property Value

Type	Description
ScriptableRenderer

shEvalMode

Defines the type of Spherical Harmonic (SH) evaluation in lighting.

Declaration

public ShEvalMode shEvalMode { get; }

Property Value

Type	Description
ShEvalMode

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

smallMeshScreenPercentage

Default minimum screen percentage (0-20%) gpu-driven Renderers can cover before getting culled.

Declaration

public float smallMeshScreenPercentage { 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.

supportDataDrivenLensFlare

Returns true if Data Driven Lens Flare are supported by this asset, false otherwise.

Declaration

public bool supportDataDrivenLensFlare { get; }

Property Value

Type	Description
bool

supportProbeVolume

Indicates if this render pipeline instance supports Adaptive Probe Volume.

Declaration

public bool supportProbeVolume { get; }

Property Value

Type	Description
bool

supportProbeVolumeDiskStreaming

Support Disk Streaming for Probe Volumes.

Declaration

public bool supportProbeVolumeDiskStreaming { get; }

Property Value

Type	Description
bool

supportProbeVolumeGPUStreaming

Support GPU Streaming for Probe Volumes.

Declaration

public bool supportProbeVolumeGPUStreaming { get; }

Property Value

Type	Description
bool

supportProbeVolumeScenarioBlending

Support Lighting Scenario Blending for Probe Volumes.

Declaration

public bool supportProbeVolumeScenarioBlending { get; }

Property Value

Type	Description
bool

supportProbeVolumeScenarios

Support Lighting Scenario Baking for Probe Volumes.

Declaration

public bool supportProbeVolumeScenarios { get; }

Property Value

Type	Description
bool

supportScreenSpaceLensFlare

Returns true if Screen Space Lens Flare are supported by this asset, false otherwise.

Declaration

public bool supportScreenSpaceLensFlare { get; }

Property Value

Type	Description
bool

supportsAdditionalLightShadows

Specifies if objects lit by additional lights cast shadows.

Declaration

public bool supportsAdditionalLightShadows { get; }

Property Value

Type	Description
bool

supportsCameraDepthTexture

When true, the pipeline creates a depth texture that can be read in shaders. The depth texture can be accessed as _CameraDepthTexture. This setting can be overridden per camera.

Declaration

public bool supportsCameraDepthTexture { get; set; }

Property Value

Type	Description
bool

supportsCameraOpaqueTexture

When true, the pipeline creates a texture that contains a copy of the color buffer after rendering opaque objects. This texture can be accessed in shaders as _CameraOpaqueTexture. This setting can be overridden per camera.

Declaration

public bool supportsCameraOpaqueTexture { get; set; }

Property Value

Type	Description
bool

supportsDynamicBatching

Specifies if this UniversalRenderPipelineAsset should use dynamic batching.

Declaration

public bool supportsDynamicBatching { get; set; }

Property Value

Type	Description
bool

supportsHDR

When enabled, the camera renders to HDR buffers. This setting can be overridden per camera.

Declaration

public bool supportsHDR { get; set; }

Property Value

Type	Description
bool

supportsLightCookies

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

Declaration

public bool supportsLightCookies { get; }

Property Value

Type	Description
bool

supportsMainLightShadows

Specifies if objects lit by main light cast shadows.

Declaration

public bool supportsMainLightShadows { get; }

Property Value

Type	Description
bool

supportsMixedLighting

Returns true if the Render Pipeline Asset supports mixed lighting, false otherwise.

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

This settings controls if the asset UniversalRenderPipelineAsset supports terrain holes.

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

useRenderingLayers

Returns true if the Render Pipeline Asset supports rendering layers for lights, false otherwise.

Declaration

public bool useRenderingLayers { get; }

Property Value

Type	Description
bool

useSRPBatcher

Specifies if SRPBacher is used by this UniversalRenderPipelineAsset.

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

volumeProfile

A volume profile that can be used to override global default volume profile values. This provides a way e.g. to have different volume default values per quality level without having to place global volumes in scenes.

Declaration

public VolumeProfile volumeProfile { get; set; }

Property Value

Type	Description
VolumeProfile

Methods

Create(ScriptableRendererData)

Declaration

public static UniversalRenderPipelineAsset Create(ScriptableRendererData rendererData = null)

Parameters

Type	Name	Description
ScriptableRendererData	rendererData

Returns

Type	Description
UniversalRenderPipelineAsset

CreatePipeline()

Creates a UniversalRenderPipeline from the UniversalRenderPipelineAsset.

Declaration

protected override RenderPipeline CreatePipeline()

Returns

Type	Description
RenderPipeline	Returns a `UniversalRenderPipeline` created from this UniversalRenderPipelineAsset.

Overrides

RenderPipelineAsset.CreatePipeline()

EnsureGlobalSettings()

Ensures Global Settings are ready and registered into GraphicsSettings

Declaration

protected override void EnsureGlobalSettings()

Overrides

RenderPipelineAsset.EnsureGlobalSettings()

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

IsGPUResidentDrawerSupportedBySRP(out string, out LogType)

Declaration

public bool IsGPUResidentDrawerSupportedBySRP(out string message, out LogType severty)

Parameters

Type	Name	Description
string	message
LogType	severty

Returns

Type	Description
bool

LoadBuiltinRendererData(RendererType)

Use this class to initialize the rendererData element that is required by the renderer.

Declaration

public ScriptableRendererData LoadBuiltinRendererData(RendererType type = RendererType.UniversalRenderer)

Parameters

Type	Name	Description
RendererType	type	The `RendererType` of the new renderer that is initialized within this asset.

Returns

Type	Description
ScriptableRendererData

OnAfterDeserialize()

Unity raises a callback to this method after it deserializes the asset.

Declaration

public void OnAfterDeserialize()

OnBeforeSerialize()

Unity raises a callback to this method before it serializes the asset.

Declaration

public void OnBeforeSerialize()

OnDisable()

Unity calls this function when the asset is disabled.

Declaration

protected override void OnDisable()

Overrides

RenderPipelineAsset.OnDisable()

Implements

ISerializationCallbackReceiver

IProbeVolumeEnabledRenderPipeline

IGPUResidentRenderPipeline

IRenderGraphEnabledRenderPipeline

ISTPEnabledRenderPipeline