@defold-typescript/types 0.19.4 → 0.20.1

package/generated/camera.d.ts

@@ -3,17 +3,19 @@ import type { Matrix4, Url, Vector3 } from "../src/core-types";
 
 declare global {
   /**
-   * Camera functions, messages and constants.
+   * Messages to control camera components and camera focus.
    */
   namespace camera {
     /**
      * Computes zoom so the original display area covers the entire window while preserving aspect ratio.
      * Equivalent to using max(window_width/width, window_height/height).
+     * The result is multiplied by the user-controlled orthographic zoom.
      */
     const ORTHO_MODE_AUTO_COVER: number & { readonly __brand: "camera.ORTHO_MODE_AUTO_COVER" };
     /**
      * Computes zoom so the original display area (game.project width/height) fits inside the window
      * while preserving aspect ratio. Equivalent to using min(window_width/width, window_height/height).
+     * The result is multiplied by the user-controlled orthographic zoom.
      */
     const ORTHO_MODE_AUTO_FIT: number & { readonly __brand: "camera.ORTHO_MODE_AUTO_FIT" };
     /**
@@ -81,6 +83,14 @@ declare global {
      * @returns the near z.
      */
     function get_near_z(camera?: Url | number): number;
+    /**
+     * Gets the orthographic zoom calculated from the current window and project dimensions
+     * in auto-fit and auto-cover modes. Returns 1.0 in fixed mode.
+     *
+     * @param camera - camera id
+     * @returns the calculated orthographic auto zoom.
+     */
+    function get_orthographic_auto_zoom(camera?: Url | number): number;
     /**
      * get orthographic zoom mode
      *
@@ -90,10 +100,11 @@ declare global {
      */
     function get_orthographic_mode(camera?: Url | number): number;
     /**
-     * get orthographic zoom
+     * Gets the positive user-controlled orthographic zoom multiplier. In auto-fit and auto-cover
+     * modes, this value is multiplied with camera.get_orthographic_auto_zoom(camera).
      *
      * @param camera - camera id
-     * @returns the zoom level when the camera uses orthographic projection.
+     * @returns the positive zoom multiplier when the camera uses orthographic projection.
      */
     function get_orthographic_zoom(camera?: Url | number): number;
     /**
@@ -214,10 +225,11 @@ declare global {
      */
     function set_orthographic_mode(camera: Url | number | undefined, mode: number): void;
     /**
-     * set orthographic zoom
+     * Sets the positive user-controlled orthographic zoom multiplier. In auto-fit and auto-cover
+     * modes, this value is multiplied with camera.get_orthographic_auto_zoom(camera).
      *
      * @param camera - camera id
-     * @param orthographic_zoom - the zoom level when the camera uses orthographic projection.
+     * @param orthographic_zoom - the positive zoom multiplier when the camera uses orthographic projection.
      */
     function set_orthographic_zoom(camera: Url | number | undefined, orthographic_zoom: number): void;
     /**
@@ -239,6 +251,51 @@ declare global {
      * ```
      */
     function world_to_screen(world_pos: Vector3, camera?: Url | number): Vector3;
+    interface properties {
+      /**
+       * The ratio between the frustum width and height. Used when calculating the
+       * projection of a perspective camera.
+       * The type of the property is number.
+       */
+      aspect_ratio: unknown;
+      /**
+       * Camera frustum far plane.
+       * The type of the property is float.
+       */
+      far_z: unknown;
+      /**
+       * Vertical field of view of the camera.
+       * The type of the property is float.
+       */
+      fov: unknown;
+      /**
+       * Camera frustum near plane.
+       * The type of the property is float.
+       */
+      near_z: unknown;
+      /**
+       * READ ONLY The zoom calculated from the current window and project dimensions
+       * in auto fit and auto cover modes. The value is 1.0 in fixed mode.
+       * The type of the property is float.
+       */
+      orthographic_auto_zoom: unknown;
+      /**
+       * Positive zoom multiplier when using an orthographic projection. In auto fit and auto cover
+       * modes, this value is multiplied with the calculated orthographic_auto_zoom value.
+       * The type of the property is float.
+       */
+      orthographic_zoom: unknown;
+      /**
+       * READ ONLY The calculated projection matrix of the camera.
+       * The type of the property is matrix4.
+       */
+      projection: unknown;
+      /**
+       * READ ONLY The calculated view matrix of the camera.
+       * The type of the property is matrix4.
+       */
+      view: unknown;
+    }
   }
 }
 

