imagecopymergegray.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e50e79746736dbdfbabe9bd3566793b3ddf38f58 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka -->
<refentry xml:id="function.imagecopymergegray" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imagecopymergegray</refname>
  <refpurpose>グレースケールでイメージの一部をコピー、マージする</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>imagecopymergegray</methodname>
   <methodparam><type>GdImage</type><parameter>dst_image</parameter></methodparam>
   <methodparam><type>GdImage</type><parameter>src_image</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_width</parameter></methodparam>
   <methodparam><type>int</type><parameter>src_height</parameter></methodparam>
   <methodparam><type>int</type><parameter>pct</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>imagecopymergegray</function> は、
   <parameter>src_image</parameter> の X,Y座標
   <parameter>src_x</parameter>, <parameter>src_y</parameter> から
   始まる幅 <parameter>src_width</parameter>、高さ
   <parameter>src_height</parameter> の領域を
   <parameter>dst_image</parameter> にコピーします。
   定義された部分は、x、y座標<parameter>dst_x</parameter>、
   <parameter>dst_y</parameter>にコピーされます。
  </para>
  <para>
   この関数は <function>imagecopymerge</function> と同じですが、マー
   ジをする際に、コピー前にコピー先のピクセルをグレースケールに変換
   することにより、コピー先のピクセルをコピー元の色相を維持するとこ
   ろが異なります。
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>dst_image</parameter></term>
     <listitem>
      <para>&gd.image.destination;</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>src_image</parameter></term>
     <listitem>
      <para>&gd.image.source;</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>dst_x</parameter></term>
     <listitem>
      <para>
       コピー先の x 座標。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>dst_y</parameter></term>
     <listitem>
      <para>
       コピー先の y 座標。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>src_x</parameter></term>
     <listitem>
      <para>
       コピー元の x 座標。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>src_y</parameter></term>
     <listitem>
      <para>
       コピー元の y 座標。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>src_width</parameter></term>
     <listitem>
      <para>&gd.source.width;</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>src_height</parameter></term>
     <listitem>
      <para>&gd.source.height;</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>pct</parameter></term>
     <listitem>
      <para>
        <parameter>src_image</parameter> が <parameter>pct</parameter>
        にしたがってグレースケールに変換されます。
        <parameter>pct</parameter> が 0 の場合は完全なグレースケール、
        100 の場合は何も変わらない状態となります。
        <parameter>pct</parameter> = 100 の場合、パレット画像に対してはこの関数は
        <function>imagecopy</function> と同じ動作となります
        (アルファコンポーネントを無視する点だけが違います)。
        一方 true color 画像については、この関数はアルファ透過度を実装しています。
      </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>dst_image</parameter> と
       <parameter>src_image</parameter> は、
       <classname>GdImage</classname>
       クラスのインスタンスを期待するようになりました。
       これより前のバージョンでは、
       <type>resource</type> を期待していました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>imagecopymergegray</function> の使用法</title>
    <programlisting role="php">
<![CDATA[
<?php
// 画像のインスタンスを作成します
$dest = imagecreatefromgif('php.gif');
$src = imagecreatefromgif('php.gif');

// コピー・マージ (Gray = 20%) します
imagecopymergegray($dest, $src, 10, 10, 0, 0, 100, 47, 20);

// 出力してメモリから解放します
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
-->