1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 -->
<refentry xml:id="function.ps-setcolor" xmlns="http://docbook.org/ns/docbook">
<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>
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 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>
Depending on the colorspace this is either the red component (rgb),
the cyan component (cmyk), the gray value (gray), the identifier of
the spot color or the identifier of the pattern.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>c2</parameter></term>
<listitem>
<para>
Depending on the colorspace this is either the green component (rgb),
the magenta component (cmyk).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>c3</parameter></term>
<listitem>
<para>
Depending on the colorspace this is either the blue component (rgb),
the yellow component (cmyk).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>c4</parameter></term>
<listitem>
<para>
This must only be set in cmyk colorspace and specifies the black
component.
</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> were 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:"~/.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
-->
|