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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimppixelrgn</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-image.html" title="Manupulating Images and all their Properties">
<link rel="prev" href="libgimp-gimppixelfetcher.html" title="gimppixelfetcher">
<link rel="next" href="libgimp-gimpregioniterator.html" title="gimpregioniterator">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gimpdefinitions.html" title="Part I. GIMP Constants">
<link rel="part" href="libgimp.html" title="Part II. GIMP Library">
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and all their Properties">
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
<link rel="part" href="libgimpui.html" title="Part III. GIMP User Interface Library">
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libgimp-gimppixelfetcher.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimp-image.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Library Reference Manual</th>
<td><a accesskey="n" href="libgimp-gimpregioniterator.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2549209" class="shortcut">Top</a>
 | 
<a href="#id2601236" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimp-gimppixelrgn"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2549209"></a><span class="refentrytitle">gimppixelrgn</span>
</h2>
<p>gimppixelrgn — Functions for operating on pixel regions.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
<a href="libgimp-gimppixelrgn.html#GimpPixelRgn">GimpPixelRgn</a>;
void <a href="libgimp-gimppixelrgn.html#gimp-pixel-rgn-init">gimp_pixel_rgn_init</a> (<a href="libgimp-gimppixelrgn.html#GimpPixelRgn">GimpPixelRgn</a> *pr,
<a href="libgimp-gimpdrawable.html#GimpDrawable">GimpDrawable</a> *drawable,
gint x,
gint y,
gint width,
gint height,
gint dirty,
gint shadow);
void <a href="libgimp-gimppixelrgn.html#gimp-pixel-rgn-resize">gimp_pixel_rgn_resize</a> (<a href="libgimp-gimppixelrgn.html#GimpPixelRgn">GimpPixelRgn</a> *pr,
gint x,
gint y,
gint width,
gint height);
void <a href="libgimp-gimppixelrgn.html#gimp-pixel-rgn-get-pixel">gimp_pixel_rgn_get_pixel</a> (<a href="libgimp-gimppixelrgn.html#GimpPixelRgn">GimpPixelRgn</a> *pr,
guchar *buf,
gint x,
gint y);
void <a href="libgimp-gimppixelrgn.html#gimp-pixel-rgn-get-row">gimp_pixel_rgn_get_row</a> (<a href="libgimp-gimppixelrgn.html#GimpPixelRgn">GimpPixelRgn</a> *pr,
guchar *buf,
gint x,
gint y,
gint width);
void <a href="libgimp-gimppixelrgn.html#gimp-pixel-rgn-get-col">gimp_pixel_rgn_get_col</a> (<a href="libgimp-gimppixelrgn.html#GimpPixelRgn">GimpPixelRgn</a> *pr,
guchar *buf,
gint x,
gint y,
gint height);
void <a href="libgimp-gimppixelrgn.html#gimp-pixel-rgn-get-rect">gimp_pixel_rgn_get_rect</a> (<a href="libgimp-gimppixelrgn.html#GimpPixelRgn">GimpPixelRgn</a> *pr,
guchar *buf,
gint x,
gint y,
gint width,
gint height);
void <a href="libgimp-gimppixelrgn.html#gimp-pixel-rgn-set-pixel">gimp_pixel_rgn_set_pixel</a> (<a href="libgimp-gimppixelrgn.html#GimpPixelRgn">GimpPixelRgn</a> *pr,
const guchar *buf,
gint x,
gint y);
void <a href="libgimp-gimppixelrgn.html#gimp-pixel-rgn-set-row">gimp_pixel_rgn_set_row</a> (<a href="libgimp-gimppixelrgn.html#GimpPixelRgn">GimpPixelRgn</a> *pr,
const guchar *buf,
gint x,
gint y,
gint width);
void <a href="libgimp-gimppixelrgn.html#gimp-pixel-rgn-set-col">gimp_pixel_rgn_set_col</a> (<a href="libgimp-gimppixelrgn.html#GimpPixelRgn">GimpPixelRgn</a> *pr,
const guchar *buf,
gint x,
gint y,
gint height);
void <a href="libgimp-gimppixelrgn.html#gimp-pixel-rgn-set-rect">gimp_pixel_rgn_set_rect</a> (<a href="libgimp-gimppixelrgn.html#GimpPixelRgn">GimpPixelRgn</a> *pr,
const guchar *buf,
gint x,
gint y,
gint width,
gint height);
gpointer <a href="libgimp-gimppixelrgn.html#gimp-pixel-rgns-register">gimp_pixel_rgns_register</a> (gint nrgns,
...);
gpointer <a href="libgimp-gimppixelrgn.html#gimp-pixel-rgns-register2">gimp_pixel_rgns_register2</a> (gint nrgns,
<a href="libgimp-gimppixelrgn.html#GimpPixelRgn">GimpPixelRgn</a> **prs);
gpointer <a href="libgimp-gimppixelrgn.html#gimp-pixel-rgns-process">gimp_pixel_rgns_process</a> (gpointer pri_ptr);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2601236"></a><h2>Description</h2>
<p>
Functions for operating on pixel regions. These functions provide
fast ways of accessing and modifying portions of a drawable.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2601254"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2601265"></a><h3>
<a name="GimpPixelRgn"></a>GimpPixelRgn</h3>
<a class="indexterm" name="id2601277"></a><pre class="programlisting">typedef struct {
guchar *data; /* pointer to region data */
GimpDrawable *drawable; /* pointer to drawable */
guint bpp; /* bytes per pixel */
guint rowstride; /* bytes per pixel row */
guint x, y; /* origin */
guint w, h; /* width and height of region */
guint dirty : 1; /* will this region be dirtied? */
guint shadow : 1; /* will this region use the shadow or normal tiles */
guint process_count; /* used internally */
} GimpPixelRgn;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2575586"></a><h3>
<a name="gimp-pixel-rgn-init"></a>gimp_pixel_rgn_init ()</h3>
<a class="indexterm" name="id2550652"></a><pre class="programlisting">void gimp_pixel_rgn_init (<a href="libgimp-gimppixelrgn.html#GimpPixelRgn">GimpPixelRgn</a> *pr,
<a href="libgimp-gimpdrawable.html#GimpDrawable">GimpDrawable</a> *drawable,
gint x,
gint y,
gint width,
gint height,
gint dirty,
gint shadow);</pre>
<p>
Initialize the pixel region pointed by <em class="parameter"><code>pr</code></em> with the specified parameters.
</p>
<p>
The <em class="parameter"><code>dirty</code></em> and <em class="parameter"><code>shadow</code></em> flags can be used as follows:
</p>
<p>
- <em class="parameter"><code>dirty</code></em> = FALSE, <em class="parameter"><code>shadow</code></em> = FALSE: the region will be used to read
the actual drawable datas. This
is useful for save plug-ins or for
filters.
</p>
<p>
- <em class="parameter"><code>dirty</code></em> = FALSE, <em class="parameter"><code>shadow</code></em> = TRUE: the region will be used to read the
shadow tiles. This is used in
some filter plug-ins which operate
in two passes such as gaussian
blur. The first pass reads the
actual drawable data and writes to
the shadow tiles, and the second
one reads from and writes to the
shadow tiles.
</p>
<p>
- <em class="parameter"><code>dirty</code></em> = TRUE, <em class="parameter"><code>shadow</code></em> = TRUE: the region will be used to write to
the shadow tiles. It is common
practice to write to the shadow
tiles and then use
#<a href="libgimp-gimpdrawable.html#gimp-drawable-merge-shadow"><code class="function">gimp_drawable_merge_shadow()</code></a> to
merge the changes from the shadow
tiles using the current selection
as a mask.
</p>
<p>
- <em class="parameter"><code>dirty</code></em> = TRUE, <em class="parameter"><code>shadow</code></em> = FALSE: the region will be used to directly
change the drawable content. Don't
do this, since this could prevent
the Undo-System from working as
expected.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>pr</code></em> :</span></td>
<td> a pointer to a <a href="libgimp-gimppixelrgn.html#GimpPixelRgn"><span class="type">GimpPixelRgn</span></a> variable.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>drawable</code></em> :</span></td>
<td> the <a href="libgimp-gimpdrawable.html#GimpDrawable"><span class="type">GimpDrawable</span></a> the new region will be attached to.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>x</code></em> :</span></td>
<td> the x coordinate of the top-left pixel of the region in the
<em class="parameter"><code>drawable</code></em>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>y</code></em> :</span></td>
<td> the y coordinate of the top-left pixel of the region in the
<em class="parameter"><code>drawable</code></em>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>width</code></em> :</span></td>
<td> the width of the region.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>height</code></em> :</span></td>
<td> the height of the region.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>dirty</code></em> :</span></td>
<td> a <span class="type">gboolean</span> indicating whether the <em class="parameter"><code>drawable</code></em> should be marked
as "dirty".
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>shadow</code></em> :</span></td>
<td> a <span class="type">gboolean</span> indicating whether the region is attached to the
shadow tiles or the real <em class="parameter"><code>drawable</code></em> tiles.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602881"></a><h3>
<a name="gimp-pixel-rgn-resize"></a>gimp_pixel_rgn_resize ()</h3>
<a class="indexterm" name="id2602892"></a><pre class="programlisting">void gimp_pixel_rgn_resize (<a href="libgimp-gimppixelrgn.html#GimpPixelRgn">GimpPixelRgn</a> *pr,
gint x,
gint y,
gint width,
gint height);</pre>
<p>
Change the position and size of a previously initialized pixel region.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>pr</code></em> :</span></td>
<td> a pointer to a previously initialized <a href="libgimp-gimppixelrgn.html#GimpPixelRgn"><span class="type">GimpPixelRgn</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>x</code></em> :</span></td>
<td> the x coordinate of the new position of the region's
top-left corner.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>y</code></em> :</span></td>
<td> the y coordinate of the new position of the region's
top-left corner.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>width</code></em> :</span></td>
<td> the new width of the region.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>height</code></em> :</span></td>
<td> the new height of the region.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2619845"></a><h3>
<a name="gimp-pixel-rgn-get-pixel"></a>gimp_pixel_rgn_get_pixel ()</h3>
<a class="indexterm" name="id2619856"></a><pre class="programlisting">void gimp_pixel_rgn_get_pixel (<a href="libgimp-gimppixelrgn.html#GimpPixelRgn">GimpPixelRgn</a> *pr,
guchar *buf,
gint x,
gint y);</pre>
<p>
Fill the buffer pointed by <em class="parameter"><code>buf</code></em> with the value of the pixel at (<em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>)
in the region <em class="parameter"><code>pr</code></em>. <em class="parameter"><code>buf</code></em> should be large enough to hold the pixel value
(1 <span class="type">guchar</span> for an indexed or grayscale drawable, 2 <span class="type">guchar</span> for
indexed with alpha or grayscale with alpha drawable, 3 <span class="type">guchar</span> for
rgb drawable and 4 <span class="type">guchar</span> for rgb with alpha drawable.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>pr</code></em> :</span></td>
<td> a pointer to a previously initialized <a href="libgimp-gimppixelrgn.html#GimpPixelRgn"><span class="type">GimpPixelRgn</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>buf</code></em> :</span></td>
<td> a pointer to an array of <span class="type">guchar</span>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>x</code></em> :</span></td>
<td> the x coordinate of the wanted pixel (relative to the drawable)
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>y</code></em> :</span></td>
<td> the y coordinate of the wanted pixel (relative to the drawable)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2620026"></a><h3>
<a name="gimp-pixel-rgn-get-row"></a>gimp_pixel_rgn_get_row ()</h3>
<a class="indexterm" name="id2620036"></a><pre class="programlisting">void gimp_pixel_rgn_get_row (<a href="libgimp-gimppixelrgn.html#GimpPixelRgn">GimpPixelRgn</a> *pr,
guchar *buf,
gint x,
gint y,
gint width);</pre>
<p>
Get several pixels of a region in a row. This function fills the buffer
<em class="parameter"><code>buf</code></em> with the values of the pixels from (<em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>) to (<em class="parameter"><code>x</code></em>+<em class="parameter"><code>width</code></em>-1, <em class="parameter"><code>y</code></em>).
<em class="parameter"><code>buf</code></em> should be large enough to hold all these values.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>pr</code></em> :</span></td>
<td> a pointer to a previously initialized <a href="libgimp-gimppixelrgn.html#GimpPixelRgn"><span class="type">GimpPixelRgn</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>buf</code></em> :</span></td>
<td> a pointer to an array of <span class="type">guchar</span>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>x</code></em> :</span></td>
<td> the x coordinate of the first pixel (relative to the drawable).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>y</code></em> :</span></td>
<td> the y coordinate of the first pixel (relative to the drawable).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>width</code></em> :</span></td>
<td> the number of pixels to get.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2620211"></a><h3>
<a name="gimp-pixel-rgn-get-col"></a>gimp_pixel_rgn_get_col ()</h3>
<a class="indexterm" name="id2620221"></a><pre class="programlisting">void gimp_pixel_rgn_get_col (<a href="libgimp-gimppixelrgn.html#GimpPixelRgn">GimpPixelRgn</a> *pr,
guchar *buf,
gint x,
gint y,
gint height);</pre>
<p>
Get several pixels of a region's column. This function fills the buffer
<em class="parameter"><code>buf</code></em> with the values of the pixels from (<em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>) to (<em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>+<em class="parameter"><code>height</code></em>-1).
<em class="parameter"><code>buf</code></em> should be large enough to hold all these values.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>pr</code></em> :</span></td>
<td> a pointer to a previously initialized <a href="libgimp-gimppixelrgn.html#GimpPixelRgn"><span class="type">GimpPixelRgn</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>buf</code></em> :</span></td>
<td> a pointer to an array of <span class="type">guchar</span>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>x</code></em> :</span></td>
<td> the x coordinate of the first pixel (relative to the drawable).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>y</code></em> :</span></td>
<td> the y coordinate of the first pixel (relative to the drawable).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>height</code></em> :</span></td>
<td> the number of pixels to get.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2620396"></a><h3>
<a name="gimp-pixel-rgn-get-rect"></a>gimp_pixel_rgn_get_rect ()</h3>
<a class="indexterm" name="id2620406"></a><pre class="programlisting">void gimp_pixel_rgn_get_rect (<a href="libgimp-gimppixelrgn.html#GimpPixelRgn">GimpPixelRgn</a> *pr,
guchar *buf,
gint x,
gint y,
gint width,
gint height);</pre>
<p>
Get all the pixel values from the rectangle defined by <em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>, <em class="parameter"><code>width</code></em> and
<em class="parameter"><code>height</code></em>. This function fills the buffer <em class="parameter"><code>buf</code></em> with the values of the pixels
from (<em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>) to (<em class="parameter"><code>x</code></em>+<em class="parameter"><code>width</code></em>-1, <em class="parameter"><code>y</code></em>+<em class="parameter"><code>height</code></em>-1).
<em class="parameter"><code>buf</code></em> should be large enough to hold all these values (<em class="parameter"><code>width</code></em>*<em class="parameter"><code>height</code></em>*bpp).</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>pr</code></em> :</span></td>
<td> a pointer to a previously initialized <a href="libgimp-gimppixelrgn.html#GimpPixelRgn"><span class="type">GimpPixelRgn</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>buf</code></em> :</span></td>
<td> a pointer to an array of <span class="type">guchar</span>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>x</code></em> :</span></td>
<td> the x coordinate of the first pixel (relative to the drawable).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>y</code></em> :</span></td>
<td> the y coordinate of the first pixel (relative to the drawable).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>width</code></em> :</span></td>
<td> the width of the rectangle.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>height</code></em> :</span></td>
<td> the height of the rectangle.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2620636"></a><h3>
<a name="gimp-pixel-rgn-set-pixel"></a>gimp_pixel_rgn_set_pixel ()</h3>
<a class="indexterm" name="id2620646"></a><pre class="programlisting">void gimp_pixel_rgn_set_pixel (<a href="libgimp-gimppixelrgn.html#GimpPixelRgn">GimpPixelRgn</a> *pr,
const guchar *buf,
gint x,
gint y);</pre>
<p>
Set the pixel at (<em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>) to the values from <em class="parameter"><code>buf</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>pr</code></em> :</span></td>
<td> a pointer to a previously initialized <a href="libgimp-gimppixelrgn.html#GimpPixelRgn"><span class="type">GimpPixelRgn</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>buf</code></em> :</span></td>
<td> a pointer to an array of <span class="type">guchar</span>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>x</code></em> :</span></td>
<td> the x coordinate of the pixel (relative to the drawable).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>y</code></em> :</span></td>
<td> the y coordinate of the pixel (relative to the drawable).
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2620778"></a><h3>
<a name="gimp-pixel-rgn-set-row"></a>gimp_pixel_rgn_set_row ()</h3>
<a class="indexterm" name="id2620788"></a><pre class="programlisting">void gimp_pixel_rgn_set_row (<a href="libgimp-gimppixelrgn.html#GimpPixelRgn">GimpPixelRgn</a> *pr,
const guchar *buf,
gint x,
gint y,
gint width);</pre>
<p>
Set several pixels of a region in a row. This function draws the pixels
from (<em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>) to (<em class="parameter"><code>x</code></em>+<em class="parameter"><code>width</code></em>-1, <em class="parameter"><code>y</code></em>) using the values of the buffer <em class="parameter"><code>buf</code></em>.
<em class="parameter"><code>buf</code></em> should be large enough to hold all these values.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>pr</code></em> :</span></td>
<td> a pointer to a previously initialized <a href="libgimp-gimppixelrgn.html#GimpPixelRgn"><span class="type">GimpPixelRgn</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>buf</code></em> :</span></td>
<td> a pointer to an array of <span class="type">guchar</span>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>x</code></em> :</span></td>
<td> the x coordinate of the first pixel (relative to the drawable).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>y</code></em> :</span></td>
<td> the y coordinate of the first pixel (relative to the drawable).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>width</code></em> :</span></td>
<td> the number of pixels to set.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2620964"></a><h3>
<a name="gimp-pixel-rgn-set-col"></a>gimp_pixel_rgn_set_col ()</h3>
<a class="indexterm" name="id2620975"></a><pre class="programlisting">void gimp_pixel_rgn_set_col (<a href="libgimp-gimppixelrgn.html#GimpPixelRgn">GimpPixelRgn</a> *pr,
const guchar *buf,
gint x,
gint y,
gint height);</pre>
<p>
Set several pixels of a region's column. This function draws the pixels
from (<em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>) to (<em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>+<em class="parameter"><code>height</code></em>-1) using the values from the buffer <em class="parameter"><code>buf</code></em>.
<em class="parameter"><code>buf</code></em> should be large enough to hold all these values.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>pr</code></em> :</span></td>
<td> a pointer to a previously initialized <a href="libgimp-gimppixelrgn.html#GimpPixelRgn"><span class="type">GimpPixelRgn</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>buf</code></em> :</span></td>
<td> a pointer to an array of <span class="type">guchar</span>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>x</code></em> :</span></td>
<td> the x coordinate of the first pixel (relative to the drawable).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>y</code></em> :</span></td>
<td> the y coordinate of the first pixel (relative to the drawable).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>height</code></em> :</span></td>
<td> the number of pixels to set.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2621151"></a><h3>
<a name="gimp-pixel-rgn-set-rect"></a>gimp_pixel_rgn_set_rect ()</h3>
<a class="indexterm" name="id2621161"></a><pre class="programlisting">void gimp_pixel_rgn_set_rect (<a href="libgimp-gimppixelrgn.html#GimpPixelRgn">GimpPixelRgn</a> *pr,
const guchar *buf,
gint x,
gint y,
gint width,
gint height);</pre>
<p>
Set all the pixel of the rectangle defined by <em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>, <em class="parameter"><code>width</code></em> and
<em class="parameter"><code>height</code></em>. This function draws the rectangle from (<em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>) to
(<em class="parameter"><code>x</code></em>+<em class="parameter"><code>width</code></em>-1, <em class="parameter"><code>y</code></em>+<em class="parameter"><code>height</code></em>-1), using the pixel values from the buffer <em class="parameter"><code>buf</code></em>.
<em class="parameter"><code>buf</code></em> should be large enough to hold all these values (<em class="parameter"><code>width</code></em>*<em class="parameter"><code>height</code></em>*bpp).</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>pr</code></em> :</span></td>
<td> a pointer to a previously initialized <a href="libgimp-gimppixelrgn.html#GimpPixelRgn"><span class="type">GimpPixelRgn</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>buf</code></em> :</span></td>
<td> a pointer to an array of <span class="type">guchar</span>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>x</code></em> :</span></td>
<td> the x coordinate of the first pixel (relative to the drawable).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>y</code></em> :</span></td>
<td> the y coordinate of the first pixel (relative to the drawable).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>width</code></em> :</span></td>
<td> the width of the rectangle.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>height</code></em> :</span></td>
<td> the height of the rectangle.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2621394"></a><h3>
<a name="gimp-pixel-rgns-register"></a>gimp_pixel_rgns_register ()</h3>
<a class="indexterm" name="id2621404"></a><pre class="programlisting">gpointer gimp_pixel_rgns_register (gint nrgns,
...);</pre>
<p>
This is the varargs version of <a href="libgimp-gimppixelrgn.html#gimp-pixel-rgns-register2"><span class="type">gimp_pixel_rgns_register2</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>nrgns</code></em> :</span></td>
<td> the number of regions to register.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>...</code></em> :</span></td>
<td> <em class="parameter"><code>nrgns</code></em> pointers to <a href="libgimp-gimppixelrgn.html#GimpPixelRgn"><span class="type">GimpPixelRgn</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a <span class="type">gpointer</span> to a regions iterator.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2621497"></a><h3>
<a name="gimp-pixel-rgns-register2"></a>gimp_pixel_rgns_register2 ()</h3>
<a class="indexterm" name="id2621508"></a><pre class="programlisting">gpointer gimp_pixel_rgns_register2 (gint nrgns,
<a href="libgimp-gimppixelrgn.html#GimpPixelRgn">GimpPixelRgn</a> **prs);</pre>
<p>
It takes a number of initialized regions of the same size and provides a
pixel region iterator the iterator can be used to iterate over the
registered pixel regions. While iterating the registered pixel regions will
cover subsets of the original pixel regions, chosen for optimized access to
the image data.
</p>
<p>
Note that the given regions themselves are changed by this function, so
they are resized to the first subsets.
</p>
<p>
This function has to be used together with gimp_pixel_rgns_process in a loop.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>nrgns</code></em> :</span></td>
<td> the number of regions to register.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>prs</code></em> :</span></td>
<td> an array of <em class="parameter"><code>nrgns</code></em> pointers to initialized <a href="libgimp-gimppixelrgn.html#GimpPixelRgn"><span class="type">GimpPixelRgn</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a <span class="type">gpointer</span> to a regions iterator.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2621614"></a><h3>
<a name="gimp-pixel-rgns-process"></a>gimp_pixel_rgns_process ()</h3>
<a class="indexterm" name="id2621624"></a><pre class="programlisting">gpointer gimp_pixel_rgns_process (gpointer pri_ptr);</pre>
<p>
This function update the regions registered previously with one of the
<a href="libgimp-gimppixelrgn.html#gimp-pixel-rgns-register"><span class="type">gimp_pixel_rgns_register</span></a>* functions to their next tile.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>pri_ptr</code></em> :</span></td>
<td> a regions iterator returned by <a href="libgimp-gimppixelrgn.html#gimp-pixel-rgns-register"><span class="type">gimp_pixel_rgns_register</span></a>,
<a href="libgimp-gimppixelrgn.html#gimp-pixel-rgns-register2"><span class="type">gimp_pixel_rgns_register2</span></a> or <a href="libgimp-gimppixelrgn.html#gimp-pixel-rgns-process"><span class="type">gimp_pixel_rgns_process</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a <span class="type">gpointer</span> to a new regions iterator or <span class="type">NULL</span> if there isn't
any tiles left.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>
|
