cvs: phpdoc /en/functions pdf.xml

rasmus Wed May 23 23:01:59 2001 EDT Modified files: /phpdoc/en/functions pdf.xml Log: Add a bit of detail and fix a return type Index: phpdoc/en/functions/pdf.xml diff -u phpdoc/en/functions/pdf.xml:1.55 phpdoc/en/functions/pdf.xml:1.56 --- phpdoc/en/functions/pdf.xml:1.55 Wed May 23 12:11:02 2001 +++ phpdoc/en/functions/pdf.xml Wed May 23 23:01:59 2001 @@ -726,7 +726,7 @@ <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>void <function>pdf_begin_pattern</function></funcdef> + <funcdef>int <function>pdf_begin_pattern</function></funcdef> <paramdef>int <parameter>pdf object</parameter></paramdef> <paramdef>double <parameter>width</parameter></paramdef> <paramdef>double <parameter>height</parameter></paramdef> @@ -736,7 +736,13 @@ </funcprototype> </funcsynopsis> <para> - Start a new pattern definition. + Starts a new pattern definition and returns a pattern handle. + <parameter>width</parameter>, and <parameter>height</parameter> + define the bounding box for the pattern. <parameter>xstep</parameter> + and <parameter>ystep</parameter> give the repeated pattern offsets. + <parameter>painttype</parameter>=1 means that the pattern has its + own colour settings whereas a value of 2 indicates tha the current + colour is used when the pattern is applied. </para> </refsect1> </refentry> @@ -1970,9 +1976,9 @@ <paramdef>string <parameter>type</parameter></paramdef> <paramdef>string <parameter>colorspace</parameter></paramdef> <paramdef>double <parameter>c1</parameter></paramdef> - <paramdef>double <parameter>c2</parameter></paramdef> - <paramdef>double <parameter>c3</parameter></paramdef> - <paramdef>double <parameter>c4</parameter></paramdef> + <paramdef>double <parameter><optional>c2</optional></parameter></paramdef> + <paramdef>double <parameter><optional>c3</optional></parameter></paramdef> + <paramdef>double <parameter><optional>c4</optional></parameter></paramdef> </funcprototype> </funcsynopsis> <para> @@ -1987,7 +1993,20 @@ <parameter>c1</parameter>, <parameter>c2</parameter>, <parameter>c3</parameter> and <parameter>c4</parameter> represent the color components for the color space specified by - <parameter>colorspace</parameter>. + <parameter>colorspace</parameter>. For <literal>gray</literal> only + <parameter>c1</parameter> is used. For <literal>rgb</literal> parameters + <parameter>c1</parameter>, <parameter>c2</parameter>, and + <parameter>c3</parameter> specify the Red, Green amd Blue values + respectively. + For <literal>cmyk</literal> parameters <parameter>c1</parameter>, + <parameter>c2</parameter>, <parameter>c3</parameter>, and + <parameter>c4</parameter> specify the Cyan, Magenta, Yellow and + Black values respectively. + For <literal>spot</literal> <parameter>c1</parameter> specifies + a spot color handles returned by <function>pdf_makespotcolor</function> + and <parameter>c2</parameter> specifies a tint value between 0 and 1. + For <literal>pattern</literal> <parameter>c1</parameter> specifies + a pattern handle returned by <function>pdf_begin_pattern</function>. </para> </refsect1> </refentry> @@ -2008,7 +2027,8 @@ </funcprototype> </funcsynopsis> <para> - Set the current dash pattern to b black and w white units. + Set the current dash pattern to <parameter>b</parameter> black + and <parameter>w</parameter> white units. </para> </refsect1> </refentry>