@gtkx/ffi 0.1.45 → 0.1.46

package/dist/generated/graphene/box.d.ts

@@ -2,37 +2,198 @@ import { Ref } from "@gtkx/native";
 import { Point3D } from "./point3d.js";
 import { Sphere } from "./sphere.js";
 import { Vec3 } from "./vec3.js";
+/**
+ * A 3D box, described as the volume between a minimum and
+ * a maximum vertices.
+ */
 export declare class Box {
     ptr: unknown;
+    /**
+     * Allocates a new #graphene_box_t.
+     *
+     * The contents of the returned structure are undefined.
+     */
     constructor();
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * A degenerate #graphene_box_t that can only be expanded.
+     *
+     * The returned value is owned by Graphene and should not be modified or freed.
+     */
     static empty(): Box;
+    /**
+     * A degenerate #graphene_box_t that cannot be expanded.
+     *
+     * The returned value is owned by Graphene and should not be modified or freed.
+     */
     static infinite(): Box;
+    /**
+     * A #graphene_box_t with the minimum vertex set at (-1, -1, -1) and the
+     * maximum vertex set at (0, 0, 0).
+     *
+     * The returned value is owned by Graphene and should not be modified or freed.
+     */
     static minusOne(): Box;
+    /**
+     * A #graphene_box_t with the minimum vertex set at (0, 0, 0) and the
+     * maximum vertex set at (1, 1, 1).
+     *
+     * The returned value is owned by Graphene and should not be modified or freed.
+     */
     static one(): Box;
+    /**
+     * A #graphene_box_t with the minimum vertex set at (-1, -1, -1) and the
+     * maximum vertex set at (1, 1, 1).
+     *
+     * The returned value is owned by Graphene and should not be modified or freed.
+     */
     static oneMinusOne(): Box;
+    /**
+     * A #graphene_box_t with both the minimum and maximum vertices set at (0, 0, 0).
+     *
+     * The returned value is owned by Graphene and should not be modified or freed.
+     */
     static zero(): Box;
+    /**
+     * Checks whether the #graphene_box_t `a` contains the given
+     * #graphene_box_t @b.
+     * @param b - a #graphene_box_t
+     */
     containsBox(b: Box): boolean;
+    /**
+     * Checks whether `box` contains the given @point.
+     * @param point - the coordinates to check
+     */
     containsPoint(point: Point3D): boolean;
+    /**
+     * Checks whether the two given boxes are equal.
+     * @param b - a #graphene_box_t
+     */
     equal(b: Box): boolean;
+    /**
+     * Expands the dimensions of `box` to include the coordinates at @point.
+     * @param point - the coordinates of the point to include
+     * @param res - return location for the expanded box
+     */
     expand(point: Point3D, res: Ref<Box>): void;
+    /**
+     * Expands the dimensions of `box` by the given `scalar` value.
+     *
+     * If `scalar` is positive, the #graphene_box_t will grow; if `scalar` is
+     * negative, the #graphene_box_t will shrink.
+     * @param scalar - a scalar value
+     * @param res - return location for the expanded box
+     */
     expandScalar(scalar: number, res: Ref<Box>): void;
+    /**
+     * Expands the dimensions of `box` to include the coordinates of the
+     * given vector.
+     * @param vec - the coordinates of the point to include, as a #graphene_vec3_t
+     * @param res - return location for the expanded box
+     */
     expandVec3(vec: Vec3, res: Ref<Box>): void;
+    /**
+     * Frees the resources allocated by graphene_box_alloc().
+     */
     free(): void;
+    /**
+     * Computes the bounding #graphene_sphere_t capable of containing the given
+     * #graphene_box_t.
+     * @param sphere - return location for the bounding sphere
+     */
     getBoundingSphere(sphere: Ref<Sphere>): void;
+    /**
+     * Retrieves the coordinates of the center of a #graphene_box_t.
+     * @param center - return location for the coordinates of
+     */
     getCenter(center: Ref<Point3D>): void;
+    /**
+     * Retrieves the size of the `box` on the Z axis.
+     */
     getDepth(): number;
+    /**
+     * Retrieves the size of the `box` on the Y axis.
+     */
     getHeight(): number;
+    /**
+     * Retrieves the coordinates of the maximum point of the given
+     * #graphene_box_t.
+     * @param max - return location for the maximum point
+     */
     getMax(max: Ref<Point3D>): void;
+    /**
+     * Retrieves the coordinates of the minimum point of the given
+     * #graphene_box_t.
+     * @param min - return location for the minimum point
+     */
     getMin(min: Ref<Point3D>): void;
+    /**
+     * Retrieves the size of the box on all three axes, and stores
+     * it into the given `size` vector.
+     * @param size - return location for the size
+     */
     getSize(size: Ref<Vec3>): void;
+    /**
+     * Computes the vertices of the given #graphene_box_t.
+     * @param vertices - return location for an array
+     */
     getVertices(vertices: Ref<Vec3[]>): void;
+    /**
+     * Retrieves the size of the `box` on the X axis.
+     */
     getWidth(): number;
+    /**
+     * Initializes the given #graphene_box_t with two vertices.
+     * @param min - the coordinates of the minimum vertex
+     * @param max - the coordinates of the maximum vertex
+     */
     init(min?: Point3D | null, max?: Point3D | null): Box;
+    /**
+     * Initializes the given #graphene_box_t with the vertices of
+     * another #graphene_box_t.
+     * @param src - a #graphene_box_t
+     */
     initFromBox(src: Box): Box;
+    /**
+     * Initializes the given #graphene_box_t with the given array
+     * of vertices.
+     *
+     * If `n_points` is 0, the returned box is initialized with
+     * graphene_box_empty().
+     * @param nPoints - the number #graphene_point3d_t in the `points` array
+     * @param points - an array of #graphene_point3d_t
+     */
     initFromPoints(nPoints: number, points: Point3D[]): Box;
+    /**
+     * Initializes the given #graphene_box_t with two vertices
+     * stored inside #graphene_vec3_t.
+     * @param min - the coordinates of the minimum vertex
+     * @param max - the coordinates of the maximum vertex
+     */
     initFromVec3(min?: Vec3 | null, max?: Vec3 | null): Box;
+    /**
+     * Initializes the given #graphene_box_t with the given array
+     * of vertices.
+     *
+     * If `n_vectors` is 0, the returned box is initialized with
+     * graphene_box_empty().
+     * @param nVectors - the number #graphene_point3d_t in the `vectors` array
+     * @param vectors - an array of #graphene_vec3_t
+     */
     initFromVectors(nVectors: number, vectors: Vec3[]): Box;
+    /**
+     * Intersects the two given #graphene_box_t.
+     *
+     * If the two boxes do not intersect, `res` will contain a degenerate box
+     * initialized with graphene_box_empty().
+     * @param b - a #graphene_box_t
+     * @param res - return location for the result
+     */
     intersection(b: Box, res?: Ref<Box> | null): boolean;
+    /**
+     * Unions the two given #graphene_box_t.
+     * @param b - the box to union to @a
+     * @param res - return location for the result
+     */
     union(b: Box, res: Ref<Box>): void;
 }

