@gtkx/ffi 0.1.45 → 0.1.47

package/dist/generated/gdk/enums.d.ts

@@ -1,359 +1,1428 @@
+/**
+ * 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.
+ */
 export declare enum AxisUse {
+    /** the axis is ignored. */
     IGNORE = 0,
+    /** the axis is used as the x axis. */
     X = 1,
+    /** the axis is used as the y axis. */
     Y = 2,
+    /** the axis is used as the scroll x delta */
     DELTA_X = 3,
+    /** the axis is used as the scroll y delta */
     DELTA_Y = 4,
+    /** the axis is used for pressure information. */
     PRESSURE = 5,
+    /** the axis is used for x tilt information. */
     XTILT = 6,
+    /** the axis is used for y tilt information. */
     YTILT = 7,
+    /** the axis is used for wheel information. */
     WHEEL = 8,
+    /** the axis is used for pen/tablet distance information */
     DISTANCE = 9,
+    /** the axis is used for pen rotation information */
     ROTATION = 10,
+    /** the axis is used for pen slider information */
     SLIDER = 11,
+    /** a constant equal to the numerically highest axis value. */
     LAST = 12
 }
+/**
+ * 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).
+ */
 export declare enum CicpRange {
+    /** The values use the range of 16-235 (for Y) and 16-240 for u and v. */
     NARROW = 0,
+    /** The values use the full range. */
     FULL = 1
 }
+/** Specifies the crossing mode for enter and leave events. */
 export declare enum CrossingMode {
+    /** crossing because of pointer motion. */
     NORMAL = 0,
+    /** crossing because a grab is activated. */
     GRAB = 1,
+    /** crossing because a grab is deactivated. */
     UNGRAB = 2,
+    /** crossing because a GTK grab is activated. */
     GTK_GRAB = 3,
+    /** crossing because a GTK grab is deactivated. */
     GTK_UNGRAB = 4,
+    /**
+     * crossing because a GTK widget changed
+     * state (e.g. sensitivity).
+     */
     STATE_CHANGED = 5,
+    /**
+     * crossing because a touch sequence has begun,
+     * this event is synthetic as the pointer might have not left the surface.
+     */
     TOUCH_BEGIN = 6,
+    /**
+     * crossing because a touch sequence has ended,
+     * this event is synthetic as the pointer might have not left the surface.
+     */
     TOUCH_END = 7,
+    /**
+     * 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 = 8
 }
+/** A pad feature. */
 export declare enum DevicePadFeature {
+    /** a button */
     BUTTON = 0,
+    /** a ring-shaped interactive area */
     RING = 1,
+    /** a straight interactive area */
     STRIP = 2
 }
+/**
+ * Indicates the specific type of tool being used being a tablet. Such as an
+ * airbrush, pencil, etc.
+ */
 export declare enum DeviceToolType {
+    /** Tool is of an unknown type. */
     UNKNOWN = 0,
+    /** Tool is a standard tablet stylus. */
     PEN = 1,
+    /** Tool is standard tablet eraser. */
     ERASER = 2,
+    /** Tool is a brush stylus. */
     BRUSH = 3,
+    /** Tool is a pencil stylus. */
     PENCIL = 4,
+    /** Tool is an airbrush stylus. */
     AIRBRUSH = 5,
+    /** Tool is a mouse. */
     MOUSE = 6,
+    /** Tool is a lens cursor. */
     LENS = 7
 }
+/** Error enumeration for `GdkDmabufTexture`. */
 export declare enum DmabufError {
+    /**
+     * Dmabuf support is not available, because the OS
+     * is not Linux, or it was explicitly disabled at compile- or runtime
+     */
     NOT_AVAILABLE = 0,
+    /** The requested format is not supported */
     UNSUPPORTED_FORMAT = 1,
+    /**
+     * GTK failed to create the resource for other
+     * reasons
+     */
     CREATION_FAILED = 2
 }
+/** Used in `GdkDrag` to the reason of a cancelled DND operation. */
 export declare enum DragCancelReason {
+    /** There is no suitable drop target. */
     NO_TARGET = 0,
+    /** Drag cancelled by the user */
     USER_CANCELLED = 1,
+    /** Unspecified error. */
     ERROR = 2
 }
+/** Specifies the type of the event. */
 export declare 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 = 0,
+    /** the pointer (usually a mouse) has moved. */
     MOTION_NOTIFY = 1,
+    /** a mouse button has been pressed. */
     BUTTON_PRESS = 2,
+    /** a mouse button has been released. */
     BUTTON_RELEASE = 3,
+    /** a key has been pressed. */
     KEY_PRESS = 4,
+    /** a key has been released. */
     KEY_RELEASE = 5,
+    /** the pointer has entered the surface. */
     ENTER_NOTIFY = 6,
+    /** the pointer has left the surface. */
     LEAVE_NOTIFY = 7,
+    /** the keyboard focus has entered or left the surface. */
     FOCUS_CHANGE = 8,
+    /**
+     * an input device has moved into contact with a sensing
+     * surface (e.g. a touchscreen or graphics tablet).
+     */
     PROXIMITY_IN = 9,
+    /**
+     * an input device has moved out of contact with a sensing
+     * surface.
+     */
     PROXIMITY_OUT = 10,
+    /** the mouse has entered the surface while a drag is in progress. */
     DRAG_ENTER = 11,
+    /** the mouse has left the surface while a drag is in progress. */
     DRAG_LEAVE = 12,
+    /**
+     * the mouse has moved in the surface while a drag is in
+     * progress.
+     */
     DRAG_MOTION = 13,
+    /** a drop operation onto the surface has started. */
     DROP_START = 14,
+    /** the scroll wheel was turned */
     SCROLL = 15,
+    /** a pointer or keyboard grab was broken. */
     GRAB_BROKEN = 16,
+    /** A new touch event sequence has just started. */
     TOUCH_BEGIN = 17,
+    /** A touch event sequence has been updated. */
     TOUCH_UPDATE = 18,
+    /** A touch event sequence has finished. */
     TOUCH_END = 19,
+    /** A touch event sequence has been canceled. */
     TOUCH_CANCEL = 20,
+    /**
+     * A touchpad swipe gesture event, the current state
+     * is determined by its phase field.
+     */
     TOUCHPAD_SWIPE = 21,
+    /**
+     * A touchpad pinch gesture event, the current state
+     * is determined by its phase field.
+     */
     TOUCHPAD_PINCH = 22,
+    /** A tablet pad button press event. */
     PAD_BUTTON_PRESS = 23,
+    /** A tablet pad button release event. */
     PAD_BUTTON_RELEASE = 24,
+    /** A tablet pad axis event from a "ring". */
     PAD_RING = 25,
+    /** A tablet pad axis event from a "strip". */
     PAD_STRIP = 26,
+    /** A tablet pad group mode change. */
     PAD_GROUP_MODE = 27,
+    /**
+     * A touchpad hold gesture event, the current state is determined by its phase
+     * field.
+     */
     TOUCHPAD_HOLD = 28,
+    /** A tablet pad axis event from a "dial". */
     PAD_DIAL = 29,
+    /** marks the end of the GdkEventType enumeration. */
     EVENT_LAST = 30
 }
