diff options
| author | Brian Paul <[email protected]> | 2016-08-31 10:03:53 -0600 |
|---|---|---|
| committer | Brian Paul <[email protected]> | 2016-08-31 15:51:06 -0600 |
| commit | c87e8c851526123aa5edb09b20fa50e02d4398f5 (patch) | |
| tree | f909a5b5566c41873b8f996f69960642dbe77386 /src/gallium | |
| parent | b8bff0823b0ec1986bf7ab6fab6150fd6fbf7853 (diff) | |
gallium/docs: clarify render_condition_enabled parameter to clear functions
If false, it means do the clear unconditionally.
Reviewed-by: Marek Olšák <[email protected]>
Diffstat (limited to 'src/gallium')
| -rw-r--r-- | src/gallium/docs/source/context.rst | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/src/gallium/docs/source/context.rst b/src/gallium/docs/source/context.rst index 1b045fa6ec0..13dd606173e 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 |