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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 294366 $ -->
<phpdoc:classref xml:id="class.cairooperator" 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 CairoOperator class</title>
<titleabbrev>CairoOperator</titleabbrev>
<partintro>
<!-- {{{ CairoOperator intro -->
<section xml:id="cairooperator.intro">
&reftitle.intro;
<para>
This is used to set the compositing operator for all cairo drawing operations.
</para>
<para>
The default operator is <constant>CairoOperator::OVER</constant>
</para>
<para>
The operators marked as unbounded modify their destination even outside of the mask layer (that is,
their effect is not bound by the mask layer). However, their effect can still be limited by way of clipping.
</para>
<para>
To keep things simple, the operator descriptions here document the behavior for when both source and destination
are either fully transparent or fully opaque. The actual implementation works for translucent layers too.
For a more detailed explanation of the effects of each operator, including the mathematical definitions,
see http://cairographics.org/operators/.
</para>
</section>
<!-- }}} -->
<section xml:id="cairooperator.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>CairoOperator</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>CairoOperator</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="cairooperator.constants.clear">CairoOperator::CLEAR</varname>
<initializer>0</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="cairooperator.constants.source">CairoOperator::SOURCE</varname>
<initializer>1</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="cairooperator.constants.over">CairoOperator::OVER</varname>
<initializer>2</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="cairooperator.constants.in">CairoOperator::IN</varname>
<initializer>3</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="cairooperator.constants.out">CairoOperator::OUT</varname>
<initializer>4</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="cairooperator.constants.atop">CairoOperator::ATOP</varname>
<initializer>5</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="cairooperator.constants.dest">CairoOperator::DEST</varname>
<initializer>6</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="cairooperator.constants.dest-over">CairoOperator::DEST_OVER</varname>
<initializer>7</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="cairooperator.constants.dest-in">CairoOperator::DEST_IN</varname>
<initializer>8</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="cairooperator.constants.dest-out">CairoOperator::DEST_OUT</varname>
<initializer>9</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="cairooperator.constants.dest-atop">CairoOperator::DEST_ATOP</varname>
<initializer>10</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="cairooperator.constants.xor">CairoOperator::XOR</varname>
<initializer>11</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="cairooperator.constants.add">CairoOperator::ADD</varname>
<initializer>12</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="cairooperator.constants.saturate">CairoOperator::SATURATE</varname>
<initializer>13</initializer>
</fieldsynopsis>
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ CairoOperator constants -->
<section xml:id="cairooperator.constants">
&reftitle.constants;
<section xml:id="cairooperator.constants.types">
<title>CairoOperator Node Types</title>
<variablelist>
<varlistentry xml:id="cairooperator.constants.clear">
<term><constant>CairoOperator::CLEAR</constant></term>
<listitem>
<para>Clear destination layer (bounded)</para>
</listitem>
</varlistentry>
<varlistentry xml:id="cairooperator.constants.source">
<term><constant>CairoOperator::SOURCE</constant></term>
<listitem>
<para>Replace destination layer (bounded) </para>
</listitem>
</varlistentry>
<varlistentry xml:id="cairooperator.constants.over">
<term><constant>CairoOperator::OVER</constant></term>
<listitem>
<para>Draw source layer on top of destination layer (bounded) </para>
</listitem>
</varlistentry>
<varlistentry xml:id="cairooperator.constants.in">
<term><constant>CairoOperator::IN</constant></term>
<listitem>
<para>Draw source where there was destination content (unbounded) </para>
</listitem>
</varlistentry>
<varlistentry xml:id="cairooperator.constants.out">
<term><constant>CairoOperator::OUT</constant></term>
<listitem>
<para>Draw source where there was no destination content (unbounded) </para>
</listitem>
</varlistentry>
<varlistentry xml:id="cairooperator.constants.atop">
<term><constant>CairoOperator::ATOP</constant></term>
<listitem>
<para>Draw source on top of destination content and only there </para>
</listitem>
</varlistentry>
<varlistentry xml:id="cairooperator.constants.dest">
<term><constant>CairoOperator::DEST</constant></term>
<listitem>
<para>Ignore the source </para>
</listitem>
</varlistentry>
<varlistentry xml:id="cairooperator.constants.dest-over">
<term><constant>CairoOperator::DEST_OVER</constant></term>
<listitem>
<para>Draw destination on top of source </para>
</listitem>
</varlistentry>
<varlistentry xml:id="cairooperator.constants.dest-in">
<term><constant>CairoOperator::DEST_IN</constant></term>
<listitem>
<para>Leave destination only where there was source content (unbounded) </para>
</listitem>
</varlistentry>
<varlistentry xml:id="cairooperator.constants.dest-out">
<term><constant>CairoOperator::DEST_OUT</constant></term>
<listitem>
<para>Leave destination only where there was no source content </para>
</listitem>
</varlistentry>
<varlistentry xml:id="cairooperator.constants.dest-atop">
<term><constant>CairoOperator::DEST_ATOP</constant></term>
<listitem>
<para>Leave destination on top of source content and only there (unbounded) </para>
</listitem>
</varlistentry>
<varlistentry xml:id="cairooperator.constants.xor">
<term><constant>CairoOperator::XOR</constant></term>
<listitem>
<para>Source and destination are shown where there is only one of them </para>
</listitem>
</varlistentry>
<varlistentry xml:id="cairooperator.constants.add">
<term><constant>CairoOperator::ADD</constant></term>
<listitem>
<para>Source and destination layers are accumulated </para>
</listitem>
</varlistentry>
<varlistentry xml:id="cairooperator.constants.saturate">
<term><constant>CairoOperator::SATURATE</constant></term>
<listitem>
<para>Like <constant>CairoOperator::OVER</constant>, but assuming source and dest are disjoint geometries </para>
</listitem>
</varlistentry>
</variablelist>
</section>
</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
-->
|
