Skip to content

Commit fdca31a

Browse files
committed
stencil doc
1 parent 6729f62 commit fdca31a

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

tutorials/shaders/shader_reference/spatial_shader.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -113,12 +113,11 @@ Some of the most well-known uses are:
113113
- Outlines: Mask out the inner mesh that is being outlined to avoid inner outlines.
114114
- X-Ray: Display a mesh behind other objects.
115115
- Portals: Draw geometry that is normally "impossible" (non-Euclidian) by masking objects.
116-
- Shadows: Draw sharp shadows without relying on shadow maps.
117116

118117
.. note::
119118

120-
You can only read stencil in the transparent pass.
121-
Any attempt to read in the opaque pass will fail, as it's not supported behavior.
119+
You can only read from stencil in the transparent pass.
120+
Any attempt to read in the opaque pass will fail, as it's currently not supported behavior.
122121

123122
Also, stencil operations aren't yet supported in compositor effects.
124123
Please use the full screen quad method described in
@@ -133,13 +132,15 @@ Some of the most well-known uses are:
133132
+-------------------------------+------------------------------------------------------------------------------------------------------+
134133
| **write_if_depth_fail** | Write reference value to the stencil buffer if the depth test fails. |
135134
+-------------------------------+------------------------------------------------------------------------------------------------------+
135+
| **compare_equal** | Always pass stencil test |
136+
+-------------------------------+------------------------------------------------------------------------------------------------------+
136137
| **compare_equal** | Pass stencil test if the reference value is equal to the stencil buffer value. |
137138
+-------------------------------+------------------------------------------------------------------------------------------------------+
138139
| **compare_not_equal** | Pass stencil test if the reference value is not equal to the stencil buffer value. |
139140
+-------------------------------+------------------------------------------------------------------------------------------------------+
140-
| **compare_less** | Pass stencil test if the reference value is less than the stencil buffer value. |
141+
| **compare_less** | Pass stencil test if the reference value is less than the stencil buffer value. |
141142
+-------------------------------+------------------------------------------------------------------------------------------------------+
142-
| **compare_less_or_equal** | Pass stencil test if the reference value is less than or equal to the stencil buffer value. |
143+
| **compare_less_or_equal** | Pass stencil test if the reference value is less than or equal to the stencil buffer value. |
143144
+-------------------------------+------------------------------------------------------------------------------------------------------+
144145
| **compare_greater** | Pass stencil test if the reference value is greater than the stencil buffer value. |
145146
+-------------------------------+------------------------------------------------------------------------------------------------------+

0 commit comments

Comments
 (0)