<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.imageresolution" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>imageresolution</refname>
  <refpurpose>Get or set the resolution of the image</refpurpose>
 </refnamediv>

 <refsect1 role="description"><!-- {{{ -->
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>bool</type></type><methodname>imageresolution</methodname>
   <methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>resolution_x</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>resolution_y</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>imageresolution</function> allows to set and get the resolution of
   an image in DPI (dots per inch). If the optional parameters are &null;,
   the current resolution is returned as an indexed array. If only
   <parameter>resolution_x</parameter> is not &null;, the horizontal and vertical resolution
   are set to this value. If none of the optional parameters are &null;, the horizontal
   and vertical resolution are set to these values, respectively.
  </para>
  <para>
   The resolution is only used as meta information when images are read from and
   written to formats supporting this kind of information (curently PNG and
   JPEG). It does not affect any drawing operations. The default resolution
   for new images is 96 DPI.
  </para>
 </refsect1><!-- }}} -->

 <refsect1 role="parameters"><!-- {{{ -->
  &reftitle.parameters;
  <variablelist>
   &gd.image.description;
   <varlistentry>
    <term><parameter>resolution_x</parameter></term>
    <listitem>
     <para>
      The horizontal resolution in DPI.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>resolution_y</parameter></term>
    <listitem>
     <para>
      The vertical resolution in DPI.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1><!-- }}} -->

 <refsect1 role="returnvalues"><!-- {{{ -->
  &reftitle.returnvalues;
  <para>
   When used as getter,
   it returns an indexed array of the horizontal and vertical resolution on
   success, &return.falseforfailure;.
   When used as setter, it returns
   &true; on success, &return.falseforfailure;.
  </para>
 </refsect1><!-- }}} -->


 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>resolution_x</parameter> and <parameter>resolution_y</parameter> are now nullable.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples"><!-- {{{ -->
  &reftitle.examples;
  <example xml:id="imageresolution.example.basic"><!-- {{{ -->
   <title>Setting and getting the resolution of an image</title>
   <programlisting role="php">
<![CDATA[
<?php
$im = imagecreatetruecolor(100, 100);
imageresolution($im, 200);
print_r(imageresolution($im));
imageresolution($im, 300, 72);
print_r(imageresolution($im));
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
Array
(
    [0] => 200
    [1] => 200
)
Array
(
    [0] => 300
    [1] => 72
)
]]>
   </screen>
  </example><!-- }}} -->
 </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
-->