package/generated/compute.d.ts

@@ -0,0 +1,306 @@
+/** @noSelfInFile */
+import type { Hash, Matrix4, Vector3, Vector4 } from "../src/core-types";
+
+declare global {
+  /**
+   * Functions for interacting with compute programs.
+   */
+  namespace compute {
+    /**
+     * Returns a table of all the shader constants in the compute program.
+     *
+     * @param path - The path to the resource
+     * @returns A table of tables, where each entry contains info about the shader constants:
+     *
+     * `name`
+     * hash the hashed name of the constant
+     * `type`
+     * number the type of the constant. Supported values:
+     *
+     * - `material.CONSTANT_TYPE_USER`
+     *
+     * - `material.CONSTANT_TYPE_USER_MATRIX4`
+     *
+     * - `material.CONSTANT_TYPE_VIEWPROJ`
+     *
+     * - `material.CONSTANT_TYPE_WORLD`
+     *
+     * - `material.CONSTANT_TYPE_TEXTURE`
+     *
+     * - `material.CONSTANT_TYPE_VIEW`
+     *
+     * - `material.CONSTANT_TYPE_PROJECTION`
+     *
+     * - `material.CONSTANT_TYPE_NORMAL`
+     *
+     * - `material.CONSTANT_TYPE_WORLDVIEW`
+     *
+     * - `material.CONSTANT_TYPE_WORLDVIEWPROJ`
+     *
+     * - `material.CONSTANT_TYPE_TIME`
+     *
+     * - `material.CONSTANT_TYPE_WORLD_INVERSE`
+     *
+     * - `material.CONSTANT_TYPE_VIEW_INVERSE`
+     *
+     * - `material.CONSTANT_TYPE_PROJECTION_INVERSE`
+     *
+     * - `material.CONSTANT_TYPE_VIEWPROJ_INVERSE`
+     *
+     * - `material.CONSTANT_TYPE_WORLDVIEW_INVERSE`
+     *
+     * - `material.CONSTANT_TYPE_WORLDVIEWPROJ_INVERSE`
+     *
+     * `value`
+     * vmath.vector4 | vmath.matrix4 the value(s) of the constant. If the constant is an array, the value will be a table of vmath.vector4 or vmath.matrix4 if the type is `material.CONSTANT_TYPE_USER_MATRIX4`.
+     * @example
+     * ```ts
+     * const constants = compute.get_constants("/my_compute.computec");
+     * ```
+     */
+    function get_constants(path: Hash | string): { name: Hash; type: number; value: Vector4 | Matrix4 }[];
+    /**
+     * Returns a table of all the texture samplers in the compute program. This function will return all the texture samplers
+     * that are available, even the ones that have not been specified in the compute resource.
+     *
+     * @param path - The path to the resource
+     * @returns A table of tables, where each entry contains info about the texture samplers:
+     *
+     * `name`
+     * hash the hashed name of the texture sampler
+     * `u_wrap`
+     * number the u wrap mode of the texture sampler. Supported values:
+     *
+     * - `graphics.TEXTURE_WRAP_CLAMP_TO_BORDER`
+     *
+     * - `graphics.TEXTURE_WRAP_CLAMP_TO_EDGE`
+     *
+     * - `graphics.TEXTURE_WRAP_MIRRORED_REPEAT`
+     *
+     * - `graphics.TEXTURE_WRAP_REPEAT`
+     *
+     * `v_wrap`
+     * number the v wrap mode of the texture sampler. Supported values:
+     *
+     * - `graphics.TEXTURE_WRAP_CLAMP_TO_BORDER`
+     *
+     * - `graphics.TEXTURE_WRAP_CLAMP_TO_EDGE`
+     *
+     * - `graphics.TEXTURE_WRAP_MIRRORED_REPEAT`
+     *
+     * - `graphics.TEXTURE_WRAP_REPEAT`
+     *
+     * `min_filter`
+     * number the min filter mode of the texture sampler. Supported values:
+     *
+     * - `graphics.TEXTURE_FILTER_DEFAULT`
+     *
+     * - `graphics.TEXTURE_FILTER_NEAREST`
+     *
+     * - `graphics.TEXTURE_FILTER_LINEAR`
+     *
+     * - `graphics.TEXTURE_FILTER_NEAREST_MIPMAP_NEAREST`
+     *
+     * - `graphics.TEXTURE_FILTER_NEAREST_MIPMAP_LINEAR`
+     *
+     * - `graphics.TEXTURE_FILTER_LINEAR_MIPMAP_NEAREST`
+     *
+     * - `graphics.TEXTURE_FILTER_LINEAR_MIPMAP_LINEAR`
+     *
+     * `mag_filter`
+     * number the mag filter mode of the texture sampler
+     *
+     * - `graphics.TEXTURE_FILTER_DEFAULT`
+     *
+     * - `graphics.TEXTURE_FILTER_NEAREST`
+     *
+     * - `graphics.TEXTURE_FILTER_LINEAR`
+     *
+     * `max_anisotropy`
+     * number the max anisotropy of the texture sampler
+     * @example
+     * ```ts
+     * const samplers = compute.get_samplers("/my_compute.computec");
+     * ```
+     */
+    function get_samplers(path: Hash | string): { name: Hash; u_wrap: number; v_wrap: number; min_filter: number; mag_filter: number; max_anisotropy: number }[];
+    /**
+     * Returns a table of all the textures from the compute program.
+     *
+     * @param path - The path to the resource
+     * @returns A table of tables, where each entry contains info about the compute textures:
+     *
+     * `path`
+     * hash the resource path of the texture. Only available if the texture is a resource.
+     * `handle`
+     * hash the runtime handle of the texture.
+     * `width`
+     * number the width of the texture
+     * `height`
+     * number the height of the texture
+     * `depth`
+     * number the depth of the texture. Corresponds to the number of layers in an array texture.
+     * `mipmaps`
+     * number the number of mipmaps in the texture
+     * `type`
+     * number the type of the texture. Supported values:
+     *
+     * - `graphics.TEXTURE_TYPE_2D`
+     *
+     * - `graphics.TEXTURE_TYPE_2D_ARRAY`
+     *
+     * - `graphics.TEXTURE_TYPE_CUBE_MAP`
+     *
+     * - `graphics.TEXTURE_TYPE_IMAGE_2D`
+     *
+     * - `graphics.TEXTURE_TYPE_3D`
+     *
+     * - `graphics.TEXTURE_TYPE_IMAGE_3D`
+     *
+     * `flags`
+     * number the flags of the texture. This field is a bit mask of these supported flags:
+     *
+     * - `graphics.TEXTURE_USAGE_FLAG_SAMPLE`
+     *
+     * - `graphics.TEXTURE_USAGE_FLAG_MEMORYLESS`
+     *
+     * - `graphics.TEXTURE_USAGE_FLAG_STORAGE`
+     *
+     * - `graphics.TEXTURE_USAGE_FLAG_INPUT`
+     *
+     * - `graphics.TEXTURE_USAGE_FLAG_COLOR`
+     * @example
+     * ```ts
+     * const textures = compute.get_textures("/my_compute.computec");
+     * ```
+     */
+    function get_textures(path: Hash | string): { path: Hash; handle: Hash; width: number; height: number; depth: number; mipmaps: number; type: number; flags: number }[];
+    /**
+     * Sets shader constants in a compute program, if the constants exist.
+     *
+     * @param path - The path to the resource
+     * @param constants - A table keyed by constant name with args tables as values. Constants can be partially updated. Supported entries:
+     *
+     * `type`
+     * number the type of the constant. Supported values:
+     *
+     * - `material.CONSTANT_TYPE_USER`
+     *
+     * - `material.CONSTANT_TYPE_USER_MATRIX4`
+     *
+     * - `material.CONSTANT_TYPE_VIEWPROJ`
+     *
+     * - `material.CONSTANT_TYPE_WORLD`
+     *
+     * - `material.CONSTANT_TYPE_TEXTURE`
+     *
+     * - `material.CONSTANT_TYPE_VIEW`
+     *
+     * - `material.CONSTANT_TYPE_PROJECTION`
+     *
+     * - `material.CONSTANT_TYPE_NORMAL`
+     *
+     * - `material.CONSTANT_TYPE_WORLDVIEW`
+     *
+     * - `material.CONSTANT_TYPE_WORLDVIEWPROJ`
+     *
+     * - `material.CONSTANT_TYPE_TIME`
+     *
+     * - `material.CONSTANT_TYPE_WORLD_INVERSE`
+     *
+     * - `material.CONSTANT_TYPE_VIEW_INVERSE`
+     *
+     * - `material.CONSTANT_TYPE_PROJECTION_INVERSE`
+     *
+     * - `material.CONSTANT_TYPE_VIEWPROJ_INVERSE`
+     *
+     * - `material.CONSTANT_TYPE_WORLDVIEW_INVERSE`
+     *
+     * - `material.CONSTANT_TYPE_WORLDVIEWPROJ_INVERSE`
+     *
+     * `value`
+     * vmath.vector4 | vmath.vector3 | vmath.matrix4 | number | table the value(s) of the constant. If the shader constant is an array, the amount of values to update depends on how many values that are passed in the 'value' field.
+     * @example
+     * ```ts
+     * compute.set_constants("/my_compute.computec", { tint: { value: vmath.vector4(1, 0, 0, 1) } });
+     * ```
+     */
+    function set_constants(path: Hash | string, constants: Record<string, { type?: number; value?: Vector4 | Vector3 | Matrix4 | number | (Vector4 | Matrix4)[] }>): void;
+    /**
+     * Sets texture samplers in a compute program, if the samplers exist. Use this function to change the settings of texture samplers.
+     * To set actual textures that should be bound to the samplers, use the `compute.set_textures` function instead.
+     *
+     * @param path - The path to the resource
+     * @param samplers - A table keyed by sampler name with args tables as values. Partial updates are supported. Supported entries:
+     *
+     * `u_wrap`
+     * number the u wrap mode of the texture sampler. Supported values:
+     *
+     * - `graphics.TEXTURE_WRAP_CLAMP_TO_BORDER`
+     *
+     * - `graphics.TEXTURE_WRAP_CLAMP_TO_EDGE`
+     *
+     * - `graphics.TEXTURE_WRAP_MIRRORED_REPEAT`
+     *
+     * - `graphics.TEXTURE_WRAP_REPEAT`
+     *
+     * `v_wrap`
+     * number the v wrap mode of the texture sampler. Supported values:
+     *
+     * - `graphics.TEXTURE_WRAP_CLAMP_TO_BORDER`
+     *
+     * - `graphics.TEXTURE_WRAP_CLAMP_TO_EDGE`
+     *
+     * - `graphics.TEXTURE_WRAP_MIRRORED_REPEAT`
+     *
+     * - `graphics.TEXTURE_WRAP_REPEAT`
+     *
+     * `min_filter`
+     * number the min filter mode of the texture sampler. Supported values:
+     *
+     * - `graphics.TEXTURE_FILTER_DEFAULT`
+     *
+     * - `graphics.TEXTURE_FILTER_NEAREST`
+     *
+     * - `graphics.TEXTURE_FILTER_LINEAR`
+     *
+     * - `graphics.TEXTURE_FILTER_NEAREST_MIPMAP_NEAREST`
+     *
+     * - `graphics.TEXTURE_FILTER_NEAREST_MIPMAP_LINEAR`
+     *
+     * - `graphics.TEXTURE_FILTER_LINEAR_MIPMAP_NEAREST`
+     *
+     * - `graphics.TEXTURE_FILTER_LINEAR_MIPMAP_LINEAR`
+     *
+     * `mag_filter`
+     * number the mag filter mode of the texture sampler
+     *
+     * - `graphics.TEXTURE_FILTER_DEFAULT`
+     *
+     * - `graphics.TEXTURE_FILTER_NEAREST`
+     *
+     * - `graphics.TEXTURE_FILTER_LINEAR`
+     *
+     * `max_anisotropy`
+     * number the max anisotropy of the texture sampler
+     * @example
+     * ```ts
+     * compute.set_samplers("/my_compute.computec", { texture_sampler: { u_wrap: graphics.TEXTURE_WRAP_REPEAT, v_wrap: graphics.TEXTURE_WRAP_MIRRORED_REPEAT } });
+     * ```
+     */
+    function set_samplers(path: Hash | string, samplers: Record<string, { u_wrap?: number; v_wrap?: number; min_filter?: number; mag_filter?: number; max_anisotropy?: number }>): void;
+    /**
+     * Sets textures in a compute program, if the samplers exist.
+     *
+     * @param path - The path to the resource
+     * @param textures - A table keyed by sampler name with texture resources as values.
+     * @example
+     * ```ts
+     * compute.set_textures("/my_compute.computec", { my_texture: resource.texture() });
+     * ```
+     */
+    function set_textures(path: Hash | string, textures: LuaMap<string, Hash>): void;
+  }
+}
+
+export {};

