Custom Depth in Unreal Engine 4

阳光穿透心脏的1/2处 2022-07-13 07:15 65阅读 0赞

Posted on [September 14, 2014][September 14_ 2014] by [Tom][]

Unreal Engine 4 introduced a new depth buffer along with their PBR rendering system. It’s called “Custom Depth” and can be used for effects like the selection outline that is built-in the Editor, rendering of occluded meshes or custom culling of transparency. I will discuss some of the basics of using this buffer in the material editor and explain some of the features I used it for in my own projects.

Contents \[[hide][]\]

*  [1 Custom Depth 101][]
 *  [2 Rendering Object Outlines][]
 *  [3 Culling Inner Triangles][]
 *  [4 Other Uses][]
 *  [5 Multi-Color Outline Effect][]
 *  [6 Issues & Limitations][6 Issues _ Limitations]
 *  [7 References][]

When using the techniques described for your own effect that utilize Custom Depth it’s important to read through the Issues & Limitations at the bottom of the page to prevent you hours of headache and unnecessary debugging.

[![ue4\_builtin\_selectionoutline][ue4_builtin_selectionoutline]][ue4_builtin_selectionoutline_ue4_builtin_selectionoutline]

## Custom Depth 101 ##

For those who have never used this feature before, you can enable it for both Static and Skeletal meshes under the Rendering category named “Render Custom Depth”.

[![ue4\_customdepth\_properties.][ue4_customdepth_properties.]][ue4_customdepth_properties._ue4_customdepth_properties.]

To view this particular buffer go to Buffer Visualization in the viewport-options.

[![ue4\_customdepth\_visualisationdropdown][ue4_customdepth_visualisationdropdown]][ue4_customdepth_visualisationdropdown_ue4_customdepth_visualisationdropdown]

Note that objects close to the camera are near-black and may be difficult to see!

[![ue4\_customdepthbuffer][ue4_customdepthbuffer]][ue4_customdepthbuffer_ue4_customdepthbuffer]

## Rendering Object Outlines ##

To render outlines around specific meshes (like a fallen ally, usable loot container etc.) we need a buffer to get their silhouettes. Custom Depth is perfect for this.

With the buffer filled with our object depth info we can perform a simple depth comparison by sampling the neighboring pixels in our post process. If a neighbor has depth info but the pixel itself does not – we color it to our outline color.

We can use another technique for drawing a translucent overlay for all occluded geometry by comparing custom depth against SceneDepth. If CustomDepth is larger than SceneDepth we blend in a white tint with SceneColor.

Combining both techniques results in the post effect below:

![ue4\_customdepth\_outlines\_03][ue4_customdepth_outlines_03]

I skipped most of the implementation details – if you have any questions feel free to ask them in the comment section below! I’ve made this effect available for download, feel free to modify and use this in your game.

![ue4_customdepth_thumb.jpg_zoom_1.25_w_720][]

Outline Post Process \[Download\]

Post Process material for outlines with translucent veil on occluded pixels.

After copying the .uasset files into the Content folder of your project you must add a Post Process Volume into your scene and enable the Unbound property, also don’t forget to add the post effect material under Blendables.

[![ue4\_postvolume\_properties][ue4_postvolume_properties]][ue4_postvolume_properties_ue4_postvolume_properties]

[Download Now!][Download Now] 10581 Downloads

## Culling Inner Triangles ##

When using transparency on models like character that have inner triangles (eyes, mouth, arm or bit of armor sticking through) you will see a noticable highlight in your material that attracts attention and simply doesnt look right. We can solve this issue using Custom Depth.

By rendering our character into the Custom Depth buffer we can cull any pixels that are behind the outter shell of the mesh. A slight depth offset should be added when comparing depth of Scene and Custom to prevent too many pixels to be culled including the outer shell. The material setup for this is quite simple:

[![materialnodes\_depthculling][materialnodes_depthculling]][materialnodes_depthculling_materialnodes_depthculling]

[Material Nodes][] – Copy this url’s content and you can directly paste the above nodes into your own material. ([Project Source is available on GitHub][])

I made a comparison of depth culling enabled and disabled in the setup below. The character on the right displays all occluded pixels in red. I rendered each character TWICE to work around a limitation where transparent materials do not render into custom depth at all (this is normal behavior for SceneDepth, but undesirable when explicitly enabling Custom Depth on a mesh with transparency applied) You can download the project source to see exactly how this was done.

[![ue4\_screenshotsaturday\_hologram\_small][ue4_screenshotsaturday_hologram_small]][ue4_screenshotsaturday_hologram_small_ue4_screenshotsaturday_hologram_small]

For [Switch ][Switch]we use this culling technique on a stealth effect giving it a more consistent ‘shell’ and highlight on a mesh that has a lot of overlapping pixels.