+/** Indicates which monitor a surface should span over when in fullscreen mode. */
 export declare enum FullscreenMode {
+    /** Fullscreen on current monitor only. */
     CURRENT_MONITOR = 0,
+    /** Span across all monitors when fullscreen. */
     ALL_MONITORS = 1
 }
+/** Error enumeration for `GdkGLContext`. */
 export declare enum GLError {
+    /** OpenGL support is not available */
     NOT_AVAILABLE = 0,
+    /** The requested visual format is not supported */
     UNSUPPORTED_FORMAT = 1,
+    /** The requested profile is not supported */
     UNSUPPORTED_PROFILE = 2,
+    /** The shader compilation failed */
     COMPILATION_FAILED = 3,
+    /** The shader linking failed */
     LINK_FAILED = 4
 }
+/** Defines the reference point of a surface and is used in `GdkPopupLayout`. */
 export declare enum Gravity {
+    /** the reference point is at the top left corner. */
     NORTH_WEST = 1,
+    /** the reference point is in the middle of the top edge. */
     NORTH = 2,
+    /** the reference point is at the top right corner. */
     NORTH_EAST = 3,
+    /** the reference point is at the middle of the left edge. */
     WEST = 4,
+    /** the reference point is at the center of the surface. */
     CENTER = 5,
+    /** the reference point is at the middle of the right edge. */
     EAST = 6,
+    /** the reference point is at the lower left corner. */
     SOUTH_WEST = 7,
+    /** the reference point is at the middle of the lower edge. */
     SOUTH = 8,
+    /** the reference point is at the lower right corner. */
     SOUTH_EAST = 9,
+    /**
+     * the reference point is at the top left corner of the
+     * surface itself, ignoring window manager decorations.
+     */
     STATIC = 10
 }
+/** An enumeration describing the type of an input device in general terms. */
 export declare 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 = 0,
+    /** the device is a stylus of a graphics tablet or similar device. */
     PEN = 1,
+    /** the device is a keyboard. */
     KEYBOARD = 2,
+    /**
+     * the device is a direct-input touch device, such
+     * as a touchscreen or tablet
+     */
     TOUCHSCREEN = 3,
+    /**
+     * the device is an indirect touch device, such
+     * as a touchpad
+     */
     TOUCHPAD = 4,
+    /** the device is a trackpoint */
     TRACKPOINT = 5,
+    /**
+     * the device is a "pad", a collection of buttons,
+     * rings and strips found in drawing tablets
+     */
     TABLET_PAD = 6
 }
+/**
+ * Describes how well an event matches a given keyval and modifiers.
+ *
+ * `GdkKeyMatch` values are returned by [method@Gdk.KeyEvent.matches].
+ */
 export declare enum KeyMatch {
+    /** The key event does not match */
     NONE = 0,
+    /**
+     * The key event matches if keyboard state
+     * (specifically, the currently active group) is ignored
+     */
     PARTIAL = 1,
+    /** The key event matches */
     EXACT = 2
 }
