The High Definition Render Pipeline Asset
The High Definition Render Pipeline (HDRP) Asset controls the global rendering settings of your Project and creates an instance of the render pipeline.
Unity only allocates memory and builds shader variants for features you enable in the HDRP Asset. This means that you can disable features your project does not use to save memory. Since certain features require shader variants or other resources when Unity builds your project, you can only enable and disable features at edit time. However, it is possible to toggle the rendering of particular features at runtime, just not using the HDRP Asset. Instead, Frame-Settings control the features that cameras in the scene render. Frame Settings can only toggle features that are enabled in the HDRP Asset; they cannot enable features that are disabled.
Creating an HDRP Asset
A new Project using the HDRP template includes an HDRP Asset file named HDRenderPipelineAsset in the Assets/Settings folder.
If you upgrade a Project to HDRP and therefore do not use the HDRP template, you need to add an HDRP Asset to your Project. To create and customize an HDRP Asset:
- In the Unity Editor, go to the Project window and navigate to the folder you want to create your HDRP Asset in. This folder must be inside the Assets folder; you can not create Assets in the Packages folder.
- In the main menu, go to Assets > Create > Rendering and click High Definition Render Pipeline Asset.
- Enter a name for the HDRP Asset and press the Return key to confirm it.
When you have created an HDRP Asset, you must assign it it to the pipeline:
- Navigate to Edit > Project Settings > Graphics and locate the Scriptable Render Pipeline Settings property at the top.
- Either drag and drop the HDRP Asset into the property field, or use the object picker (located on the right of the field) to select it from a list of all HDRP Assets in your Project.
Unity now uses the High Definition Render Pipeline (HDRP) in your Unity Project. HDRP does not support gamma space, so your Project must use linear color space, To do this:
- Navigate to Edit > Project Settings > Player > Other Settings and locate the Color Space property.
- Select Linear from the Color Space drop-down.
You can create multiple HDRP Assets containing different settings. This is useful for Project that support multiple platforms, such as PC, Xbox One and PlayStation 4. In each HDRP Asset, you can change settings to suite the hardware of each platform and then assign the relevant one when building your Project for each platform. For more information on using creating HDRP Assets to target different platforms, see Scalability in HDRP.
To change which HDRP Asset your render pipeline uses, either manually select an HDRP Asset in the Graphics Settings window (as shown above), or use the GraphicsSettings.renderPipelineAsset property via script.
When you create an HDRP Asset, open it in the Inspector to edit its properties.
Rendering
Property | Description |
---|---|
Color Buffer Format | The format of the color buffer that HDRP will use for rendering, using R16G16B16A16 instead of R11G11B10 will double the memory usage but help you to avoid banding. R16G16B16A16 is also required for Alpha-Output. |
Lit Shader Mode | Use the drop-down to choose which mode HDRP uses for the Lit Shader. • Forward Only: forces HDRP to only use forward rendering for Lit Shaders. • Deferred Only: forces HDRP to use deferred rendering for Lit Shaders (HDRP still renders advanced Materials using forward rendering). • Both: allows the Camera to use deferred and forward rendering. Select Both to allow you to switch between forward and deferred rendering for Lit Shaders at runtime per Camera. Selecting a specific mode reduces build time and Shader memory because HDRP requires less Shader variants, but it is not possible to switch from one mode to the other at runtime. |
- Multisample Anti-aliasing Quality | Use the drop-down to set the number of samples HDRP uses for multisample anti-aliasing (MSAA). The larger the sample count, the better the quality. Select None to disable MSAA. This property is only visible when Lit Shader Mode is set to Forward Only or Both. |
Motion Vectors | Enable the checkbox to make HDRP support motion vectors. HDRP uses motion vectors for effects like screen space reflection (SSR) and motion blur. When disabled, motion blur has no effect and HDRP calculates SSR with lower quality. |
Runtime Debug Display | Enable the checkbox to make HDRP able to use debug modes from the Render Pipeline Debug window at runtime. Disable the checkbox to reduce build time and shader memory. This disables the following debug modes: All material property debug modes except GBuffer debug, the various property override options, and all the lighting debug modes. |
Runtime AOV API | Enable the checkbox to make HDRP able to use the AOV API (rendering of material properties and lighting modes) at runtime. Disable this checkbox to reduce build time and shader memory. This disables the following AOV modes: All material properties and lighting modes. |
Dithering Cross-fade | Enable the checkbox to make HDRP support dithering cross fade. This allows HDRP to implement smooth transitions between a GameObject’s LOD levels. When disabled, this reduces build time if you are not using LOD fade. |
Terrain Hole | Enable the checkbox to make HDRP support Terrain Holes. If you do not enable this, Terrain Holes are not visible in your Scene. |
Transparent Backface | Enable the checkbox to make HDRP support transparent back-face render passes. If your Unity Project does not need to make a transparent back-face pass, disable this checkbox to reduce build time. |
Transparent Depth Prepass | Enable the checkbox to make HDRP support transparent depth render prepasses. If your Unity Project does not need to make a transparent depth prepass, disable this checkbox to reduce build time . |
Transparent Depth Postpass | Enable the checkbox to make HDRP support transparent depth render postpasses. If your Unity Project does not make use of a transparent depth postpass. Uncheck this checkbox to reduce build time . |
Custom Pass | Enable the checkbox to make HDRP support custom passes. If your Unity Project does not make use Custom Passes, Uncheck this checkbox to save memory . |
- Custom Buffer Format | Specify the texture format for the custom buffer. If you experience banding issues due to your custom passes, you can change it to either R11G11B10 if you don't need alpha or R16G16B16A16 . |
Realtime Raytracing (Preview) | Enable the checkbox to enable HDRP realtime ray tracing (Preview). It requires to have ray tracing compatible hardware. For more information, please refer to the Ray Tracing Getting Started page. |
Supported Ray Tracing Mode (Preview) | Select the supported modes for ray tracing effects (Performance, Quality or Both). For more information, see the Ray Tracing Getting Started page. |
- LOD Bias | Set the value that Cameras use to calculate their LOD bias. The Camera uses this value differently depending on the LOD Bias Mode you select. |
- Maximum LOD Level | Set the value that Cameras use to calculate their maximum level of detail. The Camera uses this value differently depending on the Maximum LOD Level Mode you select. |
Decals
These settings control the draw distance and resolution of the decals atlas that HDRP uses when it renders decals projected onto transparent surfaces.
Property | Description |
---|---|
Enable | Enable the checkbox to make HDRP support decals in your Unity Project. |
- Draw Distance | The maximum distance from the Camera at which Unity draws Decals. |
- Atlas Width | The Decal Atlas width. This atlas stores all decals that project onto transparent surfaces. |
- Atlas Height | The Decal Atlas height. This atlas stores all decals that project onto transparent surfaces. |
- Metal and Ambient Occlusion properties | Enable the checkbox to allow decals to affect metallic and ambient occlusion Material properties. Enabling this feature has a performance impact. |
- Maximum Clustered Decals on Screen | The maximum number of clustered decals that can affect transparent GameObjects on screen. Clustered decals refer to a list of decals that HDRP uses when it renders transparent GameObjects. |
- Layers | Enable the checkbox to allow decals to only affect specific layers. |
Dynamic Resolution
Property | Description |
---|---|
Enable | Enable the checkbox to make HDRP support dynamic resolution in your Unity Project. |
- Dynamic Resolution Type | Use the drop-down to select the type of dynamic resolution HDRP uses: • Software: This option allocates render targets to accommodate the maximum resolution possible, then rescales the viewport accordingly. This allows the viewport to render at varying resolutions. |
- Upscale Filter | Use the drop-down to select the filter that HDRP uses for upscaling. • Bilinear: A low quality upsample. The least resource intensive option. • Catmull-Rom: A bicubic upsample with 4 taps. • Lanczos: A sharp upsample. This method can potentially introduce artifacts so you should not use it for extreme upsampling cases for example, when the screen percentage is less than 50%. • Contrast Adaptive Sharpen: An ultra sharp upsample. This option is not meant for screen percentages less than 50% and still sharpens when the screen percentage is set to 100%. This uses FidelityFX (CAS) AMD™. For information about FidelityFX and Contrast Adaptive Sharpening, see AMD FidelityFX. |
- Minimum Screen Percentage | The minimum screen percentage that dynamic resolution can reach. |
- Maximum Screen Percentage | The maximum screen percentage that dynamic resolution can reach. This value must be higher than the Min Screen Percentage. |
- Force Screen Percentage | Enable the checkbox to force HDRP to use a specific screen percentage for dynamic resolution. This feature is useful for debugging dynamic resolution. |
- Forced Screen Percentage | The specific screen percentage that HDRP uses for dynamic resolution. This property is only visible when you enable the Force Screen Percentage.. |
Lighting
Property | Description |
---|---|
Screen Space Ambient Occlusion | Enable the checkbox to make HDRP support screen space ambient occlusion (SSAO). SSAO is a technique for approximating ambient occlusion efficiently in real time. |
Screen Space Global Illumination | Enable the checkbox to make HDRP support screen space global illumination (SSGI). SSGI is a technique for approximating global illumination efficiently in real time. |
Volumetrics | Enable the checkbox to make HDRP support volumetrics. This allows you to use Volumetric Fog for the Fog Type in the Visual Environment. |
Light Layers | Enable the checkbox to make HDRP support Light Layers. You can assign a Layer to a Light which then only lights up Mesh Renderers or Terrain with a matching rendering Layer. |
Cookies
Use the Cookie settings to configure the maximum resolution of the atlas and it's format. A bigger resolution means that you can have more cookies on screen at one time or use bigger cookies texture in general. Increasing for format will allow you to handle HDR cookies and have better precision at the cost of memory.
Property | Description |
---|---|
2D Atlas Size | Use the drop-down to select the maximum size for 2D cookie atlas. HDRP uses 2D cookies for Directional, Spot Lights and Area Lights. |
2D Atlas Last Valid Mip | Adds padding to prevent area light cookie border to be cut but can blur the texture a lot if too high values are used. Generally the default value (0) works well in most cases. |
Cookie Format | The format of the cookies that HDRP will use, using R16G16B16A16 instead of R11G11B10 will double the memory usage but help you to avoid banding and adds the support for EXR cookies. |
Reflections
Use the Reflection settings to configure the max number and resolution of the probes and whether Unity should compress the Reflection Probe caches or not. The Reflection Probe cache refers to runtime memory that HDRP reserves for Reflection Probes. The cache is a first in, first out list that stores the currently visible Reflection Probes.
Property | Description |
---|---|
Screen Space Reflection | Enable the checkbox to make HDRP support screen space reflection. SSR is a technique for calculating reflections by reusing screen space data. |
- Transparent | Enable the checkbox to make HDRP support screen space reflection on transparent materials. |
Reflection and Planar Probes Format | Color format used for reflection and planar probes. |
Compress Reflection Probe Cache | Enable the checkbox to compress the Reflection Probe cache in order to save space on disk. |
Reflection Cubemap Size | Use the drop-down to select the maximum resolution of individual Reflection Probecubemaps. |
Probe Cache Size | The maximum size of the Probe Cache. Defines how many Probe cube maps HDRP can save in cache. |
Planar Reflection Atlas Size | Use the drop-down to select the resolution of the planar probe atlas. It defines how many reflection probe you'll be able to render at once and at which resolution. |
Planar Resolution Tiers | |
- L | Set the resolution of planar reflection set to this quality. Planar Reflection Probe's with their Resolution set to Low use this resolution for their planar reflection. |
- M | Set the resolution of planar reflection set to this quality. Planar Reflection Probe's with their Resolution set to Medium use this resolution for their planar reflection. |
- H | Set the resolution of planar reflection set to this quality. Planar Reflection Probe's with their Resolution set to High use this resolution for their planar reflection. |
Max Planar Reflection On Screen | The maximum number of planar reflections on screen at once. |
Maximum Environment Lights on Screen | The maximum number of environment Lights HDRP can manage on screen at once. |
Sky
These settings control skybox reflections and skybox lighting.
Property | Description |
---|---|
Reflection Size | Use the drop-down to select the maximum resolution of the cube map HDRP uses to manage fallback reflection when no local reflection probes are present. This property has no effect on the quality of the sky itself. |
Lighting Override Mask | Use the drop-down to select the Volume layer mask HDRP uses to override sky lighting. Use this to decouple the display sky and lighting. See the Environment Lighting for information on how to decouple environment lighting from the sky background. |
Shadow
These settings adjust the size of the shadowmask. Smaller values causes Unity to discard more distant shadows, while higher values lead to Unity displaying more shadows at longer distances from the Camera.
Property | Description |
---|---|
Shadowmask | Enable the checkbox to make HDRP support the Shadowmask lighting mode in your Unity Project. |
Maximum Shadow on Screen | The maximum number of shadows you can have in view. A Spot Light casts a single shadow, a Point Light casts six shadows, and a Directional Light casts shadows equal to the number of cascades defined in the HD Shadow Settings override. |
Filtering Quality | Use the drop-down to select the filtering quality for shadows. Higher values increase the shadow quality in HDRP as better filtering near the edges of shadows reduce aliasing effects. For information on each filtering quality preset, see the Filtering Qualities table. |
Screen Space Shadows | Enable the checkbox to allow HDRP to compute shadows in a separate pass and store them in a screen-aligned Texture. |
- Maximum | Set the maximum number of screen space shadows that HDRP can handle. |
- Buffer Format | Defines the format (R11G11B10 or R16G16B16A16) of the buffer used for screen space shadows. |
The following sections allow you to customize the shadow atlases and individual shadow resolution tiers for each type of Light in HDRP. Shadow resolution tiers are useful because, instead of defining the shadow resolution for each individual Light as a number, you can assign a numbered resolution to a named shadow resolution tier then use the named tier instead of rewriting the number. For example, instead of setting the resolution of each Light to 512, you could say that Medium resolution shadows have a resolution of 512 and then set the shadow quality of each Light to be Medium. This way, you can more easily have consistent shadow quality across your HDRP Project.
The three sections here are:
- Directional Light Shadows
- Punctual Light Shadows
- Area Light Shadows
They all share the same properties, except Directional Light Shadows which does not include Resolution or Dynamic Rescale.
Property | Description |
---|---|
Light Atlas | |
Resolution | Use the drop-down to select the resolution of the shadow atlas. |
Precision | Use the drop-down to select the precision of the shadow map. This sets the bit depth of each pixel of the shadow map. 16 bit is faster and uses less memory at the expense of precision. |
Dynamic Rescale | Enable the checkbox to allow HDRP to rescale the shadow atlas if all the shadows on the screen don’t currently fit onto it. |
Shadow Resolution Tiers | |
---|---|
L | Set the resolution of shadows set to this quality. Light's with their Resolution set to Low use this resolution for their shadows. |
M | Set the resolution of shadows set to this quality. Light's with their Resolution set to Medium use this resolution for their shadows. |
H | Set the resolution of shadows set to this quality. Light's with their Resolution set to High use this resolution for their shadows. |
U | Set the resolution of shadows set to this quality. Light's with their Resolution set to Ultra use this resolution for their shadows. |
Maximum Shadow Resolution | Set the maximum resolution of any shadow map of this Light type. If you set any shadow resolution to a value higher than this, HDRP clamps it to this value. |
Filtering Qualities
Filtering Quality | Algorithm |
---|---|
Low | • Point/Spot Lights: Percentage Closer Filtering (PCF) 3x3 (4 taps). • Directional Lights: PCF Tent 5x5 (9 taps). • Area Lights: EVSM. |
Medium | • Point/Spot Lights: PCF 5x5 (9 taps). • Directional Lights: PCF Tent 5x5 (9 taps). • Area Lights: EVSM. |
High | •Point/Spot/Directional Lights: Percentage Closer Soft Shadow (PCSS). You can change the sample count to decrease the quality of these shadows. This decreases the resource intensity of this algorithm. To change the sample count for shadows cast by that Light, set the Filter Sample Count in the Inspector of each Light component. Note: The softness of PCSS shadows is defined by the shape radius of Point and Spot Lights, and by the angular diameter of Directional Lights. • Area Lights: EVSM. |
The PCF algorithm applies a fixed size blur. PCSS applies a different blur size depending on the distance between the shadowed pixel and the shadow caster. This results in a more realistic shadow, that is also more resource intensive to compute.
Lights
Use these settings to enable or disable settings relating to lighting in HDRP.
Property | Description |
---|---|
Maximum Directional On Screen | The maximum number of Directional Lights HDRP can manage on screen at once. |
Maximum Punctual On Screen | The maximum number of Point and Spot Lights HDRP can manage on screen at once. |
Maximum Area On Screen | The maximum number of area Lights HDRP can manage on screen at once. |
Maximum Lights Per Cell (Ray Tracing) | The maximum number of Lights that an individual grid cell in a Light Cluster can store. |
Material
Property | Description |
---|---|
Distortion | Enable the checkbox to make HDRP support distortion. If your Unity Project does not use distortion, disable this checkbox to reduce build time. |
Subsurface Scattering | Enable the checkbox to make HDRP support subsurface scattering (SSS). SSS describes light penetration of the surface of a translucent object |
- High Quality | Enable the checkbox to increase the SSS Sample Count and enable high quality subsurface scattering. Increasing the sample count greatly increases the performance cost of the Subsurface Scattering effect. |
Fabric BSDF Convolution | By default, Fabric Materials reuse the Reflection Probes that HDRP calculates for the Lit Shader (GGX BRDF). Enable the checkbox to make HDRP calculate another version of each Reflection Probe for the Fabric Shader, creating more accurate lighting effects. This increases the resource intensity because HDRP must condition two Reflection Probes instead of one. It also reduces the number of visible Reflection Probes in the current view by half because the size of the cache that stores Reflection Probe data does not change and must now store both versions of each Reflection Probe. |
Post-processing
Property | Description |
---|---|
Grading LUT Size | The size of the internal and external color grading lookup textures (LUTs). This size is fixed for the Project. You can not mix and match LUT sizes, so decide on a size before you start the color grading process. The default value, 32, provides a good balance of speed and quality. |
Grading LUT Format | Use the drop-down to select the format to encode the color grading LUTs with. Lower precision formats are faster and use less memory at the expense of color precision. These formats directly map to their equivalent in the built-in GraphicsFormat enum value. |
Buffer Format | Use the drop-down to select the format of the color buffers that are used in the post-processing passes. Lower precision formats are faster and use less memory at the expense of color precision. These formats directly map to their equivalent in the built-in GraphicsFormat enum value. |
Post-processing Quality Settings
These settings define the quality levels (low, medium, high) related to post processing effects in HDRP. For a detailed description of each setting, see the Post-processing in HDRP section of the documentation.
Virtual Texturing
Property | Description |
---|---|
CPU Cache Size | Amount of CPU memory (in MB) that can be allocated by the Streaming Virtual Texturing system to cache texture data. |
GPU Cache Size per Format | Amount of GPU memory (in MB) that can be allocated per format by the Streaming Virtual Texturing system to cache texture data. The value assigned to None is used for all unspecified formats. |