php-doc-en/reference/image/functions/imagesavealpha.xml
2020-10-09 13:59:15 +00:00

110 lines
2.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.imagesavealpha" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imagesavealpha</refname>
<refpurpose>Whether to retain full alpha channel information when saving PNG images</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imagesavealpha</methodname>
<methodparam><type>resource</type><parameter>image</parameter></methodparam>
<methodparam><type>bool</type><parameter>saveflag</parameter></methodparam>
</methodsynopsis>
<para>
<function>imagesavealpha</function> sets the flag which determines whether to retain
full alpha channel information (as opposed to single-color transparency)
when saving PNG images.
</para>
<para>
Alphablending has to be disabled (<code>imagealphablending($im, false)</code>)
to retain the alpha-channel in the first place.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&gd.image.description;
<varlistentry>
<term><parameter>saveflag</parameter></term>
<listitem>
<para>
Whether to save the alpha channel or not. Defaults to &false;.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Basic <function>imagesavealpha</function> Usage</title>
<programlisting role="php">
<![CDATA[
<?php
// Load a png image with alpha channel
$png = imagecreatefrompng('./alphachannel_example.png');
// Turn off alpha blending
imagealphablending($png, false);
// Do desired operations
// Set alpha flag
imagesavealpha($png, true);
// Output image to browser
header('Content-Type: image/png');
imagepng($png);
imagedestroy($png);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>imagealphablending</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
-->