+/**
+ * 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
+ * for details).
+ */
 export declare enum MemoryFormat {
+    /**
+     * 4 bytes; for blue, green, red, alpha.
+     * The color values are premultiplied with the alpha value.
+     */
     B8G8R8A8_PREMULTIPLIED = 0,
+    /**
+     * 4 bytes; for alpha, red, green, blue.
+     * The color values are premultiplied with the alpha value.
+     */
     A8R8G8B8_PREMULTIPLIED = 1,
+    /**
+     * 4 bytes; for red, green, blue, alpha
+     * The color values are premultiplied with the alpha value.
+     */
     R8G8B8A8_PREMULTIPLIED = 2,
+    /** 4 bytes; for blue, green, red, alpha. */
     B8G8R8A8 = 3,
+    /** 4 bytes; for alpha, red, green, blue. */
     A8R8G8B8 = 4,
+    /** 4 bytes; for red, green, blue, alpha. */
     R8G8B8A8 = 5,
+    /** 4 bytes; for alpha, blue, green, red. */
     A8B8G8R8 = 6,
+    /** 3 bytes; for red, green, blue. The data is opaque. */
     R8G8B8 = 7,
+    /** 3 bytes; for blue, green, red. The data is opaque. */
     B8G8R8 = 8,
+    /** 3 guint16 values; for red, green, blue. */
     R16G16B16 = 9,
+    /**
+     * 4 guint16 values; for red, green, blue, alpha. The color values are
+     * premultiplied with the alpha value.
+     */
     R16G16B16A16_PREMULTIPLIED = 10,
+    /** 4 guint16 values; for red, green, blue, alpha. */
     R16G16B16A16 = 11,
+    /** 3 half-float values; for red, green, blue. The data is opaque. */
     R16G16B16_FLOAT = 12,
+    /**
+     * 4 half-float values; for red, green, blue and alpha. The color values are
+     * premultiplied with the alpha value.
+     */
     R16G16B16A16_FLOAT_PREMULTIPLIED = 13,
+    /** 4 half-float values; for red, green, blue and alpha. */
     R16G16B16A16_FLOAT = 14,
+    /** 3 float values; for red, green, blue. */
     R32G32B32_FLOAT = 15,
+    /**
+     * 4 float values; for red, green, blue and alpha. The color values are
+     * premultiplied with the alpha value.
+     */
     R32G32B32A32_FLOAT_PREMULTIPLIED = 16,
+    /** 4 float values; for red, green, blue and alpha. */
     R32G32B32A32_FLOAT = 17,
+    /**
+     * 2 bytes; for grayscale, alpha. The color values are premultiplied with the
+     * alpha value.
+     */
     G8A8_PREMULTIPLIED = 18,
+    /** 2 bytes; for grayscale, alpha. */
     G8A8 = 19,
+    /** One byte; for grayscale. The data is opaque. */
     G8 = 20,
+    /**
+     * 2 guint16 values; for grayscale, alpha. The color values are premultiplied
+     * with the alpha value.
+     */
     G16A16_PREMULTIPLIED = 21,
+    /** 2 guint16 values; for grayscale, alpha. */
     G16A16 = 22,
+    /** One guint16 value; for grayscale. The data is opaque. */
     G16 = 23,
+    /** One byte; for alpha. */
     A8 = 24,
+    /** One guint16 value; for alpha. */
     A16 = 25,
+    /** One half-float value; for alpha. */
     A16_FLOAT = 26,
+    /** One float value; for alpha. */
     A32_FLOAT = 27,
+    /**
+     * 4 bytes; for alpha, blue, green, red, The color values are premultiplied with
+     * the alpha value.
+     */
     A8B8G8R8_PREMULTIPLIED = 28,
+    /** 4 bytes; for blue, green, red, unused. */
     B8G8R8X8 = 29,
+    /** 4 bytes; for unused, red, green, blue. */
     X8R8G8B8 = 30,
+    /** 4 bytes; for red, green, blue, unused. */
     R8G8B8X8 = 31,
+    /** 4 bytes; for unused, blue, green, red. */
     X8B8G8R8 = 32,
+    /**
+     * 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 = 33,
+    /**
+     * 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 = 34,
+    /**
+     * 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 = 35,
+    /**
+     * 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 = 36,
+    /**
+     * 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 = 37,
+    /**
+     * 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 = 38,
+    /**
+     * 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 = 39,
+    /**
+     * 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 = 40,
+    /**
+     * 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 = 41,
+    /**
+     * 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 = 42,
+    /**
+     * 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 = 43,
+    /**
+     * 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 = 44,
+    /**
+     * 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 = 45,
+    /**
+     * 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
+     * 3rd channel.
+     *
+     * The third plane usually contains the second chroma channel.
+     * Subsampled in both the X and Y direction. It is mapped into the
+     * 1st channel.
+     *
+     * Commonly known by the fourcc "YUV420".
+     */
     G8_B8_R8_420 = 46,
+    /**
+     * 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. It is mapped into the
+     * 1st channel.
+     *
+     * The third plane usually contains the first chroma channel.
+     * Subsampled in both the X and Y direction. It is mapped into the
+     * 3rd channel.
+     *
+     * Commonly known by the fourcc "YVU420".
+     */
     G8_R8_B8_420 = 47,
+    /**
+     * 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. It is mapped into the 3rd channel.
+     *
+     * The third plane usually contains the second chroma channel.
+     * Subsampled in the X direction. It is mapped into the 1st channel.
+     *
+     * Commonly known by the fourcc "YUV422".
+     */
     G8_B8_R8_422 = 48,
+    /**
+     * 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. It is mapped into the 1st channel.
+     *
+     * The third plane usually contains the first chroma channel.
+     * Subsampled in the X direction. It is mapped into the 3rd channel.
+     *
+     * Commonly known by the fourcc "YVU422".
+     */
     G8_R8_B8_422 = 49,
+    /**
+     * 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. It is
+     * mapped into the 3rd channel.
+     *
+     * The third plane usually contains the second chroma channel. It is
+     * mapped into the 1st channel.
+     *
+     * Commonly known by the fourcc "YUV444".
+     */
     G8_B8_R8_444 = 50,
+    /**
+     * 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. It is mapped into the 1st channel.
+     *
+     * The third plane usually contains the first chroma channel.
+     * Subsampled in the X direction. It is mapped into the 3rd channel.
+     *
+     * Commonly known by the fourcc "YVU444".
+     */
     G8_R8_B8_444 = 51,
+    /**
+     * Packed format with subsampled channels.
+     *
+     * Each channel is a 8 bit integer. The red and blue/chroma channels
+     * are subsampled and interleaved with the green/luma channel.
+     *
+     * Each block contains 2 pixels, so the width must be a multiple of
+     * 2.
+     *
+     * Commonly known by the fourcc "YUYV".
+     */
     G8B8G8R8_422 = 52,
+    /**
+     * Packed format with subsampled channels.
+     *
+     * Each channel is a 8 bit integer. The red and blue/chroma channels
+     * are subsampled and interleaved with the green/luma channel.
+     *
+     * Each block contains 2 pixels, so the width must be a multiple of
+     * 2.
+     *
+     * Commonly known by the fourcc "YVYU".
+     */
     G8R8G8B8_422 = 53,
+    /**
+     * Packed format with subsampled channels.
+     *
+     * Each channel is a 8 bit integer. The red and blue/chroma channels
+     * are subsampled and interleaved with the green/luma channel.
+     *
+     * Each block contains 2 pixels, so the width must be a multiple of
+     * 2.
+     *
+     * Commonly known by the fourcc "VYUY".
+     */
     R8G8B8G8_422 = 54,
+    /**
+     * Packed format with subsampled channels.
+     *
+     * Each channel is a 8 bit integer. The red and blue/chroma channels
+     * are subsampled and interleaved with the green/luma channel.
+     *
+     * Each block contains 2 pixels, so the width must be a multiple of
+     * 2.
+     *
+     * Commonly known by the fourcc "UYVY".
+     */
     B8G8R8G8_422 = 55,
+    /**
+     * Multiplane format with 3 planes.
+     *
+     * Each channel is a 16 bit integer.
+     *
+     * Only the 10 lower bits are used. The remaining ones must be set to 0 by the
+     * producer.
+     *
+     * 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
+     * 3rd channel.
+     *
+     * The third plane usually contains the second chroma channel.
+     * Subsampled in both the X and Y direction. It is mapped into the
+     * 1st channel.
+     *
+     * Commonly known by the fourcc "S010".
+     */
     X6G10_X6B10_X6R10_420 = 56,
+    /**
+     * Multiplane format with 3 planes.
+     *
+     * Each channel is a 16 bit integer.
+     *
+     * Only the 10 lower bits are used. The remaining ones must be set to 0 by the
+     * producer.
+     *
+     * 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. It is mapped into the 3rd channel.
+     *
+     * The third plane usually contains the second chroma channel.
+     * Subsampled in the X direction. It is mapped into the 1st channel.
+     *
+     * Commonly known by the fourcc "S210".
+     */
     X6G10_X6B10_X6R10_422 = 57,
+    /**
+     * Multiplane format with 3 planes.
+     *
+     * Each channel is a 16 bit integer.
+     *
+     * Only the 10 lower bits are used. The remaining ones must be set to 0 by the
+     * producer.
+     *
+     * The first plane usually contains the luma channel. It is mapped
+     * into the 2nd channel.
+     *
+     * The second plane usually contains the first chroma chanel. It is
+     * mapped into the 3rd channel.
+     *
+     * The third plane usually contains the second chroma channel. It is
+     * mapped into the 1st channel.
+     *
+     * Commonly known by the fourcc "S410".
+     */
     X6G10_X6B10_X6R10_444 = 58,
+    /**
+     * Multiplane format with 3 planes.
+     *
+     * Each channel is a 16 bit integer.
+     *
+     * Only the 12 lower bits are used. The remaining ones must be set to 0 by the
+     * producer.
+     *
+     * 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
+     * 3rd channel.
+     *
+     * The third plane usually contains the second chroma channel.
+     * Subsampled in both the X and Y direction. It is mapped into the
+     * 1st channel.
+     *
+     * Commonly known by the fourcc "S012".
+     */
     X4G12_X4B12_X4R12_420 = 59,
+    /**
+     * Multiplane format with 3 planes.
+     *
+     * Each channel is a 16 bit integer.
+     *
+     * Only the 12 lower bits are used. The remaining ones must be set to 0 by the
+     * producer.
+     *
+     * 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. It is mapped into the 3rd channel.
+     *
+     * The third plane usually contains the second chroma channel.
+     * Subsampled in the X direction. It is mapped into the 1st channel.
+     *
+     * Commonly known by the fourcc "S212".
+     */
     X4G12_X4B12_X4R12_422 = 60,
+    /**
+     * Multiplane format with 3 planes.
+     *
+     * Each channel is a 16 bit integer.
+     *
+     * Only the 12 lower bits are used. The remaining ones must be set to 0 by the
+     * producer.
+     *
+     * The first plane usually contains the luma channel. It is mapped
+     * into the 2nd channel.
+     *
+     * The second plane usually contains the first chroma chanel. It is
+     * mapped into the 3rd channel.
+     *
+     * The third plane usually contains the second chroma channel. It is
+     * mapped into the 1st channel.
+     *
+     * Commonly known by the fourcc "S412".
+     */
     X4G12_X4B12_X4R12_444 = 61,
+    /**
+     * Multiplane format with 3 planes.
+     *
+     * Each channel is a 16 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
+     * 3rd channel.
+     *
+     * The third plane usually contains the second chroma channel.
+     * Subsampled in both the X and Y direction. It is mapped into the
+     * 1st channel.
+     *
+     * Commonly known by the fourcc "S016".
+     */
     G16_B16_R16_420 = 62,
+    /**
+     * Multiplane format with 3 planes.
+     *
+     * Each channel is a 16 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. It is mapped into the 3rd channel.
+     *
+     * The third plane usually contains the second chroma channel.
+     * Subsampled in the X direction. It is mapped into the 1st channel.
+     *
+     * Commonly known by the fourcc "S216".
+     */
     G16_B16_R16_422 = 63,
+    /**
+     * Multiplane format with 3 planes.
+     *
+     * Each channel is a 16 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. It is
+     * mapped into the 3rd channel.
+     *
+     * The third plane usually contains the second chroma channel. It is
+     * mapped into the 1st channel.
+     *
+     * Commonly known by the fourcc "S416".
+     */
     G16_B16_R16_444 = 64,
+    /**
+     * The number of formats. This value will change as
+     * more formats get added, so do not rely on its concrete integer.
+     */
     N_FORMATS = 65
 }