It’s important to know that if multiple materials use this technique that only the object closest to camera is culled correctly. In this image you can see the errors can would occur if you have multiple meshes overlapping. This should be taken into consideration when considering this technique – it may never be an issue if you use this effect sparingly or consistent isolated scenarios.

[![showingoverlappingissue][]][showingoverlappingissue 1]

This issue can possibly be solved by adding a max depth delta when culling. I have had no need to dive into this further, but may come back to this in the future when it starts to cause practical issues.

## Other Uses ##

For our game [Switch ][Switch]we are using Custom Depth for a number of features, one of them includes an x-ray material that exposes players behind a wall – I added a short video of an early proof of concept below.

## Multi-Color Outline Effect ##

A few engine versions ago Stencil Index buffer was added alongside Custom Depth. This enables us to create multi-colored outline effects among many other cool effects! [Click here][] to read about this new effect, included with a download link for the material.

[![ue4\_coloredoutlines01\_small][ue4_coloredoutlines01_small]][ue4_coloredoutlines01_small_ue4_coloredoutlines01_small]

## Issues & Limitations ##

*  Custom Depth does not work on translucent materials. In that case you need a second copy of the mesh using a simple opaque material with Custom Depth enabled and Render Main pass disabled. [View on AnswerHub][]
 *  Because the buffer is filled with all objects using Custom Depth it will not work when having multiple overlapped meshes (one behind the other) depending on how you’re using the depth value – a transparent mesh might be entirely culled if you use custom depth to cull inner triangles. A possible workaround is to add a maximum depth difference when looking for inner triangles to reduce the errors.

## References ##

*  [Source files on GitHub][Project Source is available on GitHub]
 *  [Multi-color Outline Effect][Click here]

Posted on [September 14, 2014][September 14_ 2014] by [Tom][]

Contents \[[hide][]\]

[![ue4\_builtin\_selectionoutline][ue4_builtin_selectionoutline]][ue4_builtin_selectionoutline_ue4_builtin_selectionoutline]

## Custom Depth 101 ##

For those who have never used this feature before, you can enable it for both Static and Skeletal meshes under the Rendering category named “Render Custom Depth”.

[![ue4\_customdepth\_properties.][ue4_customdepth_properties.]][ue4_customdepth_properties._ue4_customdepth_properties.]

To view this particular buffer go to Buffer Visualization in the viewport-options.

[![ue4\_customdepth\_visualisationdropdown][ue4_customdepth_visualisationdropdown]][ue4_customdepth_visualisationdropdown_ue4_customdepth_visualisationdropdown]

Note that objects close to the camera are near-black and may be difficult to see!

[![ue4\_customdepthbuffer][ue4_customdepthbuffer]][ue4_customdepthbuffer_ue4_customdepthbuffer]

## Rendering Object Outlines ##

To render outlines around specific meshes (like a fallen ally, usable loot container etc.) we need a buffer to get their silhouettes. Custom Depth is perfect for this.

Combining both techniques results in the post effect below:

![ue4\_customdepth\_outlines\_03][ue4_customdepth_outlines_03]

![ue4_customdepth_thumb.jpg_zoom_1.25_w_720][]

Outline Post Process \[Download\]

Post Process material for outlines with translucent veil on occluded pixels.

After copying the .uasset files into the **Content folder** of your project you must add a Post Process Volume into your scene and enable the **Unbound** property, also don’t forget to add the post effect material under **Blendables**.

[![ue4\_postvolume\_properties][ue4_postvolume_properties]][ue4_postvolume_properties_ue4_postvolume_properties]

[Download Now!][Download Now] 10581 Downloads

## Culling Inner Triangles ##

[![materialnodes\_depthculling][materialnodes_depthculling]][materialnodes_depthculling_materialnodes_depthculling]

[Material Nodes][] – **Copy this url’s content and you can directly paste the above nodes into your own material. ([Project Source is available on GitHub][])**

[![ue4\_screenshotsaturday\_hologram\_small][ue4_screenshotsaturday_hologram_small]][ue4_screenshotsaturday_hologram_small_ue4_screenshotsaturday_hologram_small]

For [Switch ][Switch]we use this culling technique on a stealth effect giving it a more consistent ‘shell’ and highlight on a mesh that has a lot of overlapping pixels.

[![showingoverlappingissue][]][showingoverlappingissue 1]

## Other Uses ##

## Multi-Color Outline Effect ##

A few engine versions ago Stencil Index buffer was added alongside Custom Depth. This enables us to create multi-colored outline effects among many other cool effects! **[Click here][]** to read about this new effect, included with a download link for the material.

[![ue4\_coloredoutlines01\_small][ue4_coloredoutlines01_small]][ue4_coloredoutlines01_small_ue4_coloredoutlines01_small]

## Issues & Limitations ##

## References ##

*  [Source files on GitHub][Project Source is available on GitHub]
 *  [Multi-color Outline Effect][Click here]

