@girs/coglpango-8 8.0.0-4.0.0-beta.38

package/README.md

@@ -0,0 +1,85 @@
+
+# CoglPango-8
+
+![version](https://img.shields.io/npm/v/@girs/coglpango-8)
+![downloads/week](https://img.shields.io/npm/dw/@girs/coglpango-8)
+
+
+GJS TypeScript type definitions for CoglPango-8, generated from library version 8.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.38.
+
+## Install
+
+To use this type definitions, install them with NPM:
+```bash
+npm install @girs/coglpango-8
+```
+
+## Usage
+
+You can import this package into your project like this:
+```ts
+import CoglPango from '@girs/coglpango-8';
+```
+
+### Ambient Modules
+
+You can also use [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules) to import this module like you would do this in JavaScript.
+For this you need to include `@girs/coglpango-8` or `@girs/coglpango-8/ambient` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
+```ts
+import '@girs/coglpango-8'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/coglpango-8"],
+  ...
+}
+```
+
+Now you can import the ambient module with TypeScript support: 
+
+```ts
+import CoglPango from 'gi://CoglPango?version=8';
+```
+
+### Global import
+
+You can also import the module with Typescript support using the global `imports.gi` object of GJS.
+For this you need to include `@girs/coglpango-8` or `@girs/coglpango-8/import` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
+```ts
+import '@girs/coglpango-8'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/coglpango-8"],
+  ...
+}
+```
+
+Now you have also type support for this, too:
+
+```ts
+const CoglPango = imports.gi.CoglPango;
+```
+
+### Bundle
+
+Depending on your project configuration, it is recommended to use a bundler like [esbuild](https://esbuild.github.io/). You can find examples using different bundlers [here](https://github.com/gjsify/ts-for-gir/tree/main/examples).
+
+## Other packages
+
+All existing pre-generated packages can be found on [gjsify/types](https://github.com/gjsify/types).
+

package/coglpango-8-ambient.d.ts

@@ -0,0 +1,9 @@
+declare module 'gi://CoglPango?version=8' {
+    import CoglPango8 from '@girs/coglpango-8';
+    export default CoglPango8;
+}
+
+declare module 'gi://CoglPango' {
+    import CoglPango8 from 'gi://CoglPango?version=8';
+    export default CoglPango8;
+}

package/coglpango-8-ambient.js

@@ -0,0 +1,2 @@
+export {}
+

package/coglpango-8-import.d.ts

@@ -0,0 +1 @@
+// Module import type definition not generated, otherwise this would cause a type conflict, this is because several GIR modules were generated with the same namespace: "CoglPango"

package/coglpango-8-import.js

@@ -0,0 +1,3 @@
+const gi = globalThis.imports?.gi || {};
+export default gi;
+

package/coglpango-8.d.ts

@@ -0,0 +1,155 @@
+/**
+ * Type Definitions for Gjs (https://gjs.guide/)
+ *
+ * These type definitions are automatically generated, do not edit them by hand.
+ * If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gir
+ *
+ * The based EJS template file is used for the generated .d.ts file of each GIR module like Gtk-4.0, GObject-2.0, ...
+ */
+
+import '@girs/gjs';
+
+// Module dependencies
+import type PangoCairo from '@girs/pangocairo-1.0';
+import type cairo from 'cairo';
+import type GObject from '@girs/gobject-2.0';
+import type GLib from '@girs/glib-2.0';
+import type Pango from '@girs/pango-1.0';
+import type HarfBuzz from '@girs/harfbuzz-0.0';
+import type freetype2 from '@girs/freetype2-2.0';
+import type Gio from '@girs/gio-2.0';
+import type GModule from '@girs/gmodule-2.0';
+import type Cogl from '@girs/cogl-8';
+import type Graphene from '@girs/graphene-1.0';
+import type GL from '@girs/gl-1.0';
+
+export namespace CoglPango {
+    /**
+     * CoglPango-8
+     */
+
+    /**
+     * This updates any internal glyph cache textures as necessary to be
+     * able to render the given `layout`.
+     *
+     * This api should be used to avoid mid-scene modifications of
+     * glyph-cache textures which can lead to undefined rendering results.
+     * @param layout A #PangoLayout
+     */
+    function ensure_glyph_cache_for_layout(layout: Pango.Layout): void;
+    /**
+     * Clears the glyph cache for `font_map`.
+     * @param font_map a #CoglPangoFontMap
+     */
+    function font_map_clear_glyph_cache(font_map: FontMap): void;
+    /**
+     * Create a #PangoContext for the given `font_map`.
+     * @param font_map a #CoglPangoFontMap
+     * @returns the newly created context: free with g_object_unref().
+     */
+    function font_map_create_context(font_map: FontMap): Pango.Context;
+    /**
+     * Retrieves the #CoglPangoRenderer for the passed `font_map`.
+     * @param font_map a #CoglPangoFontMap
+     * @returns a #PangoRenderer
+     */
+    function font_map_get_renderer(font_map: FontMap): Pango.Renderer;
+    /**
+     * Retrieves whether the #CoglPangoRenderer used by `font_map` will use
+     * mipmapping when rendering the glyphs.
+     * @param font_map a #CoglPangoFontMap
+     * @returns %TRUE if mipmapping is used, %FALSE otherwise.
+     */
+    function font_map_get_use_mipmapping(font_map: FontMap): boolean;
+    /**
+     * Creates a new font map.
+     * @returns the newly created #PangoFontMap
+     */
+    function font_map_new(): Pango.FontMap;
+    /**
+     * Sets the resolution for the `font_map`. This is a scale factor
+     * between points specified in a #PangoFontDescription and Cogl units.
+     * The default value is %96, meaning that a 10 point font will be 13
+     * units high. (10 * 96. / 72. = 13.3).
+     * @param font_map a #CoglPangoFontMap
+     * @param dpi The resolution in "dots per inch". (Physical inches aren't       actually involved; the terminology is conventional.)
+     */
+    function font_map_set_resolution(font_map: FontMap, dpi: number): void;
+    /**
+     * Sets whether the renderer for the passed font map should use
+     * mipmapping when rendering a #PangoLayout.
+     * @param font_map a #CoglPangoFontMap
+     * @param value %TRUE to enable the use of mipmapping
+     */
+    function font_map_set_use_mipmapping(font_map: FontMap, value: boolean): void;
+    namespace Renderer {
+        // Signal signatures
+        interface SignalSignatures extends Pango.Renderer.SignalSignatures {
+            'notify::context': (pspec: GObject.ParamSpec) => void;
+        }
+
+        // Constructor properties interface
+
+        interface ConstructorProps extends Pango.Renderer.ConstructorProps {
+            context: any;
+        }
+    }
+
+    class Renderer extends Pango.Renderer {
+        static $gtype: GObject.GType<Renderer>;
+
+        // Properties
+
+        set context(val: any);
+
+        /**
+         * Compile-time signal type information.
+         *
+         * This instance property is generated only for TypeScript type checking.
+         * It is not defined at runtime and should not be accessed in JS code.
+         * @internal
+         */
+        $signals: Renderer.SignalSignatures;
+
+        // Constructors
+
+        constructor(properties?: Partial<Renderer.ConstructorProps>, ...args: any[]);
+
+        _init(...args: any[]): void;
+
+        // Signals
+
+        connect<K extends keyof Renderer.SignalSignatures>(
+            signal: K,
+            callback: GObject.SignalCallback<this, Renderer.SignalSignatures[K]>,
+        ): number;
+        connect(signal: string, callback: (...args: any[]) => any): number;
+        connect_after<K extends keyof Renderer.SignalSignatures>(
+            signal: K,
+            callback: GObject.SignalCallback<this, Renderer.SignalSignatures[K]>,
+        ): number;
+        connect_after(signal: string, callback: (...args: any[]) => any): number;
+        emit<K extends keyof Renderer.SignalSignatures>(
+            signal: K,
+            ...args: GObject.GjsParameters<Renderer.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
+        ): void;
+        emit(signal: string, ...args: any[]): void;
+    }
+
+    type RendererClass = typeof Renderer;
+    type FontMap = PangoCairo.FontMap;
+    /**
+     * Name of the imported GIR library
+     * `see` https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L188
+     */
+    const __name__: string;
+    /**
+     * Version of the imported GIR library
+     * `see` https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L189
+     */
+    const __version__: string;
+}
+
+export default CoglPango;
+
+// END

package/coglpango-8.js

@@ -0,0 +1,5 @@
+
+// @ts-expect-error
+import CoglPango from 'gi://CoglPango?version=8';
+export default CoglPango;
+

package/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Type Definitions for Gjs (https://gjs.guide/)
+ *
+ * These type definitions are automatically generated, do not edit them by hand.
+ * If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gir
+ *
+ * This template is used to generate the index.d.ts file of each GIR module like Gtk-4.0, GObject-2.0, ...
+ */
+
+import './coglpango-8-ambient.d.ts';
+
+import CoglPango from './coglpango-8.js';
+export default CoglPango;

package/index.js

@@ -0,0 +1,5 @@
+
+// @ts-expect-error
+import CoglPango from './coglpango-8.js';
+export default CoglPango;
+

package/package.json

@@ -0,0 +1,63 @@
+{
+    "name": "@girs/coglpango-8",
+    "version": "8.0.0-4.0.0-beta.38",
+    "description": "GJS TypeScript type definitions for CoglPango-8, generated from library version 8.0.0",
+    "type": "module",
+    "module": "coglpango-8.js",
+    "main": "coglpango-8.js",
+    "exports": {
+      "./ambient": {
+        "types": "./coglpango-8-ambient.d.ts",
+        "import": "./coglpango-8-ambient.js",
+        "default": "./coglpango-8-ambient.js"
+      },
+      "./import": {
+        "types": "./coglpango-8-import.d.ts",
+        "import": "./coglpango-8-import.js",
+        "default": "./coglpango-8-import.js"
+      },
+      "./coglpango-8": {
+        "types": "./coglpango-8.d.ts",
+        "import": "./coglpango-8.js",
+        "default": "./coglpango-8.js"
+      },
+      ".": {
+        "types": "./index.d.ts",
+        "import": "./index.js",
+        "default": "./index.js"
+      }
+    },
+    "scripts": {
+      "test": "tsc --project tsconfig.json"
+    },
+    "dependencies": {
+      "@girs/gjs": "4.0.0-beta.38",
+      "@girs/pangocairo-1.0": "1.0.0-4.0.0-beta.38",
+      "@girs/cairo-1.0": "1.0.0-4.0.0-beta.38",
+      "@girs/gobject-2.0": "2.86.0-4.0.0-beta.38",
+      "@girs/glib-2.0": "2.86.0-4.0.0-beta.38",
+      "@girs/pango-1.0": "1.57.0-4.0.0-beta.38",
+      "@girs/harfbuzz-0.0": "11.5.0-4.0.0-beta.38",
+      "@girs/freetype2-2.0": "2.0.0-4.0.0-beta.38",
+      "@girs/gio-2.0": "2.86.0-4.0.0-beta.38",
+      "@girs/gmodule-2.0": "2.0.0-4.0.0-beta.38",
+      "@girs/cogl-8": "8.0.0-4.0.0-beta.38",
+      "@girs/graphene-1.0": "1.0.0-4.0.0-beta.38",
+      "@girs/gl-1.0": "1.0.0-4.0.0-beta.38"    },
+    "devDependencies": {
+      "typescript": "*"
+    },
+    "keywords": ["Gir", "TypeScript", "types", "GObject-Introspection", "GJS", "CoglPango-8"],
+    "author": "ts-for-gir",
+    "license": "MIT",
+    "repository": {
+      "type": "git",
+      "url": "git+https://github.com/gjsify/types.git"
+    },
+    "bugs": {
+      "url": "https://github.com/gjsify/ts-for-gir/issues"
+    },
+    "homepage": "https://github.com/gjsify/types/tree/main/coglpango-8#readme"
+}
+
+

package/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    // General settings for code interpretation
+    "target": "ESNext",
+    "module": "NodeNext",
+    "lib": ["ESNext"],
+    "types": [],
+    "experimentalDecorators": true,
+    "moduleResolution": "NodeNext",
+    "noEmit": true,
+    "noEmitOnError": false,
+    "baseUrl": "./",
+    "rootDir": ".",
+    // General settings for code generation
+    "removeComments": false,
+    "inlineSourceMap": false,
+    "inlineSources": false,
+    "newLine": "LF",
+    // Show diagnostics
+    "diagnostics": true
+  },
+  "include": ["./coglpango-8.d.ts"]
+}
+
+

package/typedoc.json

@@ -0,0 +1,7 @@
+{
+    "entryPoints": ["./coglpango-8.d.ts"],
+    "readme": "./README.md",
+    "name": "CoglPango-8",
+    "tsconfig": "./tsconfig.json"
+}
+