php-doc-en/reference/pdf/functions/pdf-shading.xml

66 lines
2.7 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-shading">
<refnamediv>
<refname>pdf_shading</refname>
<refpurpose>Define blend</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pdf_shading</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>shtype</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>
Defines a blend from the current fill color to another color.
For axial shadings, (<parameter>x0</parameter>, <parameter>y0</parameter>)
and (<parameter>x1</parameter>, <parameter>y1</parameter>) are the
coordinates of the starting and ending points of the shading. For radial
shadings these points specify the centers of the starting and ending
circles. <parameter>c1</parameter>, <parameter>c2</parameter>,
<parameter>c3</parameter>, and <parameter>c4</parameter> are the color
values of the shading endpoint, interpreted in the current fill color
space in the same way as the color parameters in
<function>pdf_setcolor</function>.
</para>
<para>
This function returns a shading handle that can be used in subsequent calls to <function>pdf_shading_pattern</function> and <function>pdf_shfill</function>.
</para>
<para>
This function requires PDF 1.4 or above.
</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:"../../../../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
-->