ps-shading.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 -->
<refentry xml:id="function.ps-shading" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ps_shading</refname>
  <refpurpose>Creates a shading for later use</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>int</type><type>false</type></type><methodname>ps_shading</methodname>
   <methodparam><type>resource</type><parameter>psdoc</parameter></methodparam>
   <methodparam><type>string</type><parameter>type</parameter></methodparam>
   <methodparam><type>float</type><parameter>x0</parameter></methodparam>
   <methodparam><type>float</type><parameter>y0</parameter></methodparam>
   <methodparam><type>float</type><parameter>x1</parameter></methodparam>
   <methodparam><type>float</type><parameter>y1</parameter></methodparam>
   <methodparam><type>float</type><parameter>c1</parameter></methodparam>
   <methodparam><type>float</type><parameter>c2</parameter></methodparam>
   <methodparam><type>float</type><parameter>c3</parameter></methodparam>
   <methodparam><type>float</type><parameter>c4</parameter></methodparam>
   <methodparam><type>string</type><parameter>optlist</parameter></methodparam>
  </methodsynopsis>
  <para>
   Creates a shading, which can be used by <function>ps_shfill</function> or
   <function>ps_shading_pattern</function>.
  </para>
  <para>
   The color of the shading can be in any color space except for
   <literal>pattern</literal>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>psdoc</parameter></term>
     <listitem>
      <para>
       Resource identifier of the postscript file
       as returned by <function>ps_new</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>type</parameter></term>
     <listitem>
      <para>
       The type of shading can be either <literal>radial</literal> or
       <literal>axial</literal>. 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).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>x0, x1, y0, y1</parameter></term>
     <listitem>
      <para>
       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 type of shading is
       <literal>radial</literal> the two points are the middle points of
       a starting and ending circle.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>c1, c2, c3, c4</parameter></term>
     <listitem>
      <para>
       See <function>ps_setcolor</function> for their meaning.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>optlist</parameter></term>
     <listitem>
      <para>
       If the shading is of type <literal>radial</literal> the
       <parameter>optlist</parameter> must also contain the parameters
       <literal>r0</literal> and <literal>r1</literal> with the radius of the
       start and end circle.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the identifier of the pattern &return.falseforfailure;.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ps_shading_pattern</function></member>
    <member><function>ps_shfill</function></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->