<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.ps.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'function.ps-setcolor.php',
    1 => 'ps_setcolor',
    2 => 'Sets current color',
  ),
  'up' => 
  array (
    0 => 'ref.ps.php',
    1 => 'PS Functions',
  ),
  'prev' => 
  array (
    0 => 'function.ps-set-value.php',
    1 => 'ps_set_value',
  ),
  'next' => 
  array (
    0 => 'function.ps-setdash.php',
    1 => 'ps_setdash',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/ps/functions/ps-setcolor.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.ps-setcolor" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">ps_setcolor</h1>
  <p class="verinfo">(PECL ps &gt;= 1.1.0)</p><p class="refpurpose"><span class="refname">ps_setcolor</span> &mdash; <span class="dc-title">Sets current color</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.ps-setcolor-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>ps_setcolor</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter">$psdoc</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$type</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$colorspace</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.float.php" class="type float">float</a></span> <code class="parameter">$c1</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.float.php" class="type float">float</a></span> <code class="parameter">$c2</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.float.php" class="type float">float</a></span> <code class="parameter">$c3</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.float.php" class="type float">float</a></span> <code class="parameter">$c4</code></span><br>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="para rdfs-comment">
   Sets the color for drawing, filling, or both.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.ps-setcolor-parameters">
  <h3 class="title">Parameters</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">psdoc</code></dt>
     <dd>
      <p class="para">
       Resource identifier of the postscript file
       as returned by <span class="function"><a href="function.ps-new.php" class="function">ps_new()</a></span>.
      </p>
     </dd>
    
    
     <dt><code class="parameter">type</code></dt>
     <dd>
      <p class="para">
       The parameter <code class="parameter">type</code> can be 
       <code class="literal">both</code>, <code class="literal">fill</code>, or
       <code class="literal">fillstroke</code>.
      </p>
     </dd>
    
    
     <dt><code class="parameter">colorspace</code></dt>
     <dd>
      <p class="para">
       The colorspace should be one of <code class="literal">gray</code>,
       <code class="literal">rgb</code>, <code class="literal">cmyk</code>, 
       <code class="literal">spot</code>, <code class="literal">pattern</code>. Depending on the
       colorspace either only the first, the first three or all parameters
       will be used.
      </p>
     </dd>
    
    
     <dt><code class="parameter">c1</code></dt>
     <dd>
      <p class="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.
      </p>
     </dd>
    
    
     <dt><code class="parameter">c2</code></dt>
     <dd>
      <p class="para">
       Depending on the colorspace this is either the green component (rgb),
       the magenta component (cmyk).
      </p>
     </dd>
    
    
     <dt><code class="parameter">c3</code></dt>
     <dd>
      <p class="para">
       Depending on the colorspace this is either the blue component (rgb),
       the yellow component (cmyk).
      </p>
     </dd>
    
    
     <dt><code class="parameter">c4</code></dt>
     <dd>
      <p class="para">
       This must only be set in cmyk colorspace and specifies the black
       component.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.ps-setcolor-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="para">
   Returns <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> on failure.
  </p>
 </div>


 <div class="refsect1 notes" id="refsect1-function.ps-setcolor-notes">
  <h3 class="title">Notes</h3>
  <div class="caution"><strong class="caution">Caution</strong>
   <p class="para">
    The second parameter is currently not always evaluated. The color is
    sometimes set for filling and drawing just as if
    <code class="literal">fillstroke</code> were passed.
   </p>
  </div>
 </div>

</div><?php manual_footer($setup); ?>