imagescale.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: ccd3e68e1e8a89a099a32207dd31ed26b70f43cd Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->

<refentry xml:id="function.imagescale" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>imagescale</refname>
  <refpurpose>幅と高さを指定して、画像の縮尺を変更する</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>GdImage</type><type>false</type></type><methodname>imagescale</methodname>
   <methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
   <methodparam><type>int</type><parameter>width</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>height</parameter><initializer>-1</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer><constant>IMG_BILINEAR_FIXED</constant></initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>imagescale</function> は、指定した補間アルゴリズムを使って画像の縮尺を変更します。
  </para>
  <note>
   <para>
    他の画像処理関数と異なり、
    <function>imagescale</function> 関数は渡された
    <parameter>image</parameter> を変更しません。
    代わりに <emphasis>新しい</emphasis> 画像が返されます。
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   &gd.image.description;
   <varlistentry>
    <term><parameter>width</parameter></term>
    <listitem>
     <para>
      変更後の画像の幅。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>height</parameter></term>
    <listitem>
     <para>
      変更後の画像の高さ。省略したり負の数を指定したりした場合は、元の画像のアスペクト比を維持します。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>mode</parameter></term>
    <listitem>
     <para>
      <constant>IMG_NEAREST_NEIGHBOUR</constant>、
      <constant>IMG_BILINEAR_FIXED</constant>、
      <constant>IMG_BICUBIC</constant>、
      <constant>IMG_BICUBIC_FIXED</constant> あるいはそれ以外 (2 パスで使います)
      のいずれか。
      <note>
       <simpara>
        <constant>IMG_WEIGHTED4</constant> にはまだ対応していません。
       </simpara>
      </note>
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   成功した場合に、縮尺を変更した画像オブジェクトを返します。&return.falseforfailure;。
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <simpara>
   <parameter>width</parameter> または <parameter>height</parameter> がオーバーフローやアンダーフローを引き起こす場合、
   <classname>ValueError</classname> をスローします。
  </simpara>
  <simpara>
   <parameter>mode</parameter> が不正の場合、 <classname>ValueError</classname> をスローします。
  </simpara>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.4.0</entry>
      <entry>
       <parameter>width</parameter> または <parameter>height</parameter> がオーバーフローやアンダーフローを引き起こす場合でも、
       <classname>ValueError</classname> をスローするようになりました。
      </entry>
     </row>
     <row>
      <entry>8.4.0</entry>
      <entry>
       <parameter>mode</parameter> が不正の場合、 <classname>ValueError</classname> をスローするようになりました。
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       成功時には、
       この関数は <classname>GDImage</classname>
       クラスのインスタンスを返すようになりました。
       これより前のバージョンでは、
       <type>resource</type> を返していました。
      </entry>
     </row>
     &gd.changelog.image-param;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

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