@gtkx/ffi 0.1.45 → 0.1.47

package/dist/generated/gdk/gltexture-builder.d.ts

@@ -4,29 +4,186 @@ import { GLContext } from "./glcontext.js";
 import { Texture } from "./texture.js";
 import * as GObject from "../gobject/index.js";
 import * as cairo from "../cairo/index.js";
+/**
+ * Constructs [class@Gdk.Texture] objects from GL textures.
+ *
+ * The operation is quite simple: Create a texture builder, set all the necessary
+ * properties - keep in mind that the properties [property@Gdk.GLTextureBuilder:context],
+ * [property@Gdk.GLTextureBuilder:id], [property@Gdk.GLTextureBuilder:width], and
+ * [property@Gdk.GLTextureBuilder:height] are mandatory - and then call
+ * [method@Gdk.GLTextureBuilder.build] to create the new texture.
+ *
+ * `GdkGLTextureBuilder` can be used for quick one-shot construction of
+ * textures as well as kept around and reused to construct multiple textures.
+ */
 export declare class GLTextureBuilder extends GObject.GObject {
+    /**
+     * Creates a new texture builder.
+     */
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Builds a new `GdkTexture` with the values set up in the builder.
+     *
+     * The `destroy` function gets called when the returned texture gets released;
+     * either when the texture is finalized or by an explicit call to
+     * [method@Gdk.GLTexture.release]. It should release all GL resources associated
+     * with the texture, such as the [property@Gdk.GLTextureBuilder:id] and the
+     * [property@Gdk.GLTextureBuilder:sync].
+     *
+     * Note that it is a programming error to call this function if any mandatory
+     * property has not been set.
+     *
+     * It is possible to call this function multiple times to create multiple textures,
+     * possibly with changing properties in between.
+     * @param destroy - destroy function to be called when the texture is
+     * @param data - user data to pass to the destroy function
+     */
     build(destroy?: () => void | null, data?: number | null): Texture;
+    /**
+     * Gets the color state previously set via gdk_gl_texture_builder_set_color_state().
+     */
     getColorState(): ColorState;
+    /**
+     * Gets the context previously set via gdk_gl_texture_builder_set_context() or
+     * %NULL if none was set.
+     */
     getContext(): GLContext | null;
+    /**
+     * Gets the format previously set via gdk_gl_texture_builder_set_format().
+     */
     getFormat(): MemoryFormat;
+    /**
+     * Gets whether the texture has a mipmap.
+     */
     getHasMipmap(): boolean;
+    /**
+     * Gets the height previously set via gdk_gl_texture_builder_set_height() or
+     * 0 if the height wasn't set.
+     */
     getHeight(): number;
+    /**
+     * Gets the texture id previously set via gdk_gl_texture_builder_set_id() or
+     * 0 if the id wasn't set.
+     */
     getId(): number;
+    /**
+     * Gets the `GLsync` previously set via gdk_gl_texture_builder_set_sync().
+     */
     getSync(): number | null;
+    /**
+     * Gets the region previously set via gdk_gl_texture_builder_set_update_region() or
+     * %NULL if none was set.
+     */
     getUpdateRegion(): cairo.Region | null;
+    /**
+     * Gets the texture previously set via gdk_gl_texture_builder_set_update_texture() or
+     * %NULL if none was set.
+     */
     getUpdateTexture(): Texture | null;
+    /**
+     * Gets the width previously set via gdk_gl_texture_builder_set_width() or
+     * 0 if the width wasn't set.
+     */
     getWidth(): number;
+    /**
+     * Sets the color state for the texture.
+     *
+     * By default, the sRGB colorstate is used. If you don't know what
+     * colorstates are, this is probably the right thing.
+     * @param colorState - a `GdkColorState`
+     */
     setColorState(colorState: ColorState): void;
+    /**
+     * Sets the context to be used for the texture. This is the context that owns
+     * the texture.
+     *
+     * The context must be set before calling [method@Gdk.GLTextureBuilder.build].
+     * @param context - The context the texture belongs to or %NULL to unset
+     */
     setContext(context?: GLContext | null): void;
+    /**
+     * Sets the format of the texture. The default is `GDK_MEMORY_R8G8B8A8_PREMULTIPLIED`.
+     *
+     * The format is the preferred format the texture data should be downloaded to. The
+     * format must be supported by the GL version of [property@Gdk.GLTextureBuilder:context].
+     *
+     * GDK's texture download code assumes that the format corresponds to the storage
+     * parameters of the GL texture in an obvious way. For example, a format of
+     * `GDK_MEMORY_R16G16B16A16_PREMULTIPLIED` is expected to be stored as `GL_RGBA16`
+     * texture, and `GDK_MEMORY_G8A8` is expected to be stored as `GL_RG8` texture.
+     *
+     * Setting the right format is particularly useful when using high bit depth textures
+     * to preserve the bit depth, to set the correct value for unpremultiplied textures
+     * and to make sure opaque textures are treated as such.
+     *
+     * Non-RGBA textures need to have swizzling parameters set up properly to be usable
+     * in GSK's shaders.
+     * @param format - The texture's format
+     */
     setFormat(format: MemoryFormat): void;
+    /**
+     * Sets whether the texture has a mipmap. This allows the renderer and other users of the
+     * generated texture to use a higher quality downscaling.
+     *
+     * Typically, the `glGenerateMipmap` function is used to generate a mimap.
+     * @param hasMipmap - Whether the texture has a mipmap
+     */
     setHasMipmap(hasMipmap: boolean): void;
+    /**
+     * Sets the height of the texture.
+     *
+     * The height must be set before calling [method@Gdk.GLTextureBuilder.build].
+     * @param height - The texture's height or 0 to unset
+     */
     setHeight(height: number): void;
+    /**
+     * Sets the texture id of the texture. The texture id must remain unmodified
+     * until the texture was finalized. See [method@Gdk.GLTextureBuilder.build]
+     * for a longer discussion.
+     *
+     * The id must be set before calling [method@Gdk.GLTextureBuilder.build].
+     * @param id - The texture id to be used for creating the texture
+     */
     setId(id: number): void;
+    /**
+     * Sets the GLSync object to use for the texture.
+     *
+     * GTK will wait on this object before using the created `GdkTexture`.
+     *
+     * The `destroy` function that is passed to [method@Gdk.GLTextureBuilder.build]
+     * is responsible for freeing the sync object when it is no longer needed.
+     * The texture builder does not destroy it and it is the callers
+     * responsibility to make sure it doesn't leak.
+     * @param sync - the GLSync object
+     */
     setSync(sync?: number | null): void;
+    /**
+     * Sets the region to be updated by this texture. Together with
+     * [property@Gdk.GLTextureBuilder:update-texture] this describes an
+     * update of a previous texture.
+     *
+     * When rendering animations of large textures, it is possible that
+     * consecutive textures are only updating contents in parts of the texture.
+     * It is then possible to describe this update via these two properties,
+     * so that GTK can avoid rerendering parts that did not change.
+     *
+     * An example would be a screen recording where only the mouse pointer moves.
+     * @param region - the region to update
+     */
     setUpdateRegion(region?: cairo.Region | null): void;
+    /**
+     * Sets the texture to be updated by this texture. See
+     * [method@Gdk.GLTextureBuilder.set_update_region] for an explanation.
+     * @param texture - the texture to update
+     */
     setUpdateTexture(texture?: Texture | null): void;
+    /**
+     * Sets the width of the texture.
+     *
+     * The width must be set before calling [method@Gdk.GLTextureBuilder.build].
+     * @param width - The texture's width or 0 to unset
+     */
     setWidth(width: number): void;
     connect(signal: "notify", handler: (self: GLTextureBuilder, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;

package/dist/generated/gdk/gltexture-builder.js

@@ -5,7 +5,22 @@ import { GLContext } from "./glcontext.js";
 import { Texture } from "./texture.js";
 import * as GObject from "../gobject/index.js";
 import * as cairo from "../cairo/index.js";
+/**
+ * Constructs [class@Gdk.Texture] objects from GL textures.
+ *
+ * The operation is quite simple: Create a texture builder, set all the necessary
+ * properties - keep in mind that the properties [property@Gdk.GLTextureBuilder:context],
+ * [property@Gdk.GLTextureBuilder:id], [property@Gdk.GLTextureBuilder:width], and
+ * [property@Gdk.GLTextureBuilder:height] are mandatory - and then call
+ * [method@Gdk.GLTextureBuilder.build] to create the new texture.
+ *
+ * `GdkGLTextureBuilder` can be used for quick one-shot construction of
+ * textures as well as kept around and reused to construct multiple textures.
+ */
 export class GLTextureBuilder extends GObject.GObject {
+    /**
+     * Creates a new texture builder.
+     */
     constructor(...args) {
         super(...args);
     }
@@ -15,6 +30,23 @@ export class GLTextureBuilder extends GObject.GObject {
             borrowed: false,
         });
     }
+    /**
+     * Builds a new `GdkTexture` with the values set up in the builder.
+     *
+     * The `destroy` function gets called when the returned texture gets released;
+     * either when the texture is finalized or by an explicit call to
+     * [method@Gdk.GLTexture.release]. It should release all GL resources associated
+     * with the texture, such as the [property@Gdk.GLTextureBuilder:id] and the
+     * [property@Gdk.GLTextureBuilder:sync].
+     *
+     * Note that it is a programming error to call this function if any mandatory
+     * property has not been set.
+     *
+     * It is possible to call this function multiple times to create multiple textures,
+     * possibly with changing properties in between.
+     * @param destroy - destroy function to be called when the texture is
+     * @param data - user data to pass to the destroy function
+     */
     build(destroy, data) {
         const ptr = call("libgtk-4.so.1", "gdk_gl_texture_builder_build", [
             {
@@ -34,6 +66,9 @@ export class GLTextureBuilder extends GObject.GObject {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Texture);
     }
+    /**
+     * Gets the color state previously set via gdk_gl_texture_builder_set_color_state().
+     */
     getColorState() {
         const ptr = call("libgtk-4.so.1", "gdk_gl_texture_builder_get_color_state", [
             {
@@ -48,6 +83,10 @@ export class GLTextureBuilder extends GObject.GObject {
         });
         return getObject(ptr, ColorState);
     }
+    /**
+     * Gets the context previously set via gdk_gl_texture_builder_set_context() or
+     * %NULL if none was set.
+     */
     getContext() {
         const ptr = call("libgtk-4.so.1", "gdk_gl_texture_builder_get_context", [
             {
@@ -59,6 +98,9 @@ export class GLTextureBuilder extends GObject.GObject {
             return null;
         return getObject(ptr, GLContext);
     }
+    /**
+     * Gets the format previously set via gdk_gl_texture_builder_set_format().
+     */
     getFormat() {
         return call("libgtk-4.so.1", "gdk_gl_texture_builder_get_format", [
             {
@@ -67,6 +109,9 @@ export class GLTextureBuilder extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets whether the texture has a mipmap.
+     */
     getHasMipmap() {
         return call("libgtk-4.so.1", "gdk_gl_texture_builder_get_has_mipmap", [
             {
@@ -75,6 +120,10 @@ export class GLTextureBuilder extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Gets the height previously set via gdk_gl_texture_builder_set_height() or
+     * 0 if the height wasn't set.
+     */
     getHeight() {
         return call("libgtk-4.so.1", "gdk_gl_texture_builder_get_height", [
             {
@@ -83,6 +132,10 @@ export class GLTextureBuilder extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets the texture id previously set via gdk_gl_texture_builder_set_id() or
+     * 0 if the id wasn't set.
+     */
     getId() {
         return call("libgtk-4.so.1", "gdk_gl_texture_builder_get_id", [
             {
@@ -91,6 +144,9 @@ export class GLTextureBuilder extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: true });
     }
+    /**
+     * Gets the `GLsync` previously set via gdk_gl_texture_builder_set_sync().
+     */
     getSync() {
         return call("libgtk-4.so.1", "gdk_gl_texture_builder_get_sync", [
             {
@@ -99,6 +155,10 @@ export class GLTextureBuilder extends GObject.GObject {
             },
         ], { type: "int", size: 64, unsigned: true });
     }
+    /**
+     * Gets the region previously set via gdk_gl_texture_builder_set_update_region() or
+     * %NULL if none was set.
+     */
     getUpdateRegion() {
         const ptr = call("libgtk-4.so.1", "gdk_gl_texture_builder_get_update_region", [
             {
@@ -115,6 +175,10 @@ export class GLTextureBuilder extends GObject.GObject {
             return null;
         return getObject(ptr, cairo.Region);
     }
+    /**
+     * Gets the texture previously set via gdk_gl_texture_builder_set_update_texture() or
+     * %NULL if none was set.
+     */
     getUpdateTexture() {
         const ptr = call("libgtk-4.so.1", "gdk_gl_texture_builder_get_update_texture", [
             {
@@ -126,6 +190,10 @@ export class GLTextureBuilder extends GObject.GObject {
             return null;
         return getObject(ptr, Texture);
     }
+    /**
+     * Gets the width previously set via gdk_gl_texture_builder_set_width() or
+     * 0 if the width wasn't set.
+     */
     getWidth() {
         return call("libgtk-4.so.1", "gdk_gl_texture_builder_get_width", [
             {
@@ -134,6 +202,13 @@ export class GLTextureBuilder extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Sets the color state for the texture.
+     *
+     * By default, the sRGB colorstate is used. If you don't know what
+     * colorstates are, this is probably the right thing.
+     * @param colorState - a `GdkColorState`
+     */
     setColorState(colorState) {
         call("libgtk-4.so.1", "gdk_gl_texture_builder_set_color_state", [
             {
@@ -151,6 +226,13 @@ export class GLTextureBuilder extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the context to be used for the texture. This is the context that owns
+     * the texture.
+     *
+     * The context must be set before calling [method@Gdk.GLTextureBuilder.build].
+     * @param context - The context the texture belongs to or %NULL to unset
+     */
     setContext(context) {
         call("libgtk-4.so.1", "gdk_gl_texture_builder_set_context", [
             {
@@ -164,6 +246,25 @@ export class GLTextureBuilder extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the format of the texture. The default is `GDK_MEMORY_R8G8B8A8_PREMULTIPLIED`.
+     *
+     * The format is the preferred format the texture data should be downloaded to. The
+     * format must be supported by the GL version of [property@Gdk.GLTextureBuilder:context].
+     *
+     * GDK's texture download code assumes that the format corresponds to the storage
+     * parameters of the GL texture in an obvious way. For example, a format of
+     * `GDK_MEMORY_R16G16B16A16_PREMULTIPLIED` is expected to be stored as `GL_RGBA16`
+     * texture, and `GDK_MEMORY_G8A8` is expected to be stored as `GL_RG8` texture.
+     *
+     * Setting the right format is particularly useful when using high bit depth textures
+     * to preserve the bit depth, to set the correct value for unpremultiplied textures
+     * and to make sure opaque textures are treated as such.
+     *
+     * Non-RGBA textures need to have swizzling parameters set up properly to be usable
+     * in GSK's shaders.
+     * @param format - The texture's format
+     */
     setFormat(format) {
         call("libgtk-4.so.1", "gdk_gl_texture_builder_set_format", [
             {
@@ -176,6 +277,13 @@ export class GLTextureBuilder extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether the texture has a mipmap. This allows the renderer and other users of the
+     * generated texture to use a higher quality downscaling.
+     *
+     * Typically, the `glGenerateMipmap` function is used to generate a mimap.
+     * @param hasMipmap - Whether the texture has a mipmap
+     */
     setHasMipmap(hasMipmap) {
         call("libgtk-4.so.1", "gdk_gl_texture_builder_set_has_mipmap", [
             {
@@ -188,6 +296,12 @@ export class GLTextureBuilder extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the height of the texture.
+     *
+     * The height must be set before calling [method@Gdk.GLTextureBuilder.build].
+     * @param height - The texture's height or 0 to unset
+     */
     setHeight(height) {
         call("libgtk-4.so.1", "gdk_gl_texture_builder_set_height", [
             {
@@ -200,6 +314,14 @@ export class GLTextureBuilder extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the texture id of the texture. The texture id must remain unmodified
+     * until the texture was finalized. See [method@Gdk.GLTextureBuilder.build]
+     * for a longer discussion.
+     *
+     * The id must be set before calling [method@Gdk.GLTextureBuilder.build].
+     * @param id - The texture id to be used for creating the texture
+     */
     setId(id) {
         call("libgtk-4.so.1", "gdk_gl_texture_builder_set_id", [
             {
@@ -212,6 +334,17 @@ export class GLTextureBuilder extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the GLSync object to use for the texture.
+     *
+     * GTK will wait on this object before using the created `GdkTexture`.
+     *
+     * The `destroy` function that is passed to [method@Gdk.GLTextureBuilder.build]
+     * is responsible for freeing the sync object when it is no longer needed.
+     * The texture builder does not destroy it and it is the callers
+     * responsibility to make sure it doesn't leak.
+     * @param sync - the GLSync object
+     */
     setSync(sync) {
         call("libgtk-4.so.1", "gdk_gl_texture_builder_set_sync", [
             {
@@ -225,6 +358,19 @@ export class GLTextureBuilder extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the region to be updated by this texture. Together with
+     * [property@Gdk.GLTextureBuilder:update-texture] this describes an
+     * update of a previous texture.
+     *
+     * When rendering animations of large textures, it is possible that
+     * consecutive textures are only updating contents in parts of the texture.
+     * It is then possible to describe this update via these two properties,
+     * so that GTK can avoid rerendering parts that did not change.
+     *
+     * An example would be a screen recording where only the mouse pointer moves.
+     * @param region - the region to update
+     */
     setUpdateRegion(region) {
         call("libgtk-4.so.1", "gdk_gl_texture_builder_set_update_region", [
             {
@@ -243,6 +389,11 @@ export class GLTextureBuilder extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the texture to be updated by this texture. See
+     * [method@Gdk.GLTextureBuilder.set_update_region] for an explanation.
+     * @param texture - the texture to update
+     */
     setUpdateTexture(texture) {
         call("libgtk-4.so.1", "gdk_gl_texture_builder_set_update_texture", [
             {
@@ -256,6 +407,12 @@ export class GLTextureBuilder extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the width of the texture.
+     *
+     * The width must be set before calling [method@Gdk.GLTextureBuilder.build].
+     * @param width - The texture's width or 0 to unset
+     */
     setWidth(width) {
         call("libgtk-4.so.1", "gdk_gl_texture_builder_set_width", [
             {

package/dist/generated/gdk/gltexture.d.ts

@@ -1,8 +1,29 @@
 import { GLContext } from "./glcontext.js";
 import { Texture } from "./texture.js";
+/** A `GdkTexture` representing a GL texture object. */
 export declare class GLTexture extends Texture {
+    /**
+     * Creates a new texture for an existing GL texture.
+     *
+     * Note that the GL texture must not be modified until `destroy` is called,
+     * which will happen when the GdkTexture object is finalized, or due to
+     * an explicit call of [method@Gdk.GLTexture.release].
+     * @param context - a `GdkGLContext`
+     * @param id - the ID of a texture that was created with @context
+     * @param width - the nominal width of the texture
+     * @param height - the nominal height of the texture
+     * @param destroy - a destroy notify that will be called when the GL resources
+     * @param data - data that gets passed to @destroy
+     */
     constructor(context: GLContext, id: number, width: number, height: number, destroy: () => void, data?: number | null);
     constructor(...args: unknown[]);
     protected createPtr(args: unknown[]): unknown;
+    /**
+     * Releases the GL resources held by a `GdkGLTexture`.
+     *
+     * The texture contents are still available via the
+     * [method@Gdk.Texture.download] function, after this
+     * function has been called.
+     */
     release(): void;
 }

package/dist/generated/gdk/gltexture.js

@@ -1,5 +1,6 @@
 import { call } from "@gtkx/native";
 import { Texture } from "./texture.js";
+/** A `GdkTexture` representing a GL texture object. */
 export class GLTexture extends Texture {
     constructor(...args) {
         super(...args);
@@ -34,6 +35,13 @@ export class GLTexture extends Texture {
             },
         ], { type: "gobject", borrowed: false });
     }
+    /**
+     * Releases the GL resources held by a `GdkGLTexture`.
+     *
+     * The texture contents are still available via the
+     * [method@Gdk.Texture.download] function, after this
+     * function has been called.
+     */
     release() {
         call("libgtk-4.so.1", "gdk_gl_texture_release", [
             {

package/dist/generated/gdk/grab-broken-event.d.ts

@@ -1,8 +1,15 @@
 import { Surface } from "./surface.js";
 import { Event } from "./event.js";
+/** An event related to a broken windowing system grab. */
 export declare class GrabBrokenEvent extends Event {
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Extracts the grab surface from a grab broken event.
+     */
     getGrabSurface(): Surface;
+    /**
+     * Checks whether the grab broken event is for an implicit grab.
+     */
     getImplicit(): boolean;
 }

package/dist/generated/gdk/grab-broken-event.js

@@ -2,6 +2,7 @@ import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import { Surface } from "./surface.js";
 import { Event } from "./event.js";
+/** An event related to a broken windowing system grab. */
 export class GrabBrokenEvent extends Event {
     constructor(...args) {
         super(...args);
@@ -17,6 +18,9 @@ export class GrabBrokenEvent extends Event {
             { type: { type: "gobject" }, value: null },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * Extracts the grab surface from a grab broken event.
+     */
     getGrabSurface() {
         const ptr = call("libgtk-4.so.1", "gdk_grab_broken_event_get_grab_surface", [
             {
@@ -26,6 +30,9 @@ export class GrabBrokenEvent extends Event {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Surface);
     }
+    /**
+     * Checks whether the grab broken event is for an implicit grab.
+     */
     getImplicit() {
         return call("libgtk-4.so.1", "gdk_grab_broken_event_get_implicit", [
             {

package/dist/generated/gdk/key-event.d.ts

@@ -1,15 +1,54 @@
 import { Ref } from "@gtkx/native";
 import { KeyMatch, ModifierType } from "./enums.js";
 import { Event } from "./event.js";
+/** An event related to a key-based device. */
 export declare class KeyEvent extends Event {
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Extracts the consumed modifiers from a key event.
+     */
     getConsumedModifiers(): ModifierType;
+    /**
+     * Extracts the keycode from a key event.
+     */
     getKeycode(): number;
+    /**
+     * Extracts the keyval from a key event.
+     */
     getKeyval(): number;
+    /**
+     * Extracts the layout from a key event.
+     */
     getLayout(): number;
+    /**
+     * Extracts the shift level from a key event.
+     */
     getLevel(): number;
+    /**
+     * Gets a keyval and modifier combination that will match
+     * the event.
+     *
+     * See [method@Gdk.KeyEvent.matches].
+     * @param keyval - return location for a keyval
+     * @param modifiers - return location for modifiers
+     */
     getMatch(keyval: Ref<number>, modifiers: Ref<ModifierType>): boolean;
+    /**
+     * Extracts whether the key event is for a modifier key.
+     */
     isModifier(): boolean;
+    /**
+     * Matches a key event against a keyval and modifiers.
+     *
+     * This is typically used to trigger keyboard shortcuts such as Ctrl-C.
+     *
+     * Partial matches are possible where the combination matches
+     * if the currently active group is ignored.
+     *
+     * Note that we ignore Caps Lock for matching.
+     * @param keyval - the keyval to match
+     * @param modifiers - the modifiers to match
+     */
     matches(keyval: number, modifiers: ModifierType): KeyMatch;
 }