-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathGdkPixbuf-2.0.d.ts
2519 lines (2448 loc) · 98.7 KB
/
GdkPixbuf-2.0.d.ts
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
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/** Generated with https://github.com/Gr3q/GIR2TS - If possible do not modify. */
declare namespace imports.gi.GdkPixbuf {
/** This construct is only for enabling class multi-inheritance,
* use {@link Pixbuf} instead.
*/
interface IPixbuf {
/**
* The number of bits per sample.
*
* Currently only 8 bit per sample are supported.
*/
bits_per_sample: number;
/**
* The color space of the pixbuf.
*
* Currently, only `GDK_COLORSPACE_RGB` is supported.
*/
colorspace: Colorspace;
/**
* Whether the pixbuf has an alpha channel.
*/
has_alpha: boolean;
/**
* The number of rows of the pixbuf.
*/
height: number;
/**
* The number of samples per pixel.
*
* Currently, only 3 or 4 samples per pixel are supported.
*/
n_channels: number;
pixel_bytes: GLib.Bytes;
/**
* A pointer to the pixel data of the pixbuf.
*/
pixels: any;
/**
* The number of bytes between the start of a row and
* the start of the next row.
*
* This number must (obviously) be at least as large as the
* width of the pixbuf.
*/
rowstride: number;
/**
* The number of columns of the pixbuf.
*/
width: number;
/**
* Takes an existing pixbuf and adds an alpha channel to it.
*
* If the existing pixbuf already had an alpha channel, the channel
* values are copied from the original; otherwise, the alpha channel
* is initialized to 255 (full opacity).
*
* If `substitute_color` is `TRUE`, then the color specified by the
* (`r`, `g`, `b`) arguments will be assigned zero opacity. That is,
* if you pass `(255, 255, 255)` for the substitute color, all white
* pixels will become fully transparent.
*
* If `substitute_color` is `FALSE`, then the (`r`, `g`, `b`) arguments
* will be ignored.
* @param substitute_color Whether to set a color to zero opacity.
* @param r Red value to substitute.
* @param g Green value to substitute.
* @param b Blue value to substitute.
* @returns A newly-created pixbuf
*/
add_alpha(substitute_color: boolean, r: number, g: number, b: number): Pixbuf;
/**
* Takes an existing pixbuf and checks for the presence of an
* associated "orientation" option.
*
* The orientation option may be provided by the JPEG loader (which
* reads the exif orientation tag) or the TIFF loader (which reads
* the TIFF orientation tag, and compensates it for the partial
* transforms performed by libtiff).
*
* If an orientation option/tag is present, the appropriate transform
* will be performed so that the pixbuf is oriented correctly.
* @returns A newly-created pixbuf
*/
apply_embedded_orientation(): Pixbuf | null;
/**
* Creates a transformation of the source image #src by scaling by
* #scale_x and #scale_y then translating by #offset_x and #offset_y.
*
* This gives an image in the coordinates of the destination pixbuf.
* The rectangle (#dest_x, #dest_y, #dest_width, #dest_height)
* is then alpha blended onto the corresponding rectangle of the
* original destination image.
*
* When the destination rectangle contains parts not in the source
* image, the data at the edges of the source image is replicated
* to infinity.
*
* ![](composite.png)
* @param dest the #GdkPixbuf into which to render the results
* @param dest_x the left coordinate for region to render
* @param dest_y the top coordinate for region to render
* @param dest_width the width of the region to render
* @param dest_height the height of the region to render
* @param offset_x the offset in the X direction (currently rounded to an integer)
* @param offset_y the offset in the Y direction (currently rounded to an integer)
* @param scale_x the scale factor in the X direction
* @param scale_y the scale factor in the Y direction
* @param interp_type the interpolation type for the transformation.
* @param overall_alpha overall alpha for source image (0..255)
*/
composite(dest: Pixbuf, dest_x: number, dest_y: number, dest_width: number, dest_height: number, offset_x: number, offset_y: number, scale_x: number, scale_y: number, interp_type: InterpType, overall_alpha: number): void;
/**
* Creates a transformation of the source image #src by scaling by
* #scale_x and #scale_y then translating by #offset_x and #offset_y,
* then alpha blends the rectangle (#dest_x ,#dest_y, #dest_width,
* #dest_height) of the resulting image with a checkboard of the
* colors #color1 and #color2 and renders it onto the destination
* image.
*
* If the source image has no alpha channel, and #overall_alpha is 255, a fast
* path is used which omits the alpha blending and just performs the scaling.
*
* See {@link GdkPixbuf.composite_color_simple} for a simpler variant of this
* function suitable for many tasks.
* @param dest the #GdkPixbuf into which to render the results
* @param dest_x the left coordinate for region to render
* @param dest_y the top coordinate for region to render
* @param dest_width the width of the region to render
* @param dest_height the height of the region to render
* @param offset_x the offset in the X direction (currently rounded to an integer)
* @param offset_y the offset in the Y direction (currently rounded to an integer)
* @param scale_x the scale factor in the X direction
* @param scale_y the scale factor in the Y direction
* @param interp_type the interpolation type for the transformation.
* @param overall_alpha overall alpha for source image (0..255)
* @param check_x the X offset for the checkboard (origin of checkboard is at -#check_x, -#check_y)
* @param check_y the Y offset for the checkboard
* @param check_size the size of checks in the checkboard (must be a power of two)
* @param color1 the color of check at upper left
* @param color2 the color of the other check
*/
composite_color(dest: Pixbuf, dest_x: number, dest_y: number, dest_width: number, dest_height: number, offset_x: number, offset_y: number, scale_x: number, scale_y: number, interp_type: InterpType, overall_alpha: number, check_x: number, check_y: number, check_size: number, color1: number, color2: number): void;
/**
* Creates a new pixbuf by scaling `src` to `dest_width` x `dest_height`
* and alpha blending the result with a checkboard of colors `color1`
* and `color2`.
* @param dest_width the width of destination image
* @param dest_height the height of destination image
* @param interp_type the interpolation type for the transformation.
* @param overall_alpha overall alpha for source image (0..255)
* @param check_size the size of checks in the checkboard (must be a power of two)
* @param color1 the color of check at upper left
* @param color2 the color of the other check
* @returns the new pixbuf
*/
composite_color_simple(dest_width: number, dest_height: number, interp_type: InterpType, overall_alpha: number, check_size: number, color1: number, color2: number): Pixbuf | null;
/**
* Creates a new `GdkPixbuf` with a copy of the information in the specified
* `pixbuf`.
*
* Note that this does not copy the options set on the original `GdkPixbuf`,
* use {@link GdkPixbuf.copy_options} for this.
* @returns A newly-created pixbuf
*/
copy(): Pixbuf | null;
/**
* Copies a rectangular area from `src_pixbuf` to `dest_pixbuf`.
*
* Conversion of pixbuf formats is done automatically.
*
* If the source rectangle overlaps the destination rectangle on the
* same pixbuf, it will be overwritten during the copy operation.
* Therefore, you can not use this function to scroll a pixbuf.
* @param src_x Source X coordinate within #src_pixbuf.
* @param src_y Source Y coordinate within #src_pixbuf.
* @param width Width of the area to copy.
* @param height Height of the area to copy.
* @param dest_pixbuf Destination pixbuf.
* @param dest_x X coordinate within #dest_pixbuf.
* @param dest_y Y coordinate within #dest_pixbuf.
*/
copy_area(src_x: number, src_y: number, width: number, height: number, dest_pixbuf: Pixbuf, dest_x: number, dest_y: number): void;
/**
* Copies the key/value pair options attached to a `GdkPixbuf` to another
* `GdkPixbuf`.
*
* This is useful to keep original metadata after having manipulated
* a file. However be careful to remove metadata which you've already
* applied, such as the "orientation" option after rotating the image.
* @param dest_pixbuf the destination pixbuf
* @returns `TRUE` on success.
*/
copy_options(dest_pixbuf: Pixbuf): boolean;
/**
* Clears a pixbuf to the given RGBA value, converting the RGBA value into
* the pixbuf's pixel format.
*
* The alpha component will be ignored if the pixbuf doesn't have an alpha
* channel.
* @param pixel RGBA pixel to used to clear (`0xffffffff` is opaque white,
* `0x00000000` transparent black)
*/
fill(pixel: number): void;
/**
* Flips a pixbuf horizontally or vertically and returns the
* result in a new pixbuf.
* @param horizontal `TRUE` to flip horizontally, `FALSE` to flip vertically
* @returns the new pixbuf
*/
flip(horizontal: boolean): Pixbuf | null;
/**
* Queries the number of bits per color sample in a pixbuf.
* @returns Number of bits per color sample.
*/
get_bits_per_sample(): number;
/**
* Returns the length of the pixel data, in bytes.
* @returns The length of the pixel data.
*/
get_byte_length(): number;
/**
* Queries the color space of a pixbuf.
* @returns Color space.
*/
get_colorspace(): Colorspace;
/**
* Queries whether a pixbuf has an alpha channel (opacity information).
* @returns `TRUE` if it has an alpha channel, `FALSE` otherwise.
*/
get_has_alpha(): boolean;
/**
* Queries the height of a pixbuf.
* @returns Height in pixels.
*/
get_height(): number;
/**
* Queries the number of channels of a pixbuf.
* @returns Number of channels.
*/
get_n_channels(): number;
/**
* Looks up #key in the list of options that may have been attached to the
* #pixbuf when it was loaded, or that may have been attached by another
* function using {@link GdkPixbuf.set_option}.
*
* For instance, the ANI loader provides "Title" and "Artist" options.
* The ICO, XBM, and XPM loaders provide "x_hot" and "y_hot" hot-spot
* options for cursor definitions. The PNG loader provides the tEXt ancillary
* chunk key/value pairs as options. Since 2.12, the TIFF and JPEG loaders
* return an "orientation" option string that corresponds to the embedded
* TIFF/Exif orientation tag (if present). Since 2.32, the TIFF loader sets
* the "multipage" option string to "yes" when a multi-page TIFF is loaded.
* Since 2.32 the JPEG and PNG loaders set "x-dpi" and "y-dpi" if the file
* contains image density information in dots per inch.
* Since 2.36.6, the JPEG loader sets the "comment" option with the comment
* EXIF tag.
* @param key a nul-terminated string.
* @returns the value associated with `key`
*/
get_option(key: string): string | null;
/**
* Returns a `GHashTable` with a list of all the options that may have been
* attached to the `pixbuf` when it was loaded, or that may have been
* attached by another function using [method#GdkPixbuf.Pixbuf.set_option].
* @returns a #GHashTable
* of key/values pairs
*/
get_options(): string[];
/**
* Queries a pointer to the pixel data of a pixbuf.
*
* This function will cause an implicit copy of the pixbuf data if the
* pixbuf was created from read-only data.
*
* Please see the section on [image data](class.Pixbuf.html#image-data) for information
* about how the pixel data is stored in memory.
* @returns A pointer to the pixbuf's
* pixel data.
*
* The length of the binary data.
*/
get_pixels(): [ number[], number ];
/**
* Queries the rowstride of a pixbuf, which is the number of bytes between
* the start of a row and the start of the next row.
* @returns Distance between row starts.
*/
get_rowstride(): number;
/**
* Queries the width of a pixbuf.
* @returns Width in pixels.
*/
get_width(): number;
/**
* Creates a new pixbuf which represents a sub-region of `src_pixbuf`.
*
* The new pixbuf shares its pixels with the original pixbuf, so
* writing to one affects both. The new pixbuf holds a reference to
* `src_pixbuf`, so `src_pixbuf` will not be finalized until the new
* pixbuf is finalized.
*
* Note that if `src_pixbuf` is read-only, this function will force it
* to be mutable.
* @param src_x X coord in #src_pixbuf
* @param src_y Y coord in #src_pixbuf
* @param width width of region in #src_pixbuf
* @param height height of region in #src_pixbuf
* @returns a new pixbuf
*/
new_subpixbuf(src_x: number, src_y: number, width: number, height: number): Pixbuf;
/**
* Provides a #GBytes buffer containing the raw pixel data; the data
* must not be modified.
*
* This function allows skipping the implicit copy that must be made
* if {@link GdkPixbuf.get_pixels} is called on a read-only pixbuf.
* @returns A new reference to a read-only copy of
* the pixel data. Note that for mutable pixbufs, this function will
* incur a one-time copy of the pixel data for conversion into the
* returned #GBytes.
*/
read_pixel_bytes(): GLib.Bytes;
/**
* Provides a read-only pointer to the raw pixel data.
*
* This function allows skipping the implicit copy that must be made
* if {@link GdkPixbuf.get_pixels} is called on a read-only pixbuf.
* @returns a read-only pointer to the raw pixel data
*/
read_pixels(): number;
/**
* Removes the key/value pair option attached to a `GdkPixbuf`.
* @param key a nul-terminated string representing the key to remove.
* @returns `TRUE` if an option was removed, `FALSE` if not.
*/
remove_option(key: string): boolean;
/**
* Rotates a pixbuf by a multiple of 90 degrees, and returns the
* result in a new pixbuf.
*
* If `angle` is 0, this function will return a copy of `src`.
* @param angle the angle to rotate by
* @returns the new pixbuf
*/
rotate_simple(angle: PixbufRotation): Pixbuf | null;
/**
* Modifies saturation and optionally pixelates `src`, placing the result in
* `dest`.
*
* The `src` and `dest` pixbufs must have the same image format, size, and
* rowstride.
*
* The `src` and `dest` arguments may be the same pixbuf with no ill effects.
*
* If `saturation` is 1.0 then saturation is not changed. If it's less than 1.0,
* saturation is reduced (the image turns toward grayscale); if greater than
* 1.0, saturation is increased (the image gets more vivid colors).
*
* If `pixelate` is `TRUE`, then pixels are faded in a checkerboard pattern to
* create a pixelated image.
* @param dest place to write modified version of #src
* @param saturation saturation factor
* @param pixelate whether to pixelate
*/
saturate_and_pixelate(dest: Pixbuf, saturation: number, pixelate: boolean): void;
/**
* Vector version of {@link `gdk.pixbuf_save_to_buffer}`.
*
* Saves pixbuf to a new buffer in format #type, which is currently "jpeg",
* "tiff", "png", "ico" or "bmp".
*
* See [method#GdkPixbuf.Pixbuf.save_to_buffer] for more details.
* @param type name of file format.
* @param option_keys name of options to set
* @param option_values values for named options
* @returns whether an error was set
*
*
* location to receive a pointer to the new buffer.
*/
save_to_bufferv(type: string, option_keys?: string[] | null, option_values?: string[] | null): [ boolean, number[] ];
/**
* Vector version of {@link `gdk.pixbuf_save_to_callback}`.
*
* Saves pixbuf to a callback in format #type, which is currently "jpeg",
* "png", "tiff", "ico" or "bmp".
*
* If #error is set, `FALSE` will be returned.
*
* See [method#GdkPixbuf.Pixbuf.save_to_callback] for more details.
* @param save_func a function that is called to save each block of data that
* the save routine generates.
* @param type name of file format.
* @param option_keys name of options to set
* @param option_values values for named options
* @returns whether an error was set
*/
save_to_callbackv(save_func: PixbufSaveFunc, type: string, option_keys?: string[] | null, option_values?: string[] | null): boolean;
/**
* Saves `pixbuf` to an output stream.
*
* Supported file formats are currently "jpeg", "tiff", "png", "ico" or
* "bmp".
*
* See [method#GdkPixbuf.Pixbuf.save_to_stream] for more details.
* @param stream a `GOutputStream` to save the pixbuf to
* @param type name of file format
* @param option_keys name of options to set
* @param option_values values for named options
* @param cancellable optional `GCancellable` object, `NULL` to ignore
* @returns `TRUE` if the pixbuf was saved successfully, `FALSE` if an
* error was set.
*/
save_to_streamv(stream: Gio.OutputStream, type: string, option_keys?: string[] | null, option_values?: string[] | null, cancellable?: Gio.Cancellable | null): boolean;
/**
* Saves `pixbuf` to an output stream asynchronously.
*
* For more details see {@link GdkPixbuf.save_to_streamv}, which is the synchronous
* version of this function.
*
* When the operation is finished, `callback` will be called in the main thread.
*
* You can then call gdk_pixbuf_save_to_stream_finish() to get the result of
* the operation.
* @param stream a `GOutputStream` to which to save the pixbuf
* @param type name of file format
* @param option_keys name of options to set
* @param option_values values for named options
* @param cancellable optional `GCancellable` object, `NULL` to ignore
* @param callback a `GAsyncReadyCallback` to call when the pixbuf is saved
*/
save_to_streamv_async(stream: Gio.OutputStream, type: string, option_keys?: string[] | null, option_values?: string[] | null, cancellable?: Gio.Cancellable | null, callback?: Gio.AsyncReadyCallback | null): void;
/**
* Vector version of {@link `gdk.pixbuf_save}`.
*
* Saves pixbuf to a file in `type`, which is currently "jpeg", "png", "tiff", "ico" or "bmp".
*
* If #error is set, `FALSE` will be returned.
*
* See [method#GdkPixbuf.Pixbuf.save] for more details.
* @param filename name of file to save.
* @param type name of file format.
* @param option_keys name of options to set
* @param option_values values for named options
* @returns whether an error was set
*/
savev(filename: string, type: string, option_keys?: string[] | null, option_values?: string[] | null): boolean;
/**
* Creates a transformation of the source image #src by scaling by
* #scale_x and #scale_y then translating by #offset_x and #offset_y,
* then renders the rectangle (#dest_x, #dest_y, #dest_width,
* #dest_height) of the resulting image onto the destination image
* replacing the previous contents.
*
* Try to use {@link GdkPixbuf.scale_simple} first; this function is
* the industrial-strength power tool you can fall back to, if
* gdk_pixbuf_scale_simple() isn't powerful enough.
*
* If the source rectangle overlaps the destination rectangle on the
* same pixbuf, it will be overwritten during the scaling which
* results in rendering artifacts.
* @param dest the #GdkPixbuf into which to render the results
* @param dest_x the left coordinate for region to render
* @param dest_y the top coordinate for region to render
* @param dest_width the width of the region to render
* @param dest_height the height of the region to render
* @param offset_x the offset in the X direction (currently rounded to an integer)
* @param offset_y the offset in the Y direction (currently rounded to an integer)
* @param scale_x the scale factor in the X direction
* @param scale_y the scale factor in the Y direction
* @param interp_type the interpolation type for the transformation.
*/
scale(dest: Pixbuf, dest_x: number, dest_y: number, dest_width: number, dest_height: number, offset_x: number, offset_y: number, scale_x: number, scale_y: number, interp_type: InterpType): void;
/**
* Create a new pixbuf containing a copy of `src` scaled to
* `dest_width` x `dest_height`.
*
* This function leaves `src` unaffected.
*
* The `interp_type` should be `GDK_INTERP_NEAREST` if you want maximum
* speed (but when scaling down `GDK_INTERP_NEAREST` is usually unusably
* ugly). The default `interp_type` should be `GDK_INTERP_BILINEAR` which
* offers reasonable quality and speed.
*
* You can scale a sub-portion of `src` by creating a sub-pixbuf
* pointing into `src`; see [method#GdkPixbuf.Pixbuf.new_subpixbuf].
*
* If `dest_width` and `dest_height` are equal to the width and height of
* `src`, this function will return an unscaled copy of `src`.
*
* For more complicated scaling/alpha blending see [method#GdkPixbuf.Pixbuf.scale]
* and [method#GdkPixbuf.Pixbuf.composite].
* @param dest_width the width of destination image
* @param dest_height the height of destination image
* @param interp_type the interpolation type for the transformation.
* @returns the new pixbuf
*/
scale_simple(dest_width: number, dest_height: number, interp_type: InterpType): Pixbuf | null;
/**
* Attaches a key/value pair as an option to a `GdkPixbuf`.
*
* If `key` already exists in the list of options attached to the `pixbuf`,
* the new value is ignored and `FALSE` is returned.
* @param key a nul-terminated string.
* @param value a nul-terminated string.
* @returns `TRUE` on success
*/
set_option(key: string, value: string): boolean;
connect(signal: "notify::bits-per-sample", callback: (owner: this, ...args: any) => void): number;
connect(signal: "notify::colorspace", callback: (owner: this, ...args: any) => void): number;
connect(signal: "notify::has-alpha", callback: (owner: this, ...args: any) => void): number;
connect(signal: "notify::height", callback: (owner: this, ...args: any) => void): number;
connect(signal: "notify::n-channels", callback: (owner: this, ...args: any) => void): number;
connect(signal: "notify::pixel-bytes", callback: (owner: this, ...args: any) => void): number;
connect(signal: "notify::pixels", callback: (owner: this, ...args: any) => void): number;
connect(signal: "notify::rowstride", callback: (owner: this, ...args: any) => void): number;
connect(signal: "notify::width", callback: (owner: this, ...args: any) => void): number;
}
type PixbufInitOptionsMixin = GObject.ObjectInitOptions & Gio.IconInitOptions & Gio.LoadableIconInitOptions &
Pick<IPixbuf,
"bits_per_sample" |
"colorspace" |
"has_alpha" |
"height" |
"n_channels" |
"pixel_bytes" |
"pixels" |
"rowstride" |
"width">;
export interface PixbufInitOptions extends PixbufInitOptionsMixin {}
/** This construct is only for enabling class multi-inheritance,
* use {@link Pixbuf} instead.
*/
type PixbufMixin = IPixbuf & GObject.Object & Gio.Icon & Gio.LoadableIcon;
/**
* A pixel buffer.
*
* `GdkPixbuf` contains information about an image's pixel data,
* its color space, bits per sample, width and height, and the
* rowstride (the number of bytes between the start of one row
* and the start of the next).
*
* ## Creating new `GdkPixbuf`
*
* The most basic way to create a pixbuf is to wrap an existing pixel
* buffer with a [class#GdkPixbuf.Pixbuf] instance. You can use the
* [`ctor#GdkPixbuf.Pixbuf.new_from_data`] function to do this.
*
* Every time you create a new `GdkPixbuf` instance for some data, you
* will need to specify the destroy notification function that will be
* called when the data buffer needs to be freed; this will happen when
* a `GdkPixbuf` is finalized by the reference counting functions. If
* you have a chunk of static data compiled into your application, you
* can pass in `NULL` as the destroy notification function so that the
* data will not be freed.
*
* The [`ctor#GdkPixbuf.Pixbuf.new`] constructor function can be used
* as a convenience to create a pixbuf with an empty buffer; this is
* equivalent to allocating a data buffer using `malloc()` and then
* wrapping it with `gdk_pixbuf_new_from_data()`. The `gdk_pixbuf_new()`
* function will compute an optimal rowstride so that rendering can be
* performed with an efficient algorithm.
*
* As a special case, you can use the [`ctor#GdkPixbuf.Pixbuf.new_from_xpm_data`]
* function to create a pixbuf from inline XPM image data.
*
* You can also copy an existing pixbuf with the [method#Pixbuf.copy]
* function. This is not the same as just acquiring a reference to
* the old pixbuf instance: the copy function will actually duplicate
* the pixel data in memory and create a new [class#Pixbuf] instance
* for it.
*
* ## Reference counting
*
* `GdkPixbuf` structures are reference counted. This means that an
* application can share a single pixbuf among many parts of the
* code. When a piece of the program needs to use a pixbuf, it should
* acquire a reference to it by calling `g_object_ref()`; when it no
* longer needs the pixbuf, it should release the reference it acquired
* by calling `g_object_unref()`. The resources associated with a
* `GdkPixbuf` will be freed when its reference count drops to zero.
* Newly-created `GdkPixbuf` instances start with a reference count
* of one.
*
* ## Image Data
*
* Image data in a pixbuf is stored in memory in an uncompressed,
* packed format. Rows in the image are stored top to bottom, and
* in each row pixels are stored from left to right.
*
* There may be padding at the end of a row.
*
* The "rowstride" value of a pixbuf, as returned by [`method#GdkPixbuf.Pixbuf.get_rowstride`],
* indicates the number of bytes between rows.
*
* **NOTE**: If you are copying raw pixbuf data with `memcpy()` note that the
* last row in the pixbuf may not be as wide as the full rowstride, but rather
* just as wide as the pixel data needs to be; that is: it is unsafe to do
* `memcpy (dest, pixels, rowstride * height)` to copy a whole pixbuf. Use
* [method#GdkPixbuf.Pixbuf.copy] instead, or compute the width in bytes of the
* last row as:
*
* ```c
* last_row = width * ((n_channels * bits_per_sample + 7) / 8);
* ```
*
* The same rule applies when iterating over each row of a `GdkPixbuf` pixels
* array.
*
* The following code illustrates a simple `put_pixel()`
* function for RGB pixbufs with 8 bits per channel with an alpha
* channel.
*
* ```c
* static void
* put_pixel (GdkPixbuf *pixbuf,
* int x,
* int y,
* guchar red,
* guchar green,
* guchar blue,
* guchar alpha)
* {
* int n_channels = gdk_pixbuf_get_n_channels (pixbuf);
*
* // Ensure that the pixbuf is valid
* g_assert (gdk_pixbuf_get_colorspace (pixbuf) == GDK_COLORSPACE_RGB);
* g_assert (gdk_pixbuf_get_bits_per_sample (pixbuf) == 8);
* g_assert (gdk_pixbuf_get_has_alpha (pixbuf));
* g_assert (n_channels == 4);
*
* int width = gdk_pixbuf_get_width (pixbuf);
* int height = gdk_pixbuf_get_height (pixbuf);
*
* // Ensure that the coordinates are in a valid range
* g_assert (x >= 0 && x < width);
* g_assert (y >= 0 && y < height);
*
* int rowstride = gdk_pixbuf_get_rowstride (pixbuf);
*
* // The pixel buffer in the GdkPixbuf instance
* guchar *pixels = gdk_pixbuf_get_pixels (pixbuf);
*
* // The pixel we wish to modify
* guchar *p = pixels + y * rowstride + x * n_channels;
* p[0] = red;
* p[1] = green;
* p[2] = blue;
* p[3] = alpha;
* }
* ```
*
* ## Loading images
*
* The `GdkPixBuf` class provides a simple mechanism for loading
* an image from a file in synchronous and asynchronous fashion.
*
* For GUI applications, it is recommended to use the asynchronous
* stream API to avoid blocking the control flow of the application.
*
* Additionally, `GdkPixbuf` provides the [class#GdkPixbuf.PixbufLoader`]
* API for progressive image loading.
*
* ## Saving images
*
* The `GdkPixbuf` class provides methods for saving image data in
* a number of file formats. The formatted data can be written to a
* file or to a memory buffer. `GdkPixbuf` can also call a user-defined
* callback on the data, which allows to e.g. write the image
* to a socket or store it in a database.
*/
interface Pixbuf extends PixbufMixin {}
class Pixbuf {
public constructor(options?: Partial<PixbufInitOptions>);
/**
* Creates a new `GdkPixbuf` structure and allocates a buffer for it.
*
* If the allocation of the buffer failed, this function will return `NULL`.
*
* The buffer has an optimal rowstride. Note that the buffer is not cleared;
* you will have to fill it completely yourself.
* @param colorspace Color space for image
* @param has_alpha Whether the image should have transparency information
* @param bits_per_sample Number of bits per color sample
* @param width Width of image in pixels, must be > 0
* @param height Height of image in pixels, must be > 0
* @returns A newly-created pixel buffer
*/
public static new(colorspace: Colorspace, has_alpha: boolean, bits_per_sample: number, width: number, height: number): Pixbuf | null;
/**
* Creates a new #GdkPixbuf out of in-memory readonly image data.
*
* Currently only RGB images with 8 bits per sample are supported.
*
* This is the `GBytes` variant of {@link GdkPixbuf.new_from_data}, useful
* for language bindings.
* @param data Image data in 8-bit/sample packed format inside a #GBytes
* @param colorspace Colorspace for the image data
* @param has_alpha Whether the data has an opacity channel
* @param bits_per_sample Number of bits per sample
* @param width Width of the image in pixels, must be > 0
* @param height Height of the image in pixels, must be > 0
* @param rowstride Distance in bytes between row starts
* @returns A newly-created pixbuf
*/
public static new_from_bytes(data: GLib.Bytes, colorspace: Colorspace, has_alpha: boolean, bits_per_sample: number, width: number, height: number, rowstride: number): Pixbuf;
/**
* Creates a new #GdkPixbuf out of in-memory image data.
*
* Currently only RGB images with 8 bits per sample are supported.
*
* Since you are providing a pre-allocated pixel buffer, you must also
* specify a way to free that data. This is done with a function of
* type `GdkPixbufDestroyNotify`. When a pixbuf created with is
* finalized, your destroy notification function will be called, and
* it is its responsibility to free the pixel array.
*
* See also: [ctor#GdkPixbuf.Pixbuf.new_from_bytes]
* @param data Image data in 8-bit/sample packed format
* @param colorspace Colorspace for the image data
* @param has_alpha Whether the data has an opacity channel
* @param bits_per_sample Number of bits per sample
* @param width Width of the image in pixels, must be > 0
* @param height Height of the image in pixels, must be > 0
* @param rowstride Distance in bytes between row starts
* @param destroy_fn Function used to free the data when the pixbuf's reference count
* drops to zero, or %NULL if the data should not be freed
* @returns A newly-created pixbuf
*/
public static new_from_data(data: number[], colorspace: Colorspace, has_alpha: boolean, bits_per_sample: number, width: number, height: number, rowstride: number, destroy_fn?: PixbufDestroyNotify | null): Pixbuf;
/**
* Creates a new pixbuf by loading an image from a file.
*
* The file format is detected automatically.
*
* If `NULL` is returned, then #error will be set. Possible errors are:
*
* - the file could not be opened
* - there is no loader for the file's format
* - there is not enough memory to allocate the image buffer
* - the image buffer contains invalid data
*
* The error domains are `GDK_PIXBUF_ERROR` and `G_FILE_ERROR`.
* @param filename Name of file to load, in the GLib file
* name encoding
* @returns A newly-created pixbuf
*/
public static new_from_file(filename: string): Pixbuf | null;
/**
* Creates a new pixbuf by loading an image from a file.
*
* The file format is detected automatically.
*
* If `NULL` is returned, then #error will be set. Possible errors are:
*
* - the file could not be opened
* - there is no loader for the file's format
* - there is not enough memory to allocate the image buffer
* - the image buffer contains invalid data
*
* The error domains are `GDK_PIXBUF_ERROR` and `G_FILE_ERROR`.
*
* The image will be scaled to fit in the requested size, optionally preserving
* the image's aspect ratio.
*
* When preserving the aspect ratio, a `width` of -1 will cause the image
* to be scaled to the exact given height, and a `height` of -1 will cause
* the image to be scaled to the exact given width. When not preserving
* aspect ratio, a `width` or `height` of -1 means to not scale the image
* at all in that dimension. Negative values for `width` and `height` are
* allowed since 2.8.
* @param filename Name of file to load, in the GLib file
* name encoding
* @param width The width the image should have or -1 to not constrain the width
* @param height The height the image should have or -1 to not constrain the height
* @param preserve_aspect_ratio `TRUE` to preserve the image's aspect ratio
* @returns A newly-created pixbuf
*/
public static new_from_file_at_scale(filename: string, width: number, height: number, preserve_aspect_ratio: boolean): Pixbuf | null;
/**
* Creates a new pixbuf by loading an image from a file.
*
* The file format is detected automatically.
*
* If `NULL` is returned, then #error will be set. Possible errors are:
*
* - the file could not be opened
* - there is no loader for the file's format
* - there is not enough memory to allocate the image buffer
* - the image buffer contains invalid data
*
* The error domains are `GDK_PIXBUF_ERROR` and `G_FILE_ERROR`.
*
* The image will be scaled to fit in the requested size, preserving
* the image's aspect ratio. Note that the returned pixbuf may be smaller
* than `width` x `height`, if the aspect ratio requires it. To load
* and image at the requested size, regardless of aspect ratio, use
* [ctor#GdkPixbuf.Pixbuf.new_from_file_at_scale].
* @param filename Name of file to load, in the GLib file
* name encoding
* @param width The width the image should have or -1 to not constrain the width
* @param height The height the image should have or -1 to not constrain the height
* @returns A newly-created pixbuf
*/
public static new_from_file_at_size(filename: string, width: number, height: number): Pixbuf | null;
/**
* @deprecated
* Use `GResource` instead.
*
* Creates a `GdkPixbuf` from a flat representation that is suitable for
* storing as inline data in a program.
*
* This is useful if you want to ship a program with images, but don't want
* to depend on any external files.
*
* GdkPixbuf ships with a program called `gdk-pixbuf-csource`, which allows
* for conversion of `GdkPixbuf`s into such a inline representation.
*
* In almost all cases, you should pass the `--raw` option to
* `gdk-pixbuf-csource`. A sample invocation would be:
*
* ```
* gdk-pixbuf-csource --raw --name=myimage_inline myimage.png
* ```
*
* For the typical case where the inline pixbuf is read-only static data,
* you don't need to copy the pixel data unless you intend to write to
* it, so you can pass `FALSE` for `copy_pixels`. If you pass `--rle` to
* `gdk-pixbuf-csource`, a copy will be made even if `copy_pixels` is `FALSE`,
* so using this option is generally a bad idea.
*
* If you create a pixbuf from const inline data compiled into your
* program, it's probably safe to ignore errors and disable length checks,
* since things will always succeed:
*
* ```c
* pixbuf = gdk_pixbuf_new_from_inline (-1, myimage_inline, FALSE, NULL);
* ```
*
* For non-const inline data, you could get out of memory. For untrusted
* inline data located at runtime, you could have corrupt inline data in
* addition.
* @param data Byte data containing a
* serialized `GdkPixdata` structure
* @param copy_pixels Whether to copy the pixel data, or use direct pointers
* `data` for the resulting pixbuf
* @returns A newly-created pixbuf
*/
public static new_from_inline(data: number[], copy_pixels: boolean): Pixbuf;
/**
* Creates a new pixbuf by loading an image from an resource.
*
* The file format is detected automatically. If `NULL` is returned, then
* #error will be set.
* @param resource_path the path of the resource file
* @returns A newly-created pixbuf
*/
public static new_from_resource(resource_path: string): Pixbuf | null;
/**
* Creates a new pixbuf by loading an image from an resource.
*
* The file format is detected automatically. If `NULL` is returned, then
* #error will be set.
*
* The image will be scaled to fit in the requested size, optionally
* preserving the image's aspect ratio. When preserving the aspect ratio,
* a #width of -1 will cause the image to be scaled to the exact given
* height, and a #height of -1 will cause the image to be scaled to the
* exact given width. When not preserving aspect ratio, a #width or
* #height of -1 means to not scale the image at all in that dimension.
*
* The stream is not closed.
* @param resource_path the path of the resource file
* @param width The width the image should have or -1 to not constrain the width
* @param height The height the image should have or -1 to not constrain the height
* @param preserve_aspect_ratio `TRUE` to preserve the image's aspect ratio
* @returns A newly-created pixbuf
*/
public static new_from_resource_at_scale(resource_path: string, width: number, height: number, preserve_aspect_ratio: boolean): Pixbuf | null;
/**
* Creates a new pixbuf by loading an image from an input stream.
*
* The file format is detected automatically.
*
* If `NULL` is returned, then `error` will be set.
*
* The `cancellable` can be used to abort the operation from another thread.
* If the operation was cancelled, the error `G_IO_ERROR_CANCELLED` will be
* returned. Other possible errors are in the `GDK_PIXBUF_ERROR` and
* `G_IO_ERROR` domains.
*
* The stream is not closed.
* @param stream a `GInputStream` to load the pixbuf from
* @param cancellable optional `GCancellable` object, `NULL` to ignore
* @returns A newly-created pixbuf
*/
public static new_from_stream(stream: Gio.InputStream, cancellable?: Gio.Cancellable | null): Pixbuf | null;
/**
* Creates a new pixbuf by loading an image from an input stream.
*
* The file format is detected automatically. If `NULL` is returned, then
* #error will be set. The #cancellable can be used to abort the operation
* from another thread. If the operation was cancelled, the error
* `G_IO_ERROR_CANCELLED` will be returned. Other possible errors are in
* the `GDK_PIXBUF_ERROR` and `G_IO_ERROR` domains.
*
* The image will be scaled to fit in the requested size, optionally
* preserving the image's aspect ratio.
*
* When preserving the aspect ratio, a `width` of -1 will cause the image to be
* scaled to the exact given height, and a `height` of -1 will cause the image
* to be scaled to the exact given width. If both `width` and `height` are
* given, this function will behave as if the smaller of the two values
* is passed as -1.
*
* When not preserving aspect ratio, a `width` or `height` of -1 means to not
* scale the image at all in that dimension.
*
* The stream is not closed.
* @param stream a `GInputStream` to load the pixbuf from
* @param width The width the image should have or -1 to not constrain the width
* @param height The height the image should have or -1 to not constrain the height
* @param preserve_aspect_ratio `TRUE` to preserve the image's aspect ratio
* @param cancellable optional `GCancellable` object, `NULL` to ignore
* @returns A newly-created pixbuf
*/
public static new_from_stream_at_scale(stream: Gio.InputStream, width: number, height: number, preserve_aspect_ratio: boolean, cancellable?: Gio.Cancellable | null): Pixbuf | null;
/**
* Finishes an asynchronous pixbuf creation operation started with
* {@link GdkPixbuf.new_from_stream_async}.
* @param async_result a `GAsyncResult`
* @returns the newly created pixbuf
*/
public static new_from_stream_finish(async_result: Gio.AsyncResult): Pixbuf | null;
/**
* Creates a new pixbuf by parsing XPM data in memory.
*
* This data is commonly the result of including an XPM file into a
* program's C source.
* @param data Pointer to inline XPM data.
* @returns A newly-created pixbuf
*/
public static new_from_xpm_data(data: string[]): Pixbuf;
/**
* Calculates the rowstride that an image created with those values would
* have.
*
* This function is useful for front-ends and backends that want to check
* image values without needing to create a `GdkPixbuf`.
* @param colorspace Color space for image
* @param has_alpha Whether the image should have transparency information
* @param bits_per_sample Number of bits per color sample
* @param width Width of image in pixels, must be > 0
* @param height Height of image in pixels, must be > 0
* @returns the rowstride for the given values, or -1 in case of error.
*/
public static calculate_rowstride(colorspace: Colorspace, has_alpha: boolean, bits_per_sample: number, width: number, height: number): number;
/**
* Parses an image file far enough to determine its format and size.
* @param filename The name of the file to identify.
* @returns A `GdkPixbufFormat` describing
* the image format of the file
*
* Return location for the width of the image
*
* Return location for the height of the image
*/
public static get_file_info(filename: string): [ PixbufFormat | null, number | null, number | null ];
/**
* Asynchronously parses an image file far enough to determine its
* format and size.
*
* For more details see {@link GdkPixbuf.get_file_info}, which is the synchronous
* version of this function.
*
* When the operation is finished, #callback will be called in the
* main thread. You can then call gdk_pixbuf_get_file_info_finish() to
* get the result of the operation.
* @param filename The name of the file to identify
* @param cancellable optional `GCancellable` object, `NULL` to ignore
* @param callback a `GAsyncReadyCallback` to call when the file info is available
*/
public static get_file_info_async(filename: string, cancellable?: Gio.Cancellable | null, callback?: Gio.AsyncReadyCallback | null): void;
/**
* Finishes an asynchronous pixbuf parsing operation started with
* {@link GdkPixbuf.get_file_info_async}.
* @param async_result a `GAsyncResult`
* @returns A `GdkPixbufFormat` describing the
* image format of the file
*
* Return location for the width of the image, or `NULL`
*
* Return location for the height of the image, or `NULL`
*/