php-doc-en/reference/imagick/imagick/clippathimage.xml
2012-01-12 05:08:38 +00:00

84 lines
2.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="imagick.clippathimage">
<refnamediv>
<refname>Imagick::clipPathImage</refname>
<refpurpose>Clips along the named paths from the 8BIM profile</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>Imagick::clipPathImage</methodname>
<methodparam><type>string</type><parameter>pathname</parameter></methodparam>
<methodparam><type>bool</type><parameter>inside</parameter></methodparam>
</methodsynopsis>
<para>
Clips along the named paths from the 8BIM profile, if
present. Later operations take effect inside the path.
It may be a number if preceded with #, to work on a
numbered path, e.g., "#1" to use the first path.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>pathname</parameter></term>
<listitem>
<para>
The name of the path
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>inside</parameter></term>
<listitem>
<para>
If &true; later operations take effect inside clipping path.
Otherwise later operations take effect outside clipping path.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&imagick.return.success;
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
&imagick.imagick.throws;
</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
-->