Mesa (master): gallium/docs: clarify render_condition_enabled parameter to clear functions

Brian Paul brianp at kemper.freedesktop.org
Wed Aug 31 21:50:35 UTC 2016


Module: Mesa
Branch: master
Commit: c87e8c851526123aa5edb09b20fa50e02d4398f5
URL:    http://cgit.freedesktop.org/mesa/mesa/commit/?id=c87e8c851526123aa5edb09b20fa50e02d4398f5

Author: Brian Paul <brianp at vmware.com>
Date:   Wed Aug 31 10:03:53 2016 -0600

gallium/docs: clarify render_condition_enabled parameter to clear functions

If false, it means do the clear unconditionally.

Reviewed-by: Marek Olšák <marek.olsak at amd.com>

---

 src/gallium/docs/source/context.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/gallium/docs/source/context.rst b/src/gallium/docs/source/context.rst
index 1b045fa..13dd606 100644
--- a/src/gallium/docs/source/context.rst
+++ b/src/gallium/docs/source/context.rst
@@ -231,12 +231,16 @@ If a surface includes several layers then all layers will be cleared.
 ``clear_render_target`` clears a single color rendertarget with the specified
 color value. While it is only possible to clear one surface at a time (which can
 include several layers), this surface need not be bound to the framebuffer.
+If render_condition_enabled is false, any current rendering condition is ignored
+and the clear will be unconditional.
 
 ``clear_depth_stencil`` clears a single depth, stencil or depth/stencil surface
 with the specified depth and stencil values (for combined depth/stencil buffers,
 it is also possible to only clear one or the other part). While it is only
 possible to clear one surface at a time (which can include several layers),
 this surface need not be bound to the framebuffer.
+If render_condition_enabled is false, any current rendering condition is ignored
+and the clear will be unconditional.
 
 ``clear_texture`` clears a non-PIPE_BUFFER resource's specified level
 and bounding box with a clear value provided in that resource's native




More information about the mesa-commit mailing list