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. |
+-------------------------------+------------------------------------------------------------------------------------------------------+There was a problem hiding this comment.
The missing documentation was amended. Though there seems to be one space too many in the Stencil mode column and the dot is missing in the Description text.
clayjohn
left a comment
clayjohn
left a comment
There was a problem hiding this comment.
This should also have an example of a super basic stencil material so users can see how the syntax looks
| +-------------------------------+------------------------------------------------------------------------------------------------------+ | ||
| | **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?
There was a problem hiding this comment.
You can make this description take multiple lines
AThousandShips
removed
the
waiting on pr merge
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro> Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
|
|
||
| .. note:: | ||
|
|
||
| You can only read from stencil in the transparent pass. |
There was a problem hiding this comment.
| You can only read from stencil in the transparent pass. | |
| You can only read from the stencil buffer in the transparent pass. |
| You can only read from stencil in the transparent pass. | ||
| Any attempt to read in the opaque pass will fail, as it's currently not supported behavior. | ||
|
|
||
| Also, stencil operations aren't yet supported in compositor effects. |
There was a problem hiding this comment.
That's not true, stencil operations have been supported in compositor effects from the beginning. What isn't supporting is copying the main renderers stencil buffer into a custom texture
There was a problem hiding this comment.
I don't understand what this means. If stencils from the main renderer can't be used, then maybe it's technically correct to say they are supported, but i don't think it makes sense in the doc to say that you can use them..?
7 participants
Documentation for godotengine/godot#80710