gallium/docs: document alpha_to_coverage and alpha_to_one blend state
authorBrian Paul <brianp@vmware.com>
Thu, 15 Sep 2016 21:32:59 +0000 (15:32 -0600)
committerBrian Paul <brianp@vmware.com>
Fri, 16 Sep 2016 14:44:26 +0000 (08:44 -0600)
The gallium interface defines these like DX10.  Note that OpenGL ignores
these options if MSAA is disabled or the dest buffer doesn't support
MSAA.

Reviewed-by: Roland Scheidegger <sroland@vmware.com>
src/gallium/docs/source/cso/blend.rst

index dce999c8327975c0f1aa328cafbce83d85bb25cc..7316e5c71cf66a90204d8e014b832cb1775bbce8 100644 (file)
@@ -88,6 +88,18 @@ independent_blend_enable
    the first member of the rt array contains valid data.
 rt
    Contains the per-rendertarget blend state.
+alpha_to_coverage
+   If enabled, the fragment's alpha value is used to override the fragment's
+   coverage mask.  The coverage mask will be all zeros if the alpha value is
+   zero.  The coverage mask will be all ones if the alpha value is one.
+   Otherwise, the number of bits set in the coverage mask will be proportional
+   to the alpha value.  Note that this step happens regardless of whether
+   multisample is enabled or the destination buffer is multisampled.
+alpha_to_one
+   If enabled, the fragment's alpha value will be set to one.  As with
+   alpha_to_coverage, this step happens regardless of whether multisample
+   is enabled or the destination buffer is multisampled.
+
 
 Per-rendertarget Members
 ------------------------