php-doc-en/reference/cairo/cairopatterntype.xml
2012-01-03 07:06:01 +00:00

134 lines
3.9 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.cairopatterntype" 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 CairoPatternType class</title>
<titleabbrev>CairoPatternType</titleabbrev>
<partintro>
<!-- {{{ CairoPatternType intro -->
<section xml:id="cairopatterntype.intro">
&reftitle.intro;
<para>
<classname>CairoPatternType</classname> is used to describe the type of a given pattern.
</para>
<para>
The type of a pattern is determined by the function used to create it.
The <function>cairo_pattern_create_rgb</function> and <function>cairo_pattern_create_rgba</function>
functions create <constant>CairoPatternType::SOLID</constant> patterns. The remaining
cairo_pattern_create_* functions map to pattern types in obvious ways.
</para>
</section>
<!-- }}} -->
<section xml:id="cairopatterntype.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>CairoPatternType</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>CairoPatternType</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="cairopatterntype.constants.solid">CairoPatternType::SOLID</varname>
<initializer>0</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="cairopatterntype.constants.surface">CairoPatternType::SURFACE</varname>
<initializer>1</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="cairopatterntype.constants.linear">CairoPatternType::LINEAR</varname>
<initializer>2</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="cairopatterntype.constants.radial">CairoPatternType::RADIAL</varname>
<initializer>3</initializer>
</fieldsynopsis>
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ CairoPatternType constants -->
<section xml:id="cairopatterntype.constants">
&reftitle.constants;
<variablelist>
<varlistentry xml:id="cairopatterntype.constants.solid">
<term><constant>CairoPatternType::SOLID</constant></term>
<listitem>
<para>The pattern is a solid (uniform) color. It may be opaque or translucent.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="cairopatterntype.constants.surface">
<term><constant>CairoPatternType::SURFACE</constant></term>
<listitem>
<para>The pattern is a based on a surface (an image). </para>
</listitem>
</varlistentry>
<varlistentry xml:id="cairopatterntype.constants.linear">
<term><constant>CairoPatternType::LINEAR</constant></term>
<listitem>
<para>The pattern is a linear gradient. </para>
</listitem>
</varlistentry>
<varlistentry xml:id="cairopatterntype.constants.radial">
<term><constant>CairoPatternType::RADIAL</constant></term>
<listitem>
<para>The pattern is a radial gradient. </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
-->