Class HDRenderPipelineAsset

High Definition Render Pipeline asset.

Inheritance
object
Object
ScriptableObject
RenderPipelineAsset
RenderPipelineAsset<HDRenderPipeline>
HDRenderPipelineAsset
Implements
IVirtualTexturingEnabledRenderPipeline
IProbeVolumeEnabledRenderPipeline
IGPUResidentRenderPipeline
IRenderGraphEnabledRenderPipeline
ISTPEnabledRenderPipeline
Inherited Members
RenderPipelineAsset<HDRenderPipeline>.pipelineType
RenderPipelineAsset<HDRenderPipeline>.renderPipelineType
ScriptableObject.SetDirty()
ScriptableObject.CreateInstance<T>()
Object.GetHashCode()
Object.InstantiateAsync<T>(T)
Object.InstantiateAsync<T>(T, Transform)
Object.InstantiateAsync<T>(T, Vector3, Quaternion)
Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
Object.Instantiate<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.DestroyObject(Object)
Object.FindObjectsOfType<T>()
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindObjectOfType<T>()
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Namespace: UnityEngine.Rendering.HighDefinition
Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll
Syntax
public class HDRenderPipelineAsset : RenderPipelineAsset<HDRenderPipeline>, IVirtualTexturingEnabledRenderPipeline, IProbeVolumeEnabledRenderPipeline, IGPUResidentRenderPipeline, IRenderGraphEnabledRenderPipeline, ISTPEnabledRenderPipeline, IVersionable<HDRenderPipelineAsset.Version>

Fields

availableMaterialQualityLevels

Available material quality levels for this asset.

Declaration
[FormerlySerializedAs("materialQualityLevels")]
public MaterialQuality availableMaterialQualityLevels
Field Value
Type Description
MaterialQuality

Properties

autodeskInteractiveMaskedShader

HDRP default autodesk interactive masked shader.

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

autodeskInteractiveShader

HDRP default autodesk interactive shader.

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

autodeskInteractiveTransparentShader

HDRP default autodesk interactive transparent shader.

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

currentPlatformRenderPipelineSettings

Settings currently used by HDRP. Note that setting this property has a significant cost as it will cause the whole pipeline to be rebuilt from scratch.

Declaration
public RenderPipelineSettings currentPlatformRenderPipelineSettings { get; set; }
Property Value
Type Description
RenderPipelineSettings

decalLayerNames

Names used for display of decal layers.

Declaration
[Obsolete("Use renderingLayerNames")]
public string[] decalLayerNames { get; }
Property Value
Type Description
string[]

defaultMaterial

HDRP default material.

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

defaultMaterialQualityLevel

Default material quality level for this asset.

Declaration
public MaterialQuality defaultMaterialQualityLevel { get; }
Property Value
Type Description
MaterialQuality

defaultParticleMaterial

HDRP default particles material.

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

defaultShader

HDRP default shader.

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

defaultSpeedTree8Shader

HDRP default speed tree v8 shader

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

defaultSpeedTree9Shader

HDRP default speed tree v9 shader

Declaration
public override Shader defaultSpeedTree9Shader { get; }
Property Value
Type Description
Shader
Overrides

defaultTerrainMaterial

HDRP default terrain material.

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

gpuResidentDrawerMode

GPUResidentDrawerMode configured on this pipeline asset

Declaration
public GPUResidentDrawerMode gpuResidentDrawerMode { get; set; }
Property Value
Type Description
GPUResidentDrawerMode

isImmediateModeSupported

Indicates if this render pipeline instance supports ImmediateMode when debugging the render graph.

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

isStpUsed

Returns true if STP is used by the current dynamic resolution settings

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

lightLayerNames

Names used for display of light layers.

Declaration
[Obsolete("Use renderingLayerNames")]
public string[] lightLayerNames { get; }
Property Value
Type Description
string[]

maxSHBands

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

Declaration
public ProbeVolumeSHBands maxSHBands { get; }
Property Value
Type Description
ProbeVolumeSHBands

prefixedRenderingLayerMaskNames

Names used for display of rendering layer masks with a prefix.

Declaration
[Obsolete("This property is obsolete. Use RenderingLayerMask API and Tags & Layers project settings instead. #from(23.3)", false)]
public override string[] prefixedRenderingLayerMaskNames { get; }
Property Value
Type Description
string[]
Overrides

probeVolumeSceneData

Returns the projects global ProbeVolumeSceneData instance.

Declaration
[Obsolete("This property is no longer necessary.")]
public ProbeVolumeSceneData probeVolumeSceneData { get; }
Property Value
Type Description
ProbeVolumeSceneData

renderPipelineShaderTag

Declaration
public override string renderPipelineShaderTag { get; }
Property Value
Type Description
string
Overrides
UnityEngine.Rendering.RenderPipelineAsset<UnityEngine.Rendering.HighDefinition.HDRenderPipeline>.renderPipelineShaderTag

renderingLayerMaskNames

Names used for display of rendering layer masks.

Declaration
[Obsolete("This property is obsolete. Use RenderingLayerMask API and Tags & Layers project settings instead. #from(23.3)", false)]
public override string[] renderingLayerMaskNames { get; }
Property Value
Type Description
string[]
Overrides

renderingLayerNames

Names used for display of light layers.

Declaration
[Obsolete("This property is obsolete. Use RenderingLayerMask API and Tags & Layers project settings instead. #from(23.3)", false)]
public string[] renderingLayerNames { get; }
Property Value
Type Description
string[]

supportProbeVolume

Indicates if this render pipeline instance supports Adaptive Probe Volume.

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

virtualTexturingEnabled

Indicates if virtual texturing is currently enabled for this render pipeline instance.

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

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

CreatePipeline()

CreatePipeline implementation.

Declaration
protected override RenderPipeline CreatePipeline()
Returns
Type Description
RenderPipeline

A new HDRenderPipeline instance.
Overrides

EnsureGlobalSettings()

Ensures Global Settings are ready and registered into GraphicsSettings

Declaration
protected override void EnsureGlobalSettings()
Overrides

GetDefaultDecalMaterial()

HDRP default Decal material.

Declaration
public Material GetDefaultDecalMaterial()
Returns
Type Description
Material

GetDefaultMirrorMaterial()

HDRP default mirror material.

Declaration
public Material GetDefaultMirrorMaterial()
Returns
Type Description
Material

OnValidate()

OnValidate implementation.

Declaration
protected override void OnValidate()
Overrides

Implements

UnityEngine.Rendering.IVirtualTexturingEnabledRenderPipeline
UnityEngine.Rendering.IProbeVolumeEnabledRenderPipeline
UnityEngine.Rendering.IGPUResidentRenderPipeline
UnityEngine.Rendering.RenderGraphModule.IRenderGraphEnabledRenderPipeline
UnityEngine.Rendering.ISTPEnabledRenderPipeline