+/**
+ * Specifies the kind of crossing for enter and leave events.
+ *
+ * See the X11 protocol specification of LeaveNotify for
+ * full details of crossing event generation.
+ */
 export declare enum NotifyType {
+    /**
+     * the surface is entered from an ancestor or
+     * left towards an ancestor.
+     */
     ANCESTOR = 0,
+    /**
+     * the pointer moves between an ancestor and an
+     * inferior of the surface.
+     */
     VIRTUAL = 1,
+    /**
+     * the surface is entered from an inferior or
+     * left towards an inferior.
+     */
     INFERIOR = 2,
+    /**
+     * the surface is entered from or left towards
+     * a surface which is neither an ancestor nor an inferior.
+     */
     NONLINEAR = 3,
+    /**
+     * the pointer moves between two surfaces
+     * which are not ancestors of each other and the surface is part of
+     * the ancestor chain between one of these surfaces and their least
+     * common ancestor.
+     */
     NONLINEAR_VIRTUAL = 4,
+    /** an unknown type of enter/leave event occurred. */
     UNKNOWN = 5
 }
+/** Specifies the direction for scroll events. */
 export declare enum ScrollDirection {
+    /** the surface is scrolled up. */
     UP = 0,
+    /** the surface is scrolled down. */
     DOWN = 1,
+    /** the surface is scrolled to the left. */
     LEFT = 2,
+    /** the surface is scrolled to the right. */
     RIGHT = 3,
+    /**
+     * the scrolling is determined by the delta values
+     * in scroll events. See gdk_scroll_event_get_deltas()
+     */
     SMOOTH = 4
 }
