@girs/gdkpixbuf-2.0 2.0.0-3.0.0 → 2.0.0-3.0.3

package/README.md

@@ -1,7 +1,11 @@
 
 # GdkPixbuf-2.0
 
-GJS TypeScript type definitions for GdkPixbuf-2.0, generated from library version 2.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.0.0.
+![version](https://img.shields.io/npm/v/@girs/gdkpixbuf-2.0)
+![downloads/week](https://img.shields.io/npm/dw/@girs/gdkpixbuf-2.0)
+
+
+GJS TypeScript type definitions for GdkPixbuf-2.0, generated from library version 2.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.0.3.
 
 GdkPixbuf is a library for image loading and manipulation. The GdkPixbuf documentation contains both the programmer's guide and the API reference.
 

package/gdkpixbuf-2.0.d.cts

@@ -238,6 +238,47 @@ export interface PixbufModuleFillInfoFunc {
 export interface PixbufModuleFillVtableFunc {
     (module: PixbufModule): void
 }
+/**
+ * Incrementally loads a buffer into the image data.
+ * @callback 
+ * @param context the state object created by [callback`GdkPixbuf`.PixbufModuleBeginLoadFunc]
+ * @param buf the data to load
+ * @returns `TRUE` if the incremental load was successful
+ */
+export interface PixbufModuleIncrementLoadFunc {
+    (context: any | null, buf: Uint8Array): boolean
+}
+/**
+ * Loads a file from a standard C file stream into a new `GdkPixbufAnimation`.
+ * 
+ * In case of error, this function should return `NULL` and set the `error` argument.
+ * @callback 
+ * @param f the file stream from which the image should be loaded
+ * @returns a newly created `GdkPixbufAnimation` for the contents of the file
+ */
+export interface PixbufModuleLoadAnimationFunc {
+    (f: any | null): PixbufAnimation
+}
+/**
+ * Loads a file from a standard C file stream into a new `GdkPixbuf`.
+ * 
+ * In case of error, this function should return `NULL` and set the `error` argument.
+ * @callback 
+ * @param f the file stream from which the image should be loaded
+ * @returns a newly created `GdkPixbuf` for the contents of the file
+ */
+export interface PixbufModuleLoadFunc {
+    (f: any | null): Pixbuf
+}
+/**
+ * Loads XPM data into a new `GdkPixbuf`.
+ * @callback 
+ * @param data the XPM data
+ * @returns a newly created `GdkPixbuf` for the XPM data
+ */
+export interface PixbufModuleLoadXpmDataFunc {
+    (data: string[]): Pixbuf
+}
 /**
  * Defines the type of the function that gets called once the initial
  * setup of `pixbuf` is done.
@@ -252,6 +293,31 @@ export interface PixbufModuleFillVtableFunc {
 export interface PixbufModulePreparedFunc {
     (pixbuf: Pixbuf, anim: PixbufAnimation): void
 }
+/**
+ * Saves a `GdkPixbuf` into a standard C file stream.
+ * 
+ * The optional `param_keys` and `param_values` arrays contain the keys and
+ * values (in the same order) for attributes to be saved alongside the image
+ * data.
+ * @callback 
+ * @param f the file stream into which the image should be saved
+ * @param pixbuf the image to save
+ * @param param_keys parameter keys to save
+ * @param param_values parameter values to save
+ * @returns `TRUE` on success; in case of failure, `FALSE` is returned and   the `error` is set
+ */
+export interface PixbufModuleSaveFunc {
+    (f: any | null, pixbuf: Pixbuf, param_keys: string[] | null, param_values: string[] | null): boolean
+}
+/**
+ * Checks whether the given `option_key` is supported when saving.
+ * @callback 
+ * @param option_key the option key to check
+ * @returns `TRUE` if the option is supported
+ */
+export interface PixbufModuleSaveOptionSupportedFunc {
+    (option_key: string | null): boolean
+}
 /**
  * Defines the type of the function that gets called once the size
  * of the loaded image is known.
@@ -273,6 +339,17 @@ export interface PixbufModulePreparedFunc {
 export interface PixbufModuleSizeFunc {
     (width: number, height: number): void
 }
+/**
+ * Finalizes the image loading state.
+ * 
+ * This function is called on success and error states.
+ * @callback 
+ * @param context the state object created by [callback`GdkPixbuf`.PixbufModuleBeginLoadFunc]
+ * @returns `TRUE` if the loading operation was successful
+ */
+export interface PixbufModuleStopLoadFunc {
+    (context: any | null): boolean
+}
 /**
  * Defines the type of the function that gets called every time a region
  * of `pixbuf` is updated.
@@ -2564,10 +2641,41 @@ export interface PixbufModule {
      * @field 
      */
     info: PixbufFormat
-    stop_load: (context: any) => boolean
-    load_increment: (context: any, buf: number, size: number) => boolean
-    save: (f: any, pixbuf: Pixbuf, param_keys: string | null, param_values: string | null) => boolean
-    is_save_option_supported: (option_key: string | null) => boolean
+    /**
+     * loads an image from a file.
+     * @field 
+     */
+    load: PixbufModuleLoadFunc
+    /**
+     * loads an image from data in memory.
+     * @field 
+     */
+    load_xpm_data: PixbufModuleLoadXpmDataFunc
+    /**
+     * stops an incremental load.
+     * @field 
+     */
+    stop_load: PixbufModuleStopLoadFunc
+    /**
+     * continues an incremental load.
+     * @field 
+     */
+    load_increment: PixbufModuleIncrementLoadFunc
+    /**
+     * loads an animation from a file.
+     * @field 
+     */
+    load_animation: PixbufModuleLoadAnimationFunc
+    /**
+     * saves a `GdkPixbuf` to a file.
+     * @field 
+     */
+    save: PixbufModuleSaveFunc
+    /**
+     * returns whether a save option key is supported by the module
+     * @field 
+     */
+    is_save_option_supported: PixbufModuleSaveOptionSupportedFunc
 }
 
 /**

package/gdkpixbuf-2.0.d.ts

@@ -240,6 +240,47 @@ interface PixbufModuleFillInfoFunc {
 interface PixbufModuleFillVtableFunc {
     (module: PixbufModule): void
 }
+/**
+ * Incrementally loads a buffer into the image data.
+ * @callback 
+ * @param context the state object created by [callback`GdkPixbuf`.PixbufModuleBeginLoadFunc]
+ * @param buf the data to load
+ * @returns `TRUE` if the incremental load was successful
+ */
+interface PixbufModuleIncrementLoadFunc {
+    (context: any | null, buf: Uint8Array): boolean
+}
+/**
+ * Loads a file from a standard C file stream into a new `GdkPixbufAnimation`.
+ * 
+ * In case of error, this function should return `NULL` and set the `error` argument.
+ * @callback 
+ * @param f the file stream from which the image should be loaded
+ * @returns a newly created `GdkPixbufAnimation` for the contents of the file
+ */
+interface PixbufModuleLoadAnimationFunc {
+    (f: any | null): PixbufAnimation
+}
+/**
+ * Loads a file from a standard C file stream into a new `GdkPixbuf`.
+ * 
+ * In case of error, this function should return `NULL` and set the `error` argument.
+ * @callback 
+ * @param f the file stream from which the image should be loaded
+ * @returns a newly created `GdkPixbuf` for the contents of the file
+ */
+interface PixbufModuleLoadFunc {
+    (f: any | null): Pixbuf
+}
+/**
+ * Loads XPM data into a new `GdkPixbuf`.
+ * @callback 
+ * @param data the XPM data
+ * @returns a newly created `GdkPixbuf` for the XPM data
+ */
+interface PixbufModuleLoadXpmDataFunc {
+    (data: string[]): Pixbuf
+}
 /**
  * Defines the type of the function that gets called once the initial
  * setup of `pixbuf` is done.
@@ -254,6 +295,31 @@ interface PixbufModuleFillVtableFunc {
 interface PixbufModulePreparedFunc {
     (pixbuf: Pixbuf, anim: PixbufAnimation): void
 }
+/**
+ * Saves a `GdkPixbuf` into a standard C file stream.
+ * 
+ * The optional `param_keys` and `param_values` arrays contain the keys and
+ * values (in the same order) for attributes to be saved alongside the image
+ * data.
+ * @callback 
+ * @param f the file stream into which the image should be saved
+ * @param pixbuf the image to save
+ * @param param_keys parameter keys to save
+ * @param param_values parameter values to save
+ * @returns `TRUE` on success; in case of failure, `FALSE` is returned and   the `error` is set
+ */
+interface PixbufModuleSaveFunc {
+    (f: any | null, pixbuf: Pixbuf, param_keys: string[] | null, param_values: string[] | null): boolean
+}
+/**
+ * Checks whether the given `option_key` is supported when saving.
+ * @callback 
+ * @param option_key the option key to check
+ * @returns `TRUE` if the option is supported
+ */
+interface PixbufModuleSaveOptionSupportedFunc {
+    (option_key: string | null): boolean
+}
 /**
  * Defines the type of the function that gets called once the size
  * of the loaded image is known.
@@ -275,6 +341,17 @@ interface PixbufModulePreparedFunc {
 interface PixbufModuleSizeFunc {
     (width: number, height: number): void
 }
+/**
+ * Finalizes the image loading state.
+ * 
+ * This function is called on success and error states.
+ * @callback 
+ * @param context the state object created by [callback`GdkPixbuf`.PixbufModuleBeginLoadFunc]
+ * @returns `TRUE` if the loading operation was successful
+ */
+interface PixbufModuleStopLoadFunc {
+    (context: any | null): boolean
+}
 /**
  * Defines the type of the function that gets called every time a region
  * of `pixbuf` is updated.
@@ -2566,10 +2643,41 @@ interface PixbufModule {
      * @field 
      */
     info: PixbufFormat
-    stop_load: (context: any) => boolean
-    load_increment: (context: any, buf: number, size: number) => boolean
-    save: (f: any, pixbuf: Pixbuf, param_keys: string | null, param_values: string | null) => boolean
-    is_save_option_supported: (option_key: string | null) => boolean
+    /**
+     * loads an image from a file.
+     * @field 
+     */
+    load: PixbufModuleLoadFunc
+    /**
+     * loads an image from data in memory.
+     * @field 
+     */
+    load_xpm_data: PixbufModuleLoadXpmDataFunc
+    /**
+     * stops an incremental load.
+     * @field 
+     */
+    stop_load: PixbufModuleStopLoadFunc
+    /**
+     * continues an incremental load.
+     * @field 
+     */
+    load_increment: PixbufModuleIncrementLoadFunc
+    /**
+     * loads an animation from a file.
+     * @field 
+     */
+    load_animation: PixbufModuleLoadAnimationFunc
+    /**
+     * saves a `GdkPixbuf` to a file.
+     * @field 
+     */
+    save: PixbufModuleSaveFunc
+    /**
+     * returns whether a save option key is supported by the module
+     * @field 
+     */
+    is_save_option_supported: PixbufModuleSaveOptionSupportedFunc
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@girs/gdkpixbuf-2.0",
-  "version": "2.0.0-3.0.0",
+  "version": "2.0.0-3.0.3",
   "description": "GJS TypeScript type definitions for GdkPixbuf-2.0, generated from library version 2.0.0",
   "type": "module",
   "module": "gdkpixbuf-2.0.js",
@@ -31,14 +31,14 @@
     "test:cjs": "tsc --noEmit gdkpixbuf-2.0.d.cts"
   },
   "dependencies": {
-    "@girs/gjs": "^3.0.0",
-    "@girs/gio-2.0": "^2.76.1-3.0.0",
-    "@girs/gobject-2.0": "^2.76.1-3.0.0",
-    "@girs/glib-2.0": "^2.76.1-3.0.0",
-    "@girs/gmodule-2.0": "^2.0.0-3.0.0"
+    "@girs/gio-2.0": "^2.76.1-3.0.3",
+    "@girs/gjs": "^3.0.3",
+    "@girs/glib-2.0": "^2.76.1-3.0.3",
+    "@girs/gmodule-2.0": "^2.0.0-3.0.3",
+    "@girs/gobject-2.0": "^2.76.1-3.0.3"
   },
   "devDependencies": {
-    "typescript": "^5.0.4"
+    "typescript": "*"
   },
   "keywords": [
     "Gir",