Class HDRenderPipeline

Inheritance

Object

HDRenderPipeline

Namespace: UnityEngine.Rendering.HighDefinition

Syntax

public class HDRenderPipeline : IDataProvider, RenderPipeline

Constructors

HDRenderPipeline(HDRenderPipelineAsset, HDRenderPipelineAsset)

Declaration

public HDRenderPipeline(HDRenderPipelineAsset asset, HDRenderPipelineAsset defaultAsset)

Parameters

Type	Name	Description
HDRenderPipelineAsset	asset
HDRenderPipelineAsset	defaultAsset

Fields

k_ShaderTagName

Declaration

public const string k_ShaderTagName = "HDRenderPipeline"

Field Value

Type	Description
String

Properties

debugDisplaySettings

Declaration

public DebugDisplaySettings debugDisplaySettings { get; }

Property Value

Type	Description
DebugDisplaySettings

rayTracingSupported

Declaration

public bool rayTracingSupported { get; }

Property Value

Type	Description
Boolean

Methods

CreateTransparentRendererListDesc(CullingResults, Camera, ShaderTagId, PerObjectData, Nullable<RenderQueueRange>, Nullable<RenderStateBlock>, Material, Boolean)

Declaration

protected static RendererListDesc CreateTransparentRendererListDesc(CullingResults cull, Camera camera, ShaderTagId passName, PerObjectData rendererConfiguration = null, RenderQueueRange? renderQueueRange = default(RenderQueueRange? ), RenderStateBlock? stateBlock = default(RenderStateBlock? ), Material overrideMaterial = null, bool excludeObjectMotionVectors = false)

Parameters

Type	Name	Description
CullingResults	cull
Camera	camera
ShaderTagId	passName
PerObjectData	rendererConfiguration
Nullable<RenderQueueRange>	renderQueueRange
Nullable<RenderStateBlock>	stateBlock
Material	overrideMaterial
Boolean	excludeObjectMotionVectors

Returns

Type	Description
RendererListDesc

CreateTransparentRendererListDesc(CullingResults, Camera, ShaderTagId[], PerObjectData, Nullable<RenderQueueRange>, Nullable<RenderStateBlock>, Material, Boolean)

Declaration

protected static RendererListDesc CreateTransparentRendererListDesc(CullingResults cull, Camera camera, ShaderTagId[] passNames, PerObjectData rendererConfiguration = null, RenderQueueRange? renderQueueRange = default(RenderQueueRange? ), RenderStateBlock? stateBlock = default(RenderStateBlock? ), Material overrideMaterial = null, bool excludeObjectMotionVectors = false)

Parameters

Type	Name	Description
CullingResults	cull
Camera	camera
ShaderTagId[]	passNames
PerObjectData	rendererConfiguration
Nullable<RenderQueueRange>	renderQueueRange
Nullable<RenderStateBlock>	stateBlock
Material	overrideMaterial
Boolean	excludeObjectMotionVectors

Returns

Type	Description
RendererListDesc

Dispose(Boolean)

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
Boolean	disposing

DrawOpaqueRendererList(ScriptableRenderContext, CommandBuffer, FrameSettings, RendererList)

Declaration

protected static void DrawOpaqueRendererList(in ScriptableRenderContext renderContext, CommandBuffer cmd, in FrameSettings frameSettings, RendererList rendererList)

Parameters

Type	Name	Description
ScriptableRenderContext	renderContext
CommandBuffer	cmd
FrameSettings	frameSettings
RendererList	rendererList

DrawTransparentRendererList(ScriptableRenderContext, CommandBuffer, FrameSettings, RendererList)

Declaration

protected static void DrawTransparentRendererList(in ScriptableRenderContext renderContext, CommandBuffer cmd, in FrameSettings frameSettings, RendererList rendererList)

Parameters

Type	Name	Description
ScriptableRenderContext	renderContext
CommandBuffer	cmd
FrameSettings	frameSettings
RendererList	rendererList

ExportSkyToTexture(Camera)

Declaration

public Texture2D ExportSkyToTexture(Camera camera)

Parameters

Type	Name	Description
Camera	camera

Returns

Type	Description
Texture2D

GetRaysPerFrame(RayCountValues)

This functions allows the user to have an approximation of the number of rays that were traced for a given frame.

Declaration

public uint GetRaysPerFrame(RayCountValues rayValues)

Parameters

Type	Name	Description
RayCountValues	rayValues	Specifes which ray count value should be returned.

Returns

Type	Description
UInt32	The approximated ray count for a frame

GetScreenSpaceShadowData(Int32)

Declaration

public HDRenderPipeline.ScreenSpaceShadowData GetScreenSpaceShadowData(int screenSpaceShadowIndex)

Parameters

Type	Name	Description
Int32	screenSpaceShadowIndex

Returns

Type	Description
HDRenderPipeline.ScreenSpaceShadowData

GetWorldToViewMatrix(HDCamera, Int32)

Declaration

public Matrix4x4 GetWorldToViewMatrix(HDCamera hdCamera, int viewIndex)

Parameters

Type	Name	Description
HDCamera	hdCamera
Int32	viewIndex

Returns

Type	Description
Matrix4x4

InitPathTracing()

Declaration

public void InitPathTracing()

ReleasePathTracing()

Declaration

public void ReleasePathTracing()

Render(ScriptableRenderContext, Camera[])

Declaration

protected override void Render(ScriptableRenderContext renderContext, Camera[] cameras)

Parameters

Type	Name	Description
ScriptableRenderContext	renderContext
Camera[]	cameras

RenderPathTracing(HDCamera, CommandBuffer, RTHandle, ScriptableRenderContext, Int32)

Declaration

public void RenderPathTracing(HDCamera hdCamera, CommandBuffer cmd, RTHandle outputTexture, ScriptableRenderContext renderContext, int frameCount)

Parameters

Type	Name	Description
HDCamera	hdCamera
CommandBuffer	cmd
RTHandle	outputTexture
ScriptableRenderContext	renderContext
Int32	frameCount

RequestSkyEnvironmentUpdate()

Request an update of the environment lighting.

Declaration

public void RequestSkyEnvironmentUpdate()