<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.imagesetbrush" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imagesetbrush</refname>
  <refpurpose>Set the brush image for line drawing</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>imagesetbrush</methodname>
   <methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
   <methodparam><type>GdImage</type><parameter>brush</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>imagesetbrush</function> sets the brush image to be
   used by all line drawing functions (such as <function>imageline</function>
   and <function>imagepolygon</function>) when drawing with the special
   colors <constant>IMG_COLOR_BRUSHED</constant> or
   <constant>IMG_COLOR_STYLEDBRUSHED</constant>.
  </para>
  <caution>
   <para>
    You need not take special action when you are finished with a brush, but
    if you destroy the brush image (or let PHP destroy it), you must not use the 
    <constant>IMG_COLOR_BRUSHED</constant> or
    <constant>IMG_COLOR_STYLEDBRUSHED</constant> colors until you have set a
    new brush image!
   </para>
  </caution>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &gd.image.description;
    <varlistentry>
     <term><parameter>brush</parameter></term>
     <listitem>
      <para>
       An image object.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>image</parameter> and <parameter>brush</parameter> expect
       <classname>GdImage</classname> instances now; previously, <type>resource</type>s
       were expected.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>imagesetbrush</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
// Load a mini php logo
$php = imagecreatefrompng('./php.png');

// Create the main image, 100x100
$im = imagecreatetruecolor(100, 100);

// Fill the background with white
$white = imagecolorallocate($im, 255, 255, 255);
imagefilledrectangle($im, 0, 0, 299, 99, $white);

// Set the brush
imagesetbrush($im, $php);

// Draw a couple of brushes, each overlaying each
imageline($im, 50, 50, 50, 60, IMG_COLOR_BRUSHED);

// Output image to the browser
header('Content-type: image/png');

imagepng($im);
imagedestroy($im);
imagedestroy($php);
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <mediaobject>
     <alt>Output of example : imagesetbrush()</alt>
     <imageobject>
      <imagedata fileref="en/reference/image/figures/imagesetbrush.png"/>
     </imageobject>
    </mediaobject>
   </example>
  </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
-->
