@gtkx/ffi 0.1.45 → 0.1.46

package/dist/generated/gsk/transform.js

@@ -1,7 +1,24 @@
 import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
+/**
+ * Describes a 3D transform.
+ *
+ * Unlike `graphene_matrix_t`, `GskTransform` retains the steps in how
+ * a transform was constructed, and allows inspecting them. It is modeled
+ * after the way CSS describes transforms.
+ *
+ * `GskTransform` objects are immutable and cannot be changed after creation.
+ * This means code can safely expose them as properties of objects without
+ * having to worry about others changing them.
+ */
 export class Transform {
     ptr;
+    /**
+     * Creates a new identity transform.
+     *
+     * This function is meant to be used by language
+     * bindings. For C code, this is equivalent to using `NULL`.
+     */
     constructor() {
         this.ptr = this.createPtr([]);
     }
@@ -12,6 +29,17 @@ export class Transform {
             innerType: "GskTransform",
         });
     }
+    /**
+     * Parses a given into a transform.
+     *
+     * Strings printed via [method@Gsk.Transform.to_string]
+     * can be read in again successfully using this function.
+     *
+     * If `string` does not describe a valid transform, false
+     * is returned and `NULL` is put in @out_transform.
+     * @param string - the string to parse
+     * @param outTransform - return location for the transform
+     */
     static parse(string, outTransform) {
         return call("libgtk-4.so.1", "gsk_transform_parse", [
             {
@@ -31,6 +59,10 @@ export class Transform {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Checks two transforms for equality.
+     * @param second - the second transform
+     */
     equal(second) {
         return call("libgtk-4.so.1", "gsk_transform_equal", [
             {
@@ -49,6 +81,9 @@ export class Transform {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns the category this transform belongs to.
+     */
     getCategory() {
         return call("libgtk-4.so.1", "gsk_transform_get_category", [
             {
@@ -57,6 +92,18 @@ export class Transform {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Inverts the given transform.
+     *
+     * If `self` is not invertible, `NULL` is returned.
+     * Note that inverting `NULL` also returns `NULL`, which is
+     * the correct inverse of `NULL`. If you need to differentiate
+     * between those cases, you should check `self` is not `NULL`
+     * before calling this function.
+     *
+     * This function consumes @self. Use [method@Gsk.Transform.ref] first
+     * if you want to keep it around.
+     */
     invert() {
         const ptr = call("libgtk-4.so.1", "gsk_transform_invert", [
             {
@@ -73,6 +120,13 @@ export class Transform {
             return null;
         return getObject(ptr, Transform);
     }
+    /**
+     * Multiplies `next` with the given @matrix.
+     *
+     * This function consumes @next. Use [method@Gsk.Transform.ref] first
+     * if you want to keep it around.
+     * @param matrix - the matrix to multiply `next` with
+     */
     matrix(matrix) {
         const ptr = call("libgtk-4.so.1", "gsk_transform_matrix", [
             {
@@ -96,6 +150,22 @@ export class Transform {
         });
         return getObject(ptr, Transform);
     }
+    /**
+     * Multiplies `next` with the matrix [ xx yx x0; xy yy y0; 0 0 1 ].
+     *
+     * The result of calling [method@Gsk.Transform.to_2d] on the returned
+     * [struct@Gsk.Transform] should match the input passed to this
+     * function.
+     *
+     * This function consumes @next. Use [method@Gsk.Transform.ref] first
+     * if you want to keep it around.
+     * @param xx - the xx member
+     * @param yx - the yx member
+     * @param xy - the xy member
+     * @param yy - the yy member
+     * @param dx - the x0 member
+     * @param dy - the y0 member
+     */
     matrix_2d(xx, yx, xy, yy, dx, dy) {
         const ptr = call("libgtk-4.so.1", "gsk_transform_matrix_2d", [
             {
@@ -136,6 +206,18 @@ export class Transform {
             return null;
         return getObject(ptr, Transform);
     }
+    /**
+     * Applies a perspective projection transform.
+     *
+     * This transform scales points in X and Y based on their Z value,
+     * scaling points with positive Z values away from the origin, and
+     * those with negative Z values towards the origin. Points
+     * on the z=0 plane are unchanged.
+     *
+     * This function consumes @next. Use [method@Gsk.Transform.ref] first
+     * if you want to keep it around.
+     * @param depth - distance of the z=0 plane. Lower values give a more
+     */
     perspective(depth) {
         const ptr = call("libgtk-4.so.1", "gsk_transform_perspective", [
             {
@@ -154,6 +236,13 @@ export class Transform {
         });
         return getObject(ptr, Transform);
     }
+    /**
+     * Converts the transform into a human-readable representation.
+     *
+     * The result of this function can later be parsed with
+     * [func@Gsk.Transform.parse].
+     * @param string - The string to print into
+     */
     print(string) {
         call("libgtk-4.so.1", "gsk_transform_print", [
             {
@@ -171,6 +260,9 @@ export class Transform {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Acquires a reference on the given transform.
+     */
     ref() {
         const ptr = call("libgtk-4.so.1", "gsk_transform_ref", [
             {
@@ -187,6 +279,15 @@ export class Transform {
             return null;
         return getObject(ptr, Transform);
     }
+    /**
+     * Rotates `next` by an angle around the Z axis.
+     *
+     * The rotation happens around the origin point of (0, 0).
+     *
+     * This function consumes @next. Use [method@Gsk.Transform.ref] first
+     * if you want to keep it around.
+     * @param angle - the rotation angle, in degrees (clockwise)
+     */
     rotate(angle) {
         const ptr = call("libgtk-4.so.1", "gsk_transform_rotate", [
             {
@@ -207,6 +308,16 @@ export class Transform {
             return null;
         return getObject(ptr, Transform);
     }
+    /**
+     * Rotates `next` `angle` degrees around @axis.
+     *
+     * For a rotation in 2D space, use [method@Gsk.Transform.rotate]
+     *
+     * This function consumes @next. Use [method@Gsk.Transform.ref] first
+     * if you want to keep it around.
+     * @param angle - the rotation angle, in degrees (clockwise)
+     * @param axis - The rotation axis
+     */
     rotate_3d(angle, axis) {
         const ptr = call("libgtk-4.so.1", "gsk_transform_rotate_3d", [
             {
@@ -236,6 +347,16 @@ export class Transform {
             return null;
         return getObject(ptr, Transform);
     }
+    /**
+     * Scales `next` in 2-dimensional space by the given factors.
+     *
+     * Use [method@Gsk.Transform.scale_3d] to scale in all 3 dimensions.
+     *
+     * This function consumes @next. Use [method@Gsk.Transform.ref] first
+     * if you want to keep it around.
+     * @param factorX - scaling factor on the X axis
+     * @param factorY - scaling factor on the Y axis
+     */
     scale(factorX, factorY) {
         const ptr = call("libgtk-4.so.1", "gsk_transform_scale", [
             {
@@ -260,6 +381,15 @@ export class Transform {
             return null;
         return getObject(ptr, Transform);
     }
+    /**
+     * Scales `next` by the given factors.
+     *
+     * This function consumes @next. Use [method@Gsk.Transform.ref] first
+     * if you want to keep it around.
+     * @param factorX - scaling factor on the X axis
+     * @param factorY - scaling factor on the Y axis
+     * @param factorZ - scaling factor on the Z axis
+     */
     scale_3d(factorX, factorY, factorZ) {
         const ptr = call("libgtk-4.so.1", "gsk_transform_scale_3d", [
             {
@@ -288,6 +418,14 @@ export class Transform {
             return null;
         return getObject(ptr, Transform);
     }
+    /**
+     * Applies a skew transform.
+     *
+     * This function consumes @next. Use [method@Gsk.Transform.ref] first
+     * if you want to keep it around.
+     * @param skewX - skew factor, in degrees, on the X axis
+     * @param skewY - skew factor, in degrees, on the Y axis
+     */
     skew(skewX, skewY) {
         const ptr = call("libgtk-4.so.1", "gsk_transform_skew", [
             {
@@ -312,6 +450,36 @@ export class Transform {
             return null;
         return getObject(ptr, Transform);
     }
+    /**
+     * Converts a transform to a 2D transformation matrix.
+     *
+     * `self` must be a 2D transformation. If you are not
+     * sure, use
+     *
+     * gsk_transform_get_category() >= GSK_TRANSFORM_CATEGORY_2D
+     *
+     * to check.
+     *
+     * The returned values are a subset of the full 4x4 matrix that
+     * is computed by [method@Gsk.Transform.to_matrix] and have the
+     * following layout:
+     *
+     * ```
+     * | xx yx |   |  a  b  0 |
+     * | xy yy | = |  c  d  0 |
+     * | dx dy |   | tx ty  1 |
+     * ```
+     *
+     * This function can be used to convert between a `GskTransform`
+     * and a matrix type from other 2D drawing libraries, in particular
+     * Cairo.
+     * @param outXx - return location for the xx member
+     * @param outYx - return location for the yx member
+     * @param outXy - return location for the xy member
+     * @param outYy - return location for the yy member
+     * @param outDx - return location for the x0 member
+     * @param outDy - return location for the y0 member
+     */
     to_2d(outXx, outYx, outXy, outYy, outDx, outDy) {
         call("libgtk-4.so.1", "gsk_transform_to_2d", [
             {
@@ -344,6 +512,33 @@ export class Transform {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Converts a transform to 2D transformation factors.
+     *
+     * To recreate an equivalent transform from the factors returned
+     * by this function, use
+     *
+     * gsk_transform_skew (
+     * gsk_transform_scale (
+     * gsk_transform_rotate (
+     * gsk_transform_translate (NULL, &GRAPHENE_POINT_T (dx, dy)),
+     * angle),
+     * scale_x, scale_y),
+     * skew_x, skew_y)
+     *
+     * `self` must be a 2D transformation. If you are not sure, use
+     *
+     * gsk_transform_get_category() >= GSK_TRANSFORM_CATEGORY_2D
+     *
+     * to check.
+     * @param outSkewX - return location for the skew factor
+     * @param outSkewY - return location for the skew factor
+     * @param outScaleX - return location for the scale
+     * @param outScaleY - return location for the scale
+     * @param outAngle - return location for the rotation angle
+     * @param outDx - return location for the translation
+     * @param outDy - return location for the translation
+     */
     to_2dComponents(outSkewX, outSkewY, outScaleX, outScaleY, outAngle, outDx, outDy) {
         call("libgtk-4.so.1", "gsk_transform_to_2d_components", [
             {
@@ -380,6 +575,29 @@ export class Transform {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Converts a transform to 2D affine transformation factors.
+     *
+     * To recreate an equivalent transform from the factors returned
+     * by this function, use
+     *
+     * gsk_transform_scale (
+     * gsk_transform_translate (
+     * NULL,
+     * &GRAPHENE_POINT_T (dx, dy)),
+     * sx, sy)
+     *
+     * `self` must be a 2D affine transformation. If you are not
+     * sure, use
+     *
+     * gsk_transform_get_category() >= GSK_TRANSFORM_CATEGORY_2D_AFFINE
+     *
+     * to check.
+     * @param outScaleX - return location for the scale
+     * @param outScaleY - return location for the scale
+     * @param outDx - return location for the translation
+     * @param outDy - return location for the translation
+     */
     toAffine(outScaleX, outScaleY, outDx, outDy) {
         call("libgtk-4.so.1", "gsk_transform_to_affine", [
             {
@@ -404,6 +622,12 @@ export class Transform {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Computes the 4x4 matrix for the transform.
+     *
+     * The previous value of `out_matrix` will be ignored.
+     * @param outMatrix - return location for the matrix
+     */
     toMatrix(outMatrix) {
         call("libgtk-4.so.1", "gsk_transform_to_matrix", [
             {
@@ -423,6 +647,13 @@ export class Transform {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Converts the transform into a human-readable string.
+     *
+     * The resulting string can be parsed with [func@Gsk.Transform.parse].
+     *
+     * This is a wrapper around [method@Gsk.Transform.print].
+     */
     toString() {
         return call("libgtk-4.so.1", "gsk_transform_to_string", [
             {
@@ -431,6 +662,18 @@ export class Transform {
             },
         ], { type: "string" });
     }
+    /**
+     * Converts a transform to a translation operation.
+     *
+     * `self` must be a 2D transformation. If you are not
+     * sure, use
+     *
+     * gsk_transform_get_category() >= GSK_TRANSFORM_CATEGORY_2D_TRANSLATE
+     *
+     * to check.
+     * @param outDx - return location for the translation
+     * @param outDy - return location for the translation
+     */
     toTranslate(outDx, outDy) {
         call("libgtk-4.so.1", "gsk_transform_to_translate", [
             {
@@ -447,6 +690,13 @@ export class Transform {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Applies all the operations from `other` to @next.
+     *
+     * This function consumes @next. Use [method@Gsk.Transform.ref] first
+     * if you want to keep it around.
+     * @param other - transform to apply
+     */
     transform(other) {
         const ptr = call("libgtk-4.so.1", "gsk_transform_transform", [
             {
@@ -473,6 +723,13 @@ export class Transform {
             return null;
         return getObject(ptr, Transform);
     }
+    /**
+     * Transforms a rectangle using the given transform.
+     *
+     * The result is the bounding box containing the coplanar quad.
+     * @param rect - the rectangle to transform
+     * @param outRect - return location for the bounds
+     */
     transformBounds(rect, outRect) {
         call("libgtk-4.so.1", "gsk_transform_transform_bounds", [
             {
@@ -501,6 +758,11 @@ export class Transform {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Transforms a point using the given transform.
+     * @param point - the point to transform
+     * @param outPoint - return location for
+     */
     transformPoint(point, outPoint) {
         call("libgtk-4.so.1", "gsk_transform_transform_point", [
             {
@@ -529,6 +791,13 @@ export class Transform {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Translates `next` in 2-dimensional space by @point.
+     *
+     * This function consumes @next. Use [method@Gsk.Transform.ref] first
+     * if you want to keep it around.
+     * @param point - the point to translate the transform by
+     */
     translate(point) {
         const ptr = call("libgtk-4.so.1", "gsk_transform_translate", [
             {
@@ -554,6 +823,13 @@ export class Transform {
             return null;
         return getObject(ptr, Transform);
     }
+    /**
+     * Translates `next` by @point.
+     *
+     * This function consumes @next. Use [method@Gsk.Transform.ref] first
+     * if you want to keep it around.
+     * @param point - the point to translate the transform by
+     */
     translate_3d(point) {
         const ptr = call("libgtk-4.so.1", "gsk_transform_translate_3d", [
             {
@@ -579,6 +855,12 @@ export class Transform {
             return null;
         return getObject(ptr, Transform);
     }
+    /**
+     * Releases a reference on the given transform.
+     *
+     * If the reference was the last, the resources associated to the `self` are
+     * freed.
+     */
     unref() {
         call("libgtk-4.so.1", "gsk_transform_unref", [
             {

package/dist/generated/gsk/vulkan-renderer.d.ts

@@ -1,5 +1,19 @@
 import { Renderer } from "./renderer.js";
+/**
+ * Renders a GSK rendernode tree with Vulkan.
+ *
+ * This renderer will fail to realize if Vulkan is not supported.
+ */
 export declare class VulkanRenderer extends Renderer {
+    /**
+     * Creates a new Vulkan renderer.
+     *
+     * The Vulkan renderer is a renderer that uses the Vulkan library for
+     * rendering.
+     *
+     * This renderer will fail to realize when GTK was not compiled with
+     * Vulkan support.
+     */
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
 }

package/dist/generated/gsk/vulkan-renderer.js

@@ -1,6 +1,20 @@
 import { call } from "@gtkx/native";
 import { Renderer } from "./renderer.js";
+/**
+ * Renders a GSK rendernode tree with Vulkan.
+ *
+ * This renderer will fail to realize if Vulkan is not supported.
+ */
 export class VulkanRenderer extends Renderer {
+    /**
+     * Creates a new Vulkan renderer.
+     *
+     * The Vulkan renderer is a renderer that uses the Vulkan library for
+     * rendering.
+     *
+     * This renderer will fail to realize when GTK was not compiled with
+     * Vulkan support.
+     */
     constructor(...args) {
         super(...args);
     }

package/dist/generated/gtk/about-dialog.d.ts

@@ -3,40 +3,206 @@ import * as GObject from "../gobject/index.js";
 import * as Gdk from "../gdk/index.js";
 import { Window } from "./window.js";
 export declare class AboutDialog extends Window {
+    /**
+     * Creates a new `GtkAboutDialog`.
+     */
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Creates a new section in the "Credits" page.
+     * @param sectionName - The name of the section
+     * @param people - the people who belong to that section
+     */
     addCreditSection(sectionName: string, people: string[]): void;
+    /**
+     * Returns the names of the artists which are displayed
+     * in the credits page.
+     */
     getArtists(): string[];
+    /**
+     * Returns the names of the authors which are displayed
+     * in the credits page.
+     */
     getAuthors(): string[];
+    /**
+     * Returns the comments string.
+     */
     getComments(): string | null;
+    /**
+     * Returns the copyright string.
+     */
     getCopyright(): string | null;
+    /**
+     * Returns the name of the documenters which are displayed
+     * in the credits page.
+     */
     getDocumenters(): string[];
+    /**
+     * Returns the license information.
+     */
     getLicense(): string | null;
+    /**
+     * Retrieves the license type.
+     */
     getLicenseType(): License;
+    /**
+     * Returns the paintable displayed as logo in the about dialog.
+     */
     getLogo(): Gdk.Paintable | null;
+    /**
+     * Returns the icon name displayed as logo in the about dialog.
+     */
     getLogoIconName(): string | null;
+    /**
+     * Returns the program name displayed in the about dialog.
+     */
     getProgramName(): string | null;
+    /**
+     * Returns the system information that is shown in the about dialog.
+     */
     getSystemInformation(): string | null;
+    /**
+     * Returns the translator credits string which is displayed
+     * in the credits page.
+     */
     getTranslatorCredits(): string | null;
+    /**
+     * Returns the version string.
+     */
     getVersion(): string | null;
+    /**
+     * Returns the website URL.
+     */
     getWebsite(): string | null;
+    /**
+     * Returns the label used for the website link.
+     */
     getWebsiteLabel(): string | null;
+    /**
+     * Returns whether the license text in the about dialog is
+     * automatically wrapped.
+     */
     getWrapLicense(): boolean;
+    /**
+     * Sets the names of the artists to be displayed
+     * in the "Credits" page.
+     * @param artists - the authors of the artwork
+     */
     setArtists(artists: string[]): void;
+    /**
+     * Sets the names of the authors which are displayed
+     * in the "Credits" page of the about dialog.
+     * @param authors - the authors of the application
+     */
     setAuthors(authors: string[]): void;
+    /**
+     * Sets the comments string to display in the about dialog.
+     *
+     * This should be a short string of one or two lines.
+     * @param comments - a comments string
+     */
     setComments(comments?: string | null): void;
+    /**
+     * Sets the copyright string to display in the about dialog.
+     *
+     * This should be a short string of one or two lines.
+     * @param copyright - the copyright string
+     */
     setCopyright(copyright?: string | null): void;
+    /**
+     * Sets the names of the documenters which are displayed
+     * in the "Credits" page.
+     * @param documenters - the authors of the documentation
+     */
     setDocumenters(documenters: string[]): void;
+    /**
+     * Sets the license information to be displayed in the
+     * about dialog.
+     *
+     * If `license` is `NULL`, the license page is hidden.
+     * @param license - the license information
+     */
     setLicense(license?: string | null): void;
+    /**
+     * Sets the license of the application showing the about dialog
+     * from a list of known licenses.
+     *
+     * This function overrides the license set using
+     * [method@Gtk.AboutDialog.set_license].
+     * @param licenseType - the type of license
+     */
     setLicenseType(licenseType: License): void;
+    /**
+     * Sets the logo in the about dialog.
+     * @param logo - a `GdkPaintable`
+     */
     setLogo(logo?: Gdk.Paintable | null): void;
+    /**
+     * Sets the icon name to be displayed as logo in the about dialog.
+     * @param iconName - an icon name
+     */
     setLogoIconName(iconName?: string | null): void;
+    /**
+     * Sets the name to display in the about dialog.
+     *
+     * If `name` is not set, the string returned
+     * by `g_get_application_name()` is used.
+     * @param name - the program name
+     */
     setProgramName(name?: string | null): void;
+    /**
+     * Sets the system information to be displayed in the about
+     * dialog.
+     *
+     * If `system_information` is `NULL`, the system information
+     * page is hidden.
+     *
+     * See [property@Gtk.AboutDialog:system-information].
+     * @param systemInformation - system information
+     */
     setSystemInformation(systemInformation?: string | null): void;
+    /**
+     * Sets the translator credits string which is displayed in
+     * the credits page.
+     *
+     * The intended use for this string is to display the translator
+     * of the language which is currently used in the user interface.
+     * Using `gettext()`, a simple way to achieve that is to mark the
+     * string for translation:
+     *
+     * ```c
+     * GtkWidget *about = gtk_about_dialog_new ();
+     * gtk_about_dialog_set_translator_credits (GTK_ABOUT_DIALOG (about),
+     * _("translator-credits"));
+     * ```
+     *
+     * It is a good idea to use the customary `msgid` “translator-credits”
+     * for this purpose, since translators will already know the purpose of
+     * that `msgid`, and since `GtkAboutDialog` will detect if “translator-credits”
+     * is untranslated and omit translator credits.
+     * @param translatorCredits - the translator credits
+     */
     setTranslatorCredits(translatorCredits?: string | null): void;
+    /**
+     * Sets the version string to display in the about dialog.
+     * @param version - the version string
+     */
     setVersion(version?: string | null): void;
+    /**
+     * Sets the URL to use for the website link.
+     * @param website - a URL string starting with `http://`
+     */
     setWebsite(website?: string | null): void;
+    /**
+     * Sets the label to be used for the website link.
+     * @param websiteLabel - the label used for the website link
+     */
     setWebsiteLabel(websiteLabel: string): void;
+    /**
+     * Sets whether the license text in the about dialog should be
+     * automatically wrapped.
+     * @param wrapLicense - whether to wrap the license
+     */
     setWrapLicense(wrapLicense: boolean): void;
     connect(signal: "activate-link", handler: (self: AboutDialog, uri: string) => boolean, after?: boolean): number;
     connect(signal: "activate-default", handler: (self: AboutDialog) => void, after?: boolean): number;