Class HDRenderPipeline
High Definition Render Pipeline class.
Namespace: UnityEngine.Rendering.HighDefinition
Syntax
public class HDRenderPipeline : IDataProvider, RenderPipelineConstructors
HDRenderPipeline(HDRenderPipelineAsset, HDRenderPipelineAsset)
HDRenderPipeline constructor.
Declaration
public HDRenderPipeline(HDRenderPipelineAsset asset, HDRenderPipelineAsset defaultAsset)Parameters
| Type | Name | Description |
|---|---|---|
| HDRenderPipelineAsset | asset | Source HDRenderPipelineAsset. |
| HDRenderPipelineAsset | defaultAsset | Defauklt HDRenderPipelineAsset. |
Fields
k_ShaderTagName
Shader Tag for the High Definition Render Pipeline.
Declaration
public const string k_ShaderTagName = "HDRenderPipeline"Field Value
| Type | Description |
|---|---|
| String |
Properties
debugDisplaySettings
Debug display settings.
Declaration
public DebugDisplaySettings debugDisplaySettings { get; }Property Value
| Type | Description |
|---|---|
| DebugDisplaySettings |
rayTracingSupported
Flag that defines if ray tracing is supported by the current HDRP asset and platform
Declaration
public bool rayTracingSupported { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Methods
Dispose(Boolean)
Disposable pattern implementation.
Declaration
protected override void Dispose(bool disposing)Parameters
| Type | Name | Description |
|---|---|---|
| Boolean | disposing | Is disposing. |
ExportSkyToTexture(Camera)
Export the provided camera's sky to a flattened cubemap.
Declaration
public Texture2D ExportSkyToTexture(Camera camera)Parameters
| Type | Name | Description |
|---|---|---|
| Camera | camera | Requested camera. |
Returns
| Type | Description |
|---|---|
| Texture2D | Result texture. |
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 |
Render(ScriptableRenderContext, Camera[])
RenderPipeline Render implementation.
Declaration
protected override void Render(ScriptableRenderContext renderContext, Camera[] cameras)Parameters
| Type | Name | Description |
|---|---|---|
| ScriptableRenderContext | renderContext | Current ScriptableRenderContext. |
| Camera[] | cameras | List of cameras to render. |
RequestSkyEnvironmentUpdate()
Request an update of the environment lighting.
Declaration
public void RequestSkyEnvironmentUpdate()ResetRTHandleReferenceSize(Int32, Int32)
Resets the reference size of the internal RTHandle System. This allows users to reduce the memory footprint of render textures after doing a super sampled rendering pass for example.
Declaration
public void ResetRTHandleReferenceSize(int width, int height)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | width | New width of the internal RTHandle System. |
| Int32 | height | New height of the internal RTHandle System. |