Add support for depth function in spatial materials #73527

apples · 2023-02-17T22:09:31Z

Adds "Depth Function" property to spatial materials, which controls the depth comparison operator.

Resolves godotengine/godot-proposals#1298.

Test project: https://github.com/apples/DepthFunctionTest

Seems to work fine in all three rendering modes in my simple testing, but more testing is likely necessary as this touches core rendering logic. I'm a little unsure about the GLES3 implementation, but I tried my best.

Currently only useful for alpha pass materials, due to #73158.

servers/rendering/renderer_rd/forward_clustered/scene_shader_forward_clustered.cpp

Ansraer · 2023-02-22T17:03:05Z

servers/rendering/renderer_rd/forward_clustered/scene_shader_forward_clustered.cpp

+			default:
+				depth_stencil_state.depth_compare_operator = RD::COMPARE_OP_LESS_OR_EQUAL;
+				break;
+		}
 	}
 	bool depth_pre_pass_enabled = bool(GLOBAL_GET("rendering/driver/depth_prepass/enable"));


Just want to point out that for opaque materials #70214 will overwrite the compare op you just set later on.
This is currently not a problem due to #73158 (which sends custom no-depth draw materials into the alpha pass) but could be a potential problem in the future.

As things are now, it would be difficult to integrate depth functions into the opaque render pass anyways, due to potential sorting issues. I'm currently looking into solutions for this, but it might be beyond the scope of this PR.

QbieShay · 2023-05-08T13:09:46Z

Hey, what's the state of this?

Calinou · 2023-08-09T07:47:49Z

Hey, what's the state of this?

This PR needs to be rebased to account for ed0c378. (I don't know if glDepthFunc() should be moved to follow glDepthMask(). In my rebase, I didn't move glDepthFunc() and it worked fine this way.)

Calinou

Tested locally, it works as expected in all 3 rendering methods.

Testing project: test_pr_73527.zip

It's possible to get a transparent x-ray effect to work with an opaque material if you use Grow with -0.001 as a value in the next pass:

However, this is a fiddly setup that is difficult to figure out and Z-fighting will occur in the distance. A custom shader that sets grow distance based on the distance to the camera might work better. (Some outline effects may benefit from a fixed size regardless of camera distance, so it could be worth considering as a core material feature.)

If this caveat is well-documented in the StandardMaterial3D class reference and manual page, this should still be a net usability upgrade overall. However, I wonder if the depth function property should be hidden for opaque materials that have Depth Draw Mode set to a value other than Never, as it appears to do nothing otherwise.

doc/classes/BaseMaterial3D.xml

apples · 2023-08-17T01:50:41Z

Updated:

Rebased to latest master.
Squashed commits.
Incorporated Calinou's suggested documentation change.
Renamed and reordered some enum values, to better match the underlying graphics API enums, and also to be more in line with the expected changes for Expose an intuitive subset of stencil operations godot-proposals#7174.
Regarding the glDepthMask change from ed0c378: that change shouldn't affect this PR, so I left it all as-is.

apples · 2023-08-28T00:24:28Z

Previous change broke Visual Shaders, pushed a small fix that involved moving the LESS_OR_EQUAL operator to slot 0 in all enums, since Visual Shaders assume 0 is the default value.

Updated stencil features to match new design Fixed stencil opaque pass Added STENCIL_RW_WRITE_ALWAYS Added docs for BaseMaterial3D stencil operations Added mobile renderer support Renamed stencil rw modes Implemented property hiding for stencil fields Updated docs Apply suggestions from code review Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com> Update scene/resources/material.cpp Co-authored-by: RedMser <5117197+RedMser@users.noreply.github.com> Update servers/rendering/renderer_rd/forward_clustered/render_forward_clustered.cpp Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com> Added missing cases Fixed stencil_mode autocompletion Fixed syntax highlighting of stencil_mode Added stencil support to VisualShader Added stencil support for GLES3 Changed stencil property default values in BaseMaterial3D Revert "Added stencil support for GLES3" This reverts commit c6f581b. Removed mask_uses_ref project setting Changed depth functions to better match PR godotengine#73527 Apply suggestions from code review Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com> Changed set_stencil_effect_color to pass by const ref Fixed errors

clayjohn · 2023-10-07T01:24:30Z

I think this looks good from a design standpoint, I am also concerned about the impact of #73158. So I would like to discuss making the changes described here #73158 (comment) in a future rendering meeting.

I'm worried about the usability of this PR. Switching between depth draw modes can be greatly impacted by the order in which nodes are draw (i.e if I render an object with depth_draw GREATER, but it is drawn first, it just won't get drawn. render_priority can help, but it can't sort between TAA and non-TAA passes or between opaque and transparent, so you can still get into trouble.

