diff --git a/renderdoc/api/replay/vk_pipestate.h b/renderdoc/api/replay/vk_pipestate.h index 02b998b24..aee57f7a0 100644 --- a/renderdoc/api/replay/vk_pipestate.h +++ b/renderdoc/api/replay/vk_pipestate.h @@ -634,16 +634,15 @@ struct ViewState DOCUMENT("A list of :class:`VKRenderArea` defining discard rectangles."); rdcarray discardRectangles; - DOCUMENT(R"( ``True`` if a fragment in any one of the discard rectangles fails the discard test, + DOCUMENT(R"(``True`` if a fragment in any one of the discard rectangles fails the discard test, and a fragment in none of them passes. ``False`` if a fragment in any one of the discard rectangles passes the discard test, and a fragment in none of them is discarded. -.. note: +.. note:: A ``True`` value and an empty list of :data:`discardRectangles` means the test is effectively disabled, since with no rectangles no fragment can be inside one. - )"); bool discardRectanglesExclusive = true; };