[September 14_ 2014]: http://www.tomlooman.com/the-many-uses-of-custom-depth-in-unreal-4/
[Tom]: http://www.tomlooman.com/author/tomlooman/
[hide]: http://www.tomlooman.com/the-many-uses-of-custom-depth-in-unreal-4/#
[1 Custom Depth 101]: http://www.tomlooman.com/the-many-uses-of-custom-depth-in-unreal-4/#Custom_Depth_101
[2 Rendering Object Outlines]: http://www.tomlooman.com/the-many-uses-of-custom-depth-in-unreal-4/#Rendering_Object_Outlines
[3 Culling Inner Triangles]: http://www.tomlooman.com/the-many-uses-of-custom-depth-in-unreal-4/#Culling_Inner_Triangles
[4 Other Uses]: http://www.tomlooman.com/the-many-uses-of-custom-depth-in-unreal-4/#Other_Uses
[5 Multi-Color Outline Effect]: http://www.tomlooman.com/the-many-uses-of-custom-depth-in-unreal-4/#Multi-Color_Outline_Effect
[6 Issues _ Limitations]: http://www.tomlooman.com/the-many-uses-of-custom-depth-in-unreal-4/#Issues_Limitations
[7 References]: http://www.tomlooman.com/the-many-uses-of-custom-depth-in-unreal-4/#References
[ue4_builtin_selectionoutline]: /images/20220713/bb7dc8f0403c42d1a5b90d23ad76061d.png?resize=720%2C402
[ue4_builtin_selectionoutline_ue4_builtin_selectionoutline]: /images/20220713/bb7dc8f0403c42d1a5b90d23ad76061d.png
[ue4_customdepth_properties.]: /images/20220713/75435131db404224b73bf0e91564d072.png?resize=398%2C358
[ue4_customdepth_properties._ue4_customdepth_properties.]: /images/20220713/75435131db404224b73bf0e91564d072.png
[ue4_customdepth_visualisationdropdown]: /images/20220713/ed295128b2054879a57a080d18d26170.png?resize=720%2C432
[ue4_customdepth_visualisationdropdown_ue4_customdepth_visualisationdropdown]: /images/20220713/ed295128b2054879a57a080d18d26170.png
[ue4_customdepthbuffer]: /images/20220713/246ec4b1582e46fa9363fd75f2737848.png?resize=701%2C324
[ue4_customdepthbuffer_ue4_customdepthbuffer]: /images/20220713/246ec4b1582e46fa9363fd75f2737848.png
[ue4_customdepth_outlines_03]: /images/20220713/caa078d716064c4b87e8cbb0ed5ac5b5.png
[ue4_customdepth_thumb.jpg_zoom_1.25_w_720]: /images/20220713/3dce6efd211349b48645ee0ad351c65a.png
[ue4_postvolume_properties]: /images/20220713/2aa5ceb60faf4d65b51c01280014d122.png?zoom=1.25&resize=720%2C341
[ue4_postvolume_properties_ue4_postvolume_properties]: /images/20220713/2aa5ceb60faf4d65b51c01280014d122.png
[Download Now]: http://www.tomlooman.com/?smd_process_download=1&download_id=813
[materialnodes_depthculling]: /images/20220713/f3635032b26b4b78bcb8709026b71d3f.png?resize=720%2C522
[materialnodes_depthculling_materialnodes_depthculling]: /images/20220713/f3635032b26b4b78bcb8709026b71d3f.png
[Material Nodes]: http://www.tomlooman.com/wp-content/uploads/2014/09/materialnodes_depthculling_copypaste.txt
[Project Source is available on GitHub]: https://github.com/tomlooman/ue4-tutorials
[ue4_screenshotsaturday_hologram_small]: /images/20220713/e642a2dc893e4c0c9424b04fce5a29bd.png?resize=720%2C537
[ue4_screenshotsaturday_hologram_small_ue4_screenshotsaturday_hologram_small]: /images/20220713/e642a2dc893e4c0c9424b04fce5a29bd.png
[Switch]: http://www.tomlooman.com/switch-dynamic-online-first-person-shooter/
[showingoverlappingissue]: /images/20220713/f30890b76e274363b8707eaf7b999785.png
[showingoverlappingissue 1]: https://i0.wp.com/www.tomlooman.com/wp-content/uploads/2014/09/showingoverlappingissue.jpg
[Click here]: http://www.tomlooman.com/multi-color-outline-post-process-in-unreal-engine-4/
[ue4_coloredoutlines01_small]: /images/20220713/eaa61e60c2714326953bc57a318b178d.png?resize=720%2C373
[ue4_coloredoutlines01_small_ue4_coloredoutlines01_small]: /images/20220713/eaa61e60c2714326953bc57a318b178d.png
[View on AnswerHub]: https://answers.unrealengine.com/questions/98542/issues-with-rendering-custom-depth.html