php-doc-en/reference/cairo/cairofilter.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<phpdoc:classref xml:id="class.cairofilter" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>The CairoFilter class</title>
 <titleabbrev>CairoFilter</titleabbrev>

 <partintro>

<!-- {{{ CairoFilter intro -->
  <section xml:id="cairofilter.intro">
   &reftitle.intro;
   <para>
    A <classname>CairoFilter</classname> is used to indicate what filtering should be applied when reading pixel values
    from patterns. See <methodname>CairoPattern::setSource</methodname> or <function>cairo_pattern_set_source</function>
    for indicating the desired filter to be used with a particular pattern.
   </para>
  </section>
<!-- }}} -->

  <section xml:id="cairofilter.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass><classname>CairoFilter</classname></ooclass>

<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <classname>CairoFilter</classname>
     </ooclass>
    </classsynopsisinfo>
<!-- }}} -->
    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="cairofilter.constants.fast">CairoFilter::FAST</varname>
     <initializer>0</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="cairofilter.constants.good">CairoFilter::GOOD</varname>
     <initializer>1</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="cairofilter.constants.best">CairoFilter::BEST</varname>
     <initializer>2</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="cairofilter.constants.nearest">CairoFilter::NEAREST</varname>
     <initializer>3</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="cairofilter.constants.bilinear">CairoFilter::BILINEAR</varname>
     <initializer>4</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="cairofilter.constants.gaussian">CairoFilter::GAUSSIAN</varname>
     <initializer>5</initializer>
    </fieldsynopsis>
    
   </classsynopsis>
<!-- }}} -->

  </section>
  
<!-- {{{ CairoFilter constants -->
  <section xml:id="cairofilter.constants">
   &reftitle.constants;
   <variablelist>

    <varlistentry xml:id="cairofilter.constants.fast">
     <term><constant>CairoFilter::FAST</constant></term>
     <listitem>
      <para> A high-performance filter, with quality similar to <constant>CairoFilter::NEAREST</constant></para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="cairofilter.constants.good">
     <term><constant>CairoFilter::GOOD</constant></term>
     <listitem>
      <para>A reasonable-performance filter, with quality similar to <constant>CairoFilter::BILINEAR</constant></para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="cairofilter.constants.best">
     <term><constant>CairoFilter::BEST</constant></term>
     <listitem>
      <para>The highest-quality available, performance may not be suitable for interactive use.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="cairofilter.constants.nearest">
     <term><constant>CairoFilter::NEAREST</constant></term>
     <listitem>
      <para>Nearest-neighbor filtering </para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="cairofilter.constants.bilinear">
     <term><constant>CairoFilter::BILINEAR</constant></term>
     <listitem>
      <para>Linear interpolation in two dimensions </para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="cairofilter.constants.gaussian">
     <term><constant>CairoFilter::GAUSSIAN</constant></term>
     <listitem>
      <para>This filter value is currently unimplemented, and should not be used in current code. </para>
     </listitem>
    </varlistentry>

   </variablelist>
  </section>
<!-- }}} -->


 </partintro>

 

</phpdoc:classref>

<!-- 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
-->