mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 23:08:55 +00:00
b95d28e6ec
Functions which return false on failure should state that in their signature as well. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351135 c90b9560-bf6c-de11-be94-00142212c4b1
109 lines
3.1 KiB
XML
109 lines
3.1 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="function.imagescale" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>imagescale</refname>
|
|
<refpurpose>Scale an image using the given new width and height</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type class="union"><type>resource</type><type>false</type></type><methodname>imagescale</methodname>
|
|
<methodparam><type>resource</type><parameter>image</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>new_width</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>new_height</parameter><initializer>-1</initializer></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer>IMG_BILINEAR_FIXED</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>imagescale</function> scales an image using the given
|
|
interpolation algorithm.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
Unlike many of other image functions, <function>imagescale</function> does
|
|
not modify the passed <parameter>image</parameter>; instead, a
|
|
<emphasis>new</emphasis> image is returned.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
&gd.image.description;
|
|
<varlistentry>
|
|
<term><parameter>new_width</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The width to scale the image to.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>new_height</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The height to scale the image to. If omitted or negative, the aspect
|
|
ratio will be preserved.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>mode</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
One of <constant>IMG_NEAREST_NEIGHBOUR</constant>,
|
|
<constant>IMG_BILINEAR_FIXED</constant>,
|
|
<constant>IMG_BICUBIC</constant>,
|
|
<constant>IMG_BICUBIC_FIXED</constant> or anything else (will use two
|
|
pass).
|
|
<note>
|
|
<simpara>
|
|
<constant>IMG_WEIGHTED4</constant> is not yet supported.
|
|
</simpara>
|
|
</note>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Return the scaled image resource on success&return.falseforfailure;.
|
|
</para>
|
|
</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
|
|
-->
|