← Back to branch summary

~ubuntu-branches/ubuntu/maverick/gimp/maverick-security

« back to all changes in this revision

Viewing changes to devel-docs/libgimpmath/xml/gimpmatrix.xml

  • Committer: Bazaar Package Importer
  • Author(s): Ari Pollak
  • Date: 2009-08-14 09:57:17 UTC
  • mto: (1.1.21 upstream) (0.1.5 squeeze)
  • mto: This revision was merged to the branch mainline in revision 48.
  • Revision ID: james.westby@ubuntu.com-20090814095717-37dh2xqy5t0rurpk
Import upstream version 2.6.7

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpmath/xml/gimpmatrix.xml
12
12
<refnamediv>
13
13
<refname>GimpMatrix</refname>
14
14
<refpurpose>Utilities to set up and manipulate 3x3 transformation matrices.</refpurpose>
15
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
15
</refnamediv>
17
16
 
18
17
<refsynopsisdiv id="libgimpmath-GimpMatrix.synopsis" role="synopsis">
62
61
                                                         <link linkend="gdouble">gdouble</link> *a,
63
62
                                                         <link linkend="gdouble">gdouble</link> *b,
64
63
                                                         <link linkend="gdouble">gdouble</link> *c);
65
 
#define             <link linkend="GIMP-TYPE-MATRIX2:CAPS">GIMP_TYPE_MATRIX2</link>
66
 
#define             <link linkend="GIMP-TYPE-PARAM-MATRIX2:CAPS">GIMP_TYPE_PARAM_MATRIX2</link>
67
 
#define             <link linkend="GIMP-IS-PARAM-SPEC-MATRIX2:CAPS">GIMP_IS_PARAM_SPEC_MATRIX2</link>          (pspec)
68
 
