php-doc-en/reference/image/functions/imagecopymerge.xml
Peter Cowburn 8432279c30 more detail for imagecopymerge/imagecopymergegray
--
Provided by anonymous #20490 (ajf@ajf.me)

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@328331 c90b9560-bf6c-de11-be94-00142212c4b1
2012-11-12 22:33:52 +00:00

162 lines
4.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.imagecopymerge" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imagecopymerge</refname>
<refpurpose>Copy and merge part of an image</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imagecopymerge</methodname>
<methodparam><type>resource</type><parameter>dst_im</parameter></methodparam>
<methodparam><type>resource</type><parameter>src_im</parameter></methodparam>
<methodparam><type>int</type><parameter>dst_x</parameter></methodparam>
<methodparam><type>int</type><parameter>dst_y</parameter></methodparam>
<methodparam><type>int</type><parameter>src_x</parameter></methodparam>
<methodparam><type>int</type><parameter>src_y</parameter></methodparam>
<methodparam><type>int</type><parameter>src_w</parameter></methodparam>
<methodparam><type>int</type><parameter>src_h</parameter></methodparam>
<methodparam><type>int</type><parameter>pct</parameter></methodparam>
</methodsynopsis>
<para>
Copy a part of <parameter>src_im</parameter> onto
<parameter>dst_im</parameter> starting at the x,y coordinates
<parameter>src_x</parameter>, <parameter>src_y </parameter> with
a width of <parameter>src_w</parameter> and a height of
<parameter>src_h</parameter>. The portion defined will be copied
onto the x,y coordinates, <parameter>dst_x</parameter> and
<parameter>dst_y</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>dst_im</parameter></term>
<listitem>
<para>&gd.image.destination;</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>src_im</parameter></term>
<listitem>
<para>&gd.image.source;</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>dst_x</parameter></term>
<listitem>
<para>
x-coordinate of destination point.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>dst_y</parameter></term>
<listitem>
<para>
y-coordinate of destination point.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>src_x</parameter></term>
<listitem>
<para>
x-coordinate of source point.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>src_y</parameter></term>
<listitem>
<para>
y-coordinate of source point.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>src_w</parameter></term>
<listitem>
<para>&gd.source.width;</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>src_h</parameter></term>
<listitem>
<para>&gd.source.height;</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pct</parameter></term>
<listitem>
<para>
The two images will be merged according to <parameter>pct</parameter>
which can range from 0 to 100. When <parameter>pct</parameter> = 0,
no action is taken, when 100 this function behaves identically
to <function>imagecopy</function> for pallete images, except for
ignoring alpha components, while it implements alpha transparency
for true colour images.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Merging two copies of the PHP.net logo with 75% transparency</title>
<programlisting role="php">
<![CDATA[
<?php
// Create image instances
$dest = imagecreatefromgif('php.gif');
$src = imagecreatefromgif('php.gif');
// Copy and merge
imagecopymerge($dest, $src, 10, 10, 0, 0, 100, 47, 75);
// Output and free from memory
header('Content-Type: image/gif');
imagegif($dest);
imagedestroy($dest);
imagedestroy($src);
?>
]]>
</programlisting>
</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
-->