Bug 4370: Update help page for 'alufunction', 'figure_properties' and create a page... 42/542/3
Pierre LANDO [Mon, 10 May 2010 11:59:13 +0000 (13:59 +0200)]
Change-Id: Id400403fa685adb49b8d630e7f159ba0a9e2643e

scilab/modules/graphics/help/en_US/alufunctions.xml
scilab/modules/graphics/help/en_US/figure_properties.xml
scilab/modules/graphics/help/en_US/pixel_drawing_mode.xml [new file with mode: 0644]
scilab/modules/graphics/help/fr_FR/alufunctions.xml

index 48c4424..4c5a661 100644 (file)
@@ -16,7 +16,7 @@
   </info>
   <refnamediv>
     <refname>alufunctions</refname>
-    <refpurpose>pixel drawing functions</refpurpose>
+    <refpurpose>pixel drawing functions. <emphasis role="bold">This function is obsolete.</emphasis></refpurpose>
   </refnamediv>
   <refsection>
     <title>Description</title>
index f98aa7f..e2087ec 100644 (file)
             <varlistentry>
               <term>pixel_drawing_mode: </term>
               <listitem>
-                <para>This field defines the bitwise operation used to draw the
-                 pixel on the screen. The default mode is <literal>copy</literal> what is
-                 to say the pixel is drawn as required. More generally the bitwise
-                 operation is performed between the color of the source pixel and
-                 the color of the pixel already present on the screen. Operations
-                 are : <literal>"clear"</literal>, <literal>"and"</literal>,
-                 <literal>"andReverse"</literal> , <literal>"copy"</literal>,
-                 <literal>"andInverted"</literal> , <literal>"noop"</literal> ,
-                 <literal>"xor"</literal> , <literal>"or"</literal> , <literal>"nor"</literal> ,
-                 <literal>"equiv"</literal> , <literal>"invert"</literal> ,
-                 <literal>"orReverse"</literal> , <literal>"copyInverted"</literal> ,
-                 <literal>"orInverted"</literal> , <literal>"nand"</literal> ,
-                 <literal>"set"</literal> ,</para>
+                <para>This field specifies the bitwise operation used for pixel rendering.
+                      The default mode is <literal>copy</literal>.
+                      For more details see the <link linkend="pixel_drawing_mode">pixel drawing mode reference page</link>.
+                </para>
               </listitem>
             </varlistentry>
            <varlistentry>
diff --git a/scilab/modules/graphics/help/en_US/pixel_drawing_mode.xml b/scilab/modules/graphics/help/en_US/pixel_drawing_mode.xml
new file mode 100644 (file)
index 0000000..3e1f0af
--- /dev/null
@@ -0,0 +1,125 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2010 - DIGITEO - Pierre Lando <pierre.lando@scilab.org>
+ * 
+ * This file must be used under the terms of the CeCILL.
+ * This source file is licensed as described in the file COPYING, which
+ * you should have received as part of this distribution.  The terms
+ * are also available at    
+ * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
+ *
+ -->
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="pixel_drawing_mode">
+  <info>
+    <pubdate>$LastChangedDate$</pubdate>
+  </info>
+  <refnamediv>
+    <refname>pixel_drawing_mode</refname>
+    <refpurpose>bitwise pixel rendering functions.</refpurpose>
+  </refnamediv>
+  <refsection>
+    <title>Description</title>
+    <para>      
+      Here, the color encoding is RGB.
+      The pixel drawing mode is a <link linkend="figure_properties">figure property</link> that
+      specifies a bitwise operation applied on any figure pixel between the incoming color and the already existing color on the figure.
+      The result of this operation will be the new pixel color.
+
+
+      <literal>src</literal> is the incoming color of the pixel.
+      <literal>prv</literal> is the previus color of the pixel (which is already drawn).
+      <literal>res</literal> is the resulting color of the pixel (which will be drawn).
+
+      Possible values for <literal>pixel_drawing_mode</literal> are:
+    </para>
+    
+    <informaltable border="1">
+        <tr>
+            <td>value</td>
+            <td>bitwise operation</td>
+            <td>comments</td>
+        </tr>
+        <tr>
+            <td>0</td>
+            <td>CLEAR</td>
+            <td>Result color is black</td>
+        </tr>
+        <tr>
+            <td>1</td>
+            <td>AND</td>
+            <td>res = src AND prv</td>
+        </tr>
+        <tr>
+            <td>2</td>
+            <td>AND REVERSE</td>
+            <td>res = src AND (NOT prv)</td>
+        </tr>
+        <tr>
+            <td>3</td>
+            <td>COPY</td>
+            <td>res = src, default value</td>
+        </tr>
+        <tr>
+            <td>4</td>
+            <td>AND INVERTED</td>
+            <td>res = (NOT src) AND prv</td>
+        </tr>
+        <tr>
+            <td>5</td>
+            <td>NOOP</td>
+            <td>res = prv</td>
+        </tr>
+        <tr>
+            <td>6</td>
+            <td>XOR</td>
+            <td>res = src XOR prv</td>
+        </tr>
+        <tr>
+            <td>7</td>
+            <td>OR</td>
+            <td>res = src OR prv</td>
+        </tr>
+        <tr>
+            <td>8</td>
+            <td>NOR</td>
+            <td>res = NOT (src OR prv)</td>
+        </tr>
+        <tr>
+            <td>9</td>
+            <td>EQUIV</td>
+            <td>res = (NOT src) XOR prv</td>
+        </tr>
+        <tr>
+            <td>10</td>
+            <td>INVERT</td>
+            <td>res = NOT prv</td>
+        </tr>
+        <tr>
+            <td>11</td>
+            <td>OR REVERSE</td>
+            <td>res = src OR (NOT prv)</td>
+        </tr>
+        <tr>
+            <td>12</td>
+            <td>COPY INVERTED</td>
+            <td>res = NOT src</td>
+        </tr>
+        <tr>
+            <td>13</td>
+            <td>OR INVERTED</td>
+            <td>res = (NOT src) OR prv</td>
+        </tr>
+        <tr>
+            <td>14</td>
+            <td>NAND</td>
+            <td>res = NOT (src AND prv)</td>
+        </tr>
+        <tr>
+            <td>15</td>
+            <td>SET</td>
+            <td>Result color is white</td>
+        </tr>
+    </informaltable>
+  </refsection>
+</refentry>
index d6c79d7..49b27a7 100644 (file)
@@ -5,7 +5,7 @@
   </info>
   <refnamediv>
     <refname>alufunctions</refname>
-    <refpurpose> description des modes de dessin des pixels.  </refpurpose>
+    <refpurpose> description des modes de dessin des pixels. <emphasis role="bold">Fonction obsol├Ęte.</emphasis></refpurpose>
   </refnamediv>
   <refsection>
     <title>Description</title>