@gtkx/ffi 0.1.45 → 0.1.46

package/dist/generated/pangocairo/functions.js

@@ -2,6 +2,14 @@ import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import * as Pango from "../pango/index.js";
 import * as cairo from "../cairo/index.js";
+/**
+ * Retrieves any font rendering options previously set with
+ * [func@PangoCairo.context_set_font_options].
+ *
+ * This function does not report options that are derived from
+ * the target surface by [func@update_context].
+ * @param context - a `PangoContext`, from a pangocairo font map
+ */
 export const contextGetFontOptions = (context) => {
     const ptr = call("libpangocairo-1.0.so.0", "pango_cairo_context_get_font_options", [
         {
@@ -18,6 +26,12 @@ export const contextGetFontOptions = (context) => {
         return null;
     return getObject(ptr, cairo.FontOptions);
 };
+/**
+ * Gets the resolution for the context.
+ *
+ * See [func@PangoCairo.context_set_resolution]
+ * @param context - a `PangoContext`, from a pangocairo font map
+ */
 export const contextGetResolution = (context) => {
     return call("libpangocairo-1.0.so.0", "pango_cairo_context_get_resolution", [
         {
@@ -26,6 +40,14 @@ export const contextGetResolution = (context) => {
         },
     ], { type: "float", size: 64 });
 };
+/**
+ * Sets the font options used when rendering text with this context.
+ *
+ * These options override any options that [func@update_context]
+ * derives from the target surface.
+ * @param context - a `PangoContext`, from a pangocairo font map
+ * @param options - a `cairo_font_options_t`, or %NULL to unset
+ */
 export const contextSetFontOptions = (context, options) => {
     call("libpangocairo-1.0.so.0", "pango_cairo_context_set_font_options", [
         {
@@ -44,6 +66,15 @@ export const contextSetFontOptions = (context, options) => {
         },
     ], { type: "undefined" });
 };
+/**
+ * Sets the resolution for the context.
+ *
+ * This is a scale factor between points specified in a `PangoFontDescription`
+ * and Cairo units. The default value is 96, meaning that a 10 point font will
+ * be 13 units high. (10 * 96. / 72. = 13.3).
+ * @param context - a `PangoContext`, from a pangocairo font map
+ * @param dpi - the resolution in "dots per inch". (Physical inches aren't actually
+ */
 export const contextSetResolution = (context, dpi) => {
     call("libpangocairo-1.0.so.0", "pango_cairo_context_set_resolution", [
         {
@@ -56,6 +87,16 @@ export const contextSetResolution = (context, dpi) => {
         },
     ], { type: "undefined" });
 };
+/**
+ * Sets callback function for context to use for rendering attributes
+ * of type %PANGO_ATTR_SHAPE.
+ *
+ * See `PangoCairoShapeRendererFunc` for details.
+ * @param context - a `PangoContext`, from a pangocairo font map
+ * @param func - Callback function for rendering attributes of
+ * @param data - User data that will be passed to @func.
+ * @param dnotify - Callback that will be called when the
+ */
 export const contextSetShapeRenderer = (context, func, data, dnotify) => {
     call("libpangocairo-1.0.so.0", "pango_cairo_context_set_shape_renderer", [
         {
@@ -79,6 +120,19 @@ export const contextSetShapeRenderer = (context, func, data, dnotify) => {
         },
     ], { type: "undefined" });
 };
+/**
+ * Creates a context object set up to match the current transformation
+ * and target surface of the Cairo context.
+ *
+ * This context can then be
+ * used to create a layout using [ctor@Pango.Layout.new].
+ *
+ * This function is a convenience function that creates a context using
+ * the default font map, then updates it to @cr. If you just need to
+ * create a layout for use with `cr` and do not need to access `PangoContext`
+ * directly, you can use [func@create_layout] instead.
+ * @param cr - a Cairo context
+ */
 export const createContext = (cr) => {
     const ptr = call("libpangocairo-1.0.so.0", "pango_cairo_create_context", [
         {
@@ -93,6 +147,21 @@ export const createContext = (cr) => {
     ], { type: "gobject", borrowed: true });
     return getObject(ptr, Pango.Context);
 };
+/**
+ * Creates a layout object set up to match the current transformation
+ * and target surface of the Cairo context.
+ *
+ * This layout can then be used for text measurement with functions
+ * like [method@Pango.Layout.get_size] or drawing with functions like
+ * [func@show_layout]. If you change the transformation or target
+ * surface for @cr, you need to call [func@update_layout].
+ *
+ * This function is the most convenient way to use Cairo with Pango,
+ * however it is slightly inefficient since it creates a separate
+ * `PangoContext` object for each layout. This might matter in an
+ * application that was laying out large amounts of text.
+ * @param cr - a Cairo context
+ */
 export const createLayout = (cr) => {
     const ptr = call("libpangocairo-1.0.so.0", "pango_cairo_create_layout", [
         {
@@ -107,6 +176,19 @@ export const createLayout = (cr) => {
     ], { type: "gobject", borrowed: true });
     return getObject(ptr, Pango.Layout);
 };
+/**
+ * Add a squiggly line to the current path in the specified cairo context that
+ * approximately covers the given rectangle in the style of an underline used
+ * to indicate a spelling error.
+ *
+ * The width of the underline is rounded to an integer number of up/down
+ * segments and the resulting rectangle is centered in the original rectangle.
+ * @param cr - a Cairo context
+ * @param x - The X coordinate of one corner of the rectangle
+ * @param y - The Y coordinate of one corner of the rectangle
+ * @param width - Non-negative width of the rectangle
+ * @param height - Non-negative height of the rectangle
+ */
 export const errorUnderlinePath = (cr, x, y, width, height) => {
     call("libpangocairo-1.0.so.0", "pango_cairo_error_underline_path", [
         {
@@ -136,10 +218,47 @@ export const errorUnderlinePath = (cr, x, y, width, height) => {
         },
     ], { type: "undefined" });
 };
+/**
+ * Gets a default `PangoCairoFontMap` to use with Cairo.
+ *
+ * Note that the type of the returned object will depend on the
+ * particular font backend Cairo was compiled to use; you generally
+ * should only use the `PangoFontMap` and `PangoCairoFontMap`
+ * interfaces on the returned object.
+ *
+ * The default Cairo fontmap can be changed by using
+ * [method@PangoCairo.FontMap.set_default]. This can be used to
+ * change the Cairo font backend that the default fontmap uses
+ * for example.
+ *
+ * Note that since Pango 1.32.6, the default fontmap is per-thread.
+ * Each thread gets its own default fontmap. In this way, PangoCairo
+ * can be used safely from multiple threads.
+ */
 export const fontMapGetDefault = () => {
     const ptr = call("libpangocairo-1.0.so.0", "pango_cairo_font_map_get_default", [], { type: "gobject", borrowed: true });
     return getObject(ptr, Pango.FontMap);
 };
+/**
+ * Creates a new `PangoCairoFontMap` object.
+ *
+ * A fontmap is used to cache information about available fonts,
+ * and holds certain global parameters such as the resolution.
+ * In most cases, you can use `func@PangoCairo.font_map_get_default]
+ * instead.
+ *
+ * Note that the type of the returned object will depend
+ * on the particular font backend Cairo was compiled to use;
+ * You generally should only use the `PangoFontMap` and
+ * `PangoCairoFontMap` interfaces on the returned object.
+ *
+ * You can override the type of backend returned by using an
+ * environment variable %PANGOCAIRO_BACKEND. Supported types,
+ * based on your build, are fc (fontconfig), win32, and coretext.
+ * If requested type is not available, NULL is returned. Ie.
+ * this is only useful for testing, when at least two backends
+ * are compiled in.
+ */
 export const fontMapNew = () => {
     const ptr = call("libpangocairo-1.0.so.0", "pango_cairo_font_map_new", [], {
         type: "gobject",
@@ -147,6 +266,14 @@ export const fontMapNew = () => {
     });
     return getObject(ptr, Pango.FontMap);
 };
+/**
+ * Creates a new `PangoCairoFontMap` object of the type suitable
+ * to be used with cairo font backend of type @fonttype.
+ *
+ * In most cases one should simply use [func@PangoCairo.FontMap.new], or
+ * in fact in most of those cases, just use [func@PangoCairo.FontMap.get_default].
+ * @param fonttype - desired #cairo_font_type_t
+ */
 export const fontMapNewForFontType = (fonttype) => {
     const ptr = call("libpangocairo-1.0.so.0", "pango_cairo_font_map_new_for_font_type", [
         {
@@ -158,6 +285,16 @@ export const fontMapNewForFontType = (fonttype) => {
         return null;
     return getObject(ptr, Pango.FontMap);
 };
+/**
+ * Adds the glyphs in `glyphs` to the current path in the specified
+ * cairo context.
+ *
+ * The origin of the glyphs (the left edge of the baseline)
+ * will be at the current point of the cairo context.
+ * @param cr - a Cairo context
+ * @param font - a `PangoFont` from a `PangoCairoFontMap`
+ * @param glyphs - a `PangoGlyphString`
+ */
 export const glyphStringPath = (cr, font, glyphs) => {
     call("libpangocairo-1.0.so.0", "pango_cairo_glyph_string_path", [
         {
@@ -184,6 +321,15 @@ export const glyphStringPath = (cr, font, glyphs) => {
         },
     ], { type: "undefined" });
 };
+/**
+ * Adds the text in `PangoLayoutLine` to the current path in the
+ * specified cairo context.
+ *
+ * The origin of the glyphs (the left edge of the line) will be
+ * at the current point of the cairo context.
+ * @param cr - a Cairo context
+ * @param line - a `PangoLayoutLine`
+ */
 export const layoutLinePath = (cr, line) => {
     call("libpangocairo-1.0.so.0", "pango_cairo_layout_line_path", [
         {
@@ -206,6 +352,15 @@ export const layoutLinePath = (cr, line) => {
         },
     ], { type: "undefined" });
 };
+/**
+ * Adds the text in a `PangoLayout` to the current path in the
+ * specified cairo context.
+ *
+ * The top-left corner of the `PangoLayout` will be at the
+ * current point of the cairo context.
+ * @param cr - a Cairo context
+ * @param layout - a Pango layout
+ */
 export const layoutPath = (cr, layout) => {
     call("libpangocairo-1.0.so.0", "pango_cairo_layout_path", [
         {
@@ -223,6 +378,20 @@ export const layoutPath = (cr, layout) => {
         },
     ], { type: "undefined" });
 };
+/**
+ * Draw a squiggly line in the specified cairo context that approximately
+ * covers the given rectangle in the style of an underline used to indicate a
+ * spelling error.
+ *
+ * The width of the underline is rounded to an integer
+ * number of up/down segments and the resulting rectangle is centered in the
+ * original rectangle.
+ * @param cr - a Cairo context
+ * @param x - The X coordinate of one corner of the rectangle
+ * @param y - The Y coordinate of one corner of the rectangle
+ * @param width - Non-negative width of the rectangle
+ * @param height - Non-negative height of the rectangle
+ */
 export const showErrorUnderline = (cr, x, y, width, height) => {
     call("libpangocairo-1.0.so.0", "pango_cairo_show_error_underline", [
         {
@@ -252,6 +421,22 @@ export const showErrorUnderline = (cr, x, y, width, height) => {
         },
     ], { type: "undefined" });
 };
+/**
+ * Draws the glyphs in `glyph_item` in the specified cairo context,
+ *
+ * embedding the text associated with the glyphs in the output if the
+ * output format supports it (PDF for example), otherwise it acts
+ * similar to [func@show_glyph_string].
+ *
+ * The origin of the glyphs (the left edge of the baseline) will
+ * be drawn at the current point of the cairo context.
+ *
+ * Note that `text` is the start of the text for layout, which is then
+ * indexed by `glyph_item->item->offset`.
+ * @param cr - a Cairo context
+ * @param text - the UTF-8 text that `glyph_item` refers to
+ * @param glyphItem - a `PangoGlyphItem`
+ */
 export const showGlyphItem = (cr, text, glyphItem) => {
     call("libpangocairo-1.0.so.0", "pango_cairo_show_glyph_item", [
         {
@@ -278,6 +463,15 @@ export const showGlyphItem = (cr, text, glyphItem) => {
         },
     ], { type: "undefined" });
 };
+/**
+ * Draws the glyphs in `glyphs` in the specified cairo context.
+ *
+ * The origin of the glyphs (the left edge of the baseline) will
+ * be drawn at the current point of the cairo context.
+ * @param cr - a Cairo context
+ * @param font - a `PangoFont` from a `PangoCairoFontMap`
+ * @param glyphs - a `PangoGlyphString`
+ */
 export const showGlyphString = (cr, font, glyphs) => {
     call("libpangocairo-1.0.so.0", "pango_cairo_show_glyph_string", [
         {
@@ -304,6 +498,14 @@ export const showGlyphString = (cr, font, glyphs) => {
         },
     ], { type: "undefined" });
 };
+/**
+ * Draws a `PangoLayout` in the specified cairo context.
+ *
+ * The top-left corner of the `PangoLayout` will be drawn
+ * at the current point of the cairo context.
+ * @param cr - a Cairo context
+ * @param layout - a Pango layout
+ */
 export const showLayout = (cr, layout) => {
     call("libpangocairo-1.0.so.0", "pango_cairo_show_layout", [
         {
@@ -321,6 +523,14 @@ export const showLayout = (cr, layout) => {
         },
     ], { type: "undefined" });
 };
+/**
+ * Draws a `PangoLayoutLine` in the specified cairo context.
+ *
+ * The origin of the glyphs (the left edge of the line) will
+ * be drawn at the current point of the cairo context.
+ * @param cr - a Cairo context
+ * @param line - a `PangoLayoutLine`
+ */
 export const showLayoutLine = (cr, line) => {
     call("libpangocairo-1.0.so.0", "pango_cairo_show_layout_line", [
         {
@@ -343,6 +553,16 @@ export const showLayoutLine = (cr, line) => {
         },
     ], { type: "undefined" });
 };
+/**
+ * Updates a `PangoContext` previously created for use with Cairo to
+ * match the current transformation and target surface of a Cairo
+ * context.
+ *
+ * If any layouts have been created for the context, it's necessary
+ * to call [method@Pango.Layout.context_changed] on those layouts.
+ * @param cr - a Cairo context
+ * @param context - a `PangoContext`, from a pangocairo font map
+ */
 export const updateContext = (cr, context) => {
     call("libpangocairo-1.0.so.0", "pango_cairo_update_context", [
         {
@@ -360,6 +580,13 @@ export const updateContext = (cr, context) => {
         },
     ], { type: "undefined" });
 };
+/**
+ * Updates the private `PangoContext` of a `PangoLayout` created with
+ * [func@create_layout] to match the current transformation and target
+ * surface of a Cairo context.
+ * @param cr - a Cairo context
+ * @param layout - a `PangoLayout`, from [func@create_layout]
+ */
 export const updateLayout = (cr, layout) => {
     call("libpangocairo-1.0.so.0", "pango_cairo_update_layout", [
         {

package/dist/gl/constants.d.ts

@@ -1,3 +1,7 @@
+/**
+ * OpenGL constants for use with GL functions.
+ * These are standard OpenGL enum values.
+ */
 export declare const GL_DEPTH_BUFFER_BIT = 256;
 export declare const GL_STENCIL_BUFFER_BIT = 1024;
 export declare const GL_COLOR_BUFFER_BIT = 16384;

package/dist/gl/constants.js

@@ -1,3 +1,7 @@
+/**
+ * OpenGL constants for use with GL functions.
+ * These are standard OpenGL enum values.
+ */
 export const GL_DEPTH_BUFFER_BIT = 0x00000100;
 export const GL_STENCIL_BUFFER_BIT = 0x00000400;
 export const GL_COLOR_BUFFER_BIT = 0x00004000;

package/dist/gl/gl.d.ts

@@ -1,43 +1,187 @@
+/**
+ * OpenGL function bindings via libGL.
+ * These wrap raw OpenGL calls for use in GtkGLArea render handlers.
+ */
+/**
+ * Clear buffers to preset values.
+ * @param mask - Bitwise OR of masks indicating buffers to clear (GL_COLOR_BUFFER_BIT, GL_DEPTH_BUFFER_BIT, etc.)
+ */
 export declare function glClear(mask: number): void;
+/**
+ * Specify clear values for the color buffers.
+ */
 export declare function glClearColor(red: number, green: number, blue: number, alpha: number): void;
+/**
+ * Set the viewport.
+ */
 export declare function glViewport(x: number, y: number, width: number, height: number): void;
+/**
+ * Enable server-side GL capabilities.
+ */
 export declare function glEnable(cap: number): void;
+/**
+ * Disable server-side GL capabilities.
+ */
 export declare function glDisable(cap: number): void;
+/**
+ * Specify the clear value for the depth buffer.
+ */
 export declare function glClearDepth(depth: number): void;
+/**
+ * Specify the value used for depth buffer comparisons.
+ */
 export declare function glDepthFunc(func: number): void;
+/**
+ * Creates a shader object.
+ * @param type - GL_VERTEX_SHADER or GL_FRAGMENT_SHADER
+ * @returns Shader object ID
+ */
 export declare function glCreateShader(type: number): number;
+/**
+ * Replaces the source code in a shader object.
+ * Note: This simplified version passes a single null-terminated string.
+ */
 export declare function glShaderSource(shader: number, source: string): void;
+/**
+ * Compiles a shader object.
+ */
 export declare function glCompileShader(shader: number): void;
+/**
+ * Returns a parameter from a shader object.
+ */
 export declare function glGetShaderiv(shader: number, pname: number): number;
+/**
+ * Returns the information log for a shader object.
+ */
 export declare function glGetShaderInfoLog(shader: number, _maxLength: number): string;
+/**
+ * Deletes a shader object.
+ */
 export declare function glDeleteShader(shader: number): void;
+/**
+ * Creates a program object.
+ */
 export declare function glCreateProgram(): number;
+/**
+ * Attaches a shader object to a program object.
+ */
 export declare function glAttachShader(program: number, shader: number): void;
+/**
+ * Links a program object.
+ */
 export declare function glLinkProgram(program: number): void;
+/**
+ * Installs a program object as part of current rendering state.
+ */
 export declare function glUseProgram(program: number): void;
+/**
+ * Returns a parameter from a program object.
+ */
 export declare function glGetProgramiv(program: number, pname: number): number;
+/**
+ * Returns the information log for a program object.
+ */
 export declare function glGetProgramInfoLog(program: number, _maxLength: number): string;
+/**
+ * Deletes a program object.
+ */
 export declare function glDeleteProgram(program: number): void;
+/**
+ * Returns the location of a uniform variable.
+ */
 export declare function glGetUniformLocation(program: number, name: string): number;
+/**
+ * Specify the value of a uniform variable (1 float).
+ */
 export declare function glUniform1f(location: number, v0: number): void;
+/**
+ * Specify the value of a uniform variable (2 floats).
+ */
 export declare function glUniform2f(location: number, v0: number, v1: number): void;
+/**
+ * Specify the value of a uniform variable (3 floats).
+ */
 export declare function glUniform3f(location: number, v0: number, v1: number, v2: number): void;
+/**
+ * Specify the value of a uniform variable (4 floats).
+ */
 export declare function glUniform4f(location: number, v0: number, v1: number, v2: number, v3: number): void;
+/**
+ * Specify the value of a uniform variable (1 int).
+ */
 export declare function glUniform1i(location: number, v0: number): void;
+/**
+ * Specify the value of a 4x4 matrix uniform variable.
+ */
 export declare function glUniformMatrix4fv(location: number, count: number, transpose: boolean, value: number[]): void;
+/**
+ * Generate a single vertex array object name.
+ */
 export declare function glGenVertexArray(): number;
+/**
+ * Bind a vertex array object.
+ */
 export declare function glBindVertexArray(array: number): void;
+/**
+ * Delete a vertex array object.
+ */
 export declare function glDeleteVertexArray(array: number): void;
+/**
+ * Generate a single buffer object name.
+ */
 export declare function glGenBuffer(): number;
+/**
+ * Bind a named buffer object.
+ */
 export declare function glBindBuffer(target: number, buffer: number): void;
+/**
+ * Delete a buffer object.
+ */
 export declare function glDeleteBuffer(buffer: number): void;
+/**
+ * Creates and initializes a buffer object's data store.
+ * @param target - Buffer target (GL_ARRAY_BUFFER, GL_ELEMENT_ARRAY_BUFFER, etc.)
+ * @param data - Array of float values
+ * @param usage - Usage hint (GL_STATIC_DRAW, GL_DYNAMIC_DRAW, etc.)
+ */
 export declare function glBufferData(target: number, data: number[], usage: number): void;
+/**
+ * Define an array of generic vertex attribute data.
+ */
 export declare function glVertexAttribPointer(index: number, size: number, type: number, normalized: boolean, stride: number, offset: number): void;
+/**
+ * Enable a generic vertex attribute array.
+ */
 export declare function glEnableVertexAttribArray(index: number): void;
+/**
+ * Disable a generic vertex attribute array.
+ */
 export declare function glDisableVertexAttribArray(index: number): void;
+/**
+ * Render primitives from array data.
+ */
 export declare function glDrawArrays(mode: number, first: number, count: number): void;
+/**
+ * Creates and initializes a buffer object's data store with unsigned short data.
+ * Use this for element/index buffers with GL_UNSIGNED_SHORT type.
+ * @param target - Buffer target (typically GL_ELEMENT_ARRAY_BUFFER)
+ * @param data - Array of unsigned short values (indices)
+ * @param usage - Usage hint (GL_STATIC_DRAW, GL_DYNAMIC_DRAW, etc.)
+ */
 export declare function glBufferDataUshort(target: number, data: number[], usage: number): void;
+/**
+ * Render primitives from array data with indices.
+ */
 export declare function glDrawElements(mode: number, count: number, type: number, offset: number): void;
+/**
+ * Returns the location of an attribute variable.
+ */
 export declare function glGetAttribLocation(program: number, name: string): number;
+/**
+ * Associate a generic vertex attribute index with a named attribute variable.
+ */
 export declare function glBindAttribLocation(program: number, index: number, name: string): void;
+/**
+ * Return error information.
+ */
 export declare function glGetError(): number;