@girs/cogl-9 4.3.0 → 4.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +36 -41
  2. package/cogl-9.d.ts +409 -171
  3. package/package.json +7 -7
package/cogl-9.d.ts CHANGED
@@ -33,25 +33,25 @@ export namespace Cogl {
33
33
  /**
34
34
  * Data is the same size of a byte
35
35
  */
36
- BYTE,
36
+ BYTE = 5120,
37
37
  /**
38
38
  * Data is the same size of an
39
39
  * unsigned byte
40
40
  */
41
- UNSIGNED_BYTE,
41
+ UNSIGNED_BYTE = 5121,
42
42
  /**
43
43
  * Data is the same size of a short integer
44
44
  */
45
- SHORT,
45
+ SHORT = 5122,
46
46
  /**
47
47
  * Data is the same size of
48
48
  * an unsigned short integer
49
49
  */
50
- UNSIGNED_SHORT,
50
+ UNSIGNED_SHORT = 5123,
51
51
  /**
52
52
  * Data is the same size of a float
53
53
  */
54
- FLOAT,
54
+ FLOAT = 5126,
55
55
  }
56
56
 
57
57
 
@@ -69,15 +69,15 @@ export namespace Cogl {
69
69
  * Generic failure code, something went
70
70
  * wrong.
71
71
  */
72
- FAILED,
72
+ FAILED = 0,
73
73
  /**
74
74
  * Unknown image type.
75
75
  */
76
- UNKNOWN_TYPE,
76
+ UNKNOWN_TYPE = 1,
77
77
  /**
78
78
  * An image file was broken somehow.
79
79
  */
80
- CORRUPT_IMAGE,
80
+ CORRUPT_IMAGE = 2,
81
81
  }
82
82
 
83
83
 
@@ -90,20 +90,20 @@ export namespace Cogl {
90
90
  /**
91
91
  * Generic parse error
92
92
  */
93
- PARSE_ERROR,
93
+ PARSE_ERROR = 0,
94
94
  /**
95
95
  * Argument parse error
96
96
  */
97
- ARGUMENT_PARSE_ERROR,
97
+ ARGUMENT_PARSE_ERROR = 1,
98
98
  /**
99
99
  * Internal parser error
100
100
  */
101
- INVALID_ERROR,
101
+ INVALID_ERROR = 2,
102
102
  /**
103
103
  * Blend string not
104
104
  * supported by the GPU
105
105
  */
106
- GPU_UNSUPPORTED_ERROR,
106
+ GPU_UNSUPPORTED_ERROR = 3,
107
107
  }
108
108
 
109
109
 
@@ -121,41 +121,41 @@ export namespace Cogl {
121
121
  /**
122
122
  * Never passes.
123
123
  */
124
- NEVER,
124
+ NEVER = 512,
125
125
  /**
126
126
  * Passes if the fragment's depth
127
127
  * value is less than the value currently in the depth buffer.
128
128
  */
129
- LESS,
129
+ LESS = 513,
130
130
  /**
131
131
  * Passes if the fragment's depth
132
132
  * value is equal to the value currently in the depth buffer.
133
133
  */
134
- EQUAL,
134
+ EQUAL = 514,
135
135
  /**
136
136
  * Passes if the fragment's depth
137
137
  * value is less or equal to the value currently in the depth buffer.
138
138
  */
139
- LEQUAL,
139
+ LEQUAL = 515,
140
140
  /**
141
141
  * Passes if the fragment's depth
142
142
  * value is greater than the value currently in the depth buffer.
143
143
  */
144
- GREATER,
144
+ GREATER = 516,
145
145
  /**
146
146
  * Passes if the fragment's depth
147
147
  * value is not equal to the value currently in the depth buffer.
148
148
  */
149
- NOTEQUAL,
149
+ NOTEQUAL = 517,
150
150
  /**
151
151
  * Passes if the fragment's depth
152
152
  * value greater than or equal to the value currently in the depth buffer.
153
153
  */
154
- GEQUAL,
154
+ GEQUAL = 518,
155
155
  /**
156
156
  * Always passes.
157
157
  */
158
- ALWAYS,
158
+ ALWAYS = 519,
159
159
  }
160
160
 
161
161
 
@@ -172,38 +172,38 @@ export namespace Cogl {
172
172
  * {@link Cogl.IndicesType.INT} is supported in
173
173
  * `cogl_indices_new()`.
174
174
  */
175
- OGL_FEATURE_ID_UNSIGNED_INT_INDICES,
175
+ OGL_FEATURE_ID_UNSIGNED_INT_INDICES = 0,
176
176
  /**
177
177
  * Whether `cogl_buffer_map()` is
178
178
  * supported with CoglBufferAccess including read support.
179
179
  */
180
- OGL_FEATURE_ID_MAP_BUFFER_FOR_READ,
180
+ OGL_FEATURE_ID_MAP_BUFFER_FOR_READ = 1,
181
181
  /**
182
182
  * Whether `cogl_buffer_map()` is
183
183
  * supported with CoglBufferAccess including write support.
184
184
  */
185
- OGL_FEATURE_ID_MAP_BUFFER_FOR_WRITE,
186
- OGL_FEATURE_ID_FENCE,
185
+ OGL_FEATURE_ID_MAP_BUFFER_FOR_WRITE = 2,
186
+ OGL_FEATURE_ID_FENCE = 3,
187
187
  /**
188
188
  * Support for
189
189
  * {@link Cogl.TextureComponents.RG} as the internal components of a
190
190
  * texture.
191
191
  */
192
- OGL_FEATURE_ID_TEXTURE_RG,
192
+ OGL_FEATURE_ID_TEXTURE_RG = 4,
193
193
  /**
194
194
  * Available if the age of {@link Cogl.Onscreen} back
195
195
  * buffers are tracked and so `cogl_onscreen_get_buffer_age()` can be
196
196
  * expected to return age values other than 0.
197
197
  */
198
- OGL_FEATURE_ID_BUFFER_AGE,
199
- OGL_FEATURE_ID_TEXTURE_EGL_IMAGE_EXTERNAL,
198
+ OGL_FEATURE_ID_BUFFER_AGE = 5,
199
+ OGL_FEATURE_ID_TEXTURE_EGL_IMAGE_EXTERNAL = 6,
200
200
  /**
201
201
  * Whether blitting using
202
202
  * `cogl_blit_framebuffer()` is supported.
203
203
  */
204
- OGL_FEATURE_ID_BLIT_FRAMEBUFFER,
205
- OGL_FEATURE_ID_TIMESTAMP_QUERY,
206
- OGL_FEATURE_ID_GET_GPU_TIME,
204
+ OGL_FEATURE_ID_BLIT_FRAMEBUFFER = 7,
205
+ OGL_FEATURE_ID_TIMESTAMP_QUERY = 8,
206
+ OGL_FEATURE_ID_GET_GPU_TIME = 9,
207
207
  }
208
208
 
209
209
 
@@ -216,11 +216,11 @@ export namespace Cogl {
216
216
  * The event was not handled, continues the
217
217
  * processing
218
218
  */
219
- CONTINUE,
219
+ CONTINUE = 0,
220
220
  /**
221
221
  * Remove the event, stops the processing
222
222
  */
223
- REMOVE,
223
+ REMOVE = 1,
224
224
  }
225
225
 
226
226
 
@@ -248,7 +248,7 @@ export namespace Cogl {
248
248
  * acknowledged a frame and is ready for a
249
249
  * new frame to be created.
250
250
  */
251
- SYNC,
251
+ SYNC = 1,
252
252
  /**
253
253
  * Notifies that a frame has ended. This
254
254
  * is a good time for applications to
@@ -258,7 +258,7 @@ export namespace Cogl {
258
258
  * events should be expected after a
259
259
  * `COGL_FRAME_EVENT_COMPLETE` event.
260
260
  */
261
- COMPLETE,
261
+ COMPLETE = 2,
262
262
  }
263
263
 
264
264
 