We may want to hold off on this until we have the ability to run multiple opaque passes (and clear depth etc. between passes). Otherwise I fear this feature is going to feel a bit user hostile and difficult to control for anything except simple examples.

QbieShay · 2023-10-11T13:21:03Z

Similarly to the stencil PR, we need to first come up with a design for opaque multipass.

Updated stencil features to match new design Fixed stencil opaque pass Added STENCIL_RW_WRITE_ALWAYS Added docs for BaseMaterial3D stencil operations Added mobile renderer support Renamed stencil rw modes Implemented property hiding for stencil fields Updated docs Apply suggestions from code review Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com> Update scene/resources/material.cpp Co-authored-by: RedMser <5117197+RedMser@users.noreply.github.com> Update servers/rendering/renderer_rd/forward_clustered/render_forward_clustered.cpp Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com> Added missing cases Fixed stencil_mode autocompletion Fixed syntax highlighting of stencil_mode Added stencil support to VisualShader Added stencil support for GLES3 Changed stencil property default values in BaseMaterial3D Revert "Added stencil support for GLES3" This reverts commit c6f581b. Removed mask_uses_ref project setting Changed depth functions to better match PR godotengine#73527 Apply suggestions from code review Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com> Changed set_stencil_effect_color to pass by const ref Fixed errors

apples requested review from a team as code owners February 17, 2023 22:09

Calinou added enhancement topic:rendering topic:3d labels Feb 17, 2023

Calinou added this to the 4.x milestone Feb 17, 2023

clayjohn added feature proposal and removed enhancement labels Feb 17, 2023

apples force-pushed the depth-function branch from 6a27928 to db27e5a Compare February 18, 2023 00:04

Ansraer reviewed Feb 22, 2023

View reviewed changes

apples mentioned this pull request Mar 11, 2023

Godot 4 Ultimate Flexible Outline and X-Ray Shader alfredbaudisch/GodotShaderCollection#3

Open

apples mentioned this pull request Aug 9, 2023

Expose an intuitive subset of stencil operations godotengine/godot-proposals#7174

Open

Calinou approved these changes Aug 9, 2023

View reviewed changes

Calinou reviewed Aug 9, 2023

View reviewed changes

doc/classes/BaseMaterial3D.xml Show resolved Hide resolved

apples force-pushed the depth-function branch from 416b92b to e3e4025 Compare August 17, 2023 01:46

apples mentioned this pull request Aug 17, 2023

Add stencil support to spatial materials #80710

Open

3 tasks

akien-mga requested a review from clayjohn August 18, 2023 07:19

apples force-pushed the depth-function branch from e3e4025 to 9f20505 Compare August 28, 2023 00:22

apples added a commit to apples/godot that referenced this pull request Sep 10, 2023

Changed depth functions to better match PR godotengine#73527

be85b5c

apples force-pushed the depth-function branch from 9f20505 to 9c49019 Compare September 10, 2023 07:18

QbieShay modified the milestones: 4.x, 4.2 Sep 10, 2023

clayjohn added the for pr meeting label Oct 7, 2023

akien-mga modified the milestones: 4.2, 4.3 Oct 11, 2023

akien-mga modified the milestones: 4.3, 4.x Jun 12, 2024

apples force-pushed the depth-function branch from 9c49019 to 1892b98 Compare July 20, 2024 04:17

Add depth function for spatial materials

47ff5a9

apples force-pushed the depth-function branch from 1892b98 to 47ff5a9 Compare July 20, 2024 04:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for depth function in spatial materials #73527

Add support for depth function in spatial materials #73527

apples commented Feb 17, 2023

Ansraer Feb 22, 2023

apples Feb 23, 2023

QbieShay commented May 8, 2023

Calinou commented Aug 9, 2023 •

edited

Loading

Calinou left a comment •

edited

Loading

apples commented Aug 17, 2023 •

edited

Loading

apples commented Aug 28, 2023

clayjohn commented Oct 7, 2023

QbieShay commented Oct 11, 2023

Add support for depth function in spatial materials #73527

Are you sure you want to change the base?

Add support for depth function in spatial materials #73527

Conversation

apples commented Feb 17, 2023

Ansraer Feb 22, 2023

Choose a reason for hiding this comment

apples Feb 23, 2023

Choose a reason for hiding this comment

QbieShay commented May 8, 2023

Calinou commented Aug 9, 2023 • edited Loading

Calinou left a comment • edited Loading

Choose a reason for hiding this comment

apples commented Aug 17, 2023 • edited Loading

apples commented Aug 28, 2023

clayjohn commented Oct 7, 2023

QbieShay commented Oct 11, 2023

Calinou commented Aug 9, 2023 •

edited

Loading

Calinou left a comment •

edited

Loading

apples commented Aug 17, 2023 •

edited

Loading