steinm Tue Jul 27 13:22:51 2004 EDT
Modified files:
/peardoc/en/pecl ps.xml
Log:
- added documentation for ps_shading(), ps_shading_pattern(), and
ps_shfill()
http://cvs.php.net/diff.php/peardoc/en/pecl/ps.xml?r1=1.11&r2=1.12&ty=u
Index: peardoc/en/pecl/ps.xml
diff -u peardoc/en/pecl/ps.xml:1.11 peardoc/en/pecl/ps.xml:1.12
--- peardoc/en/pecl/ps.xml:1.11 Wed Jun 16 11:51:27 2004
+++ peardoc/en/pecl/ps.xml Tue Jul 27 13:22:51 2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.11 $ -->
+<!-- $Revision: 1.12 $ -->
<!-- Author: Uwe Steinmann <[EMAIL PROTECTED]> -->
<reference id="pecl.ps">
<title>PostScript document creation</title>
@@ -515,7 +515,7 @@
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>bool <function>ps_begin_pattern</function></funcdef>
+ <funcdef>int <function>ps_begin_pattern</function></funcdef>
<paramdef>resource <parameter>psdoc</parameter></paramdef>
<paramdef>float <parameter>width</parameter></paramdef>
<paramdef>float <parameter>height</parameter></paramdef>
@@ -531,9 +531,17 @@
</refsect1>
<refsect1>
+ <title>Return value</title>
+
+ <para>The identifier of the pattern or false in case of an error.</para>
+
+ </refsect1>
+ <refsect1>
<title>See also</title>
- <para><function>ps_end_pattern</function>, <function>ps_setcolor</function></para>
+ <para><function>ps_end_pattern</function>,
+ <function>ps_setcolor</function>,
+ <function>ps_shading_pattern</function></para>
</refsect1>
</refentry>
@@ -2138,6 +2146,130 @@
<title>See also</title>
<para><function>ps_get_value</function>,
<function>ps_set_parameter</function></para>
+
+ </refsect1>
+</refentry>
+
+<refentry id="pecl.ps.ps-shading">
+ <refnamediv>
+ <refname>ps_shading</refname>
+
+ <refpurpose>Creates a shading for later use</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>int <function>ps_shading</function></funcdef>
+ <paramdef>resource <parameter>psdoc</parameter></paramdef>
+ <paramdef>string <parameter>type</parameter></paramdef>
+ <paramdef>float <parameter>x0</parameter></paramdef>
+ <paramdef>float <parameter>y0</parameter></paramdef>
+ <paramdef>float <parameter>x1</parameter></paramdef>
+ <paramdef>float <parameter>y1</parameter></paramdef>
+ <paramdef>float <parameter>c1</parameter></paramdef>
+ <paramdef>float <parameter>c2</parameter></paramdef>
+ <paramdef>float <parameter>c3</parameter></paramdef>
+ <paramdef>float <parameter>c4</parameter></paramdef>
+ <paramdef>string <parameter>optlist</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+
+ <para>Creates a shading, which can be used by
+ <function>ps_shfill</function> or
+ <function>ps_shading_pattern</function>. The type of shading
+ can be either `radial' or `axial'. Each shading starts with
+ the current fill color and ends with the given color values
+ passed in the parameters <parameter>c1</parameter> to
+ <parameter>c4</parameter> (see <function>ps_setcolor</function> for
+ their meaning). The coordinates <parameter>x0</parameter>,
+ <parameter>y0</parameter>, <parameter>x1</parameter>,
+ <parameter>y1</parameter> are the start and end point of the shading. If
+ the shading is of type `radial' the option list must also contain the
+ parameters r0 and r1 with the radius of the start and end circle.</para>
+ <para>The color of the shading can be in any color space except for
+ `pattern'.</para>
+ </refsect1>
+
+ <refsect1>
+ <title>Return value</title>
+ <para>Returns the identifier of the pattern or false in case of an
+ error.</para>
+ </refsect1>
+
+ <refsect1>
+ <title>See also</title>
+
+ <para><function>ps_shfill</function>,
+ <function>ps_shading_pattern</function></para>
+
+ </refsect1>
+</refentry>
+
+<refentry id="pecl.ps.ps-shading-pattern">
+ <refnamediv>
+ <refname>ps_shading_pattern</refname>
+
+ <refpurpose>Creates a pattern based on a shading</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>bool <function>ps_shading_pattern</function></funcdef>
+ <paramdef>resource <parameter>psdoc</parameter></paramdef>
+ <paramdef>int <parameter>shadingid</parameter></paramdef>
+ <paramdef>string <parameter>optlist</parameter></paramdef>
+
+ </funcprototype>
+ </funcsynopsis>
+
+ <para>Creates a pattern based on a shading, which has to be created
+ before with <function>ps_shading</function>. Shading patterns can be
+ used like regular patterns.</para>
+
+ </refsect1>
+ <refsect1>
+ <title>Return value</title>
+
+ <para>The identifier of the pattern or false in case of an error.</para>
+
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+
+ <para><function>ps_shading</function>,
+ <function>ps_shfill</function></para>
+
+ </refsect1>
+</refentry>
+
+<refentry id="pecl.ps.ps-shfill">
+ <refnamediv>
+ <refname>ps_shfill</refname>
+
+ <refpurpose>Fills an area with a shading</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>bool <function>ps_shfill</function></funcdef>
+ <paramdef>resource <parameter>psdoc</parameter></paramdef>
+ <paramdef>int <parameter>shadingid</parameter></paramdef>
+
+ </funcprototype>
+ </funcsynopsis>
+
+ <para>Fills an area with a shading, which has to be created before with
+ <function>ps_shading</function>.</para>
+
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+
+ <para><function>ps_shading</function>,
+ <function>ps_shading_pattern</function></para>
</refsect1>
</refentry>
