imagesetclip.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.imagesetclip" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>imagesetclip</refname>
  <refpurpose>Set the clipping rectangle</refpurpose>
 </refnamediv>

 <refsect1 role="description"><!-- {{{ -->
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>imagesetclip</methodname>
   <methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
   <methodparam><type>int</type><parameter>x1</parameter></methodparam>
   <methodparam><type>int</type><parameter>y1</parameter></methodparam>
   <methodparam><type>int</type><parameter>x2</parameter></methodparam>
   <methodparam><type>int</type><parameter>y2</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>imagesetclip</function> sets the current clipping rectangle, i.e.
   the area beyond which no pixels will be drawn.
  </para>
 </refsect1><!-- }}} -->

 <refsect1 role="parameters"><!-- {{{ -->
  &reftitle.parameters;
  <variablelist>
   &gd.image.description;
   <varlistentry>
    <term><parameter>x1</parameter></term>
    <listitem>
     <para>
      The x-coordinate of the upper left corner.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>y1</parameter></term>
    <listitem>
     <para>
      The y-coordinate of the upper left corner.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>x2</parameter></term>
    <listitem>
     <para>
      The x-coordinate of the lower right corner.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>y2</parameter></term>
    <listitem>
     <para>
      The y-coordinate of the lower right corner.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </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>
     &gd.changelog.image-param;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="seealso"><!-- {{{ -->
  &reftitle.seealso;
  <simplelist>
   <member><function>imagegetclip</function></member>
  </simplelist>
 </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
-->