php-doc-en/reference/image/functions/imageavif.xml
Sergey Panteleev 4e04068f2d
[PHP 8.1] Add imageavif and imagecreatefromavif functions (#983)
Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>
2021-09-30 13:17:20 +03:00

95 lines
2.9 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<refentry xml:id="function.imageavif" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imageavif</refname>
<refpurpose>&gd.image.output;</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imageavif</methodname>
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>resource</type><type>string</type><type>null</type></type><parameter>file</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>quality</parameter><initializer>-1</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>speed</parameter><initializer>-1</initializer></methodparam>
</methodsynopsis>
<para>
Outputs or saves a <acronym>AVIF</acronym> Raster image from the given <parameter>image</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&gd.image.description;
<varlistentry>
<term><parameter>file</parameter></term>
<listitem>
<para>
&gd.image.path;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>quality</parameter></term>
<listitem>
<para>
<parameter>quality</parameter> is optional, and ranges from 0 (worst quality, smaller file)
to 100 (best quality, larger file).
If <literal>-1</literal> is provided, the default value <literal>30</literal> is used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>speed</parameter></term>
<listitem>
<para>
<parameter>speed</parameter> is optional, and ranges from 0 (slow, smaller file)
to 10 (fast, larger file).
If <literal>-1</literal> is provided, the default value <literal>6</literal> is used.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
&gd.return.trueonerror;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>imagepng</function></member>
<member><function>imagewbmp</function></member>
<member><function>imagejpeg</function></member>
<member><function>imagetypes</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
-->