2007-06-05 02:41:01 +00:00
<?xml version="1.0" encoding="iso-8859-1"?>
2007-11-01 16:40:42 +00:00
<!-- $Revision: 1.5 $ -->
2007-06-20 22:25:43 +00:00
<refentry xmlns= "http://docbook.org/ns/docbook" xml:id= "function.imagickdraw-pushpattern" >
2007-06-05 02:41:01 +00:00
<refnamediv >
<refname > ImagickDraw::pushPattern</refname>
<refpurpose > Indicates that subsequent commands up to a ImagickDraw::opPattern() command comprise the definition of a named pattern</refpurpose>
</refnamediv>
<refsect1 role= "description" >
&reftitle.description;
<methodsynopsis >
<type > bool</type> <methodname > ImagickDraw::pushPattern</methodname>
<methodparam > <type > string</type> <parameter > pattern_id</parameter> </methodparam>
<methodparam > <type > float</type> <parameter > x</parameter> </methodparam>
<methodparam > <type > float</type> <parameter > y</parameter> </methodparam>
<methodparam > <type > float</type> <parameter > width</parameter> </methodparam>
<methodparam > <type > float</type> <parameter > height</parameter> </methodparam>
</methodsynopsis>
&warn.undocumented.func;
2007-06-14 06:13:42 +00:00
&warn.experimental.func;
2007-06-05 02:41:01 +00:00
<para >
Indicates that subsequent commands up to a DrawPopPattern() command comprise the definition of a named pattern. The pattern space is assigned top left corner coordinates, a width and height, and becomes its own drawing space. Anything which can be drawn may be used in a pattern definition. Named patterns may be used as stroke or brush definitions.
</para>
</refsect1>
<refsect1 role= "parameters" >
&reftitle.parameters;
<para >
<variablelist >
<varlistentry >
<term > <parameter > pattern_id</parameter> </term>
<listitem >
<para >
the pattern Id
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <parameter > x</parameter> </term>
<listitem >
<para >
2007-11-01 16:40:42 +00:00
x coordinate of the top-left corner
2007-06-05 02:41:01 +00:00
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <parameter > y</parameter> </term>
<listitem >
<para >
y coordinate of the top-left corner
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <parameter > width</parameter> </term>
<listitem >
<para >
width of the pattern
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <parameter > height</parameter> </term>
<listitem >
<para >
height of the pattern
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role= "returnvalues" >
&reftitle.returnvalues;
<para >
Returns true on success and false on failure.
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role= "errors" >
&reftitle.errors;
<para >
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role= "changelog" >
&reftitle.changelog;
<para >
<informaltable >
<tgroup cols= "2" >
<thead >
<row >
<entry > &Version; </entry>
<entry > &Description; </entry>
</row>
</thead>
<tbody >
<row >
<entry > Enter the PHP version of change here</entry>
<entry > Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role= "examples" >
&reftitle.examples;
<para >
<example >
<title > A <function > ImagickDraw::pushPattern</function> example</title>
<para >
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example > tag, not out
</para>
<programlisting role= "php" >
< ![CDATA[
< ?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen >
< ![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role= "seealso" >
&reftitle.seealso;
<para >
<simplelist >
<member > <function > </function> </member>
<member > Or <link linkend= "somethingelse" > something else</link> </member>
</simplelist>
</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:"../../../../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
-->