Add initial stencil documentation #10991
Conversation
Calinou
added
enhancement
topic:rendering
area:manual
| +-------------------------------+------------------------------------------------------------------------------------------------------+ | ||
| | **compare_equal** | Pass stencil test if the reference value is equal to the stencil buffer value. | | ||
| +-------------------------------+------------------------------------------------------------------------------------------------------+ |
There was a problem hiding this comment.
missing documentation:
+-------------------------------+------------------------------------------------------------------------------------------------------+
| **compare_always** | Always pass stencil test. |
+-------------------------------+------------------------------------------------------------------------------------------------------+
| @@ -35,6 +35,10 @@ For visual examples of these render modes, see :ref:`Standard Material 3D and OR | |||
| +-------------------------------+------------------------------------------------------------------------------------------------------+ | |||
| | **depth_test_disabled** | Disable depth testing. | | |||
| +-------------------------------+------------------------------------------------------------------------------------------------------+ | |||
| | **depth_test_default** | Depth test will discard the pixel if it is behind other pixels. | | |||
There was a problem hiding this comment.
Will need to mention using Depth test equal for opaque pass in in Forward+ renderer
There was a problem hiding this comment.
Will need to mention using Depth test equal for opaque pass in in Forward+ renderer
What would a user do with that extra information? I can't think of a scenario in which the user can tell the difference.
There was a problem hiding this comment.
I don' tthink i can fit it in this line of the documentation. any suggestion on where to put it?
AThousandShips
removed
the
waiting on PR merge
|
|
||
| .. note:: | ||
|
|
||
| You can only read stencil in the transparent pass. |
There was a problem hiding this comment.
| You can only read stencil in the transparent pass. | |
| You can only read the stencil in the transparent pass. |
| - Portals: Draw geometry that is normally "impossible" (non-Euclidian) by masking objects. | ||
| - Shadows: Draw sharp shadows without relying on shadow maps. |
There was a problem hiding this comment.
Might be worth mentioning that portals and shadows can only currently be implemented in very simple forms, due to the lack of a multi-pass/programmable compositor.
There was a problem hiding this comment.
@Calinou removed shadows because I don't want to raise expectations too much, as there's likely some hard limitations there.
Co-authored-by: Hugo Locurcio <[email protected]> Co-authored-by: A Thousand Ships <[email protected]>
Documentation for godotengine/godot#80710