<link linkend="GParamSpec">GParamSpec</link>*         <link linkend="gimp-param-spec-matrix2">gimp_param_spec_matrix2</link>             (const <link linkend="gchar">gchar</link> *name,
 
64
#define             <link linkend="GIMP-TYPE-MATRIX2--CAPS">GIMP_TYPE_MATRIX2</link>
 
65
#define             <link linkend="GIMP-TYPE-PARAM-MATRIX2--CAPS">GIMP_TYPE_PARAM_MATRIX2</link>
 
66
#define             <link linkend="GIMP-IS-PARAM-SPEC-MATRIX2--CAPS">GIMP_IS_PARAM_SPEC_MATRIX2</link>          (pspec)
 
67
<link linkend="GParamSpec">GParamSpec</link> *        <link linkend="gimp-param-spec-matrix2">gimp_param_spec_matrix2</link>             (const <link linkend="gchar">gchar</link> *name,
69
68
                                                         const <link linkend="gchar">gchar</link> *nick,
70
69
                                                         const <link linkend="gchar">gchar</link> *blurb,
71
70
                                                         const <link linkend="GimpMatrix2">GimpMatrix2</link> *default_value,
72
71
                                                         <link linkend="GParamFlags">GParamFlags</link> flags);
73
 
#define             <link linkend="GIMP-VALUE-HOLDS-MATRIX2:CAPS">GIMP_VALUE_HOLDS_MATRIX2</link>            (value)
 
72
#define             <link linkend="GIMP-VALUE-HOLDS-MATRIX2--CAPS">GIMP_VALUE_HOLDS_MATRIX2</link>            (value)
74
73
</synopsis>
75
74
</refsynopsisdiv>
76
75
 
86
85
<title role="desc.title">Description</title>
87
86
<para>
88
87
When doing image manipulation you will often need 3x3 transformation
89
 
matrices that define translation, rotation, scaling, shearing and 
90
 
arbitrary perspective transformations using a 3x3 matrix. Here you'll 
91
 
find a set of utility functions to set up those matrices and to perform 
 
88
matrices that define translation, rotation, scaling, shearing and
 
89
arbitrary perspective transformations using a 3x3 matrix. Here you'll
 
90
find a set of utility functions to set up those matrices and to perform
92
91
basic matrix manipulations and tests.
93
92
</para>
94
93
<para>
101
100
<title role="details.title">Details</title>
102
101
<refsect2 id="GimpMatrix2" role="struct">
103
102
<title>GimpMatrix2</title>
104
 
<indexterm zone="GimpMatrix2"><primary>GimpMatrix2</primary></indexterm><programlisting>typedef struct {
 
103
<indexterm zone="GimpMatrix2"><primary sortas="GimpMatrix2">GimpMatrix2</primary></indexterm><programlisting>typedef struct {
105
104
  gdouble coeff[2][2];
106
105
} GimpMatrix2;
107
106
</programlisting>
110
109
</para></refsect2>
111
110
<refsect2 id="GimpMatrix3" role="struct">
112
111
<title>GimpMatrix3</title>
113
 
<indexterm zone="GimpMatrix3"><primary>GimpMatrix3</primary></indexterm><programlisting>typedef struct {
 
112
<indexterm zone="GimpMatrix3"><primary sortas="GimpMatrix3">GimpMatrix3</primary></indexterm><programlisting>typedef struct {
114
113
  gdouble coeff[3][3];
115
114
} GimpMatrix3;
116
115
</programlisting>
119
118
</para></refsect2>
120
119
<refsect2 id="GimpMatrix4" role="struct">
121
120
<title>GimpMatrix4</title>
122
 
<indexterm zone="GimpMatrix4"><primary>GimpMatrix4</primary></indexterm><programlisting>typedef struct {
 
121
<indexterm zone="GimpMatrix4"><primary sortas="GimpMatrix4">GimpMatrix4</primary></indexterm><programlisting>typedef struct {
123
122
  gdouble coeff[4][4];
124
123
} GimpMatrix4;
125
124
</programlisting>
128
127
</para></refsect2>
129
128
<refsect2 id="gimp-matrix2-identity" role="function">
130
129
<title>gimp_matrix2_identity ()</title>
131
 
<indexterm zone="gimp-matrix2-identity"><primary>gimp_matrix2_identity</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_matrix2_identity               (<link linkend="GimpMatrix2">GimpMatrix2</link> *matrix);</programlisting>
 
130
<indexterm zone="gimp-matrix2-identity"><primary sortas="gimp_matrix2_identity">gimp_matrix2_identity</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_matrix2_identity               (<link linkend="GimpMatrix2">GimpMatrix2</link> *matrix);</programlisting>
132
131
<para>
133
132
Sets the matrix to the identity matrix.</para>
134
133
<para>
135
 
 
136
134
</para><variablelist role="params">
137
 
<varlistentry><term><parameter>matrix</parameter>&nbsp;:</term>
 
135
<varlistentry><term><parameter>matrix</parameter>&#160;:</term>
138
136
<listitem><simpara> A matrix.
139
137
</simpara></listitem></varlistentry>
140
138
</variablelist></refsect2>
141
139
<refsect2 id="gimp-matrix2-mult" role="function">
142
140
<title>gimp_matrix2_mult ()</title>
143
 
<indexterm zone="gimp-matrix2-mult"><primary>gimp_matrix2_mult</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_matrix2_mult                   (const <link linkend="GimpMatrix2">GimpMatrix2</link> *matrix1,
 
141
<indexterm zone="gimp-matrix2-mult"><primary sortas="gimp_matrix2_mult">gimp_matrix2_mult</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_matrix2_mult                   (const <link linkend="GimpMatrix2">GimpMatrix2</link> *matrix1,
144
142
                                                         <link linkend="GimpMatrix2">GimpMatrix2</link> *matrix2);</programlisting>
145
143
<para>
146
144
Multiplies two matrices and puts the result into the second one.</para>
147
145
<para>
148
 
 
149
146
</para><variablelist role="params">
150
 
<varlistentry><term><parameter>matrix1</parameter>&nbsp;:</term>
 
147
<varlistentry><term><parameter>matrix1</parameter>&#160;:</term>
151
148
<listitem><simpara> The first input matrix.
152
149
</simpara></listitem></varlistentry>
153
 
<varlistentry><term><parameter>matrix2</parameter>&nbsp;:</term>
 
150
<varlistentry><term><parameter>matrix2</parameter>&#160;:</term>
154
151
<listitem><simpara> The second input matrix which will be overwritten by the result.
155
152
</simpara></listitem></varlistentry>
156
153
</variablelist></refsect2>
157
154
<refsect2 id="gimp-matrix3-identity" role="function">
158
155
<title>gimp_matrix3_identity ()</title>
159
 
<indexterm zone="gimp-matrix3-identity"><primary>gimp_matrix3_identity</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_matrix3_identity               (<link linkend="GimpMatrix3">GimpMatrix3</link> *matrix);</programlisting>
 
156
<indexterm zone="gimp-matrix3-identity"><primary sortas="gimp_matrix3_identity">gimp_matrix3_identity</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_matrix3_identity               (<link linkend="GimpMatrix3">GimpMatrix3</link> *matrix);</programlisting>
160
157
<para>
161
158
Sets the matrix to the identity matrix.</para>
162
159
<para>
163
 
 
164
160
</para><variablelist role="params">
165
 
<varlistentry><term><parameter>matrix</parameter>&nbsp;:</term>
 
161
<varlistentry><term><parameter>matrix</parameter>&#160;:</term>
166
162
<listitem><simpara> A matrix.
167
163
</simpara></listitem></varlistentry>
168
164
</variablelist></refsect2>
169
165
<refsect2 id="gimp-matrix3-mult" role="function">
170
166
<title>gimp_matrix3_mult ()</title>
171
 
<indexterm zone="gimp-matrix3-mult"><primary>gimp_matrix3_mult</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_matrix3_mult                   (const <link linkend="GimpMatrix3">GimpMatrix3</link> *matrix1,
 
167
<indexterm zone="gimp-matrix3-mult"><primary sortas="gimp_matrix3_mult">gimp_matrix3_mult</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_matrix3_mult                   (const <link linkend="GimpMatrix3">GimpMatrix3</link> *matrix1,
172
168
                                                         <link linkend="GimpMatrix3">GimpMatrix3</link> *matrix2);</programlisting>
173
169
<para>
174
170
Multiplies two matrices and puts the result into the second one.</para>
175
171
<para>
176
 
 
177
172
</para><variablelist role="params">
178
 
<varlistentry><term><parameter>matrix1</parameter>&nbsp;:</term>
 
173
<varlistentry><term><parameter>matrix1</parameter>&#160;:</term>
179
174
<listitem><simpara> The first input matrix.
180
175
</simpara></listitem></varlistentry>
181
 
<varlistentry><term><parameter>matrix2</parameter>&nbsp;:</term>
 
176
<varlistentry><term><parameter>matrix2</parameter>&#160;:</term>
182
177
<listitem><simpara> The second input matrix which will be overwritten by the result.
183
178
</simpara></listitem></varlistentry>
184
179
</variablelist></refsect2>
185
180
<refsect2 id="gimp-matrix3-translate" role="function">
186
181
<title>gimp_matrix3_translate ()</title>
187
 
<indexterm zone="gimp-matrix3-translate"><primary>gimp_matrix3_translate</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_matrix3_translate              (<link linkend="GimpMatrix3">GimpMatrix3</link> *matrix,
 
182
<indexterm zone="gimp-matrix3-translate"><primary sortas="gimp_matrix3_translate">gimp_matrix3_translate</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_matrix3_translate              (<link linkend="GimpMatrix3">GimpMatrix3</link> *matrix,
188
183
                                                         <link linkend="gdouble">gdouble</link> x,
189
184
                                                         <link linkend="gdouble">gdouble</link> y);</programlisting>
190
185
<para>
191
186
Translates the matrix by x and y.</para>
192
187
<para>
193
 
 
194
188
</para><variablelist role="params">
195
 
<varlistentry><term><parameter>matrix</parameter>&nbsp;:</term>
 
189
<varlistentry><term><parameter>matrix</parameter>&#160;:</term>
196
190
<listitem><simpara> The matrix that is to be translated.
197
191
</simpara></listitem></varlistentry>
198
 
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
 
192
<varlistentry><term><parameter>x</parameter>&#160;:</term>
199
193
<listitem><simpara> Translation in X direction.
200
194
</simpara></listitem></varlistentry>
201
 
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
 
195
<varlistentry><term><parameter>y</parameter>&#160;:</term>
202
196
<listitem><simpara> Translation in Y direction.
203
197
</simpara></listitem></varlistentry>
204
198
</variablelist></refsect2>
205
199
<refsect2 id="gimp-matrix3-scale" role="function">
206
200
<title>gimp_matrix3_scale ()</title>
207
 
<indexterm zone="gimp-matrix3-scale"><primary>gimp_matrix3_scale</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_matrix3_scale                  (<link linkend="GimpMatrix3">GimpMatrix3</link> *matrix,
 
201
<indexterm zone="gimp-matrix3-scale"><primary sortas="gimp_matrix3_scale">gimp_matrix3_scale</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_matrix3_scale                  (<link linkend="GimpMatrix3">GimpMatrix3</link> *matrix,
208
202
                                                         <link linkend="gdouble">gdouble</link> x,
209
203
                                                         <link linkend="gdouble">gdouble</link> y);</programlisting>
210
204
<para>
211
205
Scales the matrix by x and y</para>
212
206
<para>
213
 
 
214
207
</para><variablelist role="params">
215
 
<varlistentry><term><parameter>matrix</parameter>&nbsp;:</term>
 
208
<varlistentry><term><parameter>matrix</parameter>&#160;:</term>
216
209
<listitem><simpara> The matrix that is to be scaled.
217
210
</simpara></listitem></varlistentry>
218
 
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
 
211
<varlistentry><term><parameter>x</parameter>&#160;:</term>
219
212
<listitem><simpara> X scale factor.
220
213
</simpara></listitem></varlistentry>
221
 
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
 
214
<varlistentry><term><parameter>y</parameter>&#160;:</term>
222
215
<listitem><simpara> Y scale factor.
223
216
</simpara></listitem></varlistentry>
224
217
</variablelist></refsect2>
225
218
<refsect2 id="gimp-matrix3-rotate" role="function">
226
219
<title>gimp_matrix3_rotate ()</title>
227
 
<indexterm zone="gimp-matrix3-rotate"><primary>gimp_matrix3_rotate</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_matrix3_rotate                 (<link linkend="GimpMatrix3">GimpMatrix3</link> *matrix,
 
220
<indexterm zone="gimp-matrix3-rotate"><primary sortas="gimp_matrix3_rotate">gimp_matrix3_rotate</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_matrix3_rotate                 (<link linkend="GimpMatrix3">GimpMatrix3</link> *matrix,
228
221
                                                         <link linkend="gdouble">gdouble</link> theta);</programlisting>
229
222
<para>
230
223
Rotates the matrix by theta degrees.</para>
231
224
<para>
232
 
 
233
225
</para><variablelist role="params">
234
 
<varlistentry><term><parameter>matrix</parameter>&nbsp;:</term>
 
226
<varlistentry><term><parameter>matrix</parameter>&#160;:</term>
235
227
<listitem><simpara> The matrix that is to be rotated.
236
228
</simpara></listitem></varlistentry>
237
 
<varlistentry><term><parameter>theta</parameter>&nbsp;:</term>
 
229
<varlistentry><term><parameter>theta</parameter>&#160;:</term>
238
230
<listitem><simpara> The angle of rotation (in radians).
239
231
</simpara></listitem></varlistentry>
240
232
</variablelist></refsect2>
241
233
<refsect2 id="gimp-matrix3-xshear" role="function">
242
234
<title>gimp_matrix3_xshear ()</title>
243
 
<indexterm zone="gimp-matrix3-xshear"><primary>gimp_matrix3_xshear</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_matrix3_xshear                 (<link linkend="GimpMatrix3">GimpMatrix3</link> *matrix,
 
235
<indexterm zone="gimp-matrix3-xshear"><primary sortas="gimp_matrix3_xshear">gimp_matrix3_xshear</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_matrix3_xshear                 (<link linkend="GimpMatrix3">GimpMatrix3</link> *matrix,
244
236
                                                         <link linkend="gdouble">gdouble</link> amount);</programlisting>
245
237
<para>
246
238
Shears the matrix in the X direction.</para>
247
239
<para>
248
 
 
249
240
</para><variablelist role="params">
250
 
<varlistentry><term><parameter>matrix</parameter>&nbsp;:</term>
 
241
<varlistentry><term><parameter>matrix</parameter>&#160;:</term>
251
242
<listitem><simpara> The matrix that is to be sheared.
252
243
</simpara></listitem></varlistentry>
253
 
<varlistentry><term><parameter>amount</parameter>&nbsp;:</term>
 
244
<varlistentry><term><parameter>amount</parameter>&#160;:</term>
254
245
<listitem><simpara> X shear amount.
255
246
</simpara></listitem></varlistentry>
256
247
</variablelist></refsect2>
257
248
<refsect2 id="gimp-matrix3-yshear" role="function">
258
249
<title>gimp_matrix3_yshear ()</title>
259
 
<indexterm zone="gimp-matrix3-yshear"><primary>gimp_matrix3_yshear</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_matrix3_yshear                 (<link linkend="GimpMatrix3">GimpMatrix3</link> *matrix,
 
250
<indexterm zone="gimp-matrix3-yshear"><primary sortas="gimp_matrix3_yshear">gimp_matrix3_yshear</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_matrix3_yshear                 (<link linkend="GimpMatrix3">GimpMatrix3</link> *matrix,
260
251
                                                         <link linkend="gdouble">gdouble</link> amount);</programlisting>
261
252
<para>
262
253
Shears the matrix in the Y direction.</para>
263
254
<para>
264
 
 
265
255
</para><variablelist role="params">
266
 
<varlistentry><term><parameter>matrix</parameter>&nbsp;:</term>
 
256
<varlistentry><term><parameter>matrix</parameter>&#160;:</term>
267
257
<listitem><simpara> The matrix that is to be sheared.
268
258
</simpara></listitem></varlistentry>
269
 
<varlistentry><term><parameter>amount</parameter>&nbsp;:</term>
 
259
<varlistentry><term><parameter>amount</parameter>&#160;:</term>
270
260
<listitem><simpara> Y shear amount.
271
261
</simpara></listitem></varlistentry>
272
262
</variablelist></refsect2>
273
263
<refsect2 id="gimp-matrix3-affine" role="function">
274
264
<title>gimp_matrix3_affine ()</title>
275
 
<indexterm zone="gimp-matrix3-affine"><primary>gimp_matrix3_affine</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_matrix3_affine                 (<link linkend="GimpMatrix3">GimpMatrix3</link> *matrix,
 
265
<indexterm zone="gimp-matrix3-affine"><primary sortas="gimp_matrix3_affine">gimp_matrix3_affine</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_matrix3_affine                 (<link linkend="GimpMatrix3">GimpMatrix3</link> *matrix,
276
266
                                                         <link linkend="gdouble">gdouble</link> a,
277
267
                                                         <link linkend="gdouble">gdouble</link> b,
278
268
                                                         <link linkend="gdouble">gdouble</link> c,
289
279
 ( b d f )
290
280
 ( 0 0 1 )</para>
291
281
<para>
292
 
 
293
282
</para><variablelist role="params">
294
 
<varlistentry><term><parameter>matrix</parameter>&nbsp;:</term>
 
283
<varlistentry><term><parameter>matrix</parameter>&#160;:</term>
295
284
<listitem><simpara> The input matrix.
296
285
</simpara></listitem></varlistentry>
297
 
<varlistentry><term><parameter>a</parameter>&nbsp;:</term>
298
 
<listitem><simpara>
299
 
</simpara></listitem></varlistentry>
300
 
<varlistentry><term><parameter>b</parameter>&nbsp;:</term>
301
 
<listitem><simpara>
302
 
</simpara></listitem></varlistentry>
303
 
<varlistentry><term><parameter>c</parameter>&nbsp;:</term>
304
 
<listitem><simpara>
305
 
</simpara></listitem></varlistentry>
306
 
<varlistentry><term><parameter>d</parameter>&nbsp;:</term>
307
 
<listitem><simpara>
308
 
</simpara></listitem></varlistentry>
309
 
<varlistentry><term><parameter>e</parameter>&nbsp;:</term>
310
 
<listitem><simpara>
311
 
</simpara></listitem></varlistentry>
312
 
<varlistentry><term><parameter>f</parameter>&nbsp;:</term>
 
286
<varlistentry><term><parameter>a</parameter>&#160;:</term>
 
287
<listitem><simpara>
 
288
</simpara></listitem></varlistentry>
 
289
<varlistentry><term><parameter>b</parameter>&#160;:</term>
 
290
<listitem><simpara>
 
291
</simpara></listitem></varlistentry>
 
292
<varlistentry><term><parameter>c</parameter>&#160;:</term>
 
293
<listitem><simpara>
 
294
</simpara></listitem></varlistentry>
 
295
<varlistentry><term><parameter>d</parameter>&#160;:</term>
 
296
<listitem><simpara>
 
297
</simpara></listitem></varlistentry>
 
298
<varlistentry><term><parameter>e</parameter>&#160;:</term>
 
299
<listitem><simpara>
 
300
</simpara></listitem></varlistentry>
 
301
<varlistentry><term><parameter>f</parameter>&#160;:</term>
313
302
<listitem><simpara>
314
303
</simpara></listitem></varlistentry>
315
304
</variablelist></refsect2>
316
305
<refsect2 id="gimp-matrix3-transform-point" role="function">
317
306
<title>gimp_matrix3_transform_point ()</title>
318
 
<indexterm zone="gimp-matrix3-transform-point"><primary>gimp_matrix3_transform_point</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_matrix3_transform_point        (const <link linkend="GimpMatrix3">GimpMatrix3</link> *matrix,
 
307
<indexterm zone="gimp-matrix3-transform-point"><primary sortas="gimp_matrix3_transform_point">gimp_matrix3_transform_point</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_matrix3_transform_point        (const <link linkend="GimpMatrix3">GimpMatrix3</link> *matrix,
319
308
                                                         <link linkend="gdouble">gdouble</link> x,
320
309
                                                         <link linkend="gdouble">gdouble</link> y,
321
310
                                                         <link linkend="gdouble">gdouble</link> *newx,
323
312
<para>
324
313
Transforms a point in 2D as specified by the transformation matrix.</para>
325
314
<para>
326
 
 
327
315
</para><variablelist role="params">
328
 
<varlistentry><term><parameter>matrix</parameter>&nbsp;:</term>
 
316
<varlistentry><term><parameter>matrix</parameter>&#160;:</term>
329
317
<listitem><simpara> The transformation matrix.
330
318
</simpara></listitem></varlistentry>
331
 
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
 
319
<varlistentry><term><parameter>x</parameter>&#160;:</term>
332
320
<listitem><simpara> The source X coordinate.
333
321
</simpara></listitem></varlistentry>
334
 
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
 
322
<varlistentry><term><parameter>y</parameter>&#160;:</term>
335
323
<listitem><simpara> The source Y coordinate.
336
324
</simpara></listitem></varlistentry>
337
 
<varlistentry><term><parameter>newx</parameter>&nbsp;:</term>
 
325
<varlistentry><term><parameter>newx</parameter>&#160;:</term>
338
326
<listitem><simpara> The transformed X coordinate.
339
327
</simpara></listitem></varlistentry>
340
 
<varlistentry><term><parameter>newy</parameter>&nbsp;:</term>
 
328
<varlistentry><term><parameter>newy</parameter>&#160;:</term>
341
329
<listitem><simpara> The transformed Y coordinate.
342
330
</simpara></listitem></varlistentry>
343
331
</variablelist></refsect2>
344
332
<refsect2 id="gimp-matrix3-determinant" role="function">
345
333
<title>gimp_matrix3_determinant ()</title>
346
 
<indexterm zone="gimp-matrix3-determinant"><primary>gimp_matrix3_determinant</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             gimp_matrix3_determinant            (const <link linkend="GimpMatrix3">GimpMatrix3</link> *matrix);</programlisting>
 
334
<indexterm zone="gimp-matrix3-determinant"><primary sortas="gimp_matrix3_determinant">gimp_matrix3_determinant</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             gimp_matrix3_determinant            (const <link linkend="GimpMatrix3">GimpMatrix3</link> *matrix);</programlisting>
347
335
<para>
348
336
Calculates the determinant of the given matrix.</para>
349
337
<para>
350
 
 
351
338
</para><variablelist role="params">
352
 
<varlistentry><term><parameter>matrix</parameter>&nbsp;:</term>
 
339
<varlistentry><term><parameter>matrix</parameter>&#160;:</term>
353
340
<listitem><simpara> The input matrix.
354
341
</simpara></listitem></varlistentry>
355
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The determinant.
 
342
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The determinant.
356
343
</simpara></listitem></varlistentry>
357
344
</variablelist></refsect2>
358
345
<refsect2 id="gimp-matrix3-invert" role="function">
359
346
<title>gimp_matrix3_invert ()</title>
360
 
<indexterm zone="gimp-matrix3-invert"><primary>gimp_matrix3_invert</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_matrix3_invert                 (<link linkend="GimpMatrix3">GimpMatrix3</link> *matrix);</programlisting>
 
347
<indexterm zone="gimp-matrix3-invert"><primary sortas="gimp_matrix3_invert">gimp_matrix3_invert</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_matrix3_invert                 (<link linkend="GimpMatrix3">GimpMatrix3</link> *matrix);</programlisting>
361
348
<para>
362
349
Inverts the given matrix.</para>
363
350
<para>
364
 
 
365
351
</para><variablelist role="params">
366
 
<varlistentry><term><parameter>matrix</parameter>&nbsp;:</term>
 
352
<varlistentry><term><parameter>matrix</parameter>&#160;:</term>
367
353
<listitem><simpara> The matrix that is to be inverted.
368
354
</simpara></listitem></varlistentry>
369
355
</variablelist></refsect2>
370
356
<refsect2 id="gimp-matrix3-is-identity" role="function">
371
357
<title>gimp_matrix3_is_identity ()</title>
372
 
<indexterm zone="gimp-matrix3-is-identity"><primary>gimp_matrix3_is_identity</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_matrix3_is_identity            (const <link linkend="GimpMatrix3">GimpMatrix3</link> *matrix);</programlisting>
 
358
<indexterm zone="gimp-matrix3-is-identity"><primary sortas="gimp_matrix3_is_identity">gimp_matrix3_is_identity</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_matrix3_is_identity            (const <link linkend="GimpMatrix3">GimpMatrix3</link> *matrix);</programlisting>
373
359
<para>
374
360
Checks if the given matrix is the identity matrix.</para>
375
361
<para>
376
 
 
377
362
</para><variablelist role="params">
378
 
<varlistentry><term><parameter>matrix</parameter>&nbsp;:</term>
 
363
<varlistentry><term><parameter>matrix</parameter>&#160;:</term>
379
364
<listitem><simpara> The matrix that is to be tested.
380
365
</simpara></listitem></varlistentry>
381
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the matrix is the identity matrix, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
 
366
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the matrix is the identity matrix, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
382
367
</simpara></listitem></varlistentry>
383
368
</variablelist></refsect2>
384
369
<refsect2 id="gimp-matrix3-is-diagonal" role="function">
385
370
<title>gimp_matrix3_is_diagonal ()</title>
386
 
<indexterm zone="gimp-matrix3-is-diagonal"><primary>gimp_matrix3_is_diagonal</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_matrix3_is_diagonal            (const <link linkend="GimpMatrix3">GimpMatrix3</link> *matrix);</programlisting>
 
371
<indexterm zone="gimp-matrix3-is-diagonal"><primary sortas="gimp_matrix3_is_diagonal">gimp_matrix3_is_diagonal</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_matrix3_is_diagonal            (const <link linkend="GimpMatrix3">GimpMatrix3</link> *matrix);</programlisting>
387
372
<para>
388
373
Checks if the given matrix is diagonal.</para>
389
374
<para>
390
 
 
391
375
</para><variablelist role="params">
392
 
<varlistentry><term><parameter>matrix</parameter>&nbsp;:</term>
 
376
<varlistentry><term><parameter>matrix</parameter>&#160;:</term>
393
377
<listitem><simpara> The matrix that is to be tested.
394
378
</simpara></listitem></varlistentry>
395
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the matrix is diagonal, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
 
379
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the matrix is diagonal, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
396
380
</simpara></listitem></varlistentry>
397
381
</variablelist></refsect2>
398
382
<refsect2 id="gimp-matrix3-is-affine" role="function" condition="since:GIMP 2.4">
399
383
<title>gimp_matrix3_is_affine ()</title>
400
 
<indexterm zone="gimp-matrix3-is-affine" role="GIMP 2.4"><primary>gimp_matrix3_is_affine</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_matrix3_is_affine              (const <link linkend="GimpMatrix3">GimpMatrix3</link> *matrix);</programlisting>
 
384
<indexterm zone="gimp-matrix3-is-affine" role="GIMP 2.4"><primary sortas="gimp_matrix3_is_affine">gimp_matrix3_is_affine</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_matrix3_is_affine              (const <link linkend="GimpMatrix3">GimpMatrix3</link> *matrix);</programlisting>
401
385
<para>
402
386
Checks if the given matrix defines an affine transformation.</para>
403
387
<para>
404
 
 
405
388
</para><variablelist role="params">
406
 
<varlistentry><term><parameter>matrix</parameter>&nbsp;:</term>
 
389
<varlistentry><term><parameter>matrix</parameter>&#160;:</term>
407
390
<listitem><simpara> The matrix that is to be tested.
408
391
</simpara></listitem></varlistentry>
409
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the matrix defines an affine transformation,
410
 
         <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
 
392
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the matrix defines an affine transformation,
 
393
         <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
411
394
 
412
395
</simpara></listitem></varlistentry>
413
 
</variablelist><para role="since">Since  GIMP 2.4
414
 
</para></refsect2>
 
396
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
415
397
<refsect2 id="gimp-matrix3-is-simple" role="function">
416
398
<title>gimp_matrix3_is_simple ()</title>
417
 
<indexterm zone="gimp-matrix3-is-simple"><primary>gimp_matrix3_is_simple</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_matrix3_is_simple              (const <link linkend="GimpMatrix3">GimpMatrix3</link> *matrix);</programlisting>
 
399
<indexterm zone="gimp-matrix3-is-simple"><primary sortas="gimp_matrix3_is_simple">gimp_matrix3_is_simple</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_matrix3_is_simple              (const <link linkend="GimpMatrix3">GimpMatrix3</link> *matrix);</programlisting>
418
400
<para>
419
401
Checks if we'll need to interpolate when applying this matrix as
420
402
a transformation.</para>
421
403
<para>
422
 
 
423
404
</para><variablelist role="params">
424
 
<varlistentry><term><parameter>matrix</parameter>&nbsp;:</term>
 
405
<varlistentry><term><parameter>matrix</parameter>&#160;:</term>
425
406
<listitem><simpara> The matrix that is to be tested.
426
407
</simpara></listitem></varlistentry>
427
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if all entries of the upper left 2x2 matrix are
428
 
         either 0 or 1, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
 
408
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if all entries of the upper left 2x2 matrix are
 
409
         either 0 or 1, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
429
410
</simpara></listitem></varlistentry>
430
411
</variablelist></refsect2>
431
412
<refsect2 id="gimp-matrix4-to-deg" role="function">
432
413
<title>gimp_matrix4_to_deg ()</title>
433
 
<indexterm zone="gimp-matrix4-to-deg"><primary>gimp_matrix4_to_deg</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_matrix4_to_deg                 (const <link linkend="GimpMatrix4">GimpMatrix4</link> *matrix,
 
414
<indexterm zone="gimp-matrix4-to-deg"><primary sortas="gimp_matrix4_to_deg">gimp_matrix4_to_deg</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_matrix4_to_deg                 (const <link linkend="GimpMatrix4">GimpMatrix4</link> *matrix,
434
415
                                                         <link linkend="gdouble">gdouble</link> *a,
435
416
                                                         <link linkend="gdouble">gdouble</link> *b,
436
417
                                                         <link linkend="gdouble">gdouble</link> *c);</programlisting>
437
418
<para>
438
419
</para>
439
420
<para>
440
 
 
441
421
</para><variablelist role="params">
442
 
<varlistentry><term><parameter>matrix</parameter>&nbsp;:</term>
443
 
<listitem><simpara>
444
 
</simpara></listitem></varlistentry>
445
 
<varlistentry><term><parameter>a</parameter>&nbsp;:</term>
446
 
<listitem><simpara>
447
 
</simpara></listitem></varlistentry>
448
 
<varlistentry><term><parameter>b</parameter>&nbsp;:</term>
449
 
<listitem><simpara>
450
 
</simpara></listitem></varlistentry>
451
 
<varlistentry><term><parameter>c</parameter>&nbsp;:</term>
 
422
<varlistentry><term><parameter>matrix</parameter>&#160;:</term>
 
423
<listitem><simpara>
 
424
</simpara></listitem></varlistentry>
 
425
<varlistentry><term><parameter>a</parameter>&#160;:</term>
 
426
<listitem><simpara>
 
427
</simpara></listitem></varlistentry>
 
428
<varlistentry><term><parameter>b</parameter>&#160;:</term>
 
429
<listitem><simpara>
 
430
</simpara></listitem></varlistentry>
 
431
<varlistentry><term><parameter>c</parameter>&#160;:</term>
452
432
<listitem><simpara>
453
433
</simpara></listitem></varlistentry>
454
434
</variablelist></refsect2>
455
 
<refsect2 id="GIMP-TYPE-MATRIX2:CAPS" role="macro">
 
435
<refsect2 id="GIMP-TYPE-MATRIX2--CAPS" role="macro">
456
436
<title>GIMP_TYPE_MATRIX2</title>
457
 
<indexterm zone="GIMP-TYPE-MATRIX2:CAPS"><primary>GIMP_TYPE_MATRIX2</primary></indexterm><programlisting>#define GIMP_TYPE_MATRIX2               (gimp_matrix2_get_type ())
 
437
<indexterm zone="GIMP-TYPE-MATRIX2--CAPS"><primary sortas="GIMP_TYPE_MATRIX2">GIMP_TYPE_MATRIX2</primary></indexterm><programlisting>#define GIMP_TYPE_MATRIX2               (gimp_matrix2_get_type ())
458
438
</programlisting>
459
439
<para>
460
 
 
461
440
</para></refsect2>
462
 
<refsect2 id="GIMP-TYPE-PARAM-MATRIX2:CAPS" role="macro">
 
441
<refsect2 id="GIMP-TYPE-PARAM-MATRIX2--CAPS" role="macro">
463
442
<title>GIMP_TYPE_PARAM_MATRIX2</title>
464
 
<indexterm zone="GIMP-TYPE-PARAM-MATRIX2:CAPS"><primary>GIMP_TYPE_PARAM_MATRIX2</primary></indexterm><programlisting>#define GIMP_TYPE_PARAM_MATRIX2            (gimp_param_matrix2_get_type ())
 
443
<indexterm zone="GIMP-TYPE-PARAM-MATRIX2--CAPS"><primary sortas="GIMP_TYPE_PARAM_MATRIX2">GIMP_TYPE_PARAM_MATRIX2</primary></indexterm><programlisting>#define GIMP_TYPE_PARAM_MATRIX2            (gimp_param_matrix2_get_type ())
465
444
</programlisting>
466
445
<para>
467
 
 
468
446
</para></refsect2>
469
 
<refsect2 id="GIMP-IS-PARAM-SPEC-MATRIX2:CAPS" role="macro">
 
447
<refsect2 id="GIMP-IS-PARAM-SPEC-MATRIX2--CAPS" role="macro">
470
448
<title>GIMP_IS_PARAM_SPEC_MATRIX2()</title>
471
 
<indexterm zone="GIMP-IS-PARAM-SPEC-MATRIX2:CAPS"><primary>GIMP_IS_PARAM_SPEC_MATRIX2</primary></indexterm><programlisting>#define GIMP_IS_PARAM_SPEC_MATRIX2(pspec)  (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), GIMP_TYPE_PARAM_MATRIX2))
 
449
<indexterm zone="GIMP-IS-PARAM-SPEC-MATRIX2--CAPS"><primary sortas="GIMP_IS_PARAM_SPEC_MATRIX2">GIMP_IS_PARAM_SPEC_MATRIX2</primary></indexterm><programlisting>#define GIMP_IS_PARAM_SPEC_MATRIX2(pspec)  (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), GIMP_TYPE_PARAM_MATRIX2))
472
450
</programlisting>
473
451
<para>
474
 
 
475
452
</para><variablelist role="params">
476
 
<varlistentry><term><parameter>pspec</parameter>&nbsp;:</term>
 
453
<varlistentry><term><parameter>pspec</parameter>&#160;:</term>
477
454
<listitem><simpara>
478
 
 
479
 
 
480
455
</simpara></listitem></varlistentry>
481
456
</variablelist></refsect2>
482
457
<refsect2 id="gimp-param-spec-matrix2" role="function" condition="since:GIMP 2.4">
483
458
<title>gimp_param_spec_matrix2 ()</title>
484
 
<indexterm zone="gimp-param-spec-matrix2" role="GIMP 2.4"><primary>gimp_param_spec_matrix2</primary></indexterm><programlisting><link linkend="GParamSpec">GParamSpec</link>*         gimp_param_spec_matrix2             (const <link linkend="gchar">gchar</link> *name,
 
459
<indexterm zone="gimp-param-spec-matrix2" role="GIMP 2.4"><primary sortas="gimp_param_spec_matrix2">gimp_param_spec_matrix2</primary></indexterm><programlisting><link linkend="GParamSpec">GParamSpec</link> *        gimp_param_spec_matrix2             (const <link linkend="gchar">gchar</link> *name,
485
460
                                                         const <link linkend="gchar">gchar</link> *nick,
486
461
                                                         const <link linkend="gchar">gchar</link> *blurb,
487
462
                                                         const <link linkend="GimpMatrix2">GimpMatrix2</link> *default_value,
490
465
Creates a param spec to hold a <link linkend="GimpMatrix2"><type>GimpMatrix2</type></link> value.
491
466
See <link linkend="g-param-spec-internal"><function>g_param_spec_internal()</function></link> for more information.</para>
492
467
<para>
493
 
 
494
468
</para><variablelist role="params">
495
 
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
469
<varlistentry><term><parameter>name</parameter>&#160;:</term>
496
470
<listitem><simpara>          Canonical name of the param
497
471
</simpara></listitem></varlistentry>
498
 
<varlistentry><term><parameter>nick</parameter>&nbsp;:</term>
 
472
<varlistentry><term><parameter>nick</parameter>&#160;:</term>
499
473
<listitem><simpara>          Nickname of the param
500
474
</simpara></listitem></varlistentry>
501
 
<varlistentry><term><parameter>blurb</parameter>&nbsp;:</term>
 
475
<varlistentry><term><parameter>blurb</parameter>&#160;:</term>
502
476
<listitem><simpara>         Brief desciption of param.
503
477
</simpara></listitem></varlistentry>
504
 
<varlistentry><term><parameter>default_value</parameter>&nbsp;:</term>
 
478
<varlistentry><term><parameter>default_value</parameter>&#160;:</term>
505
479
<listitem><simpara> Value to use if none is assigned.
506
480
</simpara></listitem></varlistentry>
507
 
<varlistentry><term><parameter>flags</parameter>&nbsp;:</term>
 
481
<varlistentry><term><parameter>flags</parameter>&#160;:</term>
508
482
<listitem><simpara>         a combination of <link linkend="GParamFlags"><type>GParamFlags</type></link>
509
483
</simpara></listitem></varlistentry>
510
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a newly allocated <link linkend="GParamSpec"><type>GParamSpec</type></link> instance
 
484
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a newly allocated <link linkend="GParamSpec"><type>GParamSpec</type></link> instance
511
485
 
512
486
</simpara></listitem></varlistentry>
513
 
</variablelist><para role="since">Since  GIMP 2.4
514
 
</para></refsect2>
515
 
<refsect2 id="GIMP-VALUE-HOLDS-MATRIX2:CAPS" role="macro">
 
487
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
 
488
<refsect2 id="GIMP-VALUE-HOLDS-MATRIX2--CAPS" role="macro">
516
489
<title>GIMP_VALUE_HOLDS_MATRIX2()</title>
517
 
<indexterm zone="GIMP-VALUE-HOLDS-MATRIX2:CAPS"><primary>GIMP_VALUE_HOLDS_MATRIX2</primary></indexterm><programlisting>#define GIMP_VALUE_HOLDS_MATRIX2(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_MATRIX2))
 
490
<indexterm zone="GIMP-VALUE-HOLDS-MATRIX2--CAPS"><primary sortas="GIMP_VALUE_HOLDS_MATRIX2">GIMP_VALUE_HOLDS_MATRIX2</primary></indexterm><programlisting>#define GIMP_VALUE_HOLDS_MATRIX2(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_MATRIX2))
518
491
</programlisting>
519
492
<para>
520
 
 
521
493
</para><variablelist role="params">
522
 
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
 
494
<varlistentry><term><parameter>value</parameter>&#160;:</term>
523
495
<listitem><simpara>
524
 
 
525
 
 
526
496
</simpara></listitem></varlistentry>
527
497
</variablelist></refsect2>
528
498