[Intel-gfx] [PATCH v2 4/4] Documentation: drm: describing plane alpha and color blending property

[David Herrmann]

Hi

On Tue, Mar 25, 2014 at 3:32 PM,  <sagar.a.kamble at intel.com> wrote:
> From: Sagar Kamble <sagar.a.kamble at intel.com>
>
> v2: Added description for "src-color" and "constant-alpha" property.
>
> Cc: Rob Landley <rob at landley.net>
> Cc: Dave Airlie <airlied at redhat.com>
> Cc: Daniel Vetter <daniel.vetter at ffwll.ch>
> Cc: Laurent Pinchart <laurent.pinchart+renesas at ideasonboard.com>
> Cc: David Herrmann <dh.herrmann at gmail.com>
> Cc: Alex Deucher <alexander.deucher at amd.com>
> Cc: "Ville Syrjälä" <ville.syrjala at linux.intel.com>
> Cc: Sagar Kamble <sagar.a.kamble at intel.com>
> Cc: "Purushothaman, Vijay A" <vijay.a.purushothaman at intel.com>
> Cc: linux-doc at vger.kernel.org
> Cc: dri-devel at lists.freedesktop.org
> Signed-off-by: Sagar Kamble <sagar.a.kamble at intel.com>
> ---
>  Documentation/DocBook/drm.tmpl | 23 ++++++++++++++++++++++-
>  1 file changed, 22 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/DocBook/drm.tmpl b/Documentation/DocBook/drm.tmpl
> index 104402a..77a45fb 100644
> --- a/Documentation/DocBook/drm.tmpl
> +++ b/Documentation/DocBook/drm.tmpl
> @@ -2253,6 +2253,14 @@ void intel_crt_init(struct drm_device *dev)
>              enumerated bits defined by the property.</para></listitem>
>          </varlistentry>
>          <varlistentry>
> +          <term>DRM_MODE_PROP_32BIT_PAIR</term>
> +          <listitem><para>This flag restricts Bitmask properties restricts all
> +           enumerated values to the 0..31 range.
> +            During get operation instance values combine one or more of the
> +            enumerated bits defined by the property. During get user can specify
> +           {type, value} pair.</para></listitem>

Please rewrite that, lots of typos in there. Furthermore, if you use
verbs as nouns, you should emphasize them. So in your text, please
somehow emphasize/quote 'get'.

Thanks
David

> +        </varlistentry>
> +        <varlistentry>
>            <term>DRM_MODE_PROP_BLOB</term>
>            <listitem><para>Blob properties store a binary blob without any format
>              restriction. The binary blobs are created as KMS standalone objects,
> @@ -2336,7 +2344,7 @@ void intel_crt_init(struct drm_device *dev)
>         </tr>
>         <tr>
>         <td rowspan="19" valign="top" >DRM</td>
> -       <td rowspan="2" valign="top" >Generic</td>
> +       <td rowspan="3" valign="top" >Generic</td>
>         <td valign="top" >"EDID"</td>
>         <td valign="top" >BLOB | IMMUTABLE</td>
>         <td valign="top" >0</td>
> @@ -2351,6 +2359,19 @@ void intel_crt_init(struct drm_device *dev)
>         <td valign="top" >Contains DPMS operation mode value.</td>
>         </tr>
>         <tr>
> +       <td valign="top" >"blend"</td>
> +       <td valign="top" >BITMASK | 32BIT_PAIR</td>
> +       <td valign="top" >{ {0, "zero"}, {1, "one"}, {2, "src-color"}, {3, "one-minus-src-color"}
> +       , {4, "dst-color"}, {5, "one-minus-dst-color"}, {6, "src-alpha"}, {7, "one-minus-src-alpha"}, {8, "dst-alpha"}
> +       , {9, "one-minus-dst-alpha"}, {10, "constant-color"}, {11, "one-minus-constant-color"}, {12, "constant-alpha"}
> +       , {13, "one-minus-constant-alpha"}, {14, "alpha-saturate"} }</td>
> +       <td valign="top" >Plane</td>
> +       <td valign="top" >Contains plane alpha/color blending operation values. These are modeled after glBlendFunc API
> +       in OpenGL. Currently only "src-color" and "constant-alpha" are supported. <para>"src-color" will consider supplied fb
> +       with plane's pixel format as input without any additional color/alpha changes.</para><para>"constant-alpha" will apply constant
> +       transparency to all pixels in addition to source color.</para></td>
> +       </tr>
> +       <tr>
>         <td rowspan="2" valign="top" >DVI-I</td>
>         <td valign="top" >"subconnector"</td>
>         <td valign="top" >ENUM</td>
> --
> 1.8.5
>