php-doc-en/reference/image/constants.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<appendix xml:id="image.constants" xmlns="http://docbook.org/ns/docbook">
 &reftitle.constants;
 &extension.constants;
 <variablelist>
  <varlistentry xml:id="constant.gd-version">
   <term>
    <constant>GD_VERSION</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     The GD version PHP was compiled against.
     (Available as of PHP 5.2.4)
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.gd-major-version">
   <term>
    <constant>GD_MAJOR_VERSION</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     The GD major version PHP was compiled against.
     (Available as of PHP 5.2.4)
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.gd-minor-version">
   <term>
    <constant>GD_MINOR_VERSION</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     The GD minor version PHP was compiled against.
     (Available as of PHP 5.2.4)
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.gd-release-version">
   <term>
    <constant>GD_RELEASE_VERSION</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     The GD release version PHP was compiled against.
     (Available as of PHP 5.2.4)
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.gd-extra-version">
   <term>
    <constant>GD_EXTRA_VERSION</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     The GD "extra" version (beta/rc..) PHP was compiled against.
     (Available as of PHP 5.2.4)
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.gd-bundled">
   <term>
    <constant>GD_BUNDLED</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     When the bundled version of GD is used this is 1 otherwise 
     its set to 0.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.img-gif">
   <term>
    <constant>IMG_GIF</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Used as a return value by <function>imagetypes</function>
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-jpg">
   <term>
    <constant>IMG_JPG</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Used as a return value by <function>imagetypes</function>
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-jpeg">
   <term>
    <constant>IMG_JPEG</constant> 
     (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Used as a return value by <function>imagetypes</function>
    </simpara>
    <note>
     <para>
      This constant has the same value as <constant>IMG_JPG</constant>
     </para>
    </note>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-png">
   <term>
    <constant>IMG_PNG</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Used as a return value by <function>imagetypes</function>
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-wbmp">
   <term>
    <constant>IMG_WBMP</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Used as a return value by <function>imagetypes</function>
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-xpm">
   <term>
    <constant>IMG_XPM</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Used as a return value by <function>imagetypes</function>
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-color-tiled">
   <term>
    <constant>IMG_COLOR_TILED</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Special color option which can be used in stead of color allocated with
     <function>imagecolorallocate</function> or
     <function>imagecolorallocatealpha</function>
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-color-styled">
   <term>
    <constant>IMG_COLOR_STYLED</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Special color option which can be used in stead of color allocated with
     <function>imagecolorallocate</function> or
     <function>imagecolorallocatealpha</function>
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-color-brushed">
   <term>
    <constant>IMG_COLOR_BRUSHED</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Special color option which can be used in stead of color allocated with
     <function>imagecolorallocate</function> or
     <function>imagecolorallocatealpha</function>
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-color-styledbrushed">
   <term>
    <constant>IMG_COLOR_STYLEDBRUSHED</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Special color option which can be used in stead of color allocated with
     <function>imagecolorallocate</function> or
     <function>imagecolorallocatealpha</function>
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-color-transparent">
   <term>
    <constant>IMG_COLOR_TRANSPARENT</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Special color option which can be used in stead of color allocated with
     <function>imagecolorallocate</function> or
     <function>imagecolorallocatealpha</function>
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-arc-rounded">
   <term>
    <constant>IMG_ARC_ROUNDED</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     A style constant used by the <function>imagefilledarc</function> function.
    </simpara>
    <note>
     <para>
      This constant has the same value as <constant>IMG_ARC_PIE</constant>
     </para>
    </note>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-arc-pie">
   <term>
    <constant>IMG_ARC_PIE</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     A style constant used by the <function>imagefilledarc</function> function.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-arc-chord">
   <term>
    <constant>IMG_ARC_CHORD</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     A style constant used by the <function>imagefilledarc</function> function.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-arc-nofill">
   <term>
    <constant>IMG_ARC_NOFILL</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     A style constant used by the <function>imagefilledarc</function> function.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-arc-edged">
   <term>
    <constant>IMG_ARC_EDGED</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     A style constant used by the <function>imagefilledarc</function> function.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-gd2-raw">
   <term>
    <constant>IMG_GD2_RAW</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     A type constant used by the <function>imagegd2</function> function.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-gd2-compressed">
   <term>
    <constant>IMG_GD2_COMPRESSED</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     A type constant used by the <function>imagegd2</function> function.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-effect-replace">
   <term>
    <constant>IMG_EFFECT_REPLACE</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Alpha blending effect used by the <function>imagelayereffect</function> function.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-effect-alphablend">
   <term>
    <constant>IMG_EFFECT_ALPHABLEND</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Alpha blending effect used by the <function>imagelayereffect</function> function.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-effect-normal">
   <term>
    <constant>IMG_EFFECT_NORMAL</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Alpha blending effect used by the <function>imagelayereffect</function> function.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-effect-overlay">
   <term>
    <constant>IMG_EFFECT_OVERLAY</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Alpha blending effect used by the <function>imagelayereffect</function> function.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-filter-negate">
   <term>
    <constant>IMG_FILTER_NEGATE</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Special GD filter used by the <function>imagefilter</function> function.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-filter-grayscale">
   <term>
    <constant>IMG_FILTER_GRAYSCALE</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Special GD filter used by the <function>imagefilter</function> function.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-filter-brightness">
   <term>
    <constant>IMG_FILTER_BRIGHTNESS</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Special GD filter used by the <function>imagefilter</function> function.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-filter-contrast">
   <term>
    <constant>IMG_FILTER_CONTRAST</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Special GD filter used by the <function>imagefilter</function> function.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-filter-colorize">
   <term>
    <constant>IMG_FILTER_COLORIZE</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Special GD filter used by the <function>imagefilter</function> function.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-filter-edgedetect">
   <term>
    <constant>IMG_FILTER_EDGEDETECT</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Special GD filter used by the <function>imagefilter</function> function.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-filter-gaussian-blur">
   <term>
    <constant>IMG_FILTER_GAUSSIAN_BLUR</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Special GD filter used by the <function>imagefilter</function> function.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-filter-selective-blur">
   <term>
    <constant>IMG_FILTER_SELECTIVE_BLUR</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Special GD filter used by the <function>imagefilter</function> function.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-filter-emboss">
   <term>
    <constant>IMG_FILTER_EMBOSS</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Special GD filter used by the <function>imagefilter</function> function.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-filter-mean-removal">
   <term>
    <constant>IMG_FILTER_MEAN_REMOVAL</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Special GD filter used by the <function>imagefilter</function> function.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-filter-smooth">
   <term>
    <constant>IMG_FILTER_SMOOTH</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Special GD filter used by the <function>imagefilter</function> function.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.img-filter-pixelate">
   <term>
    <constant>IMG_FILTER_PIXELATE</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Special GD filter used by the <function>imagefilter</function> function. 
     (Available as of PHP 5.3.0)
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.imagetype-gif">
   <term>
    <constant>IMAGETYPE_GIF</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Image type constant used by the
     <function>image_type_to_mime_type</function> and
     <function>image_type_to_extension</function> functions.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.imagetype-jpeg">
   <term>
    <constant>IMAGETYPE_JPEG</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Image type constant used by the
     <function>image_type_to_mime_type</function> and
     <function>image_type_to_extension</function> functions.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.imagetype-jpeg2000">
   <term>
    <constant>IMAGETYPE_JPEG2000</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Image type constant used by the
     <function>image_type_to_mime_type</function> and
     <function>image_type_to_extension</function> functions.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.imagetype-png">
   <term>
    <constant>IMAGETYPE_PNG</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Image type constant used by the
     <function>image_type_to_mime_type</function> and
     <function>image_type_to_extension</function> functions.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.imagetype-swf">
   <term>
    <constant>IMAGETYPE_SWF</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Image type constant used by the
     <function>image_type_to_mime_type</function> and
     <function>image_type_to_extension</function> functions.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.imagetype-psd">
   <term>
    <constant>IMAGETYPE_PSD</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Image type constant used by the
     <function>image_type_to_mime_type</function> and
     <function>image_type_to_extension</function> functions.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.imagetype-bmp">
   <term>
    <constant>IMAGETYPE_BMP</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Image type constant used by the
     <function>image_type_to_mime_type</function> and
     <function>image_type_to_extension</function> functions.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.imagetype-wbmp">
   <term>
    <constant>IMAGETYPE_WBMP</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Image type constant used by the
     <function>image_type_to_mime_type</function> and
     <function>image_type_to_extension</function> functions.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.imagetype-xbm">
   <term>
    <constant>IMAGETYPE_XBM</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Image type constant used by the
     <function>image_type_to_mime_type</function> and
     <function>image_type_to_extension</function> functions.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.imagetype-tiff-ii">
   <term>
    <constant>IMAGETYPE_TIFF_II</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Image type constant used by the
     <function>image_type_to_mime_type</function> and
     <function>image_type_to_extension</function> functions.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.imagetype-tiff-mm">
   <term>
    <constant>IMAGETYPE_TIFF_MM</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Image type constant used by the
     <function>image_type_to_mime_type</function> and
     <function>image_type_to_extension</function> functions.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.imagetype-iff">
   <term>
    <constant>IMAGETYPE_IFF</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Image type constant used by the
     <function>image_type_to_mime_type</function> and
     <function>image_type_to_extension</function> functions.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.imagetype-jb2">
   <term>
    <constant>IMAGETYPE_JB2</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Image type constant used by the
     <function>image_type_to_mime_type</function> and
     <function>image_type_to_extension</function> functions.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.imagetype-jpc">
   <term>
    <constant>IMAGETYPE_JPC</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Image type constant used by the
     <function>image_type_to_mime_type</function> and
     <function>image_type_to_extension</function> functions.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.imagetype-jp2">
   <term>
    <constant>IMAGETYPE_JP2</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Image type constant used by the
     <function>image_type_to_mime_type</function> and
     <function>image_type_to_extension</function> functions.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.imagetype-jpx">
   <term>
    <constant>IMAGETYPE_JPX</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Image type constant used by the
     <function>image_type_to_mime_type</function> and
     <function>image_type_to_extension</function> functions.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.imagetype-swc">
   <term>
    <constant>IMAGETYPE_SWC</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Image type constant used by the
     <function>image_type_to_mime_type</function> and
     <function>image_type_to_extension</function> functions.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.imagetype-ico">
   <term>
    <constant>IMAGETYPE_ICO</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Image type constant used by the
     <function>image_type_to_mime_type</function> and
     <function>image_type_to_extension</function> functions.
     (Available as of PHP 5.3.0)
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.png-no-filter">
   <term>
    <constant>PNG_NO_FILTER</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     A special PNG filter, used by the <function>imagepng</function> function.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.png-filter-none">
   <term>
    <constant>PNG_FILTER_NONE</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     A special PNG filter, used by the <function>imagepng</function> function.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.png-filter-sub">
   <term>
    <constant>PNG_FILTER_SUB</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     A special PNG filter, used by the <function>imagepng</function> function.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.png-filter-up">
   <term>
    <constant>PNG_FILTER_UP</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     A special PNG filter, used by the <function>imagepng</function> function.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.png-filter-avg">
   <term>
    <constant>PNG_FILTER_AVG</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     A special PNG filter, used by the <function>imagepng</function> function.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.png-filter-paeth">
   <term>
    <constant>PNG_FILTER_PAETH</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     A special PNG filter, used by the <function>imagepng</function> function.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.png-all-filters">
   <term>
    <constant>PNG_ALL_FILTERS</constant> 
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     A special PNG filter, used by the <function>imagepng</function> function.
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>
</appendix>
<!-- 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
-->