diff options
| author | Clément Foucault <foucault.clem@gmail.com> | 2022-10-11 11:06:38 +0300 |
|---|---|---|
| committer | Clément Foucault <foucault.clem@gmail.com> | 2022-10-12 18:39:23 +0300 |
| commit | 4552924dccf67b8f2eadd298cfc4b0b4960b7767 (patch) | |
| tree | c0a80200694f3630f35c88a5a607f22b4c25b73f /source/blender/draw | |
| parent | aa5ce2fcc1e349bdcb48a2f054d6179af293413f (diff) | |
Cleanup: DRW: Improve state_stencil documentation
Diffstat (limited to 'source/blender/draw')
| -rw-r--r-- | source/blender/draw/intern/draw_pass.hh | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/source/blender/draw/intern/draw_pass.hh b/source/blender/draw/intern/draw_pass.hh index ee2180712d1..3fae6e09932 100644 --- a/source/blender/draw/intern/draw_pass.hh +++ b/source/blender/draw/intern/draw_pass.hh @@ -174,9 +174,15 @@ class PassBase { /** * Reminders: - * - (compare_mask & reference) is what is tested against (compare_mask & stencil_value) + * - `compare_mask & reference` is what is tested against `compare_mask & stencil_value` * stencil_value being the value stored in the stencil buffer. - * - (write-mask & reference) is what gets written if the test condition is fulfilled. + * - `write-mask & reference` is what gets written if the test condition is fulfilled. + * + * This will modify the stencil state until another call to this function. + * If not specified before any draw-call, these states will be undefined. + * + * For more information see: + * https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkStencilOpState.html */ void state_stencil(uint8_t write_mask, uint8_t reference, uint8_t compare_mask); |