+/**
+ * Used in scroll events, to announce the direction relative
+ * to physical motion.
+ */
 export declare enum ScrollRelativeDirection {
+    /** Physical motion and event motion are the same */
     IDENTICAL = 0,
+    /** Physical motion is inverted relative to event motion */
     INVERTED = 1,
+    /** Relative motion is unknown on this device or backend */
     UNKNOWN = 2
 }
+/**
+ * Specifies the unit of scroll deltas.
+ *
+ * When you get %GDK_SCROLL_UNIT_WHEEL, a delta of 1.0 means 1 wheel detent
+ * click in the south direction, 2.0 means 2 wheel detent clicks in the south
+ * direction... This is the same logic for negative values but in the north
+ * direction.
+ *
+ * If you get %GDK_SCROLL_UNIT_SURFACE, are managing a scrollable view and get a
+ * value of 123, you have to scroll 123 surface logical pixels right if it's
+ * `delta_x` or down if it's @delta_y. This is the same logic for negative values
+ * but you have to scroll left instead of right if it's `delta_x` and up instead
+ * of down if it's @delta_y.
+ *
+ * 1 surface logical pixel is equal to 1 real screen pixel multiplied by the
+ * final scale factor of your graphical interface (the product of the desktop
+ * scale factor and eventually a custom scale factor in your app).
+ */
 export declare enum ScrollUnit {
+    /** The delta is in number of wheel clicks. */
     WHEEL = 0,
+    /**
+     * The delta is in surface pixels to scroll directly
+     * on screen.
+     */
     SURFACE = 1
 }
