-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathgdk-4.0.d.ts
More file actions
18377 lines (17647 loc) · 782 KB
/
gdk-4.0.d.ts
File metadata and controls
18377 lines (17647 loc) · 782 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/// <reference path="./cairo-1.0.d.ts" />
/// <reference path="./cairo.d.ts" />
/// <reference path="./gobject-2.0.d.ts" />
/// <reference path="./glib-2.0.d.ts" />
/// <reference path="./pangocairo-1.0.d.ts" />
/// <reference path="./pango-1.0.d.ts" />
/// <reference path="./harfbuzz-0.0.d.ts" />
/// <reference path="./freetype2-2.0.d.ts" />
/// <reference path="./gio-2.0.d.ts" />
/// <reference path="./gmodule-2.0.d.ts" />
/// <reference path="./gdkpixbuf-2.0.d.ts" />
/**
* Type Definitions for Gjs (https://gjs.guide/)
*
* These type definitions are automatically generated, do not edit them by hand.
* If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gir
*
* The based EJS template file is used for the generated .d.ts file of each GIR module like Gtk-4.0, GObject-2.0, ...
*/
declare module 'gi://Gdk?version=4.0' {
// Module dependencies
import type cairo from 'cairo';
import type GObject from 'gi://GObject?version=2.0';
import type GLib from 'gi://GLib?version=2.0';
import type PangoCairo from 'gi://PangoCairo?version=1.0';
import type Pango from 'gi://Pango?version=1.0';
import type HarfBuzz from 'gi://HarfBuzz?version=0.0';
import type freetype2 from 'gi://freetype2?version=2.0';
import type Gio from 'gi://Gio?version=2.0';
import type GModule from 'gi://GModule?version=2.0';
import type GdkPixbuf from 'gi://GdkPixbuf?version=2.0';
export namespace Gdk {
/**
* Gdk-4.0
*/
export namespace AxisUse {
export const $gtype: GObject.GType<AxisUse>;
}
/**
* Defines how device axes are interpreted by GTK.
*
* Note that the X and Y axes are not really needed; pointer devices
* report their location via the x/y members of events regardless. Whether
* X and Y are present as axes depends on the GDK backend.
*/
enum AxisUse {
/**
* the axis is ignored.
*/
IGNORE,
/**
* the axis is used as the x axis.
*/
X,
/**
* the axis is used as the y axis.
*/
Y,
/**
* the axis is used as the scroll x delta
*/
DELTA_X,
/**
* the axis is used as the scroll y delta
*/
DELTA_Y,
/**
* the axis is used for pressure information.
*/
PRESSURE,
/**
* the axis is used for x tilt information.
*/
XTILT,
/**
* the axis is used for y tilt information.
*/
YTILT,
/**
* the axis is used for wheel information.
*/
WHEEL,
/**
* the axis is used for pen/tablet distance information
*/
DISTANCE,
/**
* the axis is used for pen rotation information
*/
ROTATION,
/**
* the axis is used for pen slider information
*/
SLIDER,
/**
* a constant equal to the numerically highest axis value.
*/
LAST,
}
export namespace CicpRange {
export const $gtype: GObject.GType<CicpRange>;
}
/**
* The values of this enumeration describe whether image data uses
* the full range of 8-bit values.
*
* In digital broadcasting, it is common to reserve the lowest and
* highest values. Typically the allowed values for the narrow range
* are 16-235 for Y and 16-240 for u,v (when dealing with YUV data).
*/
enum CicpRange {
/**
* The values use the range of 16-235 (for Y) and 16-240 for u and v.
*/
NARROW,
/**
* The values use the full range.
*/
FULL,
}
export namespace ColorChannel {
export const $gtype: GObject.GType<ColorChannel>;
}
/**
* Enumerates the color channels of RGBA values as used in
* `GdkColor` and OpenGL/Vulkan shaders.
*
* Note that this is not the order of pixel values in Cairo
* and `GdkMemoryFormat` can have many different orders.
*/
enum ColorChannel {
/**
* The red color channel, aka 0
*/
RED,
/**
* The green color channel, aka 1
*/
GREEN,
/**
* The blue color channel, aka 2
*/
BLUE,
/**
* The alpha color channel, aka 3
*/
ALPHA,
}
export namespace CrossingMode {
export const $gtype: GObject.GType<CrossingMode>;
}
/**
* Specifies the crossing mode for enter and leave events.
*/
enum CrossingMode {
/**
* crossing because of pointer motion.
*/
NORMAL,
/**
* crossing because a grab is activated.
*/
GRAB,
/**
* crossing because a grab is deactivated.
*/
UNGRAB,
/**
* crossing because a GTK grab is activated.
*/
GTK_GRAB,
/**
* crossing because a GTK grab is deactivated.
*/
GTK_UNGRAB,
/**
* crossing because a GTK widget changed
* state (e.g. sensitivity).
*/
STATE_CHANGED,
/**
* crossing because a touch sequence has begun,
* this event is synthetic as the pointer might have not left the surface.
*/
TOUCH_BEGIN,
/**
* crossing because a touch sequence has ended,
* this event is synthetic as the pointer might have not left the surface.
*/
TOUCH_END,
/**
* crossing because of a device switch (i.e.
* a mouse taking control of the pointer after a touch device), this event
* is synthetic as the pointer didn’t leave the surface.
*/
DEVICE_SWITCH,
}
export namespace DevicePadFeature {
export const $gtype: GObject.GType<DevicePadFeature>;
}
/**
* A pad feature.
*/
enum DevicePadFeature {
/**
* a button
*/
BUTTON,
/**
* a ring-shaped interactive area
*/
RING,
/**
* a straight interactive area
*/
STRIP,
}
export namespace DeviceToolType {
export const $gtype: GObject.GType<DeviceToolType>;
}
/**
* Indicates the specific type of tool being used being a tablet. Such as an
* airbrush, pencil, etc.
*/
enum DeviceToolType {
/**
* Tool is of an unknown type.
*/
UNKNOWN,
/**
* Tool is a standard tablet stylus.
*/
PEN,
/**
* Tool is standard tablet eraser.
*/
ERASER,
/**
* Tool is a brush stylus.
*/
BRUSH,
/**
* Tool is a pencil stylus.
*/
PENCIL,
/**
* Tool is an airbrush stylus.
*/
AIRBRUSH,
/**
* Tool is a mouse.
*/
MOUSE,
/**
* Tool is a lens cursor.
*/
LENS,
}
/**
* Error enumeration for `GdkDmabufTexture`.
*/
class DmabufError extends GLib.Error {
static $gtype: GObject.GType<GLib.Error>;
// Static fields
/**
* Dmabuf support is not available, because the OS
* is not Linux, or it was explicitly disabled at compile- or runtime
*/
static NOT_AVAILABLE: number;
/**
* The requested format is not supported
*/
static UNSUPPORTED_FORMAT: number;
/**
* GTK failed to create the resource for other
* reasons
*/
static CREATION_FAILED: number;
// Constructors
constructor(options: { message: string; code: number });
// Static methods
/**
* Registers an error quark for [class`Gdk`.DmabufTexture] errors.
*/
static quark(): GLib.Quark;
}
export namespace DragCancelReason {
export const $gtype: GObject.GType<DragCancelReason>;
}
/**
* Used in `GdkDrag` to the reason of a cancelled DND operation.
*/
enum DragCancelReason {
/**
* There is no suitable drop target.
*/
NO_TARGET,
/**
* Drag cancelled by the user
*/
USER_CANCELLED,
/**
* Unspecified error.
*/
ERROR,
}
export namespace EventType {
export const $gtype: GObject.GType<EventType>;
}
/**
* Specifies the type of the event.
*/
enum EventType {
/**
* the window manager has requested that the toplevel surface be
* hidden or destroyed, usually when the user clicks on a special icon in the
* title bar.
*/
DELETE,
/**
* the pointer (usually a mouse) has moved.
*/
MOTION_NOTIFY,
/**
* a mouse button has been pressed.
*/
BUTTON_PRESS,
/**
* a mouse button has been released.
*/
BUTTON_RELEASE,
/**
* a key has been pressed.
*/
KEY_PRESS,
/**
* a key has been released.
*/
KEY_RELEASE,
/**
* the pointer has entered the surface.
*/
ENTER_NOTIFY,
/**
* the pointer has left the surface.
*/
LEAVE_NOTIFY,
/**
* the keyboard focus has entered or left the surface.
*/
FOCUS_CHANGE,
/**
* an input device has moved into contact with a sensing
* surface (e.g. a touchscreen or graphics tablet).
*/
PROXIMITY_IN,
/**
* an input device has moved out of contact with a sensing
* surface.
*/
PROXIMITY_OUT,
/**
* the mouse has entered the surface while a drag is in progress.
*/
DRAG_ENTER,
/**
* the mouse has left the surface while a drag is in progress.
*/
DRAG_LEAVE,
/**
* the mouse has moved in the surface while a drag is in
* progress.
*/
DRAG_MOTION,
/**
* a drop operation onto the surface has started.
*/
DROP_START,
/**
* the scroll wheel was turned
*/
SCROLL,
/**
* a pointer or keyboard grab was broken.
*/
GRAB_BROKEN,
/**
* A new touch event sequence has just started.
*/
TOUCH_BEGIN,
/**
* A touch event sequence has been updated.
*/
TOUCH_UPDATE,
/**
* A touch event sequence has finished.
*/
TOUCH_END,
/**
* A touch event sequence has been canceled.
*/
TOUCH_CANCEL,
/**
* A touchpad swipe gesture event, the current state
* is determined by its phase field.
*/
TOUCHPAD_SWIPE,
/**
* A touchpad pinch gesture event, the current state
* is determined by its phase field.
*/
TOUCHPAD_PINCH,
/**
* A tablet pad button press event.
*/
PAD_BUTTON_PRESS,
/**
* A tablet pad button release event.
*/
PAD_BUTTON_RELEASE,
/**
* A tablet pad axis event from a "ring".
*/
PAD_RING,
/**
* A tablet pad axis event from a "strip".
*/
PAD_STRIP,
/**
* A tablet pad group mode change.
*/
PAD_GROUP_MODE,
/**
* A touchpad hold gesture event, the current state is determined by its phase
* field.
*/
TOUCHPAD_HOLD,
/**
* A tablet pad axis event from a "dial".
*/
PAD_DIAL,
/**
* marks the end of the GdkEventType enumeration.
*/
EVENT_LAST,
}
export namespace FullscreenMode {
export const $gtype: GObject.GType<FullscreenMode>;
}
/**
* Indicates which monitor a surface should span over when in fullscreen mode.
*/
enum FullscreenMode {
/**
* Fullscreen on current monitor only.
*/
CURRENT_MONITOR,
/**
* Span across all monitors when fullscreen.
*/
ALL_MONITORS,
}
/**
* Error enumeration for `GdkGLContext`.
*/
class GLError extends GLib.Error {
static $gtype: GObject.GType<GLib.Error>;
// Static fields
/**
* OpenGL support is not available
*/
static NOT_AVAILABLE: number;
/**
* The requested visual format is not supported
*/
static UNSUPPORTED_FORMAT: number;
/**
* The requested profile is not supported
*/
static UNSUPPORTED_PROFILE: number;
/**
* The shader compilation failed
*/
static COMPILATION_FAILED: number;
/**
* The shader linking failed
*/
static LINK_FAILED: number;
// Constructors
constructor(options: { message: string; code: number });
// Static methods
/**
* Registers an error quark for [class`Gdk`.GLContext] errors.
*/
static quark(): GLib.Quark;
}
export namespace Gravity {
export const $gtype: GObject.GType<Gravity>;
}
/**
* Defines the reference point of a surface and is used in `GdkPopupLayout`.
*/
enum Gravity {
/**
* the reference point is at the top left corner.
*/
NORTH_WEST,
/**
* the reference point is in the middle of the top edge.
*/
NORTH,
/**
* the reference point is at the top right corner.
*/
NORTH_EAST,
/**
* the reference point is at the middle of the left edge.
*/
WEST,
/**
* the reference point is at the center of the surface.
*/
CENTER,
/**
* the reference point is at the middle of the right edge.
*/
EAST,
/**
* the reference point is at the lower left corner.
*/
SOUTH_WEST,
/**
* the reference point is at the middle of the lower edge.
*/
SOUTH,
/**
* the reference point is at the lower right corner.
*/
SOUTH_EAST,
/**
* the reference point is at the top left corner of the
* surface itself, ignoring window manager decorations.
*/
STATIC,
}
export namespace InputSource {
export const $gtype: GObject.GType<InputSource>;
}
/**
* An enumeration describing the type of an input device in general terms.
*/
enum InputSource {
/**
* the device is a mouse. (This will be reported for the core
* pointer, even if it is something else, such as a trackball.)
*/
MOUSE,
/**
* the device is a stylus of a graphics tablet or similar device.
*/
PEN,
/**
* the device is a keyboard.
*/
KEYBOARD,
/**
* the device is a direct-input touch device, such
* as a touchscreen or tablet
*/
TOUCHSCREEN,
/**
* the device is an indirect touch device, such
* as a touchpad
*/
TOUCHPAD,
/**
* the device is a trackpoint
*/
TRACKPOINT,
/**
* the device is a "pad", a collection of buttons,
* rings and strips found in drawing tablets
*/
TABLET_PAD,
}
export namespace KeyMatch {
export const $gtype: GObject.GType<KeyMatch>;
}
/**
* Describes how well an event matches a given keyval and modifiers.
*
* `GdkKeyMatch` values are returned by [method`Gdk`.KeyEvent.matches].
*/
enum KeyMatch {
/**
* The key event does not match
*/
NONE,
/**
* The key event matches if keyboard state
* (specifically, the currently active group) is ignored
*/
PARTIAL,
/**
* The key event matches
*/
EXACT,
}
export namespace MemoryFormat {
export const $gtype: GObject.GType<MemoryFormat>;
}
/**
* Describes formats that image data can have in memory.
*
* It describes formats by listing the contents of the memory passed to it.
* So `GDK_MEMORY_A8R8G8B8` will be 1 byte (8 bits) of alpha, followed by a
* byte each of red, green and blue. It is not endian-dependent, so
* `CAIRO_FORMAT_ARGB32` is represented by different `GdkMemoryFormats`
* on architectures with different endiannesses.
*
* Its naming is modelled after
* [VkFormat](https://www.khronos.org/registry/vulkan/specs/1.0/html/vkspec.html#VkFormat)
* for details).
*/
enum MemoryFormat {
/**
* 4 bytes; for blue, green, red, alpha.
* The color values are premultiplied with the alpha value.
*/
B8G8R8A8_PREMULTIPLIED,
/**
* 4 bytes; for alpha, red, green, blue.
* The color values are premultiplied with the alpha value.
*/
A8R8G8B8_PREMULTIPLIED,
/**
* 4 bytes; for red, green, blue, alpha
* The color values are premultiplied with the alpha value.
*/
R8G8B8A8_PREMULTIPLIED,
/**
* 4 bytes; for blue, green, red, alpha.
*/
B8G8R8A8,
/**
* 4 bytes; for alpha, red, green, blue.
*/
A8R8G8B8,
/**
* 4 bytes; for red, green, blue, alpha.
*/
R8G8B8A8,
/**
* 4 bytes; for alpha, blue, green, red.
*/
A8B8G8R8,
/**
* 3 bytes; for red, green, blue. The data is opaque.
*/
R8G8B8,
/**
* 3 bytes; for blue, green, red. The data is opaque.
*/
B8G8R8,
/**
* 3 guint16 values; for red, green, blue.
*/
R16G16B16,
/**
* 4 guint16 values; for red, green, blue, alpha. The color values are
* premultiplied with the alpha value.
*/
R16G16B16A16_PREMULTIPLIED,
/**
* 4 guint16 values; for red, green, blue, alpha.
*/
R16G16B16A16,
/**
* 3 half-float values; for red, green, blue. The data is opaque.
*/
R16G16B16_FLOAT,
/**
* 4 half-float values; for red, green, blue and alpha. The color values are
* premultiplied with the alpha value.
*/
R16G16B16A16_FLOAT_PREMULTIPLIED,
/**
* 4 half-float values; for red, green, blue and alpha.
*/
R16G16B16A16_FLOAT,
/**
* 3 float values; for red, green, blue.
*/
R32G32B32_FLOAT,
/**
* 4 float values; for red, green, blue and alpha. The color values are
* premultiplied with the alpha value.
*/
R32G32B32A32_FLOAT_PREMULTIPLIED,
/**
* 4 float values; for red, green, blue and alpha.
*/
R32G32B32A32_FLOAT,
/**
* 2 bytes; for grayscale, alpha. The color values are premultiplied with the
* alpha value.
*/
G8A8_PREMULTIPLIED,
/**
* 2 bytes; for grayscale, alpha.
*/
G8A8,
/**
* One byte; for grayscale. The data is opaque.
*/
G8,
/**
* 2 guint16 values; for grayscale, alpha. The color values are premultiplied
* with the alpha value.
*/
G16A16_PREMULTIPLIED,
/**
* 2 guint16 values; for grayscale, alpha.
*/
G16A16,
/**
* One guint16 value; for grayscale. The data is opaque.
*/
G16,
/**
* One byte; for alpha.
*/
A8,
/**
* One guint16 value; for alpha.
*/
A16,
/**
* One half-float value; for alpha.
*/
A16_FLOAT,
/**
* One float value; for alpha.
*/
A32_FLOAT,
/**
* 4 bytes; for alpha, blue, green, red, The color values are premultiplied with
* the alpha value.
*/
A8B8G8R8_PREMULTIPLIED,
/**
* 4 bytes; for blue, green, red, unused.
*/
B8G8R8X8,
/**
* 4 bytes; for unused, red, green, blue.
*/
X8R8G8B8,
/**
* 4 bytes; for red, green, blue, unused.
*/
R8G8B8X8,
/**
* 4 bytes; for unused, blue, green, red.
*/
X8B8G8R8,
/**
* Multiplane format with 2 planes.
*
* The first plane contains the first channel, usually containing
* luma values.
* The second plane with interleaved chroma values, Cb followed by Cr.
* Subsampled in both the X and Y direction.
*
* Commonly known by the fourcc "NV12".
*/
G8_B8R8_420,
/**
* Multiplane format with 2 planes.
*
* The first plane contains the first channel, usually containing
* luma values.
* The second plane with interleaved chroma values, Cr followed by Cb.
* Subsampled in both the X and Y direction.
*
* Commonly known by the fourcc "NV21".
*/
G8_R8B8_420,
/**
* Multiplane format with 2 planes.
*
* The first plane contains the first channel, usually containing
* luma values.
* The second plane with interleaved chroma values, Cb followed by Cr.
* Subsampled in the X direction.
*
* Commonly known by the fourcc "NV16".
*/
G8_B8R8_422,
/**
* Multiplane format with 2 planes.
*
* The first plane contains the first channel, usually containing
* luma values.
* The second plane with interleaved chroma values, Cr followed by Cb.
* Subsampled in the X direction.
*
* Commonly known by the fourcc "NV61".
*/
G8_R8B8_422,
/**
* Multiplane format with 2 planes.
*
* The first plane contains the first channel, usually containing
* luma values.
* The second plane with interleaved chroma values, Cb followed by Cr.
* This format is not subsampled.
*
* Commonly known by the fourcc "NV24".
*/
G8_B8R8_444,
/**
* Multiplane format with 2 planes.
*
* The first plane contains the first channel, usually containing
* luma values.
* The second plane with interleaved chroma values, Cr followed by Cb.
* This format is not subsampled.
*
* Commonly known by the fourcc "NV42".
*/
G8_R8B8_444,
/**
* Multiplane format with 2 planes.
*
* Each channel is a 16 bit integer, but only the highest 10 bits are used.
*
* The first plane contains the first channel, usually containing
* luma values.
* The second plane with interleaved chroma values, Cr followed by Cb.
* This format is not subsampled.
*
* Commonly known by the fourcc "P010".
*/
G10X6_B10X6R10X6_420,
/**
* Multiplane format with 2 planes.
*
* Each channel is a 16 bit integer, but only the highest 10 bits are used.
*
* The first plane contains the first channel, usually containing
* luma values.
* The second plane with interleaved chroma values, Cr followed by Cb.
* This format is not subsampled.
*
* Commonly known by the fourcc "P012".
*/
G12X4_B12X4R12X4_420,
/**
* Multiplane format with 2 planes.
*
* Each channel is a 16 bit integer.
*
* The first plane contains the first channel, usually containing
* luma values.
* The second plane with interleaved chroma values, Cr followed by Cb.
* This format is not subsampled.
*
* Commonly known by the fourcc "P016".
*/
G16_B16R16_420,
/**
* Multiplane format with 3 planes.
*
* Each channel is a 8 bit integer.
*
* The first plane usually contains the luma channel. It is mapped
* into the 2nd channel.
*
* The second plane usually contains the first chroma chanel.
* Subsampled in both the X and Y direction with 4:1 ratio. It is
* mapped into the 3rd channel.
*
* The third plane usually contains the second chroma channel.
* Subsampled in both the X and Y direction with 4:1 ratio. It is
* mapped into the 1st channel.
*
* Commonly known by the fourcc "YUV410".
*/
G8_B8_R8_410,
/**
* Multiplane format with 3 planes.
*
* Each channel is a 8 bit integer.
*
* The first plane usually contains the luma channel. It is mapped
* into the 2nd channel.
*
* The second plane usually contains the second chroma chanel.
* Subsampled in both the X and Y direction with 4:1 ratio. It is
* mapped into the 1st channel.
*
* The third plane usually contains the first chroma channel.
* Subsampled in both the X and Y direction with 4:1 ratio. It is
* mapped into the 3rd channel.
*
* Commonly known by the fourcc "YVU410".
*/
G8_R8_B8_410,
/**
* Multiplane format with 3 planes.
*
* Each channel is a 8 bit integer.
*
* The first plane usually contains the luma channel. It is mapped
* into the 2nd channel.
*
* The second plane usually contains the first chroma chanel.
* Subsampled in the X direction with 4:1 ratio. It is
* mapped into the 3rd channel.
*
* The third plane usually contains the second chroma channel.
* Subsampled in the X direction with 4:1 ratio. It is
* mapped into the 1st channel.
*
* Commonly known by the fourcc "YUV411".
*/
G8_B8_R8_411,
/**
* Multiplane format with 3 planes.
*
* Each channel is a 8 bit integer.
*
* The first plane usually contains the luma channel. It is mapped
* into the 2nd channel.
*
* The second plane usually contains the second chroma chanel.
* Subsampled in the X direction with 4:1 ratio. It is
* mapped into the 1st channel.
*
* The third plane usually contains the first chroma channel.
* Subsampled in the X direction with 4:1 ratio. It is
* mapped into the 3rd channel.
*
* Commonly known by the fourcc "YVU411".
*/
G8_R8_B8_411,
/**
* Multiplane format with 3 planes.
*
* Each channel is a 8 bit integer.
*
* The first plane usually contains the luma channel. It is mapped
* into the 2nd channel.
*
* The second plane usually contains the first chroma chanel.
* Subsampled in both the X and Y direction. It is mapped into the