php-doc-en/reference/image/functions/imageinterlace.xml
Yannick Torres 29be612175 fix markup
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@279771 c90b9560-bf6c-de11-be94-00142212c4b1
2009-05-03 13:17:08 +00:00

90 lines
2.3 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.11 $ -->
<refentry xml:id="function.imageinterlace" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imageinterlace</refname>
<refpurpose>Enable or disable interlace</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>imageinterlace</methodname>
<methodparam><type>resource</type><parameter>image</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>interlace</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
<function>imageinterlace</function> turns the interlace bit on or off.
</para>
<para>
If the interlace bit is set and the image is used as a <acronym>JPEG</acronym> image,
the image is created as a progressive <acronym>JPEG</acronym>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&gd.image.description;
<varlistentry>
<term><parameter>interlace</parameter></term>
<listitem>
<para>
If non-zero, the image will be interlaced, else the interlace bit is
turned off.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns 1 if the interlace bit is set for the image, 0 otherwise.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Turn on interlacing using <function>imageinterlace</function></title>
<programlisting role="php">
<![CDATA[
<?php
// Create an image instance
$im = imagecreatefrom('php.gif');
// Enable interlancing
imageinterlace($im, true);
// Save the interfaced image
imagegif($im, './php_interlaced.gif');
imagedestroy($im);
?>
]]>
</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:"../../../../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
-->