+/**
+ * This enumeration describes how the red, green and blue components
+ * of physical pixels on an output device are laid out.
+ */
 export declare enum SubpixelLayout {
+    /** The layout is not known */
     UNKNOWN = 0,
+    /** Not organized in this way */
     NONE = 1,
+    /** The layout is horizontal, the order is RGB */
     HORIZONTAL_RGB = 2,
+    /** The layout is horizontal, the order is BGR */
     HORIZONTAL_BGR = 3,
+    /** The layout is vertical, the order is RGB */
     VERTICAL_RGB = 4,
+    /** The layout is vertical, the order is BGR */
     VERTICAL_BGR = 5
 }
+/** Determines a surface edge or corner. */
 export declare enum SurfaceEdge {
+    /** the top left corner. */
     NORTH_WEST = 0,
+    /** the top edge. */
     NORTH = 1,
+    /** the top right corner. */
     NORTH_EAST = 2,
+    /** the left edge. */
     WEST = 3,
+    /** the right edge. */
     EAST = 4,
+    /** the lower left corner. */
     SOUTH_WEST = 5,
+    /** the lower edge. */
     SOUTH = 6,
+    /** the lower right corner. */
     SOUTH_EAST = 7
 }
+/** Possible errors that can be returned by `GdkTexture` constructors. */
 export declare enum TextureError {
+    /** Not enough memory to handle this image */
     TOO_LARGE = 0,
+    /** The image data appears corrupted */
     CORRUPT_IMAGE = 1,
+    /**
+     * The image contains features
+     * that cannot be loaded
+     */
     UNSUPPORTED_CONTENT = 2,
+    /** The image format is not supported */
     UNSUPPORTED_FORMAT = 3
 }
+/**
+ * The kind of title bar gesture to emit with
+ * [method@Gdk.Toplevel.titlebar_gesture].
+ */
 export declare enum TitlebarGesture {
+    /** double click gesture */
     DOUBLE_CLICK = 1,
+    /** right click gesture */
     RIGHT_CLICK = 2,
+    /** middle click gesture */
     MIDDLE_CLICK = 3
 }
+/**
+ * Specifies the current state of a touchpad gesture.
+ *
+ * All gestures are guaranteed to begin with an event with phase
+ * %GDK_TOUCHPAD_GESTURE_PHASE_BEGIN, followed by 0 or several events
+ * with phase %GDK_TOUCHPAD_GESTURE_PHASE_UPDATE.
+ *
+ * A finished gesture may have 2 possible outcomes, an event with phase
+ * %GDK_TOUCHPAD_GESTURE_PHASE_END will be emitted when the gesture is
+ * considered successful, this should be used as the hint to perform any
+ * permanent changes.
+ *
+ * Cancelled gestures may be so for a variety of reasons, due to hardware
+ * or the compositor, or due to the gesture recognition layers hinting the
+ * gesture did not finish resolutely (eg. a 3rd finger being added during
+ * a pinch gesture). In these cases, the last event will report the phase
+ * %GDK_TOUCHPAD_GESTURE_PHASE_CANCEL, this should be used as a hint
+ * to undo any visible/permanent changes that were done throughout the
+ * progress of the gesture.
+ */
 export declare enum TouchpadGesturePhase {
+    /** The gesture has begun. */
     BEGIN = 0,
+    /** The gesture has been updated. */
     UPDATE = 1,
+    /**
+     * The gesture was finished, changes
+     * should be permanently applied.
+     */
     END = 2,
+    /**
+     * The gesture was cancelled, all
+     * changes should be undone.
+     */
     CANCEL = 3
 }
+/** Error enumeration for `GdkVulkanContext`. */
 export declare enum VulkanError {
+    /**
+     * Vulkan is not supported on this backend or has not been
+     * compiled in.
+     */
     UNSUPPORTED = 0,
+    /** Vulkan support is not available on this Surface */
     NOT_AVAILABLE = 1
 }