package/generated/crash.d.ts

@@ -94,7 +94,7 @@ declare global {
      * @param index - system field enum. Must be less than crash.SYSFIELD_MAX
      * @returns value recorded in the crash dump, or `nil` if it didn't exist
      */
-    function get_sys_field(handle: number, index: number): string | unknown;
+    function get_sys_field(handle: number, index: number): string | undefined;
     /**
      * reads user field from a loaded crash dump
      *
@@ -109,7 +109,7 @@ declare global {
      *
      * @returns handle to the loaded dump, or `nil` if no dump was found
      */
-    function load_previous(): number | unknown;
+    function load_previous(): number | undefined;
     /**
      * releases a previously loaded crash dump
      *

package/generated/go.d.ts

@@ -3,9 +3,7 @@ import type { Hash, Matrix4, Opaque, Quaternion, Url, Vector, Vector3, Vector4 }
 
 declare global {
   /**
-   * Functions, core hooks, messages and constants for manipulation of
-   * game objects. The "go" namespace is accessible from game object script
-   * files.
+   * Game object API documentation
    */
   namespace go {
     /**
@@ -398,7 +396,7 @@ declare global {
      * const parent_id2 = go.get_parent("x");
      * ```
      */
-    export function get_parent(id?: string | Hash | Url): Hash | unknown;
+    export function get_parent(id?: string | Hash | Url): Hash | undefined;
     /**
      * The position is relative the parent (if any). Use go.get_world_position to retrieve the global world position.
      *
@@ -650,8 +648,14 @@ declare global {
      * `userid`
      * Id of the user associated with the controller. Usually only relevant on consoles.
      *
+     * `gamepad_guid`
+     * The guid of the gamepad controller. Only passed with "connected" action.
+     *
+     * `gamepad_guid_info`
+     * Parsed guid info table. Only passed with "connected" action. See table below.
+     *
      * `gamepad_unknown`
-     * True if the inout originated from an unknown/unmapped gamepad.
+     * True if the input originated from an unknown/unmapped gamepad.
      *
      * `gamepad_name`
      * Name of the gamepad
@@ -703,6 +707,27 @@ declare global {
      * `acc_z`
      * Accelerometer z value (if present).
      *
+     * Guid info table:
+     * This info is only passed with a `connected` action.
+     *
+     * Field
+     * Description
+     *
+     * `vendor`
+     * USB vendor id. E.g. Nintendo 0x057e, Sony 0x054c, or Microsoft 0x045e
+     *
+     * `product`
+     * USB product id
+     *
+     * `bus`
+     * How device is communicating. E.g.0x0003 for USB devices and 0x0005 for Bluetooth devices.
+     *
+     * `crc`
+     * SDL CRC16 signature, typically used when vendor and product ids are unavailable
+     *
+     * `version`
+     * The device or firmware version
+     *
      * @param self - reference to the script state to be used for storing data
      * @param action_id - id of the received input action, as mapped in the input_binding-file
      * @param action - a table containing the input data, see above for a description
@@ -742,7 +767,7 @@ declare global {
      * });
      * ```
      */
-    export function on_input(self: Opaque<"userdata">, action_id: Hash, action: { value?: number; pressed?: boolean; released?: boolean; repeated?: boolean; x?: number; y?: number; screen_x?: number; screen_y?: number; dx?: number; dy?: number; screen_dx?: number; screen_dy?: number; gamepad?: number; gamepad_axis?: Vector3; touch?: { id?: number; pressed?: boolean; released?: boolean; tap_count?: number; x?: number; y?: number; dx?: number; dy?: number; acc_x?: number; acc_y?: number; acc_z?: number }[]; text?: string }): boolean | unknown;
+    export function on_input(self: Opaque<"userdata">, action_id: Hash, action: { value?: number; pressed?: boolean; released?: boolean; repeated?: boolean; x?: number; y?: number; screen_x?: number; screen_y?: number; dx?: number; dy?: number; screen_dx?: number; screen_dy?: number; gamepad?: number; gamepad_axis?: Vector3; touch?: { id?: number; pressed?: boolean; released?: boolean; tap_count?: number; x?: number; y?: number; dx?: number; dy?: number; acc_x?: number; acc_y?: number; acc_z?: number }[]; text?: string }): boolean | undefined;
     /**
      * This is a callback-function, which is called by the engine whenever a message has been sent to the script component.
      * It can be used to take action on the message, e.g. send a response back to the sender of the message.

package/generated/graphics.d.ts

@@ -4,6 +4,11 @@ declare global {
    * Graphics functions and constants.
    */
   namespace graphics {
+    const BLEND_EQUATION_ADD: number & { readonly __brand: "graphics.BLEND_EQUATION_ADD" };
+    const BLEND_EQUATION_MAX: number & { readonly __brand: "graphics.BLEND_EQUATION_MAX" };
+    const BLEND_EQUATION_MIN: number & { readonly __brand: "graphics.BLEND_EQUATION_MIN" };
+    const BLEND_EQUATION_REVERSE_SUBTRACT: number & { readonly __brand: "graphics.BLEND_EQUATION_REVERSE_SUBTRACT" };
+    const BLEND_EQUATION_SUBTRACT: number & { readonly __brand: "graphics.BLEND_EQUATION_SUBTRACT" };
     const BLEND_FACTOR_CONSTANT_ALPHA: number & { readonly __brand: "graphics.BLEND_FACTOR_CONSTANT_ALPHA" };
     const BLEND_FACTOR_CONSTANT_COLOR: number & { readonly __brand: "graphics.BLEND_FACTOR_CONSTANT_COLOR" };
     const BLEND_FACTOR_DST_ALPHA: number & { readonly __brand: "graphics.BLEND_FACTOR_DST_ALPHA" };
@@ -47,6 +52,44 @@ declare global {
     const COMPRESSION_TYPE_DEFAULT: number & { readonly __brand: "graphics.COMPRESSION_TYPE_DEFAULT" };
     const COMPRESSION_TYPE_WEBP: number & { readonly __brand: "graphics.COMPRESSION_TYPE_WEBP" };
     const COMPRESSION_TYPE_WEBP_LOSSY: number & { readonly __brand: "graphics.COMPRESSION_TYPE_WEBP_LOSSY" };
+    /**
+     * Context feature flag indicating support for 3D (volume) textures.
+     */
+    const CONTEXT_FEATURE_3D_TEXTURES: number & { readonly __brand: "graphics.CONTEXT_FEATURE_3D_TEXTURES" };
+    /**
+     * Context feature flag indicating support for ASTC compressed 2D array textures.
+     * Some WebGL/GLES drivers fail array texture ASTC uploads while 2D ASTC works.
+     */
+    const CONTEXT_FEATURE_ASTC_ARRAY_TEXTURES: number & { readonly __brand: "graphics.CONTEXT_FEATURE_ASTC_ARRAY_TEXTURES" };
+    /**
+     * Context feature flag indicating support for min/max blend equations.
+     * Requires GLES3+ or EXT_blend_minmax.
+     */
+    const CONTEXT_FEATURE_BLEND_EQUATION_MIN_MAX: number & { readonly __brand: "graphics.CONTEXT_FEATURE_BLEND_EQUATION_MIN_MAX" };
+    /**
+     * Context feature flag indicating support for compute shaders.
+     */
+    const CONTEXT_FEATURE_COMPUTE_SHADER: number & { readonly __brand: "graphics.CONTEXT_FEATURE_COMPUTE_SHADER" };
+    /**
+     * Context feature flag indicating support for hardware instancing.
+     */
+    const CONTEXT_FEATURE_INSTANCING: number & { readonly __brand: "graphics.CONTEXT_FEATURE_INSTANCING" };
+    /**
+     * Context feature flag indicating support for rendering to multiple color targets simultaneously.
+     */
+    const CONTEXT_FEATURE_MULTI_TARGET_RENDERING: number & { readonly __brand: "graphics.CONTEXT_FEATURE_MULTI_TARGET_RENDERING" };
+    /**
+     * Context feature flag indicating support for storage buffers.
+     */
+    const CONTEXT_FEATURE_STORAGE_BUFFER: number & { readonly __brand: "graphics.CONTEXT_FEATURE_STORAGE_BUFFER" };
+    /**
+     * Context feature flag indicating support for texture arrays.
+     */
+    const CONTEXT_FEATURE_TEXTURE_ARRAY: number & { readonly __brand: "graphics.CONTEXT_FEATURE_TEXTURE_ARRAY" };
+    /**
+     * Context feature flag indicating support for vertical sync (vsync).
+     */
+    const CONTEXT_FEATURE_VSYNC: number & { readonly __brand: "graphics.CONTEXT_FEATURE_VSYNC" };
     const FACE_TYPE_BACK: number & { readonly __brand: "graphics.FACE_TYPE_BACK" };
     const FACE_TYPE_FRONT: number & { readonly __brand: "graphics.FACE_TYPE_FRONT" };
     const FACE_TYPE_FRONT_AND_BACK: number & { readonly __brand: "graphics.FACE_TYPE_FRONT_AND_BACK" };
@@ -220,6 +263,58 @@ declare global {
     const TEXTURE_WRAP_CLAMP_TO_EDGE: number & { readonly __brand: "graphics.TEXTURE_WRAP_CLAMP_TO_EDGE" };
     const TEXTURE_WRAP_MIRRORED_REPEAT: number & { readonly __brand: "graphics.TEXTURE_WRAP_MIRRORED_REPEAT" };
     const TEXTURE_WRAP_REPEAT: number & { readonly __brand: "graphics.TEXTURE_WRAP_REPEAT" };
+    /**
+     * Returns a table describing the active graphics context: the adapter family,
+     * its hardware limits, the list of driver-reported extensions, and the set of
+     * optional context features supported by the backend.
+     *
+     * @returns table with the following fields:
+     * `family` string adapter family name (e.g. "opengl", "vulkan")
+     * `version_major` number adapter API major version (e.g. 1 for Vulkan 1.4)
+     * `version_minor` number adapter API minor version (e.g. 4 for Vulkan 1.4)
+     * `limits` table hardware/driver limits:
+     *
+     * ``max_texture_size_2d` [type:number] max 2D texture dimension in texels
+     * `max_texture_size_3d` [type:number] max 3D (volume) texture dimension in texels
+     * `max_texture_size_cube` [type:number] max cube map face dimension in texels
+     * `max_texture_array_layers` [type:number] max layers in an array texture
+     * `max_framebuffer_width` [type:number] max framebuffer width in pixels
+     * `max_framebuffer_height` [type:number] max framebuffer height in pixels
+     * `max_color_attachments` [type:number] max simultaneous color attachments
+     * `max_samplers_per_stage` [type:number] max texture samplers per shader stage
+     * `max_textures_per_stage` [type:number] max sampled textures per shader stage
+     * `max_vertex_attributes` [type:number] max vertex attributes
+     * `max_vertex_buffers` [type:number] max vertex buffer bindings
+     * `max_compute_workgroup_size_x` [type:number] max compute workgroup size (X)
+     * `max_compute_workgroup_size_y` [type:number] max compute workgroup size (Y)
+     * `max_compute_workgroup_size_z` [type:number] max compute workgroup size (Z)
+     * `max_compute_workgroup_invocations` [type:number] max invocations per compute workgroup
+     * `max_compute_shared_memory_size` [type:number] max shared memory per compute workgroup (bytes)
+     * `max_uniform_buffer_range` [type:number] max bindable uniform buffer range (bytes)
+     * `max_storage_buffer_range` [type:number] max bindable storage buffer range (bytes)
+     * `
+     *
+     * `extensions` table array of driver-reported extension name strings
+     * `features` table array of supported context feature ids:
+     *
+     * ``graphics.CONTEXT_FEATURE_MULTI_TARGET_RENDERING` multi-target rendering
+     * `graphics.CONTEXT_FEATURE_TEXTURE_ARRAY` texture arrays
+     * `graphics.CONTEXT_FEATURE_COMPUTE_SHADER` compute shaders
+     * `graphics.CONTEXT_FEATURE_STORAGE_BUFFER` storage buffers
+     * `graphics.CONTEXT_FEATURE_VSYNC` vertical sync
+     * `graphics.CONTEXT_FEATURE_INSTANCING` hardware instancing
+     * `graphics.CONTEXT_FEATURE_3D_TEXTURES` 3D (volume) textures
+     * `graphics.CONTEXT_FEATURE_ASTC_ARRAY_TEXTURES` ASTC compressed 2D array textures
+     * `graphics.CONTEXT_FEATURE_BLEND_EQUATION_MIN_MAX` min/max blend equations
+     * `
+     */
+    function get_adapter_info(): { family: string; version_major: number; version_minor: number; limits: { max_texture_size_2d: number; max_texture_size_3d: number; max_texture_size_cube: number; max_texture_array_layers: number; max_framebuffer_width: number; max_framebuffer_height: number; max_color_attachments: number; max_samplers_per_stage: number; max_textures_per_stage: number; max_vertex_attributes: number; max_vertex_buffers: number; max_compute_workgroup_size_x: number; max_compute_workgroup_size_y: number; max_compute_workgroup_size_z: number; max_compute_workgroup_invocations: number; max_compute_shared_memory_size: number; max_uniform_buffer_range: number; max_storage_buffer_range: number }; extensions: string[]; features: number[] };
+    /**
+     * get the list of graphics adapters that have been registered with the engine
+     *
+     * @returns array of adapter family name strings (e.g. "opengl", "vulkan", "webgpu")
+     */
+    function get_engine_adapters(): string[];
   }
 }
 

package/generated/gui.d.ts

@@ -3,9 +3,7 @@ import type { Hash, Opaque, Quaternion, Url, Vector, Vector3, Vector4 } from "..
 
 declare global {
   /**
-   * GUI core hooks, functions, messages, properties and constants for
-   * creation and manipulation of GUI nodes. The "gui" namespace is
-   * accessible only from gui scripts.
+   * GUI API documentation
    */
   namespace gui {
     /**
@@ -1046,7 +1044,7 @@ declare global {
      * @param node - the node from which to retrieve its parent
      * @returns parent instance or `nil`
      */
-    function get_parent(node: Opaque<"node">): Opaque<"node"> | unknown;
+    function get_parent(node: Opaque<"node">): Opaque<"node"> | undefined;
     /**
      * Get the paricle fx for a gui node
      *
@@ -1191,7 +1189,7 @@ declare global {
      *
      * @param node - node from which to get the type
      */
-    function get_type(node: Opaque<"node">): LuaMultiReturn<[Opaque<"constant">, number | unknown]>;
+    function get_type(node: Opaque<"node">): LuaMultiReturn<[Opaque<"constant">, number | undefined]>;
     /**
      * Returns `true` if a node is visible and `false` if it's not.
      * Invisible nodes are not rendered.
@@ -1520,7 +1518,7 @@ declare global {
      * });
      * ```
      */
-    function on_input(self: Opaque<"userdata">, action_id: Hash, action: { value?: number; pressed?: boolean; released?: boolean; repeated?: boolean; x?: number; y?: number; screen_x?: number; screen_y?: number; dx?: number; dy?: number; screen_dx?: number; screen_dy?: number; gamepad?: number; gamepad_axis?: Vector3; touch?: { id?: number; pressed?: boolean; released?: boolean; tap_count?: number; x?: number; y?: number; dx?: number; dy?: number; acc_x?: number; acc_y?: number; acc_z?: number }[]; text?: string }): boolean | unknown;
+    function on_input(self: Opaque<"userdata">, action_id: Hash, action: { value?: number; pressed?: boolean; released?: boolean; repeated?: boolean; x?: number; y?: number; screen_x?: number; screen_y?: number; dx?: number; dy?: number; screen_dx?: number; screen_dy?: number; gamepad?: number; gamepad_axis?: Vector3; touch?: { id?: number; pressed?: boolean; released?: boolean; tap_count?: number; x?: number; y?: number; dx?: number; dy?: number; acc_x?: number; acc_y?: number; acc_z?: number }[]; text?: string }): boolean | undefined;
     /**
      * This is a callback-function, which is called by the engine whenever a message has been sent to the gui component.
      * It can be used to take action on the message, e.g. update the gui or send a response back to the sender of the message.