Add a bit of detail and fix a return type

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@48352 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Rasmus Lerdorf 2001-05-24 06:01:59 +00:00
parent b4d1138fb2
commit 3c83cdea54

View file

@ -726,7 +726,7 @@ pdf_delete($pdf);
<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 @@ pdf_delete($pdf);
</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 @@ pdf_close_image($pdf, $pim);
<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 @@ pdf_close_image($pdf, $pim);
<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 @@ pdf_close_image($pdf, $pim);
</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>