gallium/docs: clarify render_condition_enabled parameter to clear functions
authorBrian Paul <brianp@vmware.com>
Wed, 31 Aug 2016 16:03:53 +0000 (10:03 -0600)
committerBrian Paul <brianp@vmware.com>
Wed, 31 Aug 2016 21:51:06 +0000 (15:51 -0600)
If false, it means do the clear unconditionally.

Reviewed-by: Marek Olšák <marek.olsak@amd.com>
src/gallium/docs/source/context.rst

index 1b045fa6ec07d12707b734a9f3c3ffc6d988f45c..13dd606173e6b1cf146135aa3c57c42679705960 100644 (file)
@@ -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