File: fillextents.xml

package info (click to toggle)
php-doc 20100521-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 59,992 kB
  • ctags: 4,085
  • sloc: xml: 796,833; php: 21,338; cpp: 500; sh: 117; makefile: 58; awk: 28
file content (137 lines) | stat: -rw-r--r-- 3,697 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 294366 $ -->

<refentry xml:id="cairocontext.fillextents" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>CairoContext::fillExtents</refname>
  <refname>cairo_fill_extents</refname>
  <refpurpose>Computes the filled area</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>Object oriented style (method):</para>
   <methodsynopsis>
   <modifier>public</modifier> <type>array</type><methodname>CairoContext::fillExtents</methodname>
   <void />
   </methodsynopsis>
  <para>Procedural style:</para>
  <methodsynopsis>
   <type>array</type><methodname>cairo_fill_extents</methodname>
   <methodparam><type>CairoContext</type><parameter>context</parameter></methodparam>
  </methodsynopsis>
  <para>
   Computes a bounding box in user coordinates covering the area that would be affected,
   (the “inked” area), by a <methodname>CairoContext::fill</methodname> operation given the
   current path and fill parameters. If the current path is empty,
   returns an empty rectangle (0,0,0,0). Surface dimensions and clipping are not taken into account.
  </para>
  <para>
   Contrast with <methodname>CairoContext::pathExtents</methodname>, which is similar, but returns
   non-zero extents for some paths with no inked area, (such as a simple line segment).
  </para>
  <para>
   Note that <methodname>CairoContext::fillExtents</methodname> must necessarily do more work to
   compute the precise inked areas in light of the fill rule, so
   <methodname>CairoContext::pathExtents</methodname> may be more desirable for sake of
   performance if the non-inked path extents are desired.
  </para> 
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>context</parameter></term>
     <listitem>
      <para>
       A valid <classname>CairoContext</classname> object created with
       <methodname>CairoContext::__construct</methodname> or <function>cairo_create</function>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   An array with the coordinates of the afected area
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Object oriented style</title>
    <programlisting role="php">
<![CDATA[
<?php
/* ... */
?>
]]>
     </programlisting>
     &example.outputs.similar;
     <screen>
<![CDATA[
...
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title>Procedural style</title>
    <programlisting role="php">
<![CDATA[
<?php
/* ... */
?>
]]>
     </programlisting>
     &example.outputs.similar;
     <screen>
<![CDATA[
...
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>CairoContext::fill</methodname></member>
    <member><methodname>CairoContext::setFillRule</methodname></member>
    <member><methodname>CairoContext::fillPreserve</methodname></member>
   </simplelist>
  </para>
 </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
-->