@@ -266,7 +266,7 @@ export namespace Cogl {
266
266
  * @gir-type Enum
267
267
  */
268
268
  enum FramebufferError {
269
- FRAMEBUFFER_ERROR_ALLOCATE,
269
+ FRAMEBUFFER_ERROR_ALLOCATE = 0,
270
270
  }
271
271
 
272
272
 
@@ -278,11 +278,11 @@ export namespace Cogl {
278
278
  * @gir-type Enum
279
279
  */
280
280
  enum GraphicsResetStatus {
281
- NO_ERROR,
282
- GUILTY_CONTEXT_RESET,
283
- INNOCENT_CONTEXT_RESET,
284
- UNKNOWN_CONTEXT_RESET,
285
- PURGED_CONTEXT_RESET,
281
+ NO_ERROR = 0,
282
+ GUILTY_CONTEXT_RESET = 1,
283
+ INNOCENT_CONTEXT_RESET = 2,
284
+ UNKNOWN_CONTEXT_RESET = 3,
285
+ PURGED_CONTEXT_RESET = 4,
286
286
  }
287
287
 
288
288
 
@@ -302,15 +302,15 @@ export namespace Cogl {
302
302
  /**
303
303
  * Your indices are unsigned bytes
304
304
  */
305
- BYTE,
305
+ BYTE = 0,
306
306
  /**
307
307
  * Your indices are unsigned shorts
308
308
  */
309
- SHORT,
309
+ SHORT = 1,
310
310
  /**
311
311
  * Your indices are unsigned ints
312
312
  */
313
- INT,
313
+ INT = 2,
314
314
  }
315
315
 
316
316
 
@@ -325,41 +325,41 @@ export namespace Cogl {
325
325
  /**
326
326
  * Never let the fragment through.
327
327
  */
328
- NEVER,
328
+ NEVER = 512,
329
329
  /**
330
330
  * Let the fragment through if the incoming
331
331
  * alpha value is less than the reference alpha value
332
332
  */
333
- LESS,
333
+ LESS = 513,
334
334
  /**
335
335
  * Let the fragment through if the incoming
336
336
  * alpha value equals the reference alpha value
337
337
  */
338
- EQUAL,
338
+ EQUAL = 514,
339
339
  /**
340
340
  * Let the fragment through if the incoming
341
341
  * alpha value is less than or equal to the reference alpha value
342
342
  */
343
- LEQUAL,
343
+ LEQUAL = 515,
344
344
  /**
345
345
  * Let the fragment through if the incoming
346
346
  * alpha value is greater than the reference alpha value
347
347
  */
348
- GREATER,
348
+ GREATER = 516,
349
349
  /**
350
350
  * Let the fragment through if the incoming
351
351
  * alpha value does not equal the reference alpha value
352
352
  */
353
- NOTEQUAL,
353
+ NOTEQUAL = 517,
354
354
  /**
355
355
  * Let the fragment through if the incoming
356
356
  * alpha value is greater than or equal to the reference alpha value.
357
357
  */
358
- GEQUAL,
358
+ GEQUAL = 518,
359
359
  /**
360
360
  * Always let the fragment through.
361
361
  */
362
- ALWAYS,
362
+ ALWAYS = 519,
363
363
  }
364
364
 
365
365
 
@@ -376,38 +376,38 @@ export namespace Cogl {
376
376
  * Measuring in manhatten distance from the,
377
377
  * current pixel center, use the nearest texture texel
378
378
  */
379
- NEAREST,
379
+ NEAREST = 9728,
380
380
  /**
381
381
  * Use the weighted average of the 4 texels
382
382
  * nearest the current pixel center
383
383
  */
384
- LINEAR,
384
+ LINEAR = 9729,
385
385
  /**
386
386
  * Select the mimap level whose
387
387
  * texel size most closely matches the current pixel, and use the
388
388
  * {@link Cogl.MaterialFilter.NEAREST} criterion
389
389
  */
390
- NEAREST_MIPMAP_NEAREST,
390
+ NEAREST_MIPMAP_NEAREST = 9984,
391
391
  /**
392
392
  * Select the mimap level whose
393
393
  * texel size most closely matches the current pixel, and use the
394
394
  * {@link Cogl.MaterialFilter.LINEAR} criterion
395
395
  */
396
- LINEAR_MIPMAP_NEAREST,
396
+ LINEAR_MIPMAP_NEAREST = 9985,
397
397
  /**
398
398
  * Select the two mimap levels
399
399
  * whose texel size most closely matches the current pixel, use
400
400
  * the {@link Cogl.MaterialFilter.NEAREST} criterion on each one and take
401
401
  * their weighted average
402
402
  */
403
- NEAREST_MIPMAP_LINEAR,
403
+ NEAREST_MIPMAP_LINEAR = 9986,
404
404
  /**
405
405
  * Select the two mimap levels
406
406
  * whose texel size most closely matches the current pixel, use
407
407
  * the {@link Cogl.MaterialFilter.LINEAR} criterion on each one and take
408
408
  * their weighted average
409
409
  */
410
- LINEAR_MIPMAP_LINEAR,
410
+ LINEAR_MIPMAP_LINEAR = 9987,
411
411
  }
412
412
 
413
413
 
@@ -428,14 +428,14 @@ export namespace Cogl {
428
428
  * The texture will be repeated. This
429
429
  * is useful for example to draw a tiled background.
430
430
  */
431
- REPEAT,
431
+ REPEAT = 10497,
432
432
  /**
433
433
  * The coordinates outside the
434
434
  * range 0→1 will sample copies of the edge pixels of the
435
435
  * texture. This is useful to avoid artifacts if only one copy of
436
436
  * the texture is being rendered.
437
437
  */
438
- CLAMP_TO_EDGE,
438
+ CLAMP_TO_EDGE = 33071,
439
439
  /**
440
440
  * Cogl will try to automatically
441
441
  * decide which of the above two to use. For `cogl_rectangle()`, it
@@ -446,7 +446,7 @@ export namespace Cogl {
446
446
  * layers that have point sprite coordinate generation enabled. This
447
447
  * is the default value.
448
448
  */
449
- AUTOMATIC,
449
+ AUTOMATIC = 519,
450
450
  }
451
451
 
452
452
 
@@ -461,41 +461,41 @@ export namespace Cogl {
461
461
  /**
462
462
  * Never let the fragment through.
463
463
  */
464
- NEVER,
464
+ NEVER = 512,
465
465
  /**
466
466
  * Let the fragment through if the incoming
467
467
  * alpha value is less than the reference alpha value
468
468
  */
469
- LESS,
469
+ LESS = 513,
470
470
  /**
471
471
  * Let the fragment through if the incoming
472
472
  * alpha value equals the reference alpha value
473
473
  */
474
- EQUAL,
474
+ EQUAL = 514,
475
475
  /**
476
476
  * Let the fragment through if the incoming
477
477
  * alpha value is less than or equal to the reference alpha value
478
478
  */
479
- LEQUAL,
479
+ LEQUAL = 515,
480
480
  /**
481
481
  * Let the fragment through if the incoming
482
482
  * alpha value is greater than the reference alpha value
483
483
  */
484
- GREATER,
484
+ GREATER = 516,
485
485
  /**
486
486
  * Let the fragment through if the incoming
487
487
  * alpha value does not equal the reference alpha value
488
488
  */
489
- NOTEQUAL,
489
+ NOTEQUAL = 517,
490
490
  /**
491
491
  * Let the fragment through if the incoming
492
492
  * alpha value is greater than or equal to the reference alpha value.
493
493
  */
494
- GEQUAL,
494
+ GEQUAL = 518,
495
495
  /**
496
496
  * Always let the fragment through.
497
497
  */
498
- ALWAYS,
498
+ ALWAYS = 519,
499
499
  }
500
500
 
501
501
 
@@ -509,19 +509,19 @@ export namespace Cogl {
509
509
  * Neither face will be
510
510
  * culled. This is the default.
511
511
  */
512
- NONE,
512
+ NONE = 0,
513
513
  /**
514
514
  * Front faces will be culled.
515
515
  */
516
- FRONT,
516
+ FRONT = 1,
517
517
  /**
518
518
  * Back faces will be culled.
519
519
  */
520
- BACK,
520
+ BACK = 2,
521
521
  /**
522
522
  * All faces will be culled.
523
523
  */
524
- BOTH,
524
+ BOTH = 3,
525
525
  }
526
526
 
527
527
 
@@ -538,38 +538,38 @@ export namespace Cogl {
538
538
  * Measuring in manhatten distance from the,
539
539
  * current pixel center, use the nearest texture texel
540
540
  */
541
- NEAREST,
541
+ NEAREST = 9728,
542
542
  /**
543
543
  * Use the weighted average of the 4 texels
544
544
  * nearest the current pixel center
545
545
  */
546
- LINEAR,
546
+ LINEAR = 9729,
547
547
  /**
548
548
  * Select the mimap level whose
549
549
  * texel size most closely matches the current pixel, and use the
550
550
  * {@link Cogl.PipelineFilter.NEAREST} criterion
551
551
  */
552
- NEAREST_MIPMAP_NEAREST,
552
+ NEAREST_MIPMAP_NEAREST = 9984,
553
553
  /**
554
554
  * Select the mimap level whose
555
555
  * texel size most closely matches the current pixel, and use the
556
556
  * {@link Cogl.PipelineFilter.LINEAR} criterion
557
557
  */
558
- LINEAR_MIPMAP_NEAREST,
558
+ LINEAR_MIPMAP_NEAREST = 9985,
559
559
  /**
560
560
  * Select the two mimap levels
561
561
  * whose texel size most closely matches the current pixel, use
562
562
  * the {@link Cogl.PipelineFilter.NEAREST} criterion on each one and take
563
563
  * their weighted average
564
564
  */
565
- NEAREST_MIPMAP_LINEAR,
565
+ NEAREST_MIPMAP_LINEAR = 9986,
566
566
  /**
567
567
  * Select the two mimap levels
568
568
  * whose texel size most closely matches the current pixel, use
569
569
  * the {@link Cogl.PipelineFilter.LINEAR} criterion on each one and take
570
570
  * their weighted average
571
571
  */
572
- LINEAR_MIPMAP_LINEAR,
572
+ LINEAR_MIPMAP_LINEAR = 9987,
573
573
  }
574
574
 
575
575
 
@@ -590,15 +590,15 @@ export namespace Cogl {
590
590
  * The texture will be repeated. This
591
591
  * is useful for example to draw a tiled background.
592
592
  */
593
- REPEAT,
594
- MIRRORED_REPEAT,
593
+ REPEAT = 10497,
594
+ MIRRORED_REPEAT = 33648,
595
595
  /**
596
596
  * The coordinates outside the
597
597
  * range 0→1 will sample copies of the edge pixels of the
598
598
  * texture. This is useful to avoid artifacts if only one copy of
599
599
  * the texture is being rendered.
600
600
  */
601
- CLAMP_TO_EDGE,
601
+ CLAMP_TO_EDGE = 33071,
602
602
  /**
603
603
  * Cogl will try to automatically
604
604
  * decide which of the above two to use. For `cogl_rectangle()`, it
@@ -609,7 +609,7 @@ export namespace Cogl {
609
609
  * layers that have point sprite coordinate generation enabled. This
610
610
  * is the default value.
611
611
  */
612
- AUTOMATIC,
612
+ AUTOMATIC = 519,
613
613
  }
614
614
 
615
615
 
@@ -617,8 +617,8 @@ export namespace Cogl {
617
617
  * @gir-type Enum
618
618
  */
619
619
  enum RendererError {
620
- XLIB_DISPLAY_OPEN,
621
- BAD_CONSTRAINT,
620
+ XLIB_DISPLAY_OPEN = 0,
621
+ BAD_CONSTRAINT = 1,
622
622
  }
623
623
 
624
624
 
@@ -645,11 +645,11 @@ export namespace Cogl {
645
645
  /**
646
646
  * A program for processing vertices
647
647
  */
648
- VERTEX,
648
+ VERTEX = 0,
649
649
  /**
650
650
  * A program for processing fragments
651
651
  */
652
- FRAGMENT,
652
+ FRAGMENT = 1,
653
653
  }
654
654
 
655
655
 
@@ -662,15 +662,15 @@ export namespace Cogl {
662
662
  /**
663
663
  * draw to both stereo buffers
664
664
  */
665
- BOTH,
665
+ BOTH = 0,
666
666
  /**
667
667
  * draw only to the left stereo buffer
668
668
  */
669
- LEFT,
669
+ LEFT = 1,
670
670
  /**
671
671
  * draw only to the left stereo buffer
672
672
  */
673
- RIGHT,
673
+ RIGHT = 2,
674
674
  }
675
675
 
676
676
 
@@ -700,12 +700,12 @@ export namespace Cogl {
700
700
  * You tried to use a feature or
701
701
  * configuration not currently available.
702
702
  */
703
- UNSUPPORTED,
703
+ UNSUPPORTED = 0,
704
704
  /**
705
705
  * You tried to allocate a resource
706
706
  * such as a texture and there wasn't enough memory.
707
707
  */
708
- NO_MEMORY,
708
+ NO_MEMORY = 1,
709
709
  }
710
710
 
711
711
 
@@ -718,25 +718,25 @@ export namespace Cogl {
718
718
  /**
719
719
  * Only the alpha component
720
720
  */
721
- A,
721
+ A = 1,
722
722
  /**
723
723
  * Red and green components. Note that
724
724
  * this can only be used if the {@link Cogl.FeatureID.OGL_FEATURE_ID_TEXTURE_RG} feature
725
725
  * is advertised.
726
726
  */
727
- RG,
727
+ RG = 2,
728
728
  /**
729
729
  * Red, green and blue components
730
730
  */
731
- RGB,
731
+ RGB = 3,
732
732
  /**
733
733
  * Red, green, blue and alpha components
734
734
  */
735
- RGBA,
735
+ RGBA = 4,
736
736
  /**
737
737
  * Only a depth component
738
738
  */
739
- DEPTH,
739
+ DEPTH = 5,
740
740
  }
741
741
 
742
742
 
@@ -749,17 +749,17 @@ export namespace Cogl {
749
749
  /**
750
750
  * Unsupported size
751
751
  */
752
- SIZE,
752
+ SIZE = 0,
753
753
  /**
754
754
  * Unsupported format
755
755
  */
756
- FORMAT,
757
- BAD_PARAMETER,
756
+ FORMAT = 1,
757
+ BAD_PARAMETER = 2,
758
758
  /**
759
759
  * A primitive texture type that is
760
760
  * unsupported by the driver was used
761
761
  */
762
- TYPE,
762
+ TYPE = 3,
763
763
  }
764
764
 
765
765
 
@@ -773,35 +773,35 @@ export namespace Cogl {
773
773
  * FIXME, equivalent to
774
774
  * <constant>GL_POINTS</constant>
775
775
  */
776
- POINTS,
776
+ POINTS = 0,
777
777
  /**
778
778
  * FIXME, equivalent to <constant>GL_LINES</constant>
779
779
  */
780
- LINES,
780
+ LINES = 1,
781
781
  /**
782
782
  * FIXME, equivalent to
783
783
  * <constant>GL_LINE_LOOP</constant>
784
784
  */
785
- LINE_LOOP,
785
+ LINE_LOOP = 2,
786
786
  /**
787
787
  * FIXME, equivalent to
788
788
  * <constant>GL_LINE_STRIP</constant>
789
789
  */
790
- LINE_STRIP,
790
+ LINE_STRIP = 3,
791
791
  /**
792
792
  * FIXME, equivalent to
793
793
  * <constant>GL_TRIANGLES</constant>
794
794
  */
795
- TRIANGLES,
795
+ TRIANGLES = 4,
796
796
  /**
797
797
  * FIXME, equivalent to
798
798
  * <constant>GL_TRIANGLE_STRIP</constant>
799
799
  */
800
- TRIANGLE_STRIP,
800
+ TRIANGLE_STRIP = 5,
801
801
  /**
802
802
  * FIXME, equivalent to <constant>GL_TRIANGLE_FAN</constant>
803
803
  */
804
- TRIANGLE_FAN,
804
+ TRIANGLE_FAN = 6,
805
805
  }
806
806
 
807
807
 
@@ -815,11 +815,11 @@ export namespace Cogl {
815
815
  /**
816
816
  * Vertices are in a clockwise order
817
817
  */
818
- CLOCKWISE,
818
+ CLOCKWISE = 0,
819
819
  /**
820
820
  * Vertices are in a counter-clockwise order
821
821
  */
822
- COUNTER_CLOCKWISE,
822
+ COUNTER_CLOCKWISE = 1,
823
823
  }
824
824
 
825
825
 
@@ -827,38 +827,60 @@ export namespace Cogl {
827
827
  * @gir-type Enum
828
828
  */
829
829
  enum WinsysFeature {
830
- MULTIPLE_ONSCREEN,
831
- VBLANK_COUNTER,
832
- VBLANK_WAIT,
833
- TEXTURE_FROM_PIXMAP,
834
- SWAP_BUFFERS_EVENT,
835
- SWAP_REGION,
836
- SWAP_REGION_THROTTLE,
837
- SWAP_REGION_SYNCHRONIZED,
838
- BUFFER_AGE,
839
- SYNC_AND_COMPLETE_EVENT,
840
- N_FEATURES,
830
+ MULTIPLE_ONSCREEN = 0,
831
+ VBLANK_COUNTER = 1,
832
+ VBLANK_WAIT = 2,
833
+ TEXTURE_FROM_PIXMAP = 3,
834
+ SWAP_BUFFERS_EVENT = 4,
835
+ SWAP_REGION = 5,
836
+ SWAP_REGION_THROTTLE = 6,
837
+ SWAP_REGION_SYNCHRONIZED = 7,
838
+ BUFFER_AGE = 8,
839
+ SYNC_AND_COMPLETE_EVENT = 9,
840
+ N_FEATURES = 10,
841
841
  }
842
842
 
843
843
 
844
+ /**
845
+ * @default 64
846
+ */
844
847
  const AFIRST_BIT: number;
845
848
 
849
+ /**
850
+ * @default 16
851
+ */
846
852
  const A_BIT: number;
847
853
 
854
+ /**
855
+ * @default 32
856
+ */
848
857
  const BGR_BIT: number;
849
858
 
859
+ /**
860
+ * @default 256
861
+ */
850
862
  const DEPTH_BIT: number;
851
863
 
852
864
  /**
853
865
  * The maximum number of planes of a pixel format (see also
854
866
  * `cogl_pixel_format_get_planes()`).
867
+ * @default 4
855
868
  */
856
869
  const PIXEL_FORMAT_MAX_PLANES: number;
857
870
 
871
+ /**
872
+ * @default 128
873
+ */
858
874
  const PREMULT_BIT: number;
859
875
 
876
+ /**
877
+ * @default 512
878
+ */
860
879
  const STENCIL_BIT: number;
861
880
 
881
+ /**
882
+ * @default 127
883
+ */
862
884
  const TEXTURE_MAX_WASTE: number;
863
885
 
864
886
  function blend_string_error_quark(): number;
@@ -911,6 +933,7 @@ export namespace Cogl {
911
933
  * @param dst_y Destination y position
912
934
  * @param width Width of region to copy
913
935
  * @param height Height of region to copy
936
+ * @throws GLib.Error
914
937
  */
915
938
  function blit_framebuffer(framebuffer: Framebuffer, dst: Framebuffer, src_x: number, src_y: number, dst_x: number, dst_y: number, width: number, height: number): boolean;
916
939
 
@@ -1359,6 +1382,7 @@ export namespace Cogl {
1359
1382
  * @returns A newly created {@link Cogl.Texture} or `null` on failure
1360
1383
  * @since 0.8
1361
1384
  * @deprecated since 1.18: Use specific constructors such as `cogl_texture_2d_new_from_file()`
1385
+ * @throws GLib.Error
1362
1386
  */
1363
1387
  function texture_new_from_file(filename: string, flags: TextureFlags, internal_format: PixelFormat): Texture;
1364
1388
 
@@ -1436,15 +1460,15 @@ export namespace Cogl {
1436
1460
  /**
1437
1461
  * Selects the primary color buffer
1438
1462
  */
1439
- COLOR,
1463
+ COLOR = 1,
1440
1464
  /**
1441
1465
  * Selects the depth buffer
1442
1466
  */
1443
- DEPTH,
1467
+ DEPTH = 2,
1444
1468
  /**
1445
1469
  * Selects the stencil buffer
1446
1470
  */
1447
- STENCIL,
1471
+ STENCIL = 4,
1448
1472
  }
1449
1473
 
1450
1474
 
@@ -1457,11 +1481,11 @@ export namespace Cogl {
1457
1481
  /**
1458
1482
  * FIXME
1459
1483
  */
1460
- WINDOW_BUFFER,
1484
+ WINDOW_BUFFER = 2,
1461
1485
  /**
1462
1486
  * FIXME
1463
1487
  */
1464
- OFFSCREEN_BUFFER,
1488
+ OFFSCREEN_BUFFER = 4,
1465
1489
  }
1466
1490
 
1467
1491
 
@@ -1469,8 +1493,8 @@ export namespace Cogl {
1469
1493
  * @gir-type Flags
1470
1494
  */
1471
1495
  enum EglImageFlags {
1472
- NONE,
1473
- NO_GET_DATA,
1496
+ NONE = 0,
1497
+ NO_GET_DATA = 1,
1474
1498
  }
1475
1499
 
1476
1500
 
@@ -1500,152 +1524,152 @@ export namespace Cogl {
1500
1524
  /**
1501
1525
  * Any format
1502
1526
  */
1503
- ANY,
1527
+ ANY = 0,
1504
1528
  /**
1505
1529
  * 8 bits alpha mask
1506
1530
  */
1507
- A_8,
1531
+ A_8 = 17,
1508
1532
  /**
1509
1533
  * RGB, 16 bits
1510
1534
  */
1511
- RGB_565,
1535
+ RGB_565 = 4,
1512
1536
  /**
1513
1537
  * RGBA, 16 bits
1514
1538
  */
1515
- RGBA_4444,
1539
+ RGBA_4444 = 21,
1516
1540
  /**
1517
1541
  * RGBA, 16 bits
1518
1542
  */
1519
- RGBA_5551,
1543
+ RGBA_5551 = 22,
1520
1544
  /**
1521
1545
  * Not currently supported
1522
1546
  */
1523
- YUV,
1547
+ YUV = 7,
1524
1548
  /**
1525
1549
  * Single luminance component
1526
1550
  */
1527
- G_8,
1551
+ G_8 = 8,
1528
1552
  /**
1529
1553
  * RG, 16 bits. Note that red-green textures
1530
1554
  * are only available if {@link Cogl.FeatureID.OGL_FEATURE_ID_TEXTURE_RG} is advertised.
1531
1555
  * See `cogl_texture_set_components()` for details.
1532
1556
  */
1533
- RG_88,
1557
+ RG_88 = 9,
1534
1558
  /**
1535
1559
  * RGB, 24 bits
1536
1560
  */
1537
- RGB_888,
1561
+ RGB_888 = 2,
1538
1562
  /**
1539
1563
  * BGR, 24 bits
1540
1564
  */
1541
- BGR_888,
1565
+ BGR_888 = 34,
1542
1566
  /**
1543
1567
  * RGBA, 32 bits
1544
1568
  */
1545
- RGBA_8888,
1569
+ RGBA_8888 = 19,
1546
1570
  /**
1547
1571
  * BGRA, 32 bits
1548
1572
  */
1549
- BGRA_8888,
1573
+ BGRA_8888 = 51,
1550
1574
  /**
1551
1575
  * ARGB, 32 bits
1552
1576
  */
1553
- ARGB_8888,
1577
+ ARGB_8888 = 83,
1554
1578
  /**
1555
1579
  * ABGR, 32 bits
1556
1580
  */
1557
- ABGR_8888,
1581
+ ABGR_8888 = 115,
1558
1582
  /**
1559
1583
  * RGBA, 32 bits, 10 bpc
1560
1584
  */
1561
- RGBA_1010102,
1585
+ RGBA_1010102 = 29,
1562
1586
  /**
1563
1587
  * BGRA, 32 bits, 10 bpc
1564
1588
  */
1565
- BGRA_1010102,
1589
+ BGRA_1010102 = 61,
1566
1590
  /**
1567
1591
  * ARGB, 32 bits, 10 bpc
1568
1592
  */
1569
- ARGB_2101010,
1593
+ ARGB_2101010 = 93,
1570
1594
  /**
1571
1595
  * ABGR, 32 bits, 10 bpc
1572
1596
  */
1573
- ABGR_2101010,
1597
+ ABGR_2101010 = 125,
1574
1598
  /**
1575
1599
  * RGBA half floating point, 64 bit
1576
1600
  */
1577
- RGBA_FP_16161616,
1601
+ RGBA_FP_16161616 = 27,
1578
1602
  /**
1579
1603
  * BGRA half floating point, 64 bit
1580
1604
  */
1581
- BGRA_FP_16161616,
1605
+ BGRA_FP_16161616 = 59,
1582
1606
  /**
1583
1607
  * ARGB half floating point, 64 bit
1584
1608
  */
1585
- ARGB_FP_16161616,
1609
+ ARGB_FP_16161616 = 91,
1586
1610
  /**
1587
1611
  * ABGR half floating point, 64 bit
1588
1612
  */
1589
- ABGR_FP_16161616,
1613
+ ABGR_FP_16161616 = 123,
1590
1614
  /**
1591
1615
  * Premultiplied RGBA, 32 bits
1592
1616
  */
1593
- RGBA_8888_PRE,
1617
+ RGBA_8888_PRE = 147,
1594
1618
  /**
1595
1619
  * Premultiplied BGRA, 32 bits
1596
1620
  */
1597
- BGRA_8888_PRE,
1621
+ BGRA_8888_PRE = 179,
1598
1622
  /**
1599
1623
  * Premultiplied ARGB, 32 bits
1600
1624
  */
1601
- ARGB_8888_PRE,
1625
+ ARGB_8888_PRE = 211,
1602
1626
  /**
1603
1627
  * Premultiplied ABGR, 32 bits
1604
1628
  */
1605
- ABGR_8888_PRE,
1629
+ ABGR_8888_PRE = 243,
1606
1630
  /**
1607
1631
  * Premultiplied RGBA, 16 bits
1608
1632
  */
1609
- RGBA_4444_PRE,
1633
+ RGBA_4444_PRE = 149,
1610
1634
  /**
1611
1635
  * Premultiplied RGBA, 16 bits
1612
1636
  */
1613
- RGBA_5551_PRE,
1637
+ RGBA_5551_PRE = 150,
1614
1638
  /**
1615
1639
  * Premultiplied RGBA, 32 bits, 10 bpc
1616
1640
  */
1617
- RGBA_1010102_PRE,
1641
+ RGBA_1010102_PRE = 157,
1618
1642
  /**
1619
1643
  * Premultiplied BGRA, 32 bits, 10 bpc
1620
1644
  */
1621
- BGRA_1010102_PRE,
1645
+ BGRA_1010102_PRE = 189,
1622
1646
  /**
1623
1647
  * Premultiplied ARGB, 32 bits, 10 bpc
1624
1648
  */
1625
- ARGB_2101010_PRE,
1649
+ ARGB_2101010_PRE = 221,
1626
1650
  /**
1627
1651
  * Premultiplied ABGR, 32 bits, 10 bpc
1628
1652
  */
1629
- ABGR_2101010_PRE,
1653
+ ABGR_2101010_PRE = 253,
1630
1654
  /**
1631
1655
  * Premultiplied RGBA half floating point, 64 bit
1632
1656
  */
1633
- RGBA_FP_16161616_PRE,
1657
+ RGBA_FP_16161616_PRE = 155,
1634
1658
  /**
1635
1659
  * Premultiplied BGRA half floating point, 64 bit
1636
1660
  */
1637
- BGRA_FP_16161616_PRE,
1661
+ BGRA_FP_16161616_PRE = 187,
1638
1662
  /**
1639
1663
  * Premultiplied ARGB half floating point, 64 bit
1640
1664
  */
1641
- ARGB_FP_16161616_PRE,
1665
+ ARGB_FP_16161616_PRE = 219,
1642
1666
  /**
1643
1667
  * Premultiplied ABGR half floating point, 64 bit
1644
1668
  */
1645
- ABGR_FP_16161616_PRE,
1646
- DEPTH_16,
1647
- DEPTH_32,
1648
- DEPTH_24_STENCIL_8,
1669
+ ABGR_FP_16161616_PRE = 251,
1670
+ DEPTH_16 = 265,
1671
+ DEPTH_32 = 259,
1672
+ DEPTH_24_STENCIL_8 = 771,
1649
1673
  }
1650
1674
 
1651
1675
 
@@ -1658,7 +1682,7 @@ export namespace Cogl {
1658
1682
  /**
1659
1683
  * Read from the color buffer
1660
1684
  */
1661
- READ_PIXELS_COLOR_BUFFER,
1685
+ READ_PIXELS_COLOR_BUFFER = 1,
1662
1686
  }
1663
1687
 
1664
1688
 
@@ -1671,7 +1695,7 @@ export namespace Cogl {
1671
1695
  /**
1672
1696
  * No flags specified
1673
1697
  */
1674
- NONE,
1698
+ NONE = 0,
1675
1699
  /**
1676
1700
  * Disables the automatic generation of
1677
1701
  * the mipmap pyramid from the base level image whenever it is
@@ -1679,16 +1703,16 @@ export namespace Cogl {
1679
1703
  * rendered with a mipmap filter so it should be free to leave out
1680
1704
  * this flag when using other filtering modes
1681
1705
  */
1682
- NO_AUTO_MIPMAP,
1706
+ NO_AUTO_MIPMAP = 1,
1683
1707
  /**
1684
1708
  * Disables the slicing of the texture
1685
1709
  */
1686
- NO_SLICING,
1710
+ NO_SLICING = 2,
1687
1711
  /**
1688
1712
  * Disables the insertion of the texture inside
1689
1713
  * the texture atlas used by Cogl
1690
1714
  */
1691
- NO_ATLAS,
1715
+ NO_ATLAS = 4,
1692
1716
  }
1693
1717
 
1694
1718
 
@@ -1728,27 +1752,32 @@ export namespace Cogl {
1728
1752
  * Parses an image file enough to extract the width and height
1729
1753
  * of the bitmap.
1730
1754
  * @param filename the file to check
1755
+ * @since 1.0
1731
1756
  */
1732
1757
  static get_size_from_file(filename: string): [boolean, number, number];
1733
1758
 
1734
1759
  // Methods
1735
1760
  /**
1736
1761
  * @returns the {@link Cogl.PixelFormat} that the data for the bitmap is in.
1762
+ * @since 1.10
1737
1763
  */
1738
1764
  get_format(): PixelFormat;
1739
1765
 
1740
1766
  /**
1741
1767
  * @returns the height of the bitmap
1768
+ * @since 1.10
1742
1769
  */
1743
1770
  get_height(): number;
1744
1771
 
1745
1772
  /**
1746
1773
  * @returns the rowstride of the bitmap. This is the number of bytes between the address of start of one row to the address of the next row in the image.
1774
+ * @since 1.10
1747
1775
  */
1748
1776
  get_rowstride(): number;
1749
1777
 
1750
1778
  /**
1751
1779
  * @returns the width of the bitmap
1780
+ * @since 1.10
1752
1781
  */
1753
1782
  get_width(): number;
1754
1783
  }
@@ -1855,6 +1884,7 @@ export namespace Cogl {
1855
1884
  * Gets the frame counter for the {@link Cogl.Onscreen} that corresponds
1856
1885
  * to this frame.
1857
1886
  * @returns The frame counter value
1887
+ * @since 1.14
1858
1888
  */
1859
1889
  get_frame_counter(): number;
1860
1890
 
@@ -1870,6 +1900,7 @@ export namespace Cogl {
1870
1900
  * <note>Some buggy Mesa drivers up to 9.0.1 may
1871
1901
  * incorrectly report non-monotonic timestamps.</note>
1872
1902
  * @returns the presentation time for the frame
1903
+ * @since 1.14
1873
1904
  */
1874
1905
  get_presentation_time_us(): number;
1875
1906
 
@@ -1883,6 +1914,7 @@ export namespace Cogl {
1883
1914
  * more reliable than using `cogl_frame_info_get_output()` followed by
1884
1915
  * `cogl_output_get_refresh_rate()`.</note>
1885
1916
  * @returns the refresh rate in Hertz
1917
+ * @since 1.14
1886
1918
  */
1887
1919
  get_refresh_rate(): number;
1888
1920
 
@@ -1987,6 +2019,7 @@ export namespace Cogl {
1987
2019
  * used. The disadvantage of relying on automatic allocation is that the
1988
2020
  * program will abort with an error message if there is an error during
1989
2021
  * automatic allocation.</note>
2022
+ * @since 1.8
1990
2023
  * @virtual
1991
2024
  */
1992
2025
  vfunc_allocate(): boolean;
@@ -2009,6 +2042,8 @@ export namespace Cogl {
2009
2042
  * program will abort with an error message if there is an error during
2010
2043
  * automatic allocation.</note>
2011
2044
  * @returns `true` if there were no error allocating the framebuffer, else `false`.
2045
+ * @since 1.8
2046
+ * @throws GLib.Error
2012
2047
  */
2013
2048
  allocate(): boolean;
2014
2049
 
@@ -2017,6 +2052,7 @@ export namespace Cogl {
2017
2052
  * that includes the color buffer then the specified `color` is used.
2018
2053
  * @param buffers A mask of {@link Cogl.BufferBit}<!-- -->'s identifying which auxiliary buffers to clear
2019
2054
  * @param color The color to clear the color buffer too if specified in `buffers`.
2055
+ * @since 1.8
2020
2056
  */
2021
2057
  clear(buffers: bigint | number, color: Color): void;
2022
2058
 
@@ -2028,6 +2064,7 @@ export namespace Cogl {
2028
2064
  * @param green The green component of color to clear the color buffer too if specified in `buffers`.
2029
2065
  * @param blue The blue component of color to clear the color buffer too if specified in `buffers`.
2030
2066
  * @param alpha The alpha component of color to clear the color buffer too if specified in `buffers`.
2067
+ * @since 1.8
2031
2068
  */
2032
2069
  clear4f(buffers: bigint | number, red: number, green: number, blue: number, alpha: number): void;
2033
2070
 
@@ -2049,6 +2086,7 @@ export namespace Cogl {
2049
2086
  * framebuffer, and it's not meaningful to try and discard the color buffer of
2050
2087
  * a {@link Cogl.Offscreen} framebuffer since they are single-buffered.
2051
2088
  * @param buffers A {@link Cogl.BufferBit} mask of which ancillary buffers you want to discard.
2089
+ * @since 1.8
2052
2090
  */
2053
2091
  discard_buffers(buffers: bigint | number): void;
2054
2092
 
@@ -2098,6 +2136,7 @@ export namespace Cogl {
2098
2136
  * @param y_2 y coordinate lower right on screen.
2099
2137
  * @param tex_coords An array containing groups of 4 float values: [s_1, t_1, s_2, t_2] that are interpreted as two texture coordinates; one for the top left texel, and one for the bottom right texel. Each value should be between 0.0 and 1.0, where the coordinate (0.0, 0.0) represents the top left of the texture, and (1.0, 1.0) the bottom right.
2100
2138
  * @param tex_coords_len The length of the `tex_coords` array. (For one layer and one group of texture coordinates, this would be 4)
2139
+ * @since 1.10
2101
2140
  */
2102
2141
  draw_multitextured_rectangle(pipeline: Pipeline, x_1: number, y_1: number, x_2: number, y_2: number, tex_coords: number[], tex_coords_len: number): void;
2103
2142
 
@@ -2118,6 +2157,7 @@ export namespace Cogl {
2118
2157
  * @param y_1 Y coordinate of the top-left corner
2119
2158
  * @param x_2 X coordinate of the bottom-right corner
2120
2159
  * @param y_2 Y coordinate of the bottom-right corner
2160
+ * @since 1.10
2121
2161
  */
2122
2162
  draw_rectangle(pipeline: Pipeline, x_1: number, y_1: number, x_2: number, y_2: number): void;
2123
2163
 
@@ -2144,6 +2184,7 @@ export namespace Cogl {
2144
2184
  * @param pipeline A {@link Cogl.Pipeline} state object
2145
2185
  * @param coordinates an array of coordinates containing groups of 4 float values: [x_1, y_1, x_2, y_2] that are interpreted as two position coordinates; one for the top left of the rectangle (x1, y1), and one for the bottom right of the rectangle (x2, y2).
2146
2186
  * @param n_rectangles number of rectangles defined in `coordinates`.
2187
+ * @since 1.10
2147
2188
  */
2148
2189
  draw_rectangles(pipeline: Pipeline, coordinates: number[], n_rectangles: number): void;
2149
2190
 
@@ -2183,6 +2224,7 @@ export namespace Cogl {
2183
2224
  * @param t_1 T texture coordinate of the top-left coorner
2184
2225
  * @param s_2 S texture coordinate of the bottom-right coorner
2185
2226
  * @param t_2 T texture coordinate of the bottom-right coorner
2227
+ * @since 1.10
2186
2228
  */
2187
2229
  draw_textured_rectangle(pipeline: Pipeline, x_1: number, y_1: number, x_2: number, y_2: number, s_1: number, t_1: number, s_2: number, t_2: number): void;
2188
2230
 
@@ -2224,6 +2266,7 @@ export namespace Cogl {
2224
2266
  * @param pipeline A {@link Cogl.Pipeline} state object
2225
2267
  * @param coordinates an array containing groups of 8 float values: [x_1, y_1, x_2, y_2, s_1, t_1, s_2, t_2] that have the same meaning as the arguments for `cogl_framebuffer_draw_textured_rectangle()`.
2226
2268
  * @param n_rectangles number of rectangles to `coordinates` to draw
2269
+ * @since 1.10
2227
2270
  */
2228
2271
  draw_textured_rectangles(pipeline: Pipeline, coordinates: number[], n_rectangles: number): void;
2229
2272
 
@@ -2237,6 +2280,7 @@ export namespace Cogl {
2237
2280
  * One example might be for benchmarking purposes to be sure timing
2238
2281
  * measurements reflect the time that the GPU is busy for not just the time it
2239
2282
  * takes to queue rendering commands.
2283
+ * @since 1.10
2240
2284
  */
2241
2285
  finish(): void;
2242
2286
 
@@ -2258,18 +2302,21 @@ export namespace Cogl {
2258
2302
  * @param top Y position of the top clipping plane where it intersects the near clipping plane
2259
2303
  * @param z_near The distance to the near clipping plane (Must be positive)
2260
2304
  * @param z_far The distance to the far clipping plane (Must be positive)
2305
+ * @since 1.10
2261
2306
  */
2262
2307
  frustum(left: number, right: number, bottom: number, top: number, z_near: number, z_far: number): void;
2263
2308
 
2264
2309
  /**
2265
2310
  * Retrieves the number of alpha bits of `framebuffer`
2266
2311
  * @returns the number of bits
2312
+ * @since 1.8
2267
2313
  */
2268
2314
  get_alpha_bits(): number;
2269
2315
 
2270
2316
  /**
2271
2317
  * Retrieves the number of blue bits of `framebuffer`
2272
2318
  * @returns the number of bits
2319
+ * @since 1.8
2273
2320
  */
2274
2321
  get_blue_bits(): number;
2275
2322
 
@@ -2278,12 +2325,14 @@ export namespace Cogl {
2278
2325
  * instantiated within. This is the {@link Cogl.Context} that was passed to
2279
2326
  * `cogl_onscreen_new()` for example.
2280
2327
  * @returns The {@link Cogl.Context} that the given `framebuffer` was instantiated within.
2328
+ * @since 1.8
2281
2329
  */
2282
2330
  get_context(): Context;
2283
2331
 
2284
2332
  /**
2285
2333
  * Retrieves the number of depth bits of `framebuffer`
2286
2334
  * @returns the number of bits
2335
+ * @since 2.0
2287
2336
  */
2288
2337
  get_depth_bits(): number;
2289
2338
 
@@ -2291,6 +2340,7 @@ export namespace Cogl {
2291
2340
  * Queries whether depth buffer writing is enabled for `framebuffer`. This
2292
2341
  * can be controlled via `cogl_framebuffer_set_depth_write_enabled()`.
2293
2342
  * @returns `true` if depth writing is enabled or `false` if not.
2343
+ * @since 1.18
2294
2344
  */
2295
2345
  get_depth_write_enabled(): boolean;
2296
2346
 
@@ -2302,18 +2352,21 @@ export namespace Cogl {
2302
2352
  * display pipeline does not support dithering. This value only represents
2303
2353
  * the user's request for dithering.</note>
2304
2354
  * @returns `true` if dithering has been requested or `false` if not.
2355
+ * @since 1.8
2305
2356
  */
2306
2357
  get_dither_enabled(): boolean;
2307
2358
 
2308
2359
  /**
2309
2360
  * Retrieves the number of green bits of `framebuffer`
2310
2361
  * @returns the number of bits
2362
+ * @since 1.8
2311
2363
  */
2312
2364
  get_green_bits(): number;
2313
2365
 
2314
2366
  /**
2315
2367
  * Queries the current height of the given `framebuffer`.
2316
2368
  * @returns The height of `framebuffer`.
2369
+ * @since 1.8
2317
2370
  */
2318
2371
  get_height(): number;
2319
2372
 
@@ -2321,17 +2374,20 @@ export namespace Cogl {
2321
2374
 
2322
2375
  /**
2323
2376
  * Stores the current model-view matrix in `matrix`.
2377
+ * @since 1.10
2324
2378
  */
2325
2379
  get_modelview_matrix(): Graphene.Matrix;
2326
2380
 
2327
2381
  /**
2328
2382
  * Stores the current projection matrix in `matrix`.
2383
+ * @since 1.10
2329
2384
  */
2330
2385
  get_projection_matrix(): Graphene.Matrix;
2331
2386
 
2332
2387
  /**
2333
2388
  * Retrieves the number of red bits of `framebuffer`
2334
2389
  * @returns the number of bits
2390
+ * @since 1.8
2335
2391
  */
2336
2392
  get_red_bits(): number;
2337
2393
 
@@ -2349,6 +2405,7 @@ export namespace Cogl {
2349
2405
  * framebuffer has been allocated the value will reflect the actual
2350
2406
  * number of samples that will be made by the GPU.
2351
2407
  * @returns The number of point samples made per pixel when rasterizing geometry or 0 if single-sample rendering has been chosen.
2408
+ * @since 1.10
2352
2409
  */
2353
2410
  get_samples_per_pixel(): number;
2354
2411
 
@@ -2356,6 +2413,7 @@ export namespace Cogl {
2356
2413
  * Gets the current {@link Cogl.StereoMode}, which defines which stereo buffers
2357
2414
  * should be drawn to. See `cogl_framebuffer_set_stereo_mode()`.
2358
2415
  * @returns A {@link Cogl.StereoMode}
2416
+ * @since 1.20
2359
2417
  */
2360
2418
  get_stereo_mode(): StereoMode;
2361
2419
 
@@ -2364,6 +2422,7 @@ export namespace Cogl {
2364
2422
  * using `cogl_framebuffer_set_viewport()` or the default values which are 0, 0,
2365
2423
  * framebuffer_width and framebuffer_height. The values are written into the
2366
2424
  * given `viewport` array.
2425
+ * @since 1.8
2367
2426
  */
2368
2427
  get_viewport4fv(): number[];
2369
2428
 
@@ -2371,6 +2430,7 @@ export namespace Cogl {
2371
2430
  * Queries the height of the viewport as set using `cogl_framebuffer_set_viewport()`
2372
2431
  * or the default value which is the height of the framebuffer.
2373
2432
  * @returns The height of the viewport.
2433
+ * @since 1.8
2374
2434
  */
2375
2435
  get_viewport_height(): number;
2376
2436
 
@@ -2378,6 +2438,7 @@ export namespace Cogl {
2378
2438
  * Queries the width of the viewport as set using `cogl_framebuffer_set_viewport()`
2379
2439
  * or the default value which is the width of the framebuffer.
2380
2440
  * @returns The width of the viewport.
2441
+ * @since 1.8
2381
2442
  */
2382
2443
  get_viewport_width(): number;
2383
2444
 
@@ -2385,6 +2446,7 @@ export namespace Cogl {
2385
2446
  * Queries the x coordinate of the viewport origin as set using `cogl_framebuffer_set_viewport()`
2386
2447
  * or the default value which is 0.
2387
2448
  * @returns The x coordinate of the viewport origin.
2449
+ * @since 1.8
2388
2450
  */
2389
2451
  get_viewport_x(): number;
2390
2452
 
@@ -2392,17 +2454,20 @@ export namespace Cogl {
2392
2454
  * Queries the y coordinate of the viewport origin as set using `cogl_framebuffer_set_viewport()`
2393
2455
  * or the default value which is 0.
2394
2456
  * @returns The y coordinate of the viewport origin.
2457
+ * @since 1.8
2395
2458
  */
2396
2459
  get_viewport_y(): number;
2397
2460
 
2398
2461
  /**
2399
2462
  * Queries the current width of the given `framebuffer`.
2400
2463
  * @returns The width of `framebuffer`.
2464
+ * @since 1.8
2401
2465
  */
2402
2466
  get_width(): number;
2403
2467
 
2404
2468
  /**
2405
2469
  * Resets the current model-view matrix to the identity matrix.
2470
+ * @since 1.10
2406
2471
  */
2407
2472
  identity_matrix(): void;
2408
2473
 
@@ -2415,6 +2480,7 @@ export namespace Cogl {
2415
2480
  * @param y_2 The y coordinate for the second horizontal clipping plane
2416
2481
  * @param near The <emphasis>distance</emphasis> to the near clipping plane (will be <emphasis>negative</emphasis> if the plane is behind the viewer)
2417
2482
  * @param far The <emphasis>distance</emphasis> to the far clipping plane (will be <emphasis>negative</emphasis> if the plane is behind the viewer)
2483
+ * @since 1.10
2418
2484
  */
2419
2485
  orthographic(x_1: number, y_1: number, x_2: number, y_2: number, near: number, far: number): void;
2420
2486
 
@@ -2430,6 +2496,7 @@ export namespace Cogl {
2430
2496
  * @param aspect The (width over height) aspect ratio for display
2431
2497
  * @param z_near The distance to the near clipping plane (Must be positive, and must not be 0)
2432
2498
  * @param z_far The distance to the far clipping plane (Must be positive)
2499
+ * @since 1.10
2433
2500
  */
2434
2501
  perspective(fov_y: number, aspect: number, z_near: number, z_far: number): void;
2435
2502
 
@@ -2437,17 +2504,20 @@ export namespace Cogl {
2437
2504
  * Reverts the clipping region to the state before the last call to
2438
2505
  * `cogl_framebuffer_push_scissor_clip()`, `cogl_framebuffer_push_rectangle_clip()`
2439
2506
  * `cogl_framebuffer_push_path_clip()`, or `cogl_framebuffer_push_primitive_clip()`.
2507
+ * @since 1.10
2440
2508
  */
2441
2509
  pop_clip(): void;
2442
2510
 
2443
2511
  /**
2444
2512
  * Restores the model-view matrix on the top of the matrix stack.
2513
+ * @since 1.10
2445
2514
  */
2446
2515
  pop_matrix(): void;
2447
2516
 
2448
2517
  /**
2449
2518
  * Copies the current model-view matrix onto the matrix stack. The matrix
2450
2519
  * can later be restored with `cogl_framebuffer_pop_matrix()`.
2520
+ * @since 1.10
2451
2521
  */
2452
2522
  push_matrix(): void;
2453
2523
 
@@ -2464,6 +2534,7 @@ export namespace Cogl {
2464
2534
  * @param y_1 y coordinate for top left corner of the clip rectangle
2465
2535
  * @param x_2 x coordinate for bottom right corner of the clip rectangle
2466
2536
  * @param y_2 y coordinate for bottom right corner of the clip rectangle
2537
+ * @since 1.10
2467
2538
  */
2468
2539
  push_rectangle_clip(x_1: number, y_1: number, x_2: number, y_2: number): void;
2469
2540
 
@@ -2485,6 +2556,7 @@ export namespace Cogl {
2485
2556
  * @param y top edge of the clip rectangle in window coordinates
2486
2557
  * @param width width of the clip rectangle
2487
2558
  * @param height height of the clip rectangle
2559
+ * @since 1.10
2488
2560
  */
2489
2561
  push_scissor_clip(x: number, y: number, width: number, height: number): void;
2490
2562
 
@@ -2522,6 +2594,7 @@ export namespace Cogl {
2522
2594
  * @param format The pixel format to store the data in
2523
2595
  * @param pixels The address of the buffer to store the data in
2524
2596
  * @returns `true` if the read succeeded or `false` otherwise.
2597
+ * @since 1.10
2525
2598
  */
2526
2599
  read_pixels(x: number, y: number, width: number, height: number, format: PixelFormat, pixels: number): boolean;
2527
2600
 
@@ -2541,6 +2614,7 @@ export namespace Cogl {
2541
2614
  * @param source Identifies which auxiliary buffer you want to read (only COGL_READ_PIXELS_COLOR_BUFFER supported currently)
2542
2615
  * @param bitmap The bitmap to store the results in.
2543
2616
  * @returns `true` if the read succeeded or `false` otherwise. The function is only likely to fail if the bitmap points to a pixel buffer and it could not be mapped.
2617
+ * @since 1.10
2544
2618
  */
2545
2619
  read_pixels_into_bitmap(x: number, y: number, source: ReadPixelsFlags, bitmap: Bitmap): boolean;
2546
2620
 
@@ -2565,6 +2639,7 @@ export namespace Cogl {
2565
2639
  * If you are performing incremental updates to a framebuffer you
2566
2640
  * should consider using `cogl_framebuffer_resolve_samples_region()`
2567
2641
  * instead to avoid resolving redundant pixels.
2642
+ * @since 1.8
2568
2643
  */
2569
2644
  resolve_samples(): void;
2570
2645
 
@@ -2594,6 +2669,7 @@ export namespace Cogl {
2594
2669
  * @param y top-left y coordinate of region to resolve
2595
2670
  * @param width width of region to resolve
2596
2671
  * @param height height of region to resolve
2672
+ * @since 1.8
2597
2673
  */
2598
2674
  resolve_samples_region(x: number, y: number, width: number, height: number): void;
2599
2675
 
@@ -2607,6 +2683,7 @@ export namespace Cogl {
2607
2683
  * @param x X-component of vertex to rotate around.
2608
2684
  * @param y Y-component of vertex to rotate around.
2609
2685
  * @param z Z-component of vertex to rotate around.
2686
+ * @since 1.10
2610
2687
  */
2611
2688
  rotate(angle: number, x: number, y: number, z: number): void;
2612
2689
 
@@ -2614,6 +2691,7 @@ export namespace Cogl {
2614
2691
  * Multiplies the current model-view matrix by one that rotates
2615
2692
  * according to the rotation described by `euler`.
2616
2693
  * @param euler A {@link Graphene.Euler}
2694
+ * @since 2.0
2617
2695
  */
2618
2696
  rotate_euler(euler: Graphene.Euler): void;
2619
2697
 
@@ -2623,6 +2701,7 @@ export namespace Cogl {
2623
2701
  * @param x Amount to scale along the x-axis
2624
2702
  * @param y Amount to scale along the y-axis
2625
2703
  * @param z Amount to scale along the z-axis
2704
+ * @since 1.10
2626
2705
  */
2627
2706
  scale(x: number, y: number, z: number): void;
2628
2707
 
@@ -2634,6 +2713,7 @@ export namespace Cogl {
2634
2713
  *
2635
2714
  * Depth buffer writing is enabled by default.
2636
2715
  * @param depth_write_enabled `true` to enable depth writing or `false` to disable
2716
+ * @since 1.18
2637
2717
  */
2638
2718
  set_depth_write_enabled(depth_write_enabled: boolean): void;
2639
2719
 
@@ -2652,18 +2732,21 @@ export namespace Cogl {
2652
2732
  *
2653
2733
  * Dithering is enabled by default.
2654
2734
  * @param dither_enabled `true` to enable dithering or `false` to disable
2735
+ * @since 1.8
2655
2736
  */
2656
2737
  set_dither_enabled(dither_enabled: boolean): void;
2657
2738
 
2658
2739
  /**
2659
2740
  * Sets `matrix` as the new model-view matrix.
2660
2741
  * @param matrix the new model-view matrix
2742
+ * @since 1.10
2661
2743
  */
2662
2744
  set_modelview_matrix(matrix: Graphene.Matrix): void;
2663
2745
 
2664
2746
  /**
2665
2747
  * Sets `matrix` as the new projection matrix.
2666
2748
  * @param matrix the new projection matrix
2749
+ * @since 1.10
2667
2750
  */
2668
2751
  set_projection_matrix(matrix: Graphene.Matrix): void;
2669
2752
 
@@ -2701,6 +2784,7 @@ export namespace Cogl {
2701
2784
  * framebuffer has changed this can lead to redundant work being
2702
2785
  * done.</note>
2703
2786
  * @param samples_per_pixel The minimum number of samples per pixel
2787
+ * @since 1.8
2704
2788
  */
2705
2789
  set_samples_per_pixel(samples_per_pixel: number): void;
2706
2790
 
@@ -2713,6 +2797,7 @@ export namespace Cogl {
2713
2797
  * enabled. (See `cogl_onscreen_template_set_stereo_enabled()`,
2714
2798
  * `cogl_framebuffer_get_is_stereo()`.)
2715
2799
  * @param stereo_mode A {@link Cogl.StereoMode} specifying which stereo buffers should be drawn tow.
2800
+ * @since 1.20
2716
2801
  */
2717
2802
  set_stereo_mode(stereo_mode: StereoMode): void;
2718
2803
 
@@ -2736,12 +2821,14 @@ export namespace Cogl {
2736
2821
  * @param y The top-left y coordinate of the viewport origin (only integers supported currently)
2737
2822
  * @param width The width of the viewport (only integers supported currently)
2738
2823
  * @param height The height of the viewport (only integers supported currently)
2824
+ * @since 1.8
2739
2825
  */
2740
2826
  set_viewport(x: number, y: number, width: number, height: number): void;
2741
2827
 
2742
2828
  /**
2743
2829
  * Multiplies the current model-view matrix by the given matrix.
2744
2830
  * @param matrix the matrix to multiply with the current model-view
2831
+ * @since 1.10
2745
2832
  */
2746
2833
  transform(matrix: Graphene.Matrix): void;
2747
2834
 
@@ -2751,6 +2838,7 @@ export namespace Cogl {
2751
2838
  * @param x Distance to translate along the x-axis
2752
2839
  * @param y Distance to translate along the y-axis
2753
2840
  * @param z Distance to translate along the z-axis
2841
+ * @since 1.10
2754
2842
  */
2755
2843
  translate(x: number, y: number, z: number): void;
2756
2844
  }
@@ -2924,6 +3012,7 @@ export namespace Cogl {
2924
3012
  * explicitly checked to determine if Cogl is currently tracking the
2925
3013
  * age of {@link Cogl.Onscreen} back buffer contents. If this feature is
2926
3014
  * missing then this function will always return 0.</note>
3015
+ * @since 1.14
2927
3016
  * @virtual
2928
3017
  */
2929
3018
  vfunc_get_buffer_age(): number;
@@ -2969,6 +3058,7 @@ export namespace Cogl {
2969
3058
  * @param rectangles An array of integer 4-tuples representing damaged rectangles as (x, y, width, height) tuples.
2970
3059
  * @param n_rectangles The number of 4-tuples to be read from `rectangles`
2971
3060
  * @param info
3061
+ * @since 1.16
2972
3062
  * @virtual
2973
3063
  */
2974
3064
  vfunc_swap_buffers_with_damage(rectangles: number, n_rectangles: number, info: FrameInfo): void;
@@ -2986,6 +3076,7 @@ export namespace Cogl {
2986
3076
  * @param rectangles An array of integer 4-tuples representing rectangles as (x, y, width, height) tuples.
2987
3077
  * @param n_rectangles The number of 4-tuples to be read from `rectangles`
2988
3078
  * @param info
3079
+ * @since 1.10
2989
3080
  * @virtual
2990
3081
  */
2991
3082
  vfunc_swap_region(rectangles: number, n_rectangles: number, info: FrameInfo): void;
@@ -3011,6 +3102,7 @@ export namespace Cogl {
3011
3102
  * @param callback A callback function to call for dirty events
3012
3103
  * @param destroy An optional callback to destroy `user_data` when the `callback` is removed or `onscreen` is freed.
3013
3104
  * @returns a {@link Cogl.OnscreenDirtyClosure} pointer that can be used to remove the callback and associated `user_data` later.
3105
+ * @since 1.16
3014
3106
  */
3015
3107
  add_dirty_callback(callback: OnscreenDirtyCallback, destroy: UserDataDestroyCallback | null): OnscreenDirtyClosure;
3016
3108
 
@@ -3041,6 +3133,7 @@ export namespace Cogl {
3041
3133
  * @param callback A callback function to call for frame events
3042
3134
  * @param destroy An optional callback to destroy `user_data` when the `callback` is removed or `onscreen` is freed.
3043
3135
  * @returns a {@link Cogl.FrameClosure} pointer that can be used to remove the callback and associated `user_data` later.
3136
+ * @since 1.14
3044
3137
  */
3045
3138
  add_frame_callback(callback: FrameCallback, destroy: UserDataDestroyCallback | null): FrameClosure;
3046
3139
 
@@ -3084,6 +3177,7 @@ export namespace Cogl {
3084
3177
  * age of {@link Cogl.Onscreen} back buffer contents. If this feature is
3085
3178
  * missing then this function will always return 0.</note>
3086
3179
  * @returns The age of the buffer contents or 0 when the buffer contents are undefined.
3180
+ * @since 1.14
3087
3181
  */
3088
3182
  get_buffer_age(): number;
3089
3183
 
@@ -3093,6 +3187,7 @@ export namespace Cogl {
3093
3187
  * `cogl_onscreen_swap_buffers()` or `cogl_onscreen_swap_region()`
3094
3188
  * is called.
3095
3189
  * @returns the current frame counter value
3190
+ * @since 1.14
3096
3191
  */
3097
3192
  get_frame_counter(): number;
3098
3193
 
@@ -3111,6 +3206,7 @@ export namespace Cogl {
3111
3206
  * requests e.g. to show an already visible window. This also means
3112
3207
  * that it's acceptable to alternatively use native APIs to show and
3113
3208
  * hide windows without confusing Cogl.</note>
3209
+ * @since 2.0
3114
3210
  */
3115
3211
  hide(): void;
3116
3212
 
@@ -3122,6 +3218,7 @@ export namespace Cogl {
3122
3218
  * `cogl_onscreen_add_dirty_callback()` to destroy the user data then
3123
3219
  * this will also get called.
3124
3220
  * @param closure A {@link Cogl.OnscreenDirtyClosure} returned from `cogl_onscreen_add_dirty_callback()`
3221
+ * @since 1.16
3125
3222
  */
3126
3223
  remove_dirty_callback(closure: OnscreenDirtyClosure): void;
3127
3224
 
@@ -3133,6 +3230,7 @@ export namespace Cogl {
3133
3230
  * `cogl_onscreen_add_frame_callback()` to destroy the user data then
3134
3231
  * this will get called.
3135
3232
  * @param closure A {@link Cogl.FrameClosure} returned from `cogl_onscreen_add_frame_callback()`
3233
+ * @since 1.14
3136
3234
  */
3137
3235
  remove_frame_callback(closure: FrameClosure): void;
3138
3236
 
@@ -3157,6 +3255,7 @@ export namespace Cogl {
3157
3255
  * requests e.g. to show an already visible window. This also means
3158
3256
  * that it's acceptable to alternatively use native APIs to show and
3159
3257
  * hide windows without confusing Cogl.</note>
3258
+ * @since 2.0
3160
3259
  */
3161
3260
  show(): void;
3162
3261
 
@@ -3176,6 +3275,7 @@ export namespace Cogl {
3176
3275
  * render a full buffer for every frame.</note>
3177
3276
  * @param frame_info
3178
3277
  * @param user_data
3278
+ * @since 1.10
3179
3279
  */
3180
3280
  swap_buffers(frame_info: FrameInfo, user_data: null): void;
3181
3281
 
@@ -3221,6 +3321,7 @@ export namespace Cogl {
3221
3321
  * @param n_rectangles The number of 4-tuples to be read from `rectangles`
3222
3322
  * @param info
3223
3323
  * @param user_data
3324
+ * @since 1.16
3224
3325
  */
3225
3326
  swap_buffers_with_damage(rectangles: number, n_rectangles: number, info: FrameInfo, user_data: null): void;
3226
3327
 
@@ -3238,6 +3339,7 @@ export namespace Cogl {
3238
3339
  * @param n_rectangles The number of 4-tuples to be read from `rectangles`
3239
3340
  * @param info
3240
3341
  * @param user_data
3342
+ * @since 1.10
3241
3343
  */
3242
3344
  swap_region(rectangles: number, n_rectangles: number, info: FrameInfo, user_data: null): void;
3243
3345
  }
@@ -3283,32 +3385,38 @@ export namespace Cogl {
3283
3385
  * keep track of a pipelines ancestry which we may use to help minimize GPU
3284
3386
  * state changes.
3285
3387
  * @returns a pointer to the newly allocated {@link Cogl.Pipeline}
3388
+ * @since 2.0
3286
3389
  */
3287
3390
  copy(): Pipeline;
3288
3391
 
3289
3392
  /**
3290
3393
  * Iterates all the layer indices of the given `pipeline`.
3291
3394
  * @param callback A {@link Cogl.PipelineLayerCallback} to be called for each layer index
3395
+ * @since 2.0
3292
3396
  */
3293
3397
  foreach_layer(callback: PipelineLayerCallback): void;
3294
3398
 
3295
3399
  /**
3296
3400
  * @returns The alpha test function of `pipeline`.
3401
+ * @since 2.0
3297
3402
  */
3298
3403
  get_alpha_test_function(): PipelineAlphaFunc;
3299
3404
 
3300
3405
  /**
3301
3406
  * @returns The alpha test reference value of `pipeline`.
3407
+ * @since 2.0
3302
3408
  */
3303
3409
  get_alpha_test_reference(): number;
3304
3410
 
3305
3411
  /**
3306
3412
  * Retrieves the current pipeline color.
3413
+ * @since 2.0
3307
3414
  */
3308
3415
  get_color(): Color;
3309
3416
 
3310
3417
  /**
3311
3418
  * @returns the cull face mode that was previously set with `cogl_pipeline_set_cull_face_mode()`. Status: Unstable
3419
+ * @since 2.0
3312
3420
  */
3313
3421
  get_cull_face_mode(): PipelineCullFaceMode;
3314
3422
 
@@ -3321,6 +3429,7 @@ export namespace Cogl {
3321
3429
  * {@link Cogl.Winding.CLOCKWISE} sets them to be clockwise. The default is
3322
3430
  * {@link Cogl.Winding.COUNTER_CLOCKWISE}.
3323
3431
  * @returns The `pipeline` front face winding Status: Unstable
3432
+ * @since 2.0
3324
3433
  */
3325
3434
  get_front_face_winding(): Winding;
3326
3435
 
@@ -3333,6 +3442,7 @@ export namespace Cogl {
3333
3442
  * changed using `cogl_pipeline_set_layer_filters()`.
3334
3443
  * @param layer_index the layer number to change.
3335
3444
  * @returns The magnification {@link Cogl.PipelineFilter} for the specified layer.
3445
+ * @since 1.10
3336
3446
  */
3337
3447
  get_layer_mag_filter(layer_index: number): PipelineFilter;
3338
3448
 
@@ -3345,6 +3455,7 @@ export namespace Cogl {
3345
3455
  * changed using `cogl_pipeline_set_layer_filters()`.
3346
3456
  * @param layer_index the layer number to change.
3347
3457
  * @returns The minification {@link Cogl.PipelineFilter} for the specified layer.
3458
+ * @since 1.10
3348
3459
  */
3349
3460
  get_layer_min_filter(layer_index: number): PipelineFilter;
3350
3461
 
@@ -3353,12 +3464,14 @@ export namespace Cogl {
3353
3464
  * texture layer.
3354
3465
  * @param layer_index the layer number to check.
3355
3466
  * @returns whether the texture coordinates will be replaced with point sprite coordinates.
3467
+ * @since 2.0
3356
3468
  */
3357
3469
  get_layer_point_sprite_coords_enabled(layer_index: number): boolean;
3358
3470
 
3359
3471
  /**
3360
3472
  * @param layer_index the index of the layer
3361
3473
  * @returns the texture that was set for the given layer of the pipeline or `null` if no texture was set.
3474
+ * @since 1.10
3362
3475
  */
3363
3476
  get_layer_texture(layer_index: number): Texture;
3364
3477
 
@@ -3367,6 +3480,7 @@ export namespace Cogl {
3367
3480
  * layer.
3368
3481
  * @param layer_index the layer number to change.
3369
3482
  * @returns the wrap mode for the 's' coordinate of texture lookups on this layer.
3483
+ * @since 1.6
3370
3484
  */
3371
3485
  get_layer_wrap_mode_s(layer_index: number): PipelineWrapMode;
3372
3486
 
@@ -3375,17 +3489,20 @@ export namespace Cogl {
3375
3489
  * layer.
3376
3490
  * @param layer_index the layer number to change.
3377
3491
  * @returns the wrap mode for the 't' coordinate of texture lookups on this layer.
3492
+ * @since 1.6
3378
3493
  */
3379
3494
  get_layer_wrap_mode_t(layer_index: number): PipelineWrapMode;
3380
3495
 
3381
3496
  /**
3382
3497
  * Retrieves the number of layers defined for the given `pipeline`
3383
3498
  * @returns the number of layers
3499
+ * @since 2.0
3384
3500
  */
3385
3501
  get_n_layers(): number;
3386
3502
 
3387
3503
  /**
3388
3504
  * @returns `true` if the pipeline has per-vertex point size enabled or `false` otherwise. The per-vertex point size can be enabled with `cogl_pipeline_set_per_vertex_point_size()`.
3505
+ * @since 2.0
3389
3506
  */
3390
3507
  get_per_vertex_point_size(): boolean;
3391
3508
 
@@ -3393,6 +3510,7 @@ export namespace Cogl {
3393
3510
  * Get the size of points drawn when {@link Cogl.VerticesMode.POINTS} is
3394
3511
  * used with the vertex buffer API.
3395
3512
  * @returns the point size of the `pipeline`.
3513
+ * @since 2.0
3396
3514
  */
3397
3515
  get_point_size(): number;
3398
3516
 
@@ -3408,6 +3526,7 @@ export namespace Cogl {
3408
3526
  * before calling this function.
3409
3527
  * @param uniform_name The name of a uniform
3410
3528
  * @returns A integer representing the location of the given uniform.
3529
+ * @since 2.0
3411
3530
  */
3412
3531
  get_uniform_location(uniform_name: string): number;
3413
3532
 
@@ -3415,12 +3534,14 @@ export namespace Cogl {
3415
3534
  * Queries what user program has been associated with the given
3416
3535
  * `pipeline` using `cogl_pipeline_set_user_program()`.
3417
3536
  * @returns The current user program or `null`.
3537
+ * @since 2.0
3418
3538
  */
3419
3539
  get_user_program(): Handle;
3420
3540
 
3421
3541
  /**
3422
3542
  * This function removes a layer from your pipeline
3423
3543
  * @param layer_index Specifies the layer you want to remove
3544
+ * @since 1.10
3424
3545
  */
3425
3546
  remove_layer(layer_index: number): void;
3426
3547
 
@@ -3434,6 +3555,7 @@ export namespace Cogl {
3434
3555
  * The default is {@link Cogl.PipelineAlphaFunc.ALWAYS}
3435
3556
  * @param alpha_func A `CoglPipelineAlphaFunc` constant
3436
3557
  * @param alpha_reference A reference point that the chosen alpha function uses to compare incoming fragments to.
3558
+ * @since 2.0
3437
3559
  */
3438
3560
  set_alpha_test_function(alpha_func: PipelineAlphaFunc, alpha_reference: number): void;
3439
3561
 
@@ -3505,6 +3627,8 @@ export namespace Cogl {
3505
3627
  * is in premultiplied form.
3506
3628
  * @param blend_string A <link linkend="cogl-Blend-Strings">Cogl blend string</link> describing the desired blend function.
3507
3629
  * @returns `true` if the blend string was successfully parsed, and the described blending is supported by the underlying driver/hardware. If there was an error, `false` is returned and `error` is set accordingly (if present).
3630
+ * @since 2.0
3631
+ * @throws GLib.Error
3508
3632
  */
3509
3633
  set_blend(blend_string: string): boolean;
3510
3634
 
@@ -3512,6 +3636,7 @@ export namespace Cogl {
3512
3636
  * When blending is setup to reference a CONSTANT blend factor then
3513
3637
  * blending will depend on the constant set with this function.
3514
3638
  * @param constant_color The constant color you want
3639
+ * @since 2.0
3515
3640
  */
3516
3641
  set_blend_constant(constant_color: Color): void;
3517
3642
 
@@ -3525,6 +3650,7 @@ export namespace Cogl {
3525
3650
  *
3526
3651
  * The default value is (1.0, 1.0, 1.0, 1.0)
3527
3652
  * @param color The components of the color
3653
+ * @since 2.0
3528
3654
  */
3529
3655
  set_color(color: Color): void;
3530
3656
 
@@ -3536,6 +3662,7 @@ export namespace Cogl {
3536
3662
  * @param green The green component
3537
3663
  * @param blue The blue component
3538
3664
  * @param alpha The alpha component
3665
+ * @since 2.0
3539
3666
  */
3540
3667
  set_color4f(red: number, green: number, blue: number, alpha: number): void;
3541
3668
 
@@ -3547,6 +3674,7 @@ export namespace Cogl {
3547
3674
  * @param green The green component
3548
3675
  * @param blue The blue component
3549
3676
  * @param alpha The alpha component
3677
+ * @since 2.0
3550
3678
  */
3551
3679
  set_color4ub(red: number, green: number, blue: number, alpha: number): void;
3552
3680
 
@@ -3566,6 +3694,7 @@ export namespace Cogl {
3566
3694
  *
3567
3695
  * Status: Unstable
3568
3696
  * @param cull_face_mode The new mode to set
3697
+ * @since 2.0
3569
3698
  */
3570
3699
  set_cull_face_mode(cull_face_mode: PipelineCullFaceMode): void;
3571
3700
 
@@ -3580,6 +3709,7 @@ export namespace Cogl {
3580
3709
  *
3581
3710
  * Status: Unstable
3582
3711
  * @param front_winding the winding order
3712
+ * @since 2.0
3583
3713
  */
3584
3714
  set_front_face_winding(front_winding: Winding): void;
3585
3715
 
@@ -3663,6 +3793,8 @@ export namespace Cogl {
3663
3793
  * @param layer_index Specifies the layer you want define a combine function for
3664
3794
  * @param blend_string A <link linkend="cogl-Blend-Strings">Cogl blend string</link> describing the desired texture combine function.
3665
3795
  * @returns `true` if the blend string was successfully parsed, and the described texture combining is supported by the underlying driver and or hardware. On failure, `false` is returned and `error` is set
3796
+ * @since 2.0
3797
+ * @throws GLib.Error
3666
3798
  */
3667
3799
  set_layer_combine(layer_index: number, blend_string: string): boolean;
3668
3800
 
@@ -3671,6 +3803,7 @@ export namespace Cogl {
3671
3803
  * description then you can use this function to define its value.
3672
3804
  * @param layer_index Specifies the layer you want to specify a constant used for texture combining
3673
3805
  * @param constant The constant color you want
3806
+ * @since 2.0
3674
3807
  */
3675
3808
  set_layer_combine_constant(layer_index: number, constant: Color): void;
3676
3809
 
@@ -3685,6 +3818,7 @@ export namespace Cogl {
3685
3818
  * @param layer_index the layer number to change.
3686
3819
  * @param min_filter the filter used when scaling a texture down.
3687
3820
  * @param mag_filter the filter used when magnifying a texture.
3821
+ * @since 1.10
3688
3822
  */
3689
3823
  set_layer_filters(layer_index: number, min_filter: PipelineFilter, mag_filter: PipelineFilter): void;
3690
3824
 
@@ -3693,6 +3827,7 @@ export namespace Cogl {
3693
3827
  * and rotate a single layer of a pipeline used to fill your geometry.
3694
3828
  * @param layer_index the index for the layer inside `pipeline`
3695
3829
  * @param matrix the transformation matrix for the layer
3830
+ * @since 1.10
3696
3831
  */
3697
3832
  set_layer_matrix(layer_index: number, matrix: Graphene.Matrix): void;
3698
3833
 
@@ -3712,6 +3847,7 @@ export namespace Cogl {
3712
3847
  * specify the texture type so that any pipeline copies can share the
3713
3848
  * internal texture type state for efficiency.
3714
3849
  * @param layer_index The layer number to modify
3850
+ * @since 1.10
3715
3851
  */
3716
3852
  set_layer_null_texture(layer_index: number): void;
3717
3853
 
@@ -3725,6 +3861,8 @@ export namespace Cogl {
3725
3861
  * @param layer_index the layer number to change.
3726
3862
  * @param enable whether to enable point sprite coord generation.
3727
3863
  * @returns `true` if the function succeeds, `false` otherwise.
3864
+ * @since 2.0
3865
+ * @throws GLib.Error
3728
3866
  */
3729
3867
  set_layer_point_sprite_coords_enabled(layer_index: number, enable: boolean): boolean;
3730
3868
 
@@ -3741,6 +3879,7 @@ export namespace Cogl {
3741
3879
  * `cogl_pipeline_set_layer_wrap_mode_t()` separately.
3742
3880
  * @param layer_index the layer number to change.
3743
3881
  * @param mode the new wrap mode
3882
+ * @since 2.0
3744
3883
  */
3745
3884
  set_layer_wrap_mode(layer_index: number, mode: PipelineWrapMode): void;
3746
3885
 
@@ -3748,6 +3887,7 @@ export namespace Cogl {
3748
3887
  * Sets the wrap mode for the 's' coordinate of texture lookups on this layer.
3749
3888
  * @param layer_index the layer number to change.
3750
3889
  * @param mode the new wrap mode
3890
+ * @since 2.0
3751
3891
  */
3752
3892
  set_layer_wrap_mode_s(layer_index: number, mode: PipelineWrapMode): void;
3753
3893
 
@@ -3755,6 +3895,7 @@ export namespace Cogl {
3755
3895
  * Sets the wrap mode for the 't' coordinate of texture lookups on this layer.
3756
3896
  * @param layer_index the layer number to change.
3757
3897
  * @param mode the new wrap mode
3898
+ * @since 2.0
3758
3899
  */
3759
3900
  set_layer_wrap_mode_t(layer_index: number, mode: PipelineWrapMode): void;
3760
3901
 
@@ -3771,6 +3912,8 @@ export namespace Cogl {
3771
3912
  * undefined.
3772
3913
  * @param enable whether to enable per-vertex point size
3773
3914
  * @returns `true` if the change succeeded or `false` otherwise
3915
+ * @since 2.0
3916
+ * @throws GLib.Error
3774
3917
  */
3775
3918
  set_per_vertex_point_size(enable: boolean): boolean;
3776
3919
 
@@ -3788,6 +3931,7 @@ export namespace Cogl {
3788
3931
  * if an application wants to draw points it must make sure to use a
3789
3932
  * pipeline that has an explicit point size set on it.
3790
3933
  * @param point_size the new point size.
3934
+ * @since 2.0
3791
3935
  */
3792
3936
  set_point_size(point_size: number): void;
3793
3937
 
@@ -3804,6 +3948,7 @@ export namespace Cogl {
3804
3948
  * uniform.
3805
3949
  * @param uniform_location The uniform's location identifier
3806
3950
  * @param value The new value for the uniform
3951
+ * @since 2.0
3807
3952
  */
3808
3953
  set_uniform_1f(uniform_location: number, value: number): void;
3809
3954
 
@@ -3820,6 +3965,7 @@ export namespace Cogl {
3820
3965
  * uniform or a sampler uniform.
3821
3966
  * @param uniform_location The uniform's location identifier
3822
3967
  * @param value The new value for the uniform
3968
+ * @since 2.0
3823
3969
  */
3824
3970
  set_uniform_1i(uniform_location: number, value: number): void;
3825
3971
 
@@ -3840,6 +3986,7 @@ export namespace Cogl {
3840
3986
  * @param n_components The number of components in the corresponding uniform's type
3841
3987
  * @param count The number of values to set
3842
3988
  * @param value Pointer to the new values to set
3989
+ * @since 2.0
3843
3990
  */
3844
3991
  set_uniform_float(uniform_location: number, n_components: number, count: number, value: number): void;
3845
3992
 
@@ -3860,6 +4007,7 @@ export namespace Cogl {
3860
4007
  * @param n_components The number of components in the corresponding uniform's type
3861
4008
  * @param count The number of values to set
3862
4009
  * @param value Pointer to the new values to set
4010
+ * @since 2.0
3863
4011
  */
3864
4012
  set_uniform_int(uniform_location: number, n_components: number, count: number, value: number): void;
3865
4013
 
@@ -3886,6 +4034,7 @@ export namespace Cogl {
3886
4034
  * @param count The number of values to set
3887
4035
  * @param transpose Whether to transpose the matrix
3888
4036
  * @param value Pointer to the new values to set
4037
+ * @since 2.0
3889
4038
  */
3890
4039
  set_uniform_matrix(uniform_location: number, dimensions: number, count: number, transpose: boolean, value: number): void;
3891
4040
 
@@ -3926,6 +4075,7 @@ export namespace Cogl {
3926
4075
  * meantime we hope this will handle most practical GLSL and ARBfp
3927
4076
  * requirements.
3928
4077
  * @param program A {@link Cogl.Handle} to a linked CoglProgram
4078
+ * @since 2.0
3929
4079
  */
3930
4080
  set_user_program(program: Handle): void;
3931
4081
  }
@@ -3981,6 +4131,7 @@ export namespace Cogl {
3981
4131
  * the texture, or if the texture is attached to a {@link Cogl.Offscreen}
3982
4132
  * framebuffer and rendered too.</note>
3983
4133
  * @returns `true` if the texture was successfully allocated, otherwise `false` and `error` will be updated if it wasn't `null`.
4134
+ * @throws GLib.Error
3984
4135
  */
3985
4136
  allocate(): boolean;
3986
4137
 
@@ -3992,6 +4143,7 @@ export namespace Cogl {
3992
4143
  * is {@link Cogl.TextureComponents.RGBA}. The other constructors which take
3993
4144
  * a %CoglBitmap or a data pointer default to the same components as
3994
4145
  * the pixel format of the data.
4146
+ * @since 1.18
3995
4147
  */
3996
4148
  get_components(): TextureComponents;
3997
4149
 
@@ -4038,6 +4190,7 @@ export namespace Cogl {
4038
4190
  *
4039
4191
  * By default the pre-multipled state is `TRUE`.
4040
4192
  * @returns `true` if red, green and blue components are internally stored pre-multiplied by the alpha value or `false` if not.
4193
+ * @since 1.18
4041
4194
  */
4042
4195
  get_premultiplied(): boolean;
4043
4196
 
@@ -4070,6 +4223,8 @@ export namespace Cogl {
4070
4223
  * @param sub_width Width in pixels of the subregion
4071
4224
  * @param sub_height Height in pixels of the subregion
4072
4225
  * @returns A newly created {@link Cogl.Texture} or `null` on failure
4226
+ * @since 1.2
4227
+ * @deprecated since 1.18: Use `cogl_sub_texture_new()`
4073
4228
  */
4074
4229
  new_from_sub_texture(sub_x: number, sub_y: number, sub_width: number, sub_height: number): Texture;
4075
4230
 
@@ -4094,6 +4249,7 @@ export namespace Cogl {
4094
4249
  * an image format as long as {@link Cogl.TextureComponents.RG} isn't used
4095
4250
  * as the texture's components.
4096
4251
  * @param components
4252
+ * @since 1.18
4097
4253
  */
4098
4254
  set_components(components: TextureComponents): void;
4099
4255
 
@@ -4145,6 +4301,7 @@ export namespace Cogl {
4145
4301
  * @param data the source data, pointing to the first top-left pixel to set
4146
4302
  * @param level The mipmap level to update (Normally 0 for the largest, base texture)
4147
4303
  * @returns `true` if the data upload was successful, and `false` otherwise
4304
+ * @throws GLib.Error
4148
4305
  */
4149
4306
  set_data(format: PixelFormat, rowstride: number, data: Uint8Array | string, level: number): boolean;
4150
4307
 
@@ -4171,6 +4328,7 @@ export namespace Cogl {
4171
4328
  *
4172
4329
  * By default the `premultipled` state is `TRUE`.
4173
4330
  * @param premultiplied Whether any internally stored red, green or blue components are pre-multiplied by an alpha component.
4331
+ * @since 1.18
4174
4332
  */
4175
4333
  set_premultiplied(premultiplied: boolean): void;
4176
4334
 
@@ -4208,6 +4366,7 @@ export namespace Cogl {
4208
4366
  * @param dst_height height of destination region to write. (Must be less than or equal to the bitmap height)
4209
4367
  * @param bitmap The source bitmap to read from
4210
4368
  * @returns `true` if the subregion upload was successful, and `false` otherwise
4369
+ * @since 1.8
4211
4370
  */
4212
4371
  set_region_from_bitmap(src_x: number, src_y: number, dst_x: number, dst_y: number, dst_width: number, dst_height: number, bitmap: Bitmap): boolean;
4213
4372
  }
@@ -4255,6 +4414,7 @@ export namespace Cogl {
4255
4414
  * the texture, or if the texture is attached to a {@link Cogl.Offscreen}
4256
4415
  * framebuffer and rendered too.</note>
4257
4416
  * @returns `true` if the texture was successfully allocated, otherwise `false` and `error` will be updated if it wasn't `null`.
4417
+ * @throws GLib.Error
4258
4418
  */
4259
4419
  allocate(): boolean;
4260
4420
 
@@ -4266,6 +4426,7 @@ export namespace Cogl {
4266
4426
  * is {@link Cogl.TextureComponents.RGBA}. The other constructors which take
4267
4427
  * a %CoglBitmap or a data pointer default to the same components as
4268
4428
  * the pixel format of the data.
4429
+ * @since 1.18
4269
4430
  */
4270
4431
  get_components(): TextureComponents;
4271
4432
 
@@ -4312,6 +4473,7 @@ export namespace Cogl {
4312
4473
  *
4313
4474
  * By default the pre-multipled state is `TRUE`.
4314
4475
  * @returns `true` if red, green and blue components are internally stored pre-multiplied by the alpha value or `false` if not.
4476
+ * @since 1.18
4315
4477
  */
4316
4478
  get_premultiplied(): boolean;
4317
4479
 
@@ -4344,6 +4506,8 @@ export namespace Cogl {
4344
4506
  * @param sub_width Width in pixels of the subregion
4345
4507
  * @param sub_height Height in pixels of the subregion
4346
4508
  * @returns A newly created {@link Cogl.Texture} or `null` on failure
4509
+ * @since 1.2
4510
+ * @deprecated since 1.18: Use `cogl_sub_texture_new()`
4347
4511
  */
4348
4512
  new_from_sub_texture(sub_x: number, sub_y: number, sub_width: number, sub_height: number): Texture;
4349
4513
 
@@ -4368,6 +4532,7 @@ export namespace Cogl {
4368
4532
  * an image format as long as {@link Cogl.TextureComponents.RG} isn't used
4369
4533
  * as the texture's components.
4370
4534
  * @param components
4535
+ * @since 1.18
4371
4536
  */
4372
4537
  set_components(components: TextureComponents): void;
4373
4538
 
@@ -4419,6 +4584,7 @@ export namespace Cogl {
4419
4584
  * @param data the source data, pointing to the first top-left pixel to set
4420
4585
  * @param level The mipmap level to update (Normally 0 for the largest, base texture)
4421
4586
  * @returns `true` if the data upload was successful, and `false` otherwise
4587
+ * @throws GLib.Error
4422
4588
  */
4423
4589
  set_data(format: PixelFormat, rowstride: number, data: Uint8Array | string, level: number): boolean;
4424
4590
 
@@ -4445,6 +4611,7 @@ export namespace Cogl {
4445
4611
  *
4446
4612
  * By default the `premultipled` state is `TRUE`.
4447
4613
  * @param premultiplied Whether any internally stored red, green or blue components are pre-multiplied by an alpha component.
4614
+ * @since 1.18
4448
4615
  */
4449
4616
  set_premultiplied(premultiplied: boolean): void;
4450
4617
 
@@ -4482,6 +4649,7 @@ export namespace Cogl {
4482
4649
  * @param dst_height height of destination region to write. (Must be less than or equal to the bitmap height)
4483
4650
  * @param bitmap The source bitmap to read from
4484
4651
  * @returns `true` if the subregion upload was successful, and `false` otherwise
4652
+ * @since 1.8
4485
4653
  */
4486
4654
  set_region_from_bitmap(src_x: number, src_y: number, dst_x: number, dst_y: number, dst_width: number, dst_height: number, bitmap: Bitmap): boolean;
4487
4655
  }
@@ -4510,6 +4678,7 @@ export namespace Cogl {
4510
4678
  * parameter, when using {@link Cogl.Color}<!-- -->s as keys in a {@link GLib.HashTable}.
4511
4679
  * @param v1 a {@link Cogl.Color}
4512
4680
  * @param v2 a {@link Cogl.Color}
4681
+ * @since 1.0
4513
4682
  */
4514
4683
  static equal(v1: null, v2: null): boolean;
4515
4684
 
@@ -4519,6 +4688,7 @@ export namespace Cogl {
4519
4688
  * @param hue hue value, in the 0 .. 360 range
4520
4689
  * @param saturation saturation value, in the 0 .. 1 range
4521
4690
  * @param luminance luminance value, in the 0 .. 1 range
4691
+ * @since 1.16
4522
4692
  */
4523
4693
  static init_from_hsl(hue: number, saturation: number, luminance: number): Color;
4524
4694
 
@@ -4526,11 +4696,13 @@ export namespace Cogl {
4526
4696
  /**
4527
4697
  * Creates a copy of `color`
4528
4698
  * @returns a newly-allocated {@link Cogl.Color}. Use `cogl_color_free()` to free the allocate resources
4699
+ * @since 1.0
4529
4700
  */
4530
4701
  copy(): Color;
4531
4702
 
4532
4703
  /**
4533
4704
  * Frees the resources allocated by `cogl_color_new()` and `cogl_color_copy()`
4705
+ * @since 1.0
4534
4706
  */
4535
4707
  free(): void;
4536
4708
 
@@ -4538,6 +4710,7 @@ export namespace Cogl {
4538
4710
  * Retrieves the alpha channel of `color` as a fixed point
4539
4711
  * value between 0 and 1.0.
4540
4712
  * @returns the alpha channel of the passed color
4713
+ * @since 1.0
4541
4714
  */
4542
4715
  get_alpha(): number;
4543
4716
 
@@ -4545,6 +4718,7 @@ export namespace Cogl {
4545
4718
  * Retrieves the alpha channel of `color` as a byte value
4546
4719
  * between 0 and 255
4547
4720
  * @returns the alpha channel of the passed color
4721
+ * @since 1.0
4548
4722
  */
4549
4723
  get_alpha_byte(): number;
4550
4724
 
@@ -4552,6 +4726,7 @@ export namespace Cogl {
4552
4726
  * Retrieves the alpha channel of `color` as a floating point
4553
4727
  * value between 0.0 and 1.0
4554
4728
  * @returns the alpha channel of the passed color
4729
+ * @since 1.0
4555
4730
  */
4556
4731
  get_alpha_float(): number;
4557
4732
 
@@ -4559,6 +4734,7 @@ export namespace Cogl {
4559
4734
  * Retrieves the blue channel of `color` as a fixed point
4560
4735
  * value between 0 and 1.0.
4561
4736
  * @returns the blue channel of the passed color
4737
+ * @since 1.0
4562
4738
  */
4563
4739
  get_blue(): number;
4564
4740
 
@@ -4566,6 +4742,7 @@ export namespace Cogl {
4566
4742
  * Retrieves the blue channel of `color` as a byte value
4567
4743
  * between 0 and 255
4568
4744
  * @returns the blue channel of the passed color
4745
+ * @since 1.0
4569
4746
  */
4570
4747
  get_blue_byte(): number;
4571
4748
 
@@ -4573,6 +4750,7 @@ export namespace Cogl {
4573
4750
  * Retrieves the blue channel of `color` as a floating point
4574
4751
  * value between 0.0 and 1.0
4575
4752
  * @returns the blue channel of the passed color
4753
+ * @since 1.0
4576
4754
  */
4577
4755
  get_blue_float(): number;
4578
4756
 
@@ -4580,6 +4758,7 @@ export namespace Cogl {
4580
4758
  * Retrieves the green channel of `color` as a fixed point
4581
4759
  * value between 0 and 1.0.
4582
4760
  * @returns the green channel of the passed color
4761
+ * @since 1.0
4583
4762
  */
4584
4763
  get_green(): number;
4585
4764
 
@@ -4587,6 +4766,7 @@ export namespace Cogl {
4587
4766
  * Retrieves the green channel of `color` as a byte value
4588
4767
  * between 0 and 255
4589
4768
  * @returns the green channel of the passed color
4769
+ * @since 1.0
4590
4770
  */
4591
4771
  get_green_byte(): number;
4592
4772
 
@@ -4594,6 +4774,7 @@ export namespace Cogl {
4594
4774
  * Retrieves the green channel of `color` as a floating point
4595
4775
  * value between 0.0 and 1.0
4596
4776
  * @returns the green channel of the passed color
4777
+ * @since 1.0
4597
4778
  */
4598
4779
  get_green_float(): number;
4599
4780
 
@@ -4601,6 +4782,7 @@ export namespace Cogl {
4601
4782
  * Retrieves the red channel of `color` as a fixed point
4602
4783
  * value between 0 and 1.0.
4603
4784
  * @returns the red channel of the passed color
4785
+ * @since 1.0
4604
4786
  */
4605
4787
  get_red(): number;
4606
4788
 
@@ -4608,6 +4790,7 @@ export namespace Cogl {
4608
4790
  * Retrieves the red channel of `color` as a byte value
4609
4791
  * between 0 and 255
4610
4792
  * @returns the red channel of the passed color
4793
+ * @since 1.0
4611
4794
  */
4612
4795
  get_red_byte(): number;
4613
4796
 
@@ -4615,6 +4798,7 @@ export namespace Cogl {
4615
4798
  * Retrieves the red channel of `color` as a floating point
4616
4799
  * value between 0.0 and 1.0
4617
4800
  * @returns the red channel of the passed color
4801
+ * @since 1.0
4618
4802
  */
4619
4803
  get_red_float(): number;
4620
4804
 
@@ -4624,12 +4808,14 @@ export namespace Cogl {
4624
4808
  * @param green value of the green channel, between 0 and 1.0
4625
4809
  * @param blue value of the blue channel, between 0 and 1.0
4626
4810
  * @param alpha value of the alpha channel, between 0 and 1.0
4811
+ * @since 1.4
4627
4812
  */
4628
4813
  init_from_4f(red: number, green: number, blue: number, alpha: number): void;
4629
4814
 
4630
4815
  /**
4631
4816
  * Sets the values of the passed channels into a {@link Cogl.Color}
4632
4817
  * @param color_array a pointer to an array of 4 float color components
4818
+ * @since 1.4
4633
4819
  */
4634
4820
  init_from_4fv(color_array: number): void;
4635
4821
 
@@ -4639,6 +4825,7 @@ export namespace Cogl {
4639
4825
  * @param green value of the green channel, between 0 and 255
4640
4826
  * @param blue value of the blue channel, between 0 and 255
4641
4827
  * @param alpha value of the alpha channel, between 0 and 255
4828
+ * @since 1.4
4642
4829
  */
4643
4830
  init_from_4ub(red: number, green: number, blue: number, alpha: number): void;
4644
4831
 
@@ -4646,78 +4833,91 @@ export namespace Cogl {
4646
4833
  * Converts a non-premultiplied color to a pre-multiplied color. For
4647
4834
  * example, semi-transparent red is (1.0, 0, 0, 0.5) when non-premultiplied
4648
4835
  * and (0.5, 0, 0, 0.5) when premultiplied.
4836
+ * @since 1.0
4649
4837
  */
4650
4838
  premultiply(): void;
4651
4839
 
4652
4840
  /**
4653
4841
  * Sets the alpha channel of `color` to `alpha`.
4654
4842
  * @param alpha a float value between 0.0f and 1.0f
4843
+ * @since 1.4
4655
4844
  */
4656
4845
  set_alpha(alpha: number): void;
4657
4846
 
4658
4847
  /**
4659
4848
  * Sets the alpha channel of `color` to `alpha`.
4660
4849
  * @param alpha a byte value between 0 and 255
4850
+ * @since 1.4
4661
4851
  */
4662
4852
  set_alpha_byte(alpha: number): void;
4663
4853
 
4664
4854
  /**
4665
4855
  * Sets the alpha channel of `color` to `alpha`.
4666
4856
  * @param alpha a float value between 0.0f and 1.0f
4857
+ * @since 1.4
4667
4858
  */
4668
4859
  set_alpha_float(alpha: number): void;
4669
4860
 
4670
4861
  /**
4671
4862
  * Sets the blue channel of `color` to `blue`.
4672
4863
  * @param blue a float value between 0.0f and 1.0f
4864
+ * @since 1.4
4673
4865
  */
4674
4866
  set_blue(blue: number): void;
4675
4867
 
4676
4868
  /**
4677
4869
  * Sets the blue channel of `color` to `blue`.
4678
4870
  * @param blue a byte value between 0 and 255
4871
+ * @since 1.4
4679
4872
  */
4680
4873
  set_blue_byte(blue: number): void;
4681
4874
 
4682
4875
  /**
4683
4876
  * Sets the blue channel of `color` to `blue`.
4684
4877
  * @param blue a float value between 0.0f and 1.0f
4878
+ * @since 1.4
4685
4879
  */
4686
4880
  set_blue_float(blue: number): void;
4687
4881
 
4688
4882
  /**
4689
4883
  * Sets the green channel of `color` to `green`.
4690
4884
  * @param green a float value between 0.0f and 1.0f
4885
+ * @since 1.4
4691
4886
  */
4692
4887
  set_green(green: number): void;
4693
4888
 
4694
4889
  /**
4695
4890
  * Sets the green channel of `color` to `green`.
4696
4891
  * @param green a byte value between 0 and 255
4892
+ * @since 1.4
4697
4893
  */
4698
4894
  set_green_byte(green: number): void;
4699
4895
 
4700
4896
  /**
4701
4897
  * Sets the green channel of `color` to `green`.
4702
4898
  * @param green a float value between 0.0f and 1.0f
4899
+ * @since 1.4
4703
4900
  */
4704
4901
  set_green_float(green: number): void;
4705
4902
 
4706
4903
  /**
4707
4904
  * Sets the red channel of `color` to `red`.
4708
4905
  * @param red a float value between 0.0f and 1.0f
4906
+ * @since 1.4
4709
4907
  */
4710
4908
  set_red(red: number): void;
4711
4909
 
4712
4910
  /**
4713
4911
  * Sets the red channel of `color` to `red`.
4714
4912
  * @param red a byte value between 0 and 255
4913
+ * @since 1.4
4715
4914
  */
4716
4915
  set_red_byte(red: number): void;
4717
4916
 
4718
4917
  /**
4719
4918
  * Sets the red channel of `color` to `red`.
4720
4919
  * @param red a float value between 0.0f and 1.0f
4920
+ * @since 1.4
4721
4921
  */
4722
4922
  set_red_float(red: number): void;
4723
4923
 
@@ -4726,6 +4926,7 @@ export namespace Cogl {
4726
4926
  *
4727
4927
  * The `hue` value is in the 0 .. 360 range. The `luminance` and
4728
4928
  * `saturation` values are in the 0 .. 1 range.
4929
+ * @since 1.16
4729
4930
  */
4730
4931
  to_hsl(): [number, number, number];
4731
4932
 
@@ -4733,6 +4934,7 @@ export namespace Cogl {
4733
4934
  * Converts a pre-multiplied color to a non-premultiplied color. For
4734
4935
  * example, semi-transparent red is (0.5, 0, 0, 0.5) when premultiplied
4735
4936
  * and (1.0, 0, 0, 0.5) when non-premultiplied.
4937
+ * @since 1.4
4736
4938
  */
4737
4939
  unpremultiply(): void;
4738
4940
  }
@@ -4802,6 +5004,8 @@ export namespace Cogl {
4802
5004
  * The default is {@link Cogl.MaterialAlphaFunc.ALWAYS}
4803
5005
  * @param alpha_func A `CoglMaterialAlphaFunc` constant
4804
5006
  * @param alpha_reference A reference point that the chosen alpha function uses to compare incoming fragments to.
5007
+ * @since 1.0
5008
+ * @deprecated since 1.16: Use `cogl_pipeline_set_alpha_test_function()` instead
4805
5009
  */
4806
5010
  set_alpha_test_function(alpha_func: MaterialAlphaFunc, alpha_reference: number): void;
4807
5011
 
@@ -4876,6 +5080,9 @@ export namespace Cogl {
4876
5080
  * is in premultiplied form.
4877
5081
  * @param blend_string A <link linkend="cogl-Blend-Strings">Cogl blend string</link> describing the desired blend function.
4878
5082
  * @returns `true` if the blend string was successfully parsed, and the described blending is supported by the underlying driver/hardware. If there was an error, `false` is returned and `error` is set accordingly (if present).
5083
+ * @since 1.0
5084
+ * @deprecated since 1.16: Use `cogl_pipeline_set_blend()` instead
5085
+ * @throws GLib.Error
4879
5086
  */
4880
5087
  set_blend(blend_string: string): boolean;
4881
5088
 
@@ -4883,6 +5090,8 @@ export namespace Cogl {
4883
5090
  * When blending is setup to reference a CONSTANT blend factor then
4884
5091
  * blending will depend on the constant set with this function.
4885
5092
  * @param constant_color The constant color you want
5093
+ * @since 1.0
5094
+ * @deprecated since 1.16: Use `cogl_pipeline_set_blend_constant()` instead
4886
5095
  */
4887
5096
  set_blend_constant(constant_color: Color): void;
4888
5097
 
@@ -4896,6 +5105,8 @@ export namespace Cogl {
4896
5105
  *
4897
5106
  * The default value is (1.0, 1.0, 1.0, 1.0)
4898
5107
  * @param color The components of the color
5108
+ * @since 1.0
5109
+ * @deprecated since 1.16: Use `cogl_pipeline_set_color()` instead
4899
5110
  */
4900
5111
  set_color(color: Color): void;
4901
5112
 
@@ -4907,6 +5118,8 @@ export namespace Cogl {
4907
5118
  * @param green The green component
4908
5119
  * @param blue The blue component
4909
5120
  * @param alpha The alpha component
5121
+ * @since 1.0
5122
+ * @deprecated since 1.16: Use `cogl_pipeline_set_color4ub()` instead
4910
5123
  */
4911
5124
  set_color4ub(red: number, green: number, blue: number, alpha: number): void;
4912
5125
 
@@ -4923,6 +5136,8 @@ export namespace Cogl {
4923
5136
  * as purely GLSL based layers.</note>
4924
5137
  * @param layer_index the index of the layer
4925
5138
  * @param texture a {@link Cogl.Handle} for the layer object
5139
+ * @since 1.0
5140
+ * @deprecated since 1.16: Use `cogl_pipeline_set_layer()` instead
4926
5141
  */
4927
5142
  set_layer(layer_index: number, texture: Handle): void;
4928
5143
 
@@ -5005,6 +5220,9 @@ export namespace Cogl {
5005
5220
  * @param layer_index Specifies the layer you want define a combine function for
5006
5221
  * @param blend_string A <link linkend="cogl-Blend-Strings">Cogl blend string</link> describing the desired texture combine function.
5007
5222
  * @returns `true` if the blend string was successfully parsed, and the described texture combining is supported by the underlying driver and or hardware. On failure, `false` is returned and `error` is set
5223
+ * @since 1.0
5224
+ * @deprecated since 1.16: Use `cogl_pipeline_set_layer_combine()` instead
5225
+ * @throws GLib.Error
5008
5226
  */
5009
5227
  set_layer_combine(layer_index: number, blend_string: string): boolean;
5010
5228
 
@@ -5013,6 +5231,8 @@ export namespace Cogl {
5013
5231
  * description then you can use this function to define its value.
5014
5232
  * @param layer_index Specifies the layer you want to specify a constant used for texture combining
5015
5233
  * @param constant The constant color you want
5234
+ * @since 1.0
5235
+ * @deprecated since 1.16: Use `cogl_pipeline_set_layer_combine_constant()` instead
5016
5236
  */
5017
5237
  set_layer_combine_constant(layer_index: number, constant: Color): void;
5018
5238
 
@@ -5022,6 +5242,7 @@ export namespace Cogl {
5022
5242
  * @param layer_index the layer number to change.
5023
5243
  * @param min_filter the filter used when scaling a texture down.
5024
5244
  * @param mag_filter the filter used when magnifying a texture.
5245
+ * @deprecated since 1.16: Use `cogl_pipeline_set_layer_filters()` instead
5025
5246
  */
5026
5247
  set_layer_filters(layer_index: number, min_filter: MaterialFilter, mag_filter: MaterialFilter): void;
5027
5248
 
@@ -5030,6 +5251,7 @@ export namespace Cogl {
5030
5251
  * and rotate a single layer of a material used to fill your geometry.
5031
5252
  * @param layer_index the index for the layer inside `material`
5032
5253
  * @param matrix the transformation matrix for the layer
5254
+ * @deprecated since 1.16: Use `cogl_pipeline_set_layer_matrix()` instead
5033
5255
  */
5034
5256
  set_layer_matrix(layer_index: number, matrix: Graphene.Matrix): void;
5035
5257
 
@@ -5043,6 +5265,9 @@ export namespace Cogl {
5043
5265
  * @param layer_index the layer number to change.
5044
5266
  * @param enable whether to enable point sprite coord generation.
5045
5267
  * @returns `true` if the function succeeds, `false` otherwise.
5268
+ * @since 1.4
5269
+ * @deprecated since 1.16: Use `cogl_pipeline_set_layer_point_sprite_coords_enabled()` instead
5270
+ * @throws GLib.Error
5046
5271
  */
5047
5272
  set_layer_point_sprite_coords_enabled(layer_index: number, enable: boolean): boolean;
5048
5273
 
@@ -5055,6 +5280,8 @@ export namespace Cogl {
5055
5280
  * screen space so it will be the same regardless of any
5056
5281
  * transformations. The default point size is 1.0.
5057
5282
  * @param point_size the new point size.
5283
+ * @since 1.4
5284
+ * @deprecated since 1.16: Use `cogl_pipeline_set_point_size()` instead
5058
5285
  */
5059
5286
  set_point_size(point_size: number): void;
5060
5287
 
@@ -5095,6 +5322,8 @@ export namespace Cogl {
5095
5322
  * meantime we hope this will handle most practical GLSL and ARBfp
5096
5323
  * requirements.
5097
5324
  * @param program A {@link Cogl.Handle} to a linked CoglProgram
5325
+ * @since 1.4
5326
+ * @deprecated since 1.16: Use `CoglSnippet` api instead instead
5098
5327
  */
5099
5328
  set_user_program(program: Handle): void;
5100
5329
  }
@@ -5356,6 +5585,7 @@ export namespace Cogl {
5356
5585
  * the texture, or if the texture is attached to a {@link Cogl.Offscreen}
5357
5586
  * framebuffer and rendered too.</note>
5358
5587
  * @returns `true` if the texture was successfully allocated, otherwise `false` and `error` will be updated if it wasn't `null`.
5588
+ * @throws GLib.Error
5359
5589
  */
5360
5590
  allocate(): boolean;
5361
5591
 
@@ -5367,6 +5597,7 @@ export namespace Cogl {
5367
5597
  * is {@link Cogl.TextureComponents.RGBA}. The other constructors which take
5368
5598
  * a %CoglBitmap or a data pointer default to the same components as
5369
5599
  * the pixel format of the data.
5600
+ * @since 1.18
5370
5601
  */
5371
5602
  get_components(): TextureComponents;
5372
5603
 
@@ -5413,6 +5644,7 @@ export namespace Cogl {
5413
5644
  *
5414
5645
  * By default the pre-multipled state is `TRUE`.
5415
5646
  * @returns `true` if red, green and blue components are internally stored pre-multiplied by the alpha value or `false` if not.
5647
+ * @since 1.18
5416
5648
  */
5417
5649
  get_premultiplied(): boolean;
5418
5650
 
@@ -5445,6 +5677,8 @@ export namespace Cogl {
5445
5677
  * @param sub_width Width in pixels of the subregion
5446
5678
  * @param sub_height Height in pixels of the subregion
5447
5679
  * @returns A newly created {@link Cogl.Texture} or `null` on failure
5680
+ * @since 1.2
5681
+ * @deprecated since 1.18: Use `cogl_sub_texture_new()`
5448
5682
  */
5449
5683
  new_from_sub_texture(sub_x: number, sub_y: number, sub_width: number, sub_height: number): Texture;
5450
5684
 
@@ -5469,6 +5703,7 @@ export namespace Cogl {
5469
5703
  * an image format as long as {@link Cogl.TextureComponents.RG} isn't used
5470
5704
  * as the texture's components.
5471
5705
  * @param components
5706
+ * @since 1.18
5472
5707
  */
5473
5708
  set_components(components: TextureComponents): void;
5474
5709
 
@@ -5520,6 +5755,7 @@ export namespace Cogl {
5520
5755
  * @param data the source data, pointing to the first top-left pixel to set
5521
5756
  * @param level The mipmap level to update (Normally 0 for the largest, base texture)
5522
5757
  * @returns `true` if the data upload was successful, and `false` otherwise
5758
+ * @throws GLib.Error
5523
5759
  */
5524
5760
  set_data(format: PixelFormat, rowstride: number, data: Uint8Array | string, level: number): boolean;
5525
5761
 
@@ -5546,6 +5782,7 @@ export namespace Cogl {
5546
5782
  *
5547
5783
  * By default the `premultipled` state is `TRUE`.
5548
5784
  * @param premultiplied Whether any internally stored red, green or blue components are pre-multiplied by an alpha component.
5785
+ * @since 1.18
5549
5786
  */
5550
5787
  set_premultiplied(premultiplied: boolean): void;
5551
5788
 
@@ -5583,6 +5820,7 @@ export namespace Cogl {
5583
5820
  * @param dst_height height of destination region to write. (Must be less than or equal to the bitmap height)
5584
5821
  * @param bitmap The source bitmap to read from
5585
5822
  * @returns `true` if the subregion upload was successful, and `false` otherwise
5823
+ * @since 1.8
5586
5824
  */
5587
5825
  set_region_from_bitmap(src_x: number, src_y: number, dst_x: number, dst_y: number, dst_width: number, dst_height: number, bitmap: Bitmap): boolean;
5588
5826
  }