@ts-for-gir/templates 4.0.0 → 4.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ts-for-gir/templates",
-	"version": "4.0.0",
+	"version": "4.0.2",
 	"description": "Templates for ts-for-gir",
 	"type": "module",
 	"main": "package.json",

package/templates/gjs/cairo.d.ts

@@ -247,6 +247,16 @@ import Cairo from '<%- Cairo.importPath %>';
          */
         getTarget(): Surface;
 
+        /**
+         * Returns the current destination surface for the group being
+         * built — set by the most recent {@link pushGroup} /
+         * {@link pushGroupWithContent} that has not been
+         * {@link popGroup}-ed.
+         *
+         * Source: gjs/modules/cairo-context.cpp `getGroupTarget_func`.
+         */
+        getGroupTarget(): Surface;
+
         /**
          * Gets the current tolerance value
          * @returns The current tolerance value
@@ -626,6 +636,15 @@ import Cairo from '<%- Cairo.importPath %>';
          */
         copyPath(): Path;
 
+        /**
+         * Returns a flattened copy of the current path — curves are
+         * approximated by straight-line segments according to the
+         * current tolerance.
+         *
+         * Source: gjs/modules/cairo-context.cpp `copyPathFlat_func`.
+         */
+        copyPathFlat(): Path;
+
         /**
          * Appends a path to the current path
          * @param path A path to append
@@ -673,6 +692,24 @@ import Cairo from '<%- Cairo.importPath %>';
          */
         finish(): void;
 
+        /**
+         * Surface type (image, PDF, PostScript, SVG, …) — the runtime kind
+         * regardless of static class.
+         *
+         * Source: gjs/modules/cairo-surface.cpp `getType_func`.
+         */
+        getType(): SurfaceType;
+
+        /**
+         * Write the surface's contents out to a PNG file. Only meaningful
+         * for image-backed surfaces (returns CAIRO_STATUS_WRITE_ERROR on
+         * non-image surfaces).
+         *
+         * Source: gjs/modules/cairo-surface.cpp `writeToPNG_func`.
+         * @param filename Output PNG path
+         */
+        writeToPNG(filename: string): void;
+
         /**
          * Attaches user data to the surface (C API: cairo_surface_set_user_data)
          * @param key Key for the user data
@@ -726,6 +763,16 @@ import Cairo from '<%- Cairo.importPath %>';
          */
         getHeight(): number;
 
+        /**
+         * Number of bytes between the start of one row and the start of
+         * the next, rounded up to a Cairo-imposed alignment boundary.
+         * Useful when reading the surface's raw pixel buffer.
+         *
+         * Source: gjs/modules/cairo-image-surface.cpp `getStride_func`.
+         * @returns Row stride in bytes
+         */
+        getStride(): number;
+
         /**
          * Writes the contents of the surface to a PNG file
          * @param filename Path to the PNG file to write
@@ -776,6 +823,12 @@ import Cairo from '<%- Cairo.importPath %>';
      * Base class for all Cairo patterns
      */
     export class Pattern extends Cairo.Pattern {
+        /**
+         * Get the pattern's type (Solid, Surface, Linear, Radial, Mesh, …).
+         *
+         * Source: gjs/modules/cairo-pattern.cpp `getType_func`.
+         */
+        getType(): PatternType;
     }
 
     /**
@@ -841,6 +894,39 @@ import Cairo from '<%- Cairo.importPath %>';
          * @param surface The surface to use
          */
         constructor(surface: Surface);