+/**
+ * Positioning hints for aligning a surface relative to a rectangle.
+ *
+ * These hints determine how the surface should be positioned in the case that
+ * the surface would fall off-screen if placed in its ideal position.
+ *
+ * For example, %GDK_ANCHOR_FLIP_X will replace %GDK_GRAVITY_NORTH_WEST with
+ * %GDK_GRAVITY_NORTH_EAST and vice versa if the surface extends beyond the left
+ * or right edges of the monitor.
+ *
+ * If %GDK_ANCHOR_SLIDE_X is set, the surface can be shifted horizontally to fit
+ * on-screen. If %GDK_ANCHOR_RESIZE_X is set, the surface can be shrunken
+ * horizontally to fit.
+ *
+ * In general, when multiple flags are set, flipping should take precedence over
+ * sliding, which should take precedence over resizing.
+ */
 export declare enum AnchorHints {
+    /** allow flipping anchors horizontally */
     FLIP_X = 1,
+    /** allow flipping anchors vertically */
     FLIP_Y = 2,
+    /** allow sliding surface horizontally */
     SLIDE_X = 4,
+    /** allow sliding surface vertically */
     SLIDE_Y = 8,
+    /** allow resizing surface horizontally */
     RESIZE_X = 16,
+    /** allow resizing surface vertically */
     RESIZE_Y = 32,
+    /** allow flipping anchors on both axes */
     FLIP = 3,
+    /** allow sliding surface on both axes */
     SLIDE = 12,
+    /** allow resizing surface on both axes */
     RESIZE = 48
 }
+/** Flags describing the current capabilities of a device/tool. */
 export declare enum AxisFlags {
+    /** X axis is present */
     X = 2,
+    /** Y axis is present */
     Y = 4,
+    /** Scroll X delta axis is present */
     DELTA_X = 8,
+    /** Scroll Y delta axis is present */
     DELTA_Y = 16,
+    /** Pressure axis is present */
     PRESSURE = 32,
+    /** X tilt axis is present */
     XTILT = 64,
+    /** Y tilt axis is present */
     YTILT = 128,
+    /** Wheel axis is present */
     WHEEL = 256,
+    /** Distance axis is present */
     DISTANCE = 512,
+    /** Z-axis rotation is present */
     ROTATION = 1024,
+    /** Slider axis is present */
     SLIDER = 2048
 }
+/**
+ * Used in `GdkDrop` and `GdkDrag` to indicate the actions that the
+ * destination can and should do with the dropped data.
+ */
 export declare enum DragAction {
+    /** No action. */
     NONE = 0,
+    /** Copy the data. */
     COPY = 1,
+    /**
+     * Move the data, i.e. first copy it, then delete
+     * it from the source using the DELETE target of the X selection protocol.
+     */
     MOVE = 2,
+    /**
+     * Add a link to the data. Note that this is only
+     * useful if source and destination agree on what it means, and is not
+     * supported on all platforms.
+     */
     LINK = 4,
+    /** Ask the user what to do with the data. */
     ASK = 8
 }
+/**
+ * Used to represent the different paint clock phases that can be requested.
+ *
+ * The elements of the enumeration correspond to the signals of `GdkFrameClock`.
+ */
 export declare enum FrameClockPhase {
+    /** no phase */
     NONE = 0,
+    /**
+     * corresponds to GdkFrameClock::flush-events. Should not be handled by applications.
+     */
     FLUSH_EVENTS = 1,
+    /**
+     * corresponds to GdkFrameClock::before-paint. Should not be handled by applications.
+     */
     BEFORE_PAINT = 2,
+    /** corresponds to GdkFrameClock::update. */
     UPDATE = 4,
+    /** corresponds to GdkFrameClock::layout. Should not be handled by applications. */
     LAYOUT = 8,
+    /** corresponds to GdkFrameClock::paint. */
     PAINT = 16,
+    /**
+     * corresponds to GdkFrameClock::resume-events. Should not be handled by applications.
+     */
     RESUME_EVENTS = 32,
+    /**
+     * corresponds to GdkFrameClock::after-paint. Should not be handled by applications.
+     */
     AFTER_PAINT = 64
 }
+/** The list of the different APIs that GdkGLContext can potentially support. */
 export declare enum GLAPI {
+    /** The OpenGL API */
     GL = 1,
+    /** The OpenGL ES API */
     GLES = 2
 }
