php-doc-en/reference/ps/functions/ps-setcolor.xml
Jakub Vrana 63e12612a1 Optional parameters
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@189020 c90b9560-bf6c-de11-be94-00142212c4b1
2005-06-22 13:57:20 +00:00

134 lines
3.4 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 -->
<refentry id="function.ps-setcolor">
<refnamediv>
<refname>ps_setcolor</refname>
<refpurpose>Sets current color</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ps_setcolor</methodname>
<methodparam><type>resource</type><parameter>psdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>type</parameter></methodparam>
<methodparam><type>string</type><parameter>colorspace</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>
</methodsynopsis>
<para>
Sets the color for drawing, filling, or both.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>psdoc</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>type</parameter></term>
<listitem>
<para>
The parameter <parameter>type</parameter> can be
<literal>both</literal>, <literal>fill</literal>, or
<literal>fillstroke</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>colorspace</parameter></term>
<listitem>
<para>
The colorspace should be one of <literal>gray</literal>,
<literal>rgb</literal>, <literal>cmyk</literal>,
<literal>spot</literal>, <literal>pattern</literal>. Depending on the
colorspace either only the first, the first three or all parameters
will be used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>c1</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>c2</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>c3</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>c4</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1>
<title>Bugs</title>
<para>
The second parameter is currently not always evaluated. The color is
sometimes set for filling and drawing just as if
<literal>fillstroke</literal> where passed.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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
-->