package/dist/generated/graphene/box.js

@@ -1,7 +1,16 @@
 import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
+/**
+ * A 3D box, described as the volume between a minimum and
+ * a maximum vertices.
+ */
 export class Box {
     ptr;
+    /**
+     * Allocates a new #graphene_box_t.
+     *
+     * The contents of the returned structure are undefined.
+     */
     constructor() {
         this.ptr = this.createPtr([]);
     }
@@ -12,6 +21,11 @@ export class Box {
             innerType: "GrapheneBox",
         });
     }
+    /**
+     * A degenerate #graphene_box_t that can only be expanded.
+     *
+     * The returned value is owned by Graphene and should not be modified or freed.
+     */
     static empty() {
         const ptr = call("libgraphene-1.0.so.0", "graphene_box_empty", [], {
             type: "boxed",
@@ -21,6 +35,11 @@ export class Box {
         });
         return getObject(ptr, Box);
     }
+    /**
+     * A degenerate #graphene_box_t that cannot be expanded.
+     *
+     * The returned value is owned by Graphene and should not be modified or freed.
+     */
     static infinite() {
         const ptr = call("libgraphene-1.0.so.0", "graphene_box_infinite", [], {
             type: "boxed",
@@ -30,6 +49,12 @@ export class Box {
         });
         return getObject(ptr, Box);
     }
+    /**
+     * A #graphene_box_t with the minimum vertex set at (-1, -1, -1) and the
+     * maximum vertex set at (0, 0, 0).
+     *
+     * The returned value is owned by Graphene and should not be modified or freed.
+     */
     static minusOne() {
         const ptr = call("libgraphene-1.0.so.0", "graphene_box_minus_one", [], {
             type: "boxed",
@@ -39,6 +64,12 @@ export class Box {
         });
         return getObject(ptr, Box);
     }
+    /**
+     * A #graphene_box_t with the minimum vertex set at (0, 0, 0) and the
+     * maximum vertex set at (1, 1, 1).
+     *
+     * The returned value is owned by Graphene and should not be modified or freed.
+     */
     static one() {
         const ptr = call("libgraphene-1.0.so.0", "graphene_box_one", [], {
             type: "boxed",
@@ -48,6 +79,12 @@ export class Box {
         });
         return getObject(ptr, Box);
     }
+    /**
+     * A #graphene_box_t with the minimum vertex set at (-1, -1, -1) and the
+     * maximum vertex set at (1, 1, 1).
+     *
+     * The returned value is owned by Graphene and should not be modified or freed.
+     */
     static oneMinusOne() {
         const ptr = call("libgraphene-1.0.so.0", "graphene_box_one_minus_one", [], {
             type: "boxed",
@@ -57,6 +94,11 @@ export class Box {
         });
         return getObject(ptr, Box);
     }
+    /**
+     * A #graphene_box_t with both the minimum and maximum vertices set at (0, 0, 0).
+     *
+     * The returned value is owned by Graphene and should not be modified or freed.
+     */
     static zero() {
         const ptr = call("libgraphene-1.0.so.0", "graphene_box_zero", [], {
             type: "boxed",
@@ -66,6 +108,11 @@ export class Box {
         });
         return getObject(ptr, Box);
     }
+    /**
+     * Checks whether the #graphene_box_t `a` contains the given
+     * #graphene_box_t @b.
+     * @param b - a #graphene_box_t
+     */
     containsBox(b) {
         return call("libgraphene-1.0.so.0", "graphene_box_contains_box", [
             {
@@ -83,6 +130,10 @@ export class Box {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Checks whether `box` contains the given @point.
+     * @param point - the coordinates to check
+     */
     containsPoint(point) {
         return call("libgraphene-1.0.so.0", "graphene_box_contains_point", [
             {
@@ -100,6 +151,10 @@ export class Box {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Checks whether the two given boxes are equal.
+     * @param b - a #graphene_box_t
+     */
     equal(b) {
         return call("libgraphene-1.0.so.0", "graphene_box_equal", [
             {
@@ -117,6 +172,11 @@ export class Box {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Expands the dimensions of `box` to include the coordinates at @point.
+     * @param point - the coordinates of the point to include
+     * @param res - return location for the expanded box
+     */
     expand(point, res) {
         call("libgraphene-1.0.so.0", "graphene_box_expand", [
             {
@@ -145,6 +205,14 @@ export class Box {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Expands the dimensions of `box` by the given `scalar` value.
+     *
+     * If `scalar` is positive, the #graphene_box_t will grow; if `scalar` is
+     * negative, the #graphene_box_t will shrink.
+     * @param scalar - a scalar value
+     * @param res - return location for the expanded box
+     */
     expandScalar(scalar, res) {
         call("libgraphene-1.0.so.0", "graphene_box_expand_scalar", [
             {
@@ -168,6 +236,12 @@ export class Box {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Expands the dimensions of `box` to include the coordinates of the
+     * given vector.
+     * @param vec - the coordinates of the point to include, as a #graphene_vec3_t
+     * @param res - return location for the expanded box
+     */
     expandVec3(vec, res) {
         call("libgraphene-1.0.so.0", "graphene_box_expand_vec3", [
             {
@@ -196,6 +270,9 @@ export class Box {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Frees the resources allocated by graphene_box_alloc().
+     */
     free() {
         call("libgraphene-1.0.so.0", "graphene_box_free", [
             {
@@ -204,6 +281,11 @@ export class Box {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Computes the bounding #graphene_sphere_t capable of containing the given
+     * #graphene_box_t.
+     * @param sphere - return location for the bounding sphere
+     */
     getBoundingSphere(sphere) {
         call("libgraphene-1.0.so.0", "graphene_box_get_bounding_sphere", [
             {
@@ -223,6 +305,10 @@ export class Box {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Retrieves the coordinates of the center of a #graphene_box_t.
+     * @param center - return location for the coordinates of
+     */
     getCenter(center) {
         call("libgraphene-1.0.so.0", "graphene_box_get_center", [
             {
@@ -242,6 +328,9 @@ export class Box {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Retrieves the size of the `box` on the Z axis.
+     */
     getDepth() {
         return call("libgraphene-1.0.so.0", "graphene_box_get_depth", [
             {
@@ -250,6 +339,9 @@ export class Box {
             },
         ], { type: "float", size: 32 });
     }
+    /**
+     * Retrieves the size of the `box` on the Y axis.
+     */
     getHeight() {
         return call("libgraphene-1.0.so.0", "graphene_box_get_height", [
             {
@@ -258,6 +350,11 @@ export class Box {
             },
         ], { type: "float", size: 32 });
     }
+    /**
+     * Retrieves the coordinates of the maximum point of the given
+     * #graphene_box_t.
+     * @param max - return location for the maximum point
+     */
     getMax(max) {
         call("libgraphene-1.0.so.0", "graphene_box_get_max", [
             {
@@ -277,6 +374,11 @@ export class Box {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Retrieves the coordinates of the minimum point of the given
+     * #graphene_box_t.
+     * @param min - return location for the minimum point
+     */
     getMin(min) {
         call("libgraphene-1.0.so.0", "graphene_box_get_min", [
             {
@@ -296,6 +398,11 @@ export class Box {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Retrieves the size of the box on all three axes, and stores
+     * it into the given `size` vector.
+     * @param size - return location for the size
+     */
     getSize(size) {
         call("libgraphene-1.0.so.0", "graphene_box_get_size", [
             {
@@ -315,6 +422,10 @@ export class Box {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Computes the vertices of the given #graphene_box_t.
+     * @param vertices - return location for an array
+     */
     getVertices(vertices) {
         call("libgraphene-1.0.so.0", "graphene_box_get_vertices", [
             {
@@ -337,6 +448,9 @@ export class Box {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Retrieves the size of the `box` on the X axis.
+     */
     getWidth() {
         return call("libgraphene-1.0.so.0", "graphene_box_get_width", [
             {
@@ -345,6 +459,11 @@ export class Box {
             },
         ], { type: "float", size: 32 });
     }
+    /**
+     * Initializes the given #graphene_box_t with two vertices.
+     * @param min - the coordinates of the minimum vertex
+     * @param max - the coordinates of the maximum vertex
+     */
     init(min, max) {
         const ptr = call("libgraphene-1.0.so.0", "graphene_box_init", [
             {
@@ -379,6 +498,11 @@ export class Box {
         });
         return getObject(ptr, Box);
     }
+    /**
+     * Initializes the given #graphene_box_t with the vertices of
+     * another #graphene_box_t.
+     * @param src - a #graphene_box_t
+     */
     initFromBox(src) {
         const ptr = call("libgraphene-1.0.so.0", "graphene_box_init_from_box", [
             {
@@ -402,6 +526,15 @@ export class Box {
         });
         return getObject(ptr, Box);
     }
+    /**
+     * Initializes the given #graphene_box_t with the given array
+     * of vertices.
+     *
+     * If `n_points` is 0, the returned box is initialized with
+     * graphene_box_empty().
+     * @param nPoints - the number #graphene_point3d_t in the `points` array
+     * @param points - an array of #graphene_point3d_t
+     */
     initFromPoints(nPoints, points) {
         const ptr = call("libgraphene-1.0.so.0", "graphene_box_init_from_points", [
             {
@@ -431,6 +564,12 @@ export class Box {
         });
         return getObject(ptr, Box);
     }
+    /**
+     * Initializes the given #graphene_box_t with two vertices
+     * stored inside #graphene_vec3_t.
+     * @param min - the coordinates of the minimum vertex
+     * @param max - the coordinates of the maximum vertex
+     */
     initFromVec3(min, max) {
         const ptr = call("libgraphene-1.0.so.0", "graphene_box_init_from_vec3", [
             {
@@ -465,6 +604,15 @@ export class Box {
         });
         return getObject(ptr, Box);
     }
+    /**
+     * Initializes the given #graphene_box_t with the given array
+     * of vertices.
+     *
+     * If `n_vectors` is 0, the returned box is initialized with
+     * graphene_box_empty().
+     * @param nVectors - the number #graphene_point3d_t in the `vectors` array
+     * @param vectors - an array of #graphene_vec3_t
+     */
     initFromVectors(nVectors, vectors) {
         const ptr = call("libgraphene-1.0.so.0", "graphene_box_init_from_vectors", [
             {
@@ -494,6 +642,14 @@ export class Box {
         });
         return getObject(ptr, Box);
     }
+    /**
+     * Intersects the two given #graphene_box_t.
+     *
+     * If the two boxes do not intersect, `res` will contain a degenerate box
+     * initialized with graphene_box_empty().
+     * @param b - a #graphene_box_t
+     * @param res - return location for the result
+     */
     intersection(b, res) {
         return call("libgraphene-1.0.so.0", "graphene_box_intersection", [
             {
@@ -523,6 +679,11 @@ export class Box {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Unions the two given #graphene_box_t.
+     * @param b - the box to union to @a
+     * @param res - return location for the result
+     */
     union(b, res) {
         call("libgraphene-1.0.so.0", "graphene_box_union", [
             {

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

@@ -1,38 +1,106 @@
+/**
+ * Specify the order of the rotations on each axis.
+ *
+ * The %GRAPHENE_EULER_ORDER_DEFAULT value is special, and is used
+ * as an alias for one of the other orders.
+ */
 export declare enum EulerOrder {
+    /**
+     * Rotate in the default order; the
+     * default order is one of the following enumeration values
+     */
     DEFAULT = -1,
+    /**
+     * Rotate in the X, Y, and Z order. Deprecated in
+     * Graphene 1.10, it's an alias for %GRAPHENE_EULER_ORDER_SXYZ
+     */
     XYZ = 0,
+    /**
+     * Rotate in the Y, Z, and X order. Deprecated in
+     * Graphene 1.10, it's an alias for %GRAPHENE_EULER_ORDER_SYZX
+     */
     YZX = 1,
+    /**
+     * Rotate in the Z, X, and Y order. Deprecated in
+     * Graphene 1.10, it's an alias for %GRAPHENE_EULER_ORDER_SZXY
+     */
     ZXY = 2,
+    /**
+     * Rotate in the X, Z, and Y order. Deprecated in
+     * Graphene 1.10, it's an alias for %GRAPHENE_EULER_ORDER_SXZY
+     */
     XZY = 3,
+    /**
+     * Rotate in the Y, X, and Z order. Deprecated in
+     * Graphene 1.10, it's an alias for %GRAPHENE_EULER_ORDER_SYXZ
+     */
     YXZ = 4,
+    /**
+     * Rotate in the Z, Y, and X order. Deprecated in
+     * Graphene 1.10, it's an alias for %GRAPHENE_EULER_ORDER_SZYX
+     */
     ZYX = 5,
+    /** Defines a static rotation along the X, Y, and Z axes (Since: 1.10) */
     SXYZ = 6,
+    /** Defines a static rotation along the X, Y, and X axes (Since: 1.10) */
     SXYX = 7,
+    /** Defines a static rotation along the X, Z, and Y axes (Since: 1.10) */
     SXZY = 8,
+    /** Defines a static rotation along the X, Z, and X axes (Since: 1.10) */
     SXZX = 9,
+    /** Defines a static rotation along the Y, Z, and X axes (Since: 1.10) */
     SYZX = 10,
+    /** Defines a static rotation along the Y, Z, and Y axes (Since: 1.10) */
     SYZY = 11,
+    /** Defines a static rotation along the Y, X, and Z axes (Since: 1.10) */
     SYXZ = 12,
+    /** Defines a static rotation along the Y, X, and Y axes (Since: 1.10) */
     SYXY = 13,
+    /** Defines a static rotation along the Z, X, and Y axes (Since: 1.10) */
     SZXY = 14,
+    /** Defines a static rotation along the Z, X, and Z axes (Since: 1.10) */
     SZXZ = 15,
+    /** Defines a static rotation along the Z, Y, and X axes (Since: 1.10) */
     SZYX = 16,
+    /** Defines a static rotation along the Z, Y, and Z axes (Since: 1.10) */
     SZYZ = 17,
+    /** Defines a relative rotation along the Z, Y, and X axes (Since: 1.10) */
     RZYX = 18,
+    /** Defines a relative rotation along the X, Y, and X axes (Since: 1.10) */
     RXYX = 19,
+    /** Defines a relative rotation along the Y, Z, and X axes (Since: 1.10) */
     RYZX = 20,
+    /** Defines a relative rotation along the X, Z, and X axes (Since: 1.10) */
     RXZX = 21,
+    /** Defines a relative rotation along the X, Z, and Y axes (Since: 1.10) */
     RXZY = 22,
+    /** Defines a relative rotation along the Y, Z, and Y axes (Since: 1.10) */
     RYZY = 23,
+    /** Defines a relative rotation along the Z, X, and Y axes (Since: 1.10) */
     RZXY = 24,
+    /** Defines a relative rotation along the Y, X, and Y axes (Since: 1.10) */
     RYXY = 25,
+    /** Defines a relative rotation along the Y, X, and Z axes (Since: 1.10) */
     RYXZ = 26,
+    /** Defines a relative rotation along the Z, X, and Z axes (Since: 1.10) */
     RZXZ = 27,
+    /** Defines a relative rotation along the X, Y, and Z axes (Since: 1.10) */
     RXYZ = 28,
+    /** Defines a relative rotation along the Z, Y, and Z axes (Since: 1.10) */
     RZYZ = 29
 }
+/** The type of intersection. */
 export declare enum RayIntersectionKind {
+    /** No intersection */
     NONE = 0,
+    /**
+     * The ray is entering the intersected
+     * object
+     */
     ENTER = 1,
+    /**
+     * The ray is leaving the intersected
+     * object
+     */
     LEAVE = 2
 }