+/**
+ * Flags to indicate the state of modifier keys and mouse buttons
+ * in events.
+ *
+ * Typical modifier keys are Shift, Control, Meta, Super, Hyper, Alt, Compose,
+ * Apple, CapsLock or ShiftLock.
+ *
+ * Note that GDK may add internal values to events which include values outside
+ * of this enumeration. Your code should preserve and ignore them. You can use
+ * %GDK_MODIFIER_MASK to remove all private values.
+ */
 export declare enum ModifierType {
+    /** No modifier. */
     NO_MODIFIER_MASK = 0,
+    /** the Shift key. */
     SHIFT_MASK = 1,
+    /**
+     * a Lock key (depending on the Windowing System configuration,
+     * this may either be `CapsLock` or `ShiftLock`).
+     */
     LOCK_MASK = 2,
+    /** the Control key. */
     CONTROL_MASK = 4,
+    /**
+     * the fourth modifier key (it depends on the Windowing System
+     * configuration which key is interpreted as this modifier, but normally it
+     * is the `Alt` key).
+     */
     ALT_MASK = 8,
+    /** the first mouse button. */
     BUTTON1_MASK = 256,
+    /** the second mouse button. */
     BUTTON2_MASK = 512,
+    /** the third mouse button. */
     BUTTON3_MASK = 1024,
+    /** the fourth mouse button. */
     BUTTON4_MASK = 2048,
+    /** the fifth mouse button. */
     BUTTON5_MASK = 4096,
+    /** the Super modifier. */
     SUPER_MASK = 67108864,
+    /** the Hyper modifier. */
     HYPER_MASK = 134217728,
+    /** the Meta modifier. Maps to Command on macOS. */
     META_MASK = 268435456
 }
+/**
+ * Flags about a paintable object.
+ *
+ * Implementations use these for optimizations such as caching.
+ */
 export declare enum PaintableFlags {
+    /**
+     * The size is immutable.
+     * The [signal@Gdk.Paintable::invalidate-size] signal will never be
+     * emitted.
+     */
     SIZE = 1,
+    /**
+     * The content is immutable.
+     * The [signal@Gdk.Paintable::invalidate-contents] signal will never be
+     * emitted.
+     */
     CONTENTS = 2
 }
+/** Flags describing the seat capabilities. */
 export declare enum SeatCapabilities {
+    /** No input capabilities */
     NONE = 0,
+    /** The seat has a pointer (e.g. mouse) */
     POINTER = 1,
+    /** The seat has touchscreen(s) attached */
     TOUCH = 2,
+    /** The seat has drawing tablet(s) attached */
     TABLET_STYLUS = 4,
+    /** The seat has keyboard(s) attached */
     KEYBOARD = 8,
+    /** The seat has drawing tablet pad(s) attached */
     TABLET_PAD = 16,
+    /** The union of all pointing capabilities */
     ALL_POINTING = 7,
+    /** The union of all capabilities */
     ALL = 31
 }
+/** Reflects what features a `GdkToplevel` supports. */
 export declare enum ToplevelCapabilities {
+    /** Whether tiled window states are supported. */
     EDGE_CONSTRAINTS = 1,
+    /**
+     * Whether inhibiting system shortcuts is supported.
+     * See [method@Gdk.Toplevel.inhibit_system_shortcuts].
+     */
     INHIBIT_SHORTCUTS = 2,
+    /**
+     * Whether titlebar gestures are supported.
+     * See [method@Gdk.Toplevel.titlebar_gesture].
+     */
     TITLEBAR_GESTURES = 4,
+    /**
+     * Whether showing the window menu is supported.
+     * See [method@Gdk.Toplevel.show_window_menu].
+     */
     WINDOW_MENU = 8,
+    /** Whether the toplevel can be maximized. */
     MAXIMIZE = 16,
+    /** Whether the toplevel can be made fullscreen. */
     FULLSCREEN = 32,
+    /**
+     * Whether the toplevel can be minimized.
+     * See [method@Gdk.Toplevel.minimize].
+     */
     MINIMIZE = 64,
+    /**
+     * Whether the toplevel can be lowered.
+     * See [method@Gdk.Toplevel.lower].
+     */
     LOWER = 128
 }
+/**
+ * Specifies the state of a toplevel surface.
+ *
+ * On platforms that support information about individual edges, the
+ * %GDK_TOPLEVEL_STATE_TILED state will be set whenever any of the individual
+ * tiled states is set. On platforms that lack that support, the tiled state
+ * will give an indication of tiledness without any of the per-edge states
+ * being set.
+ */
 export declare enum ToplevelState {
+    /** the surface is minimized */
     MINIMIZED = 1,
+    /** the surface is maximized */
     MAXIMIZED = 2,
+    /** the surface is sticky */
     STICKY = 4,
+    /** the surface is maximized without decorations */
     FULLSCREEN = 8,
+    /** the surface is kept above other surfaces */
     ABOVE = 16,
+    /** the surface is kept below other surfaces */
     BELOW = 32,
+    /** the surface is presented as focused (with active decorations) */
     FOCUSED = 64,
+    /** the surface is in a tiled state */
     TILED = 128,
+    /** whether the top edge is tiled */
     TOP_TILED = 256,
+    /** whether the top edge is resizable */
     TOP_RESIZABLE = 512,
+    /** whether the right edge is tiled */
     RIGHT_TILED = 1024,
+    /** whether the right edge is resizable */
     RIGHT_RESIZABLE = 2048,
+    /** whether the bottom edge is tiled */
     BOTTOM_TILED = 4096,
+    /** whether the bottom edge is resizable */
     BOTTOM_RESIZABLE = 8192,
+    /** whether the left edge is tiled */
     LEFT_TILED = 16384,
+    /** whether the left edge is resizable */
     LEFT_RESIZABLE = 32768,
+    /** The surface is not visible to the user. */
     SUSPENDED = 65536
 }