+
+        /**
+         * Sets the mode to be used for drawing outside the area of this
+         * pattern. By default the {@link Extend.NONE} mode is used (a
+         * transparent pixel) for surface patterns and
+         * {@link Extend.PAD} for gradients.
+         *
+         * Source: gjs/modules/cairo-surface-pattern.cpp `setExtend_func`.
+         * @param extend The extend mode
+         */
+        setExtend(extend: Extend): void;
+
+        /**
+         * Get the current extend mode for this pattern.
+         *
+         * Source: gjs/modules/cairo-surface-pattern.cpp `getExtend_func`.
+         */
+        getExtend(): Extend;
+
+        /**
+         * Set the filter to be used for resizing when using this pattern.
+         *
+         * Source: gjs/modules/cairo-surface-pattern.cpp `setFilter_func`.
+         * @param filter The filter
+         */
+        setFilter(filter: Filter): void;
+
+        /**
+         * Get the current filter for this pattern.
+         *
+         * Source: gjs/modules/cairo-surface-pattern.cpp `getFilter_func`.
+         */
+        getFilter(): Filter;
     }
 
     /**
@@ -880,9 +966,89 @@ import Cairo from '<%- Cairo.importPath %>';
     export class RectangleInt extends Cairo.RectangleInt {}
 
     /**
-     * A region object used for representing a set of pixels
+     * A region object used for representing a set of pixels.
+     *
+     * Constructor takes no arguments — Cairo regions start empty and grow
+     * via {@link unionRectangle} / {@link union}. Source:
+     * gjs/modules/cairo-region.cpp `constructor_impl`.
      */
-    export class Region extends Cairo.Region {}
+    export class Region extends Cairo.Region {
+        constructor();
+
+        /**
+         * Number of disjoint rectangles in the region's decomposition.
+         * Source: cairo-region.cpp `num_rectangles_func`.
+         */
+        numRectangles(): number;
+
+        /**
+         * Return the `i`-th rectangle in the region's decomposition.
+         * Throws if `i` is out of range.
+         * Source: cairo-region.cpp `get_rectangle_func`.
+         */
+        getRectangle(i: number): RectangleInt;
+
+        /**
+         * Union this region with `other` in place (`this ← this ∪ other`).
+         * Source: cairo-region.cpp `REGION_DEFINE_REGION_FUNC(union)`.
+         */
+        union(other: Region): void;
+
+        /**
+         * Subtract `other` from this region in place (`this ← this ∖ other`).
+         * Source: cairo-region.cpp `REGION_DEFINE_REGION_FUNC(subtract)`.
+         */
+        subtract(other: Region): void;
+
+        /**
+         * Intersect this region with `other` in place (`this ← this ∩ other`).
+         * Source: cairo-region.cpp `REGION_DEFINE_REGION_FUNC(intersect)`.
+         */
+        intersect(other: Region): void;
+
+        /**
+         * Replace this region with the symmetric difference (`this ⊕ other`).
+         * Source: cairo-region.cpp `REGION_DEFINE_REGION_FUNC(xor)`.
+         */
+        xor(other: Region): void;
+
+        /**
+         * Union a single rectangle into this region.
+         * Source: cairo-region.cpp `REGION_DEFINE_RECT_FUNC(union)`.
+         */
+        unionRectangle(rect: RectangleInt): void;
+
+        /**
+         * Subtract a single rectangle from this region.
+         * Source: cairo-region.cpp `REGION_DEFINE_RECT_FUNC(subtract)`.
+         */
+        subtractRectangle(rect: RectangleInt): void;
+
+        /**
+         * Intersect this region with a rectangle.
+         * Source: cairo-region.cpp `REGION_DEFINE_RECT_FUNC(intersect)`.
+         */
+        intersectRectangle(rect: RectangleInt): void;
+
+        /**
+         * Symmetric-difference this region with a rectangle.
+         * Source: cairo-region.cpp `REGION_DEFINE_RECT_FUNC(xor)`.
+         */
+        xorRectangle(rect: RectangleInt): void;
+    }
+
+    /**
+     * Integer-coordinate rectangle — Cairo's `cairo_rectangle_int_t` JS
+     * shape. Used by `Region` methods that read/write rectangle data.
+     * Source: gjs/modules/cairo-region.cpp `fill_rectangle` reads these
+     * four properties off the JS object.
+     */
+    export interface RectangleInt {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    }
 
     /**
      * A matrix object used for transforming coordinates