@gtkx/ffi 0.1.45 → 0.1.46

package/dist/generated/gdk/dmabuf-texture-builder.d.ts

@@ -3,35 +3,252 @@ import { Display } from "./display.js";
 import { Texture } from "./texture.js";
 import * as GObject from "../gobject/index.js";
 import * as cairo from "../cairo/index.js";
+/**
+ * Constructs [class@Gdk.Texture] objects from DMA buffers.
+ *
+ * DMA buffers are commonly called **_dma-bufs_**.
+ *
+ * DMA buffers are a feature of the Linux kernel to enable efficient buffer and
+ * memory sharing between hardware such as codecs, GPUs, displays, cameras and the
+ * kernel drivers controlling them. For example, a decoder may want its output to
+ * be directly shared with the display server for rendering without a copy.
+ *
+ * Any device driver which participates in DMA buffer sharing, can do so as either
+ * the exporter or importer of buffers (or both).
+ *
+ * The memory that is shared via DMA buffers is usually stored in non-system memory
+ * (maybe in device's local memory or something else not directly accessible by the
+ * CPU), and accessing this memory from the CPU may have higher-than-usual overhead.
+ *
+ * In particular for graphics data, it is not uncommon that data consists of multiple
+ * separate blocks of memory, for example one block for each of the red, green and
+ * blue channels. These blocks are called **_planes_**. DMA buffers can have up to
+ * four planes. Even if the memory is a single block, the data can be organized in
+ * multiple planes, by specifying offsets from the beginning of the data.
+ *
+ * DMA buffers are exposed to user-space as file descriptors allowing to pass them
+ * between processes. If a DMA buffer has multiple planes, there is one file
+ * descriptor per plane.
+ *
+ * The format of the data (for graphics data, essentially its colorspace) is described
+ * by a 32-bit integer. These format identifiers are defined in the header file `drm_fourcc.h`
+ * and commonly referred to as **_fourcc_** values, since they are identified by 4 ASCII
+ * characters. Additionally, each DMA buffer has a **_modifier_**, which is a 64-bit integer
+ * that describes driver-specific details of the memory layout, such as tiling or compression.
+ *
+ * For historical reasons, some producers of dma-bufs don't provide an explicit modifier, but
+ * instead return `DMA_FORMAT_MOD_INVALID` to indicate that their modifier is **_implicit_**.
+ * GTK tries to accommodate this situation by accepting `DMA_FORMAT_MOD_INVALID` as modifier.
+ *
+ * The operation of `GdkDmabufTextureBuilder` is quite simple: Create a texture builder,
+ * set all the necessary properties, and then call [method@Gdk.DmabufTextureBuilder.build]
+ * to create the new texture.
+ *
+ * The required properties for a dma-buf texture are
+ *
+ * * The width and height in pixels
+ *
+ * * The `fourcc` code and `modifier` which identify the format and memory layout of the dma-buf
+ *
+ * * The file descriptor, offset and stride for each of the planes
+ *
+ * `GdkDmabufTextureBuilder` can be used for quick one-shot construction of
+ * textures as well as kept around and reused to construct multiple textures.
+ *
+ * For further information, see
+ *
+ * * The Linux kernel documentation
+ *
+ * * The header file [drm_fourcc.h](https://gitlab.freedesktop.org/mesa/drm/-/blob/main/include/drm/drm_fourcc.h)
+ */
 export declare class DmabufTextureBuilder extends GObject.GObject {
+    /**
+     * Creates a new texture builder.
+     */
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Builds a new `GdkTexture` with the values set up in the builder.
+     *
+     * It is a programming error to call this function if any mandatory property has not been set.
+     *
+     * Not all formats defined in the `drm_fourcc.h` header are supported. You can use
+     * [method@Gdk.Display.get_dmabuf_formats] to get a list of supported formats. If the
+     * format is not supported by GTK, %NULL will be returned and `error` will be set.
+     *
+     * The `destroy` function gets called when the returned texture gets released.
+     *
+     * It is the responsibility of the caller to keep the file descriptors for the planes
+     * open until the created texture is no longer used, and close them afterwards (possibly
+     * using the `destroy` notify).
+     *
+     * It is possible to call this function multiple times to create multiple textures,
+     * possibly with changing properties in between.
+     * @param destroy - destroy function to be called when the texture is
+     * @param data - user data to pass to the destroy function
+     */
     build(destroy?: () => void | null, data?: number | null): Texture | null;
+    /**
+     * Gets the color state previously set via gdk_dmabuf_texture_builder_set_color_state().
+     */
     getColorState(): ColorState | null;
+    /**
+     * Returns the display that this texture builder is
+     * associated with.
+     */
     getDisplay(): Display;
+    /**
+     * Gets the file descriptor for a plane.
+     * @param plane - the plane to get the fd for
+     */
     getFd(plane: number): number;
+    /**
+     * Gets the format previously set via gdk_dmabuf_texture_builder_set_fourcc()
+     * or 0 if the format wasn't set.
+     *
+     * The format is specified as a fourcc code.
+     */
     getFourcc(): number;
+    /**
+     * Gets the height previously set via gdk_dmabuf_texture_builder_set_height() or
+     * 0 if the height wasn't set.
+     */
     getHeight(): number;
+    /**
+     * Gets the modifier value.
+     */
     getModifier(): number;
+    /**
+     * Gets the number of planes.
+     */
     getNPlanes(): number;
+    /**
+     * Gets the offset value for a plane.
+     * @param plane - the plane to get the offset for
+     */
     getOffset(plane: number): number;
+    /**
+     * Whether the data is premultiplied.
+     */
     getPremultiplied(): boolean;
+    /**
+     * Gets the stride value for a plane.
+     * @param plane - the plane to get the stride for
+     */
     getStride(plane: number): number;
+    /**
+     * Gets the region previously set via gdk_dmabuf_texture_builder_set_update_region() or
+     * %NULL if none was set.
+     */
     getUpdateRegion(): cairo.Region | null;
+    /**
+     * Gets the texture previously set via gdk_dmabuf_texture_builder_set_update_texture() or
+     * %NULL if none was set.
+     */
     getUpdateTexture(): Texture | null;
+    /**
+     * Gets the width previously set via gdk_dmabuf_texture_builder_set_width() or
+     * 0 if the width wasn't set.
+     */
     getWidth(): number;
+    /**
+     * Sets the color state for the texture.
+     *
+     * By default, the colorstate is `NULL`. In that case, GTK will choose the
+     * correct colorstate based on the format.
+     * If you don't know what colorstates are, this is probably the right thing.
+     * @param colorState - a `GdkColorState` or `NULL` to unset the colorstate.
+     */
     setColorState(colorState?: ColorState | null): void;
+    /**
+     * Sets the display that this texture builder is
+     * associated with.
+     *
+     * The display is used to determine the supported
+     * dma-buf formats.
+     * @param display - the display
+     */
     setDisplay(display: Display): void;
+    /**
+     * Sets the file descriptor for a plane.
+     * @param plane - the plane to set the fd for
+     * @param fd - the file descriptor
+     */
     setFd(plane: number, fd: number): void;
+    /**
+     * Sets the format of the texture.
+     *
+     * The format is specified as a fourcc code.
+     *
+     * The format must be set before calling [method@Gdk.DmabufTextureBuilder.build].
+     * @param fourcc - the texture's format or 0 to unset
+     */
     setFourcc(fourcc: number): void;
+    /**
+     * Sets the height of the texture.
+     *
+     * The height must be set before calling [method@Gdk.DmabufTextureBuilder.build].
+     * @param height - the texture's height or 0 to unset
+     */
     setHeight(height: number): void;
+    /**
+     * Sets the modifier.
+     * @param modifier - the modifier value
+     */
     setModifier(modifier: number): void;
+    /**
+     * Sets the number of planes of the texture.
+     * @param nPlanes - the number of planes
+     */
     setNPlanes(nPlanes: number): void;
+    /**
+     * Sets the offset for a plane.
+     * @param plane - the plane to set the offset for
+     * @param offset - the offset value
+     */
     setOffset(plane: number, offset: number): void;
+    /**
+     * Sets whether the data is premultiplied.
+     *
+     * Unless otherwise specified, all formats including alpha channels are assumed
+     * to be premultiplied.
+     * @param premultiplied - whether the data is premultiplied
+     */
     setPremultiplied(premultiplied: boolean): void;
+    /**
+     * Sets the stride for a plane.
+     *
+     * The stride must be set for all planes before calling [method@Gdk.DmabufTextureBuilder.build].
+     * @param plane - the plane to set the stride for
+     * @param stride - the stride value
+     */
     setStride(plane: number, stride: number): void;
+    /**
+     * Sets the region to be updated by this texture. Together with
+     * [property@Gdk.DmabufTextureBuilder:update-texture] this describes an
+     * update of a previous texture.
+     *
+     * When rendering animations of large textures, it is possible that
+     * consecutive textures are only updating contents in parts of the texture.
+     * It is then possible to describe this update via these two properties,
+     * so that GTK can avoid rerendering parts that did not change.
+     *
+     * An example would be a screen recording where only the mouse pointer moves.
+     * @param region - the region to update
+     */
     setUpdateRegion(region?: cairo.Region | null): void;
+    /**
+     * Sets the texture to be updated by this texture. See
+     * [method@Gdk.DmabufTextureBuilder.set_update_region] for an explanation.
+     * @param texture - the texture to update
+     */
     setUpdateTexture(texture?: Texture | null): void;
+    /**
+     * Sets the width of the texture.
+     *
+     * The width must be set before calling [method@Gdk.DmabufTextureBuilder.build].
+     * @param width - The texture's width or 0 to unset
+     */
     setWidth(width: number): void;
     connect(signal: "notify", handler: (self: DmabufTextureBuilder, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;

package/dist/generated/gdk/dmabuf-texture-builder.js

@@ -5,7 +5,68 @@ import { Display } from "./display.js";
 import { Texture } from "./texture.js";
 import * as GObject from "../gobject/index.js";
 import * as cairo from "../cairo/index.js";
+/**
+ * Constructs [class@Gdk.Texture] objects from DMA buffers.
+ *
+ * DMA buffers are commonly called **_dma-bufs_**.
+ *
+ * DMA buffers are a feature of the Linux kernel to enable efficient buffer and
+ * memory sharing between hardware such as codecs, GPUs, displays, cameras and the
+ * kernel drivers controlling them. For example, a decoder may want its output to
+ * be directly shared with the display server for rendering without a copy.
+ *
+ * Any device driver which participates in DMA buffer sharing, can do so as either
+ * the exporter or importer of buffers (or both).
+ *
+ * The memory that is shared via DMA buffers is usually stored in non-system memory
+ * (maybe in device's local memory or something else not directly accessible by the
+ * CPU), and accessing this memory from the CPU may have higher-than-usual overhead.
+ *
+ * In particular for graphics data, it is not uncommon that data consists of multiple
+ * separate blocks of memory, for example one block for each of the red, green and
+ * blue channels. These blocks are called **_planes_**. DMA buffers can have up to
+ * four planes. Even if the memory is a single block, the data can be organized in
+ * multiple planes, by specifying offsets from the beginning of the data.
+ *
+ * DMA buffers are exposed to user-space as file descriptors allowing to pass them
+ * between processes. If a DMA buffer has multiple planes, there is one file
+ * descriptor per plane.
+ *
+ * The format of the data (for graphics data, essentially its colorspace) is described
+ * by a 32-bit integer. These format identifiers are defined in the header file `drm_fourcc.h`
+ * and commonly referred to as **_fourcc_** values, since they are identified by 4 ASCII
+ * characters. Additionally, each DMA buffer has a **_modifier_**, which is a 64-bit integer
+ * that describes driver-specific details of the memory layout, such as tiling or compression.
+ *
+ * For historical reasons, some producers of dma-bufs don't provide an explicit modifier, but
+ * instead return `DMA_FORMAT_MOD_INVALID` to indicate that their modifier is **_implicit_**.
+ * GTK tries to accommodate this situation by accepting `DMA_FORMAT_MOD_INVALID` as modifier.
+ *
+ * The operation of `GdkDmabufTextureBuilder` is quite simple: Create a texture builder,
+ * set all the necessary properties, and then call [method@Gdk.DmabufTextureBuilder.build]
+ * to create the new texture.
+ *
+ * The required properties for a dma-buf texture are
+ *
+ * * The width and height in pixels
+ *
+ * * The `fourcc` code and `modifier` which identify the format and memory layout of the dma-buf
+ *
+ * * The file descriptor, offset and stride for each of the planes
+ *
+ * `GdkDmabufTextureBuilder` can be used for quick one-shot construction of
+ * textures as well as kept around and reused to construct multiple textures.
+ *
+ * For further information, see
+ *
+ * * The Linux kernel documentation
+ *
+ * * The header file [drm_fourcc.h](https://gitlab.freedesktop.org/mesa/drm/-/blob/main/include/drm/drm_fourcc.h)
+ */
 export class DmabufTextureBuilder extends GObject.GObject {
+    /**
+     * Creates a new texture builder.
+     */
     constructor(...args) {
         super(...args);
     }
@@ -15,6 +76,26 @@ export class DmabufTextureBuilder extends GObject.GObject {
             borrowed: false,
         });
     }
+    /**
+     * Builds a new `GdkTexture` with the values set up in the builder.
+     *
+     * It is a programming error to call this function if any mandatory property has not been set.
+     *
+     * Not all formats defined in the `drm_fourcc.h` header are supported. You can use
+     * [method@Gdk.Display.get_dmabuf_formats] to get a list of supported formats. If the
+     * format is not supported by GTK, %NULL will be returned and `error` will be set.
+     *
+     * The `destroy` function gets called when the returned texture gets released.
+     *
+     * It is the responsibility of the caller to keep the file descriptors for the planes
+     * open until the created texture is no longer used, and close them afterwards (possibly
+     * using the `destroy` notify).
+     *
+     * It is possible to call this function multiple times to create multiple textures,
+     * possibly with changing properties in between.
+     * @param destroy - destroy function to be called when the texture is
+     * @param data - user data to pass to the destroy function
+     */
     build(destroy, data) {
         const error = { value: null };
         const ptr = call("libgtk-4.so.1", "gdk_dmabuf_texture_builder_build", [
@@ -51,6 +132,9 @@ export class DmabufTextureBuilder extends GObject.GObject {
             return null;
         return getObject(ptr, Texture);
     }
+    /**
+     * Gets the color state previously set via gdk_dmabuf_texture_builder_set_color_state().
+     */
     getColorState() {
         const ptr = call("libgtk-4.so.1", "gdk_dmabuf_texture_builder_get_color_state", [
             {
@@ -67,6 +151,10 @@ export class DmabufTextureBuilder extends GObject.GObject {
             return null;
         return getObject(ptr, ColorState);
     }
+    /**
+     * Returns the display that this texture builder is
+     * associated with.
+     */
     getDisplay() {
         const ptr = call("libgtk-4.so.1", "gdk_dmabuf_texture_builder_get_display", [
             {
@@ -76,6 +164,10 @@ export class DmabufTextureBuilder extends GObject.GObject {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Display);
     }
+    /**
+     * Gets the file descriptor for a plane.
+     * @param plane - the plane to get the fd for
+     */
     getFd(plane) {
         return call("libgtk-4.so.1", "gdk_dmabuf_texture_builder_get_fd", [
             {
@@ -88,6 +180,12 @@ export class DmabufTextureBuilder extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets the format previously set via gdk_dmabuf_texture_builder_set_fourcc()
+     * or 0 if the format wasn't set.
+     *
+     * The format is specified as a fourcc code.
+     */
     getFourcc() {
         return call("libgtk-4.so.1", "gdk_dmabuf_texture_builder_get_fourcc", [
             {
@@ -96,6 +194,10 @@ export class DmabufTextureBuilder extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: true });
     }
+    /**
+     * Gets the height previously set via gdk_dmabuf_texture_builder_set_height() or
+     * 0 if the height wasn't set.
+     */
     getHeight() {
         return call("libgtk-4.so.1", "gdk_dmabuf_texture_builder_get_height", [
             {
@@ -104,6 +206,9 @@ export class DmabufTextureBuilder extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: true });
     }
+    /**
+     * Gets the modifier value.
+     */
     getModifier() {
         return call("libgtk-4.so.1", "gdk_dmabuf_texture_builder_get_modifier", [
             {
@@ -112,6 +217,9 @@ export class DmabufTextureBuilder extends GObject.GObject {
             },
         ], { type: "int", size: 64, unsigned: true });
     }
+    /**
+     * Gets the number of planes.
+     */
     getNPlanes() {
         return call("libgtk-4.so.1", "gdk_dmabuf_texture_builder_get_n_planes", [
             {
@@ -120,6 +228,10 @@ export class DmabufTextureBuilder extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: true });
     }
+    /**
+     * Gets the offset value for a plane.
+     * @param plane - the plane to get the offset for
+     */
     getOffset(plane) {
         return call("libgtk-4.so.1", "gdk_dmabuf_texture_builder_get_offset", [
             {
@@ -132,6 +244,9 @@ export class DmabufTextureBuilder extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: true });
     }
+    /**
+     * Whether the data is premultiplied.
+     */
     getPremultiplied() {
         return call("libgtk-4.so.1", "gdk_dmabuf_texture_builder_get_premultiplied", [
             {
@@ -140,6 +255,10 @@ export class DmabufTextureBuilder extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Gets the stride value for a plane.
+     * @param plane - the plane to get the stride for
+     */
     getStride(plane) {
         return call("libgtk-4.so.1", "gdk_dmabuf_texture_builder_get_stride", [
             {
@@ -152,6 +271,10 @@ export class DmabufTextureBuilder extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: true });
     }
+    /**
+     * Gets the region previously set via gdk_dmabuf_texture_builder_set_update_region() or
+     * %NULL if none was set.
+     */
     getUpdateRegion() {
         const ptr = call("libgtk-4.so.1", "gdk_dmabuf_texture_builder_get_update_region", [
             {
@@ -168,6 +291,10 @@ export class DmabufTextureBuilder extends GObject.GObject {
             return null;
         return getObject(ptr, cairo.Region);
     }
+    /**
+     * Gets the texture previously set via gdk_dmabuf_texture_builder_set_update_texture() or
+     * %NULL if none was set.
+     */
     getUpdateTexture() {
         const ptr = call("libgtk-4.so.1", "gdk_dmabuf_texture_builder_get_update_texture", [
             {
@@ -179,6 +306,10 @@ export class DmabufTextureBuilder extends GObject.GObject {
             return null;
         return getObject(ptr, Texture);
     }
+    /**
+     * Gets the width previously set via gdk_dmabuf_texture_builder_set_width() or
+     * 0 if the width wasn't set.
+     */
     getWidth() {
         return call("libgtk-4.so.1", "gdk_dmabuf_texture_builder_get_width", [
             {
@@ -187,6 +318,14 @@ export class DmabufTextureBuilder extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: true });
     }
+    /**
+     * Sets the color state for the texture.
+     *
+     * By default, the colorstate is `NULL`. In that case, GTK will choose the
+     * correct colorstate based on the format.
+     * If you don't know what colorstates are, this is probably the right thing.
+     * @param colorState - a `GdkColorState` or `NULL` to unset the colorstate.
+     */
     setColorState(colorState) {
         call("libgtk-4.so.1", "gdk_dmabuf_texture_builder_set_color_state", [
             {
@@ -205,6 +344,14 @@ export class DmabufTextureBuilder extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the display that this texture builder is
+     * associated with.
+     *
+     * The display is used to determine the supported
+     * dma-buf formats.
+     * @param display - the display
+     */
     setDisplay(display) {
         call("libgtk-4.so.1", "gdk_dmabuf_texture_builder_set_display", [
             {
@@ -217,6 +364,11 @@ export class DmabufTextureBuilder extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the file descriptor for a plane.
+     * @param plane - the plane to set the fd for
+     * @param fd - the file descriptor
+     */
     setFd(plane, fd) {
         call("libgtk-4.so.1", "gdk_dmabuf_texture_builder_set_fd", [
             {
@@ -233,6 +385,14 @@ export class DmabufTextureBuilder extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the format of the texture.
+     *
+     * The format is specified as a fourcc code.
+     *
+     * The format must be set before calling [method@Gdk.DmabufTextureBuilder.build].
+     * @param fourcc - the texture's format or 0 to unset
+     */
     setFourcc(fourcc) {
         call("libgtk-4.so.1", "gdk_dmabuf_texture_builder_set_fourcc", [
             {
@@ -245,6 +405,12 @@ export class DmabufTextureBuilder extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the height of the texture.
+     *
+     * The height must be set before calling [method@Gdk.DmabufTextureBuilder.build].
+     * @param height - the texture's height or 0 to unset
+     */
     setHeight(height) {
         call("libgtk-4.so.1", "gdk_dmabuf_texture_builder_set_height", [
             {
@@ -257,6 +423,10 @@ export class DmabufTextureBuilder extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the modifier.
+     * @param modifier - the modifier value
+     */
     setModifier(modifier) {
         call("libgtk-4.so.1", "gdk_dmabuf_texture_builder_set_modifier", [
             {
@@ -269,6 +439,10 @@ export class DmabufTextureBuilder extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the number of planes of the texture.
+     * @param nPlanes - the number of planes
+     */
     setNPlanes(nPlanes) {
         call("libgtk-4.so.1", "gdk_dmabuf_texture_builder_set_n_planes", [
             {
@@ -281,6 +455,11 @@ export class DmabufTextureBuilder extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the offset for a plane.
+     * @param plane - the plane to set the offset for
+     * @param offset - the offset value
+     */
     setOffset(plane, offset) {
         call("libgtk-4.so.1", "gdk_dmabuf_texture_builder_set_offset", [
             {
@@ -297,6 +476,13 @@ export class DmabufTextureBuilder extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether the data is premultiplied.
+     *
+     * Unless otherwise specified, all formats including alpha channels are assumed
+     * to be premultiplied.
+     * @param premultiplied - whether the data is premultiplied
+     */
     setPremultiplied(premultiplied) {
         call("libgtk-4.so.1", "gdk_dmabuf_texture_builder_set_premultiplied", [
             {
@@ -309,6 +495,13 @@ export class DmabufTextureBuilder extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the stride for a plane.
+     *
+     * The stride must be set for all planes before calling [method@Gdk.DmabufTextureBuilder.build].
+     * @param plane - the plane to set the stride for
+     * @param stride - the stride value
+     */
     setStride(plane, stride) {
         call("libgtk-4.so.1", "gdk_dmabuf_texture_builder_set_stride", [
             {
@@ -325,6 +518,19 @@ export class DmabufTextureBuilder extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the region to be updated by this texture. Together with
+     * [property@Gdk.DmabufTextureBuilder:update-texture] this describes an
+     * update of a previous texture.
+     *
+     * When rendering animations of large textures, it is possible that
+     * consecutive textures are only updating contents in parts of the texture.
+     * It is then possible to describe this update via these two properties,
+     * so that GTK can avoid rerendering parts that did not change.
+     *
+     * An example would be a screen recording where only the mouse pointer moves.
+     * @param region - the region to update
+     */
     setUpdateRegion(region) {
         call("libgtk-4.so.1", "gdk_dmabuf_texture_builder_set_update_region", [
             {
@@ -343,6 +549,11 @@ export class DmabufTextureBuilder extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the texture to be updated by this texture. See
+     * [method@Gdk.DmabufTextureBuilder.set_update_region] for an explanation.
+     * @param texture - the texture to update
+     */
     setUpdateTexture(texture) {
         call("libgtk-4.so.1", "gdk_dmabuf_texture_builder_set_update_texture", [
             {
@@ -356,6 +567,12 @@ export class DmabufTextureBuilder extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the width of the texture.
+     *
+     * The width must be set before calling [method@Gdk.DmabufTextureBuilder.build].
+     * @param width - The texture's width or 0 to unset
+     */
     setWidth(width) {
         call("libgtk-4.so.1", "gdk_dmabuf_texture_builder_set_width", [
             {

package/dist/generated/gdk/dmabuf-texture.d.ts

@@ -1,4 +1,12 @@
 import { Texture } from "./texture.js";
+/**
+ * A `GdkTexture` representing a DMA buffer.
+ *
+ * To create a `GdkDmabufTexture`, use the auxiliary
+ * [class@Gdk.DmabufTextureBuilder] object.
+ *
+ * Dma-buf textures can only be created on Linux.
+ */
 export declare class DmabufTexture extends Texture {
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;

package/dist/generated/gdk/dmabuf-texture.js

@@ -1,5 +1,13 @@
 import { call } from "@gtkx/native";
 import { Texture } from "./texture.js";
+/**
+ * A `GdkTexture` representing a DMA buffer.
+ *
+ * To create a `GdkDmabufTexture`, use the auxiliary
+ * [class@Gdk.DmabufTextureBuilder] object.
+ *
+ * Dma-buf textures can only be created on Linux.
+ */
 export class DmabufTexture extends Texture {
     constructor(...args) {
         super(...args);

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

@@ -1,7 +1,11 @@
 import { Drop } from "./drop.js";
 import { Event } from "./event.js";
+/** An event related to drag and drop operations. */
 export declare class DNDEvent extends Event {
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Gets the `GdkDrop` object from a DND event.
+     */
     getDrop(): Drop | null;
 }