@gtkx/ffi 0.1.45 → 0.1.46

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

@@ -1,6 +1,10 @@
 import { Event } from "./event.js";
+/** An event related to a button on a pointer device. */
 export declare class ButtonEvent extends Event {
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Extract the button number from a button event.
+     */
     getButton(): number;
 }

package/dist/generated/gdk/button-event.js

@@ -1,5 +1,6 @@
 import { call } from "@gtkx/native";
 import { Event } from "./event.js";
+/** An event related to a button on a pointer device. */
 export class ButtonEvent extends Event {
     constructor(...args) {
         super(...args);
@@ -15,6 +16,9 @@ export class ButtonEvent extends Event {
             { type: { type: "gobject" }, value: null },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * Extract the button number from a button event.
+     */
     getButton() {
         return call("libgtk-4.so.1", "gdk_button_event_get_button", [
             {

package/dist/generated/gdk/cairo-context.d.ts

@@ -1,7 +1,24 @@
 import * as cairo from "../cairo/index.js";
 import { DrawContext } from "./draw-context.js";
+/**
+ * Represents the platform-specific draw context.
+ *
+ * `GdkCairoContext`s are created for a surface using
+ * [method@Gdk.Surface.create_cairo_context], and the context
+ * can then be used to draw on that surface.
+ */
 export declare class CairoContext extends DrawContext {
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Retrieves a Cairo context to be used to draw on the `GdkSurface`
+     * of @context.
+     *
+     * A call to [method@Gdk.DrawContext.begin_frame] with this
+     * `context` must have been done or this function will return %NULL.
+     *
+     * The returned context is guaranteed to be valid until
+     * [method@Gdk.DrawContext.end_frame] is called.
+     */
     cairoCreate(): cairo.Context | null;
 }

package/dist/generated/gdk/cairo-context.js

@@ -2,6 +2,13 @@ import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import * as cairo from "../cairo/index.js";
 import { DrawContext } from "./draw-context.js";
+/**
+ * Represents the platform-specific draw context.
+ *
+ * `GdkCairoContext`s are created for a surface using
+ * [method@Gdk.Surface.create_cairo_context], and the context
+ * can then be used to draw on that surface.
+ */
 export class CairoContext extends DrawContext {
     constructor(...args) {
         super(...args);
@@ -17,6 +24,16 @@ export class CairoContext extends DrawContext {
             { type: { type: "gobject" }, value: null },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * Retrieves a Cairo context to be used to draw on the `GdkSurface`
+     * of @context.
+     *
+     * A call to [method@Gdk.DrawContext.begin_frame] with this
+     * `context` must have been done or this function will return %NULL.
+     *
+     * The returned context is guaranteed to be valid until
+     * [method@Gdk.DrawContext.end_frame] is called.
+     */
     cairoCreate() {
         const ptr = call("libgtk-4.so.1", "gdk_cairo_context_cairo_create", [
             {

package/dist/generated/gdk/cicp-params.d.ts

@@ -1,17 +1,81 @@
 import { CicpRange } from "./enums.js";
 import { ColorState } from "./color-state.js";
 import * as GObject from "../gobject/index.js";
+/**
+ * Contains the parameters that define a colorstate with cicp parameters.
+ *
+ * Cicp parameters are specified in the ITU-T H.273
+ * [specification](https://www.itu.int/rec/T-REC-H.273/en).
+ *
+ * See the documentation of individual properties for supported values.
+ *
+ * The 'unspecified' value (2) is not treated in any special way, and
+ * must be replaced by a different value before creating a color state.
+ *
+ * `GdkCicpParams` can be used as a builder object to construct a color
+ * state from Cicp data with [method@Gdk.CicpParams.build_color_state].
+ * The function will return an error if the given parameters are not
+ * supported.
+ *
+ * You can obtain a `GdkCicpParams` object from a color state with
+ * [method@Gdk.ColorState.create_cicp_params]. This can be used to
+ * create a variant of a color state, by changing just one of the cicp
+ * parameters, or just to obtain information about the color state.
+ */
 export declare class CicpParams extends GObject.GObject {
+    /**
+     * Creates a new `GdkCicpParams` object.
+     *
+     * The initial values of the properties are the values for "undefined"
+     * and need to be set before a color state object can be built.
+     */
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Creates a new `GdkColorState` object for the cicp parameters in @self.
+     *
+     * Note that this may fail if the cicp parameters in `self` are not
+     * supported by GTK. In that case, `NULL` is returned, and `error` is set
+     * with an error message that can be presented to the user.
+     */
     buildColorState(): ColorState;
+    /**
+     * Returns the value of the color-primaries property
+     * of @self.
+     */
     getColorPrimaries(): number;
+    /**
+     * Gets the matrix-coefficients property of @self.
+     */
     getMatrixCoefficients(): number;
+    /**
+     * Gets the range property of @self.
+     */
     getRange(): CicpRange;
+    /**
+     * Gets the transfer-function property of @self.
+     */
     getTransferFunction(): number;
+    /**
+     * Sets the color-primaries property of @self.
+     * @param colorPrimaries - the new color primaries value
+     */
     setColorPrimaries(colorPrimaries: number): void;
+    /**
+     * `self` a `GdkCicpParams`
+     * Sets the matrix-coefficients property of @self.
+     * @param matrixCoefficients - the new matrix-coefficients value
+     */
     setMatrixCoefficients(matrixCoefficients: number): void;
+    /**
+     * Sets the range property of @self
+     * @param range - the range value
+     */
     setRange(range: CicpRange): void;
+    /**
+     * Sets the transfer-function property of @self.
+     * @param transferFunction - the new transfer-function value
+     */
     setTransferFunction(transferFunction: number): void;
     connect(signal: "notify", handler: (self: CicpParams, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;

package/dist/generated/gdk/cicp-params.js

@@ -2,7 +2,34 @@ import { call } from "@gtkx/native";
 import { NativeError, getObject } from "@gtkx/ffi";
 import { ColorState } from "./color-state.js";
 import * as GObject from "../gobject/index.js";
+/**
+ * Contains the parameters that define a colorstate with cicp parameters.
+ *
+ * Cicp parameters are specified in the ITU-T H.273
+ * [specification](https://www.itu.int/rec/T-REC-H.273/en).
+ *
+ * See the documentation of individual properties for supported values.
+ *
+ * The 'unspecified' value (2) is not treated in any special way, and
+ * must be replaced by a different value before creating a color state.
+ *
+ * `GdkCicpParams` can be used as a builder object to construct a color
+ * state from Cicp data with [method@Gdk.CicpParams.build_color_state].
+ * The function will return an error if the given parameters are not
+ * supported.
+ *
+ * You can obtain a `GdkCicpParams` object from a color state with
+ * [method@Gdk.ColorState.create_cicp_params]. This can be used to
+ * create a variant of a color state, by changing just one of the cicp
+ * parameters, or just to obtain information about the color state.
+ */
 export class CicpParams extends GObject.GObject {
+    /**
+     * Creates a new `GdkCicpParams` object.
+     *
+     * The initial values of the properties are the values for "undefined"
+     * and need to be set before a color state object can be built.
+     */
     constructor(...args) {
         super(...args);
     }
@@ -12,6 +39,13 @@ export class CicpParams extends GObject.GObject {
             borrowed: false,
         });
     }
+    /**
+     * Creates a new `GdkColorState` object for the cicp parameters in @self.
+     *
+     * Note that this may fail if the cicp parameters in `self` are not
+     * supported by GTK. In that case, `NULL` is returned, and `error` is set
+     * with an error message that can be presented to the user.
+     */
     buildColorState() {
         const error = { value: null };
         const ptr = call("libgtk-4.so.1", "gdk_cicp_params_build_color_state", [
@@ -41,6 +75,10 @@ export class CicpParams extends GObject.GObject {
         }
         return getObject(ptr, ColorState);
     }
+    /**
+     * Returns the value of the color-primaries property
+     * of @self.
+     */
     getColorPrimaries() {
         return call("libgtk-4.so.1", "gdk_cicp_params_get_color_primaries", [
             {
@@ -49,6 +87,9 @@ export class CicpParams extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: true });
     }
+    /**
+     * Gets the matrix-coefficients property of @self.
+     */
     getMatrixCoefficients() {
         return call("libgtk-4.so.1", "gdk_cicp_params_get_matrix_coefficients", [
             {
@@ -57,6 +98,9 @@ export class CicpParams extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: true });
     }
+    /**
+     * Gets the range property of @self.
+     */
     getRange() {
         return call("libgtk-4.so.1", "gdk_cicp_params_get_range", [
             {
@@ -65,6 +109,9 @@ export class CicpParams extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets the transfer-function property of @self.
+     */
     getTransferFunction() {
         return call("libgtk-4.so.1", "gdk_cicp_params_get_transfer_function", [
             {
@@ -73,6 +120,10 @@ export class CicpParams extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: true });
     }
+    /**
+     * Sets the color-primaries property of @self.
+     * @param colorPrimaries - the new color primaries value
+     */
     setColorPrimaries(colorPrimaries) {
         call("libgtk-4.so.1", "gdk_cicp_params_set_color_primaries", [
             {
@@ -85,6 +136,11 @@ export class CicpParams extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * `self` a `GdkCicpParams`
+     * Sets the matrix-coefficients property of @self.
+     * @param matrixCoefficients - the new matrix-coefficients value
+     */
     setMatrixCoefficients(matrixCoefficients) {
         call("libgtk-4.so.1", "gdk_cicp_params_set_matrix_coefficients", [
             {
@@ -97,6 +153,10 @@ export class CicpParams extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the range property of @self
+     * @param range - the range value
+     */
     setRange(range) {
         call("libgtk-4.so.1", "gdk_cicp_params_set_range", [
             {
@@ -109,6 +169,10 @@ export class CicpParams extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the transfer-function property of @self.
+     * @param transferFunction - the new transfer-function value
+     */
     setTransferFunction(transferFunction) {
         call("libgtk-4.so.1", "gdk_cicp_params_set_transfer_function", [
             {

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

@@ -8,16 +8,87 @@ import * as Gio from "../gio/index.js";
 export declare class Clipboard extends GObject.GObject {
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Returns the `GdkContentProvider` currently set on @clipboard.
+     *
+     * If the `clipboard` is empty or its contents are not owned by the
+     * current process, %NULL will be returned.
+     */
     getContent(): ContentProvider | null;
+    /**
+     * Gets the `GdkDisplay` that the clipboard was created for.
+     */
     getDisplay(): Display;
+    /**
+     * Gets the formats that the clipboard can provide its current contents in.
+     */
     getFormats(): ContentFormats;
+    /**
+     * Returns if the clipboard is local.
+     *
+     * A clipboard is considered local if it was last claimed
+     * by the running application.
+     *
+     * Note that [method@Gdk.Clipboard.get_content] may return %NULL
+     * even on a local clipboard. In this case the clipboard is empty.
+     */
     isLocal(): boolean;
+    /**
+     * Finishes an asynchronous clipboard read.
+     *
+     * See [method@Gdk.Clipboard.read_async].
+     * @param result - a `GAsyncResult`
+     * @param outMimeType - location to store
+     */
     readFinish(result: Gio.AsyncResult, outMimeType?: Ref<string> | null): Gio.InputStream | null;
+    /**
+     * Finishes an asynchronous clipboard read.
+     *
+     * See [method@Gdk.Clipboard.read_text_async].
+     * @param result - a `GAsyncResult`
+     */
     readTextFinish(result: Gio.AsyncResult): string | null;
+    /**
+     * Finishes an asynchronous clipboard read.
+     *
+     * See [method@Gdk.Clipboard.read_texture_async].
+     * @param result - a `GAsyncResult`
+     */
     readTextureFinish(result: Gio.AsyncResult): Texture | null;
+    /**
+     * Finishes an asynchronous clipboard read.
+     *
+     * See [method@Gdk.Clipboard.read_value_async].
+     * @param result - a `GAsyncResult`
+     */
     readValueFinish(result: Gio.AsyncResult): GObject.Value;
+    /**
+     * Sets a new content provider on @clipboard.
+     *
+     * The clipboard will claim the `GdkDisplay`'s resources and advertise
+     * these new contents to other applications.
+     *
+     * In the rare case of a failure, this function will return %FALSE. The
+     * clipboard will then continue reporting its old contents and ignore
+     * @provider.
+     *
+     * If the contents are read by either an external application or the
+     * @clipboard's read functions, `clipboard` will select the best format to
+     * transfer the contents and then request that format from @provider.
+     * @param provider - the new contents of `clipboard`   or %NULL to clear the clipboard
+     */
     setContent(provider?: ContentProvider | null): boolean;
+    /**
+     * Sets the `clipboard` to contain the given @value.
+     * @param value - a `GValue` to set
+     */
     setValue(value: GObject.Value): void;
+    /**
+     * Finishes an asynchronous clipboard store.
+     *
+     * See [method@Gdk.Clipboard.store_async].
+     * @param result - a `GAsyncResult`
+     */
     storeFinish(result: Gio.AsyncResult): boolean;
     connect(signal: "changed", handler: (self: Clipboard) => void, after?: boolean): number;
     connect(signal: "notify", handler: (self: Clipboard, pspec: GObject.ParamSpec) => void, after?: boolean): number;

package/dist/generated/gdk/clipboard.js

@@ -6,6 +6,24 @@ import { Display } from "./display.js";
 import { Texture } from "./texture.js";
 import * as GObject from "../gobject/index.js";
 import * as Gio from "../gio/index.js";
+/**
+ * Represents data shared between applications or inside an application.
+ *
+ * To get a `GdkClipboard` object, use [method@Gdk.Display.get_clipboard] or
+ * [method@Gdk.Display.get_primary_clipboard]. You can find out about the data
+ * that is currently available in a clipboard using
+ * [method@Gdk.Clipboard.get_formats].
+ *
+ * To make text or image data available in a clipboard, use
+ * [method@Gdk.Clipboard.set_text] or [method@Gdk.Clipboard.set_texture].
+ * For other data, you can use [method@Gdk.Clipboard.set_content], which
+ * takes a [class@Gdk.ContentProvider] object.
+ *
+ * To read textual or image data from a clipboard, use
+ * [method@Gdk.Clipboard.read_text_async] or
+ * [method@Gdk.Clipboard.read_texture_async]. For other data, use
+ * [method@Gdk.Clipboard.read_async], which provides a `GInputStream` object.
+ */
 const SIGNAL_META = {
     changed: { params: [], returnType: { type: "undefined" } },
 };
@@ -24,6 +42,12 @@ export class Clipboard extends GObject.GObject {
             { type: { type: "gobject" }, value: null },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * Returns the `GdkContentProvider` currently set on @clipboard.
+     *
+     * If the `clipboard` is empty or its contents are not owned by the
+     * current process, %NULL will be returned.
+     */
     getContent() {
         const ptr = call("libgtk-4.so.1", "gdk_clipboard_get_content", [
             {
@@ -35,6 +59,9 @@ export class Clipboard extends GObject.GObject {
             return null;
         return getObject(ptr, ContentProvider);
     }
+    /**
+     * Gets the `GdkDisplay` that the clipboard was created for.
+     */
     getDisplay() {
         const ptr = call("libgtk-4.so.1", "gdk_clipboard_get_display", [
             {
@@ -44,6 +71,9 @@ export class Clipboard extends GObject.GObject {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Display);
     }
+    /**
+     * Gets the formats that the clipboard can provide its current contents in.
+     */
     getFormats() {
         const ptr = call("libgtk-4.so.1", "gdk_clipboard_get_formats", [
             {
@@ -58,6 +88,15 @@ export class Clipboard extends GObject.GObject {
         });
         return getObject(ptr, ContentFormats);
     }
+    /**
+     * Returns if the clipboard is local.
+     *
+     * A clipboard is considered local if it was last claimed
+     * by the running application.
+     *
+     * Note that [method@Gdk.Clipboard.get_content] may return %NULL
+     * even on a local clipboard. In this case the clipboard is empty.
+     */
     isLocal() {
         return call("libgtk-4.so.1", "gdk_clipboard_is_local", [
             {
@@ -66,6 +105,13 @@ export class Clipboard extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Finishes an asynchronous clipboard read.
+     *
+     * See [method@Gdk.Clipboard.read_async].
+     * @param result - a `GAsyncResult`
+     * @param outMimeType - location to store
+     */
     readFinish(result, outMimeType) {
         const error = { value: null };
         const ptr = call("libgtk-4.so.1", "gdk_clipboard_read_finish", [
@@ -101,6 +147,12 @@ export class Clipboard extends GObject.GObject {
             return null;
         return getObject(ptr, Gio.InputStream);
     }
+    /**
+     * Finishes an asynchronous clipboard read.
+     *
+     * See [method@Gdk.Clipboard.read_text_async].
+     * @param result - a `GAsyncResult`
+     */
     readTextFinish(result) {
         const error = { value: null };
         const _result = call("libgtk-4.so.1", "gdk_clipboard_read_text_finish", [
@@ -129,6 +181,12 @@ export class Clipboard extends GObject.GObject {
         }
         return _result;
     }
+    /**
+     * Finishes an asynchronous clipboard read.
+     *
+     * See [method@Gdk.Clipboard.read_texture_async].
+     * @param result - a `GAsyncResult`
+     */
     readTextureFinish(result) {
         const error = { value: null };
         const ptr = call("libgtk-4.so.1", "gdk_clipboard_read_texture_finish", [
@@ -159,6 +217,12 @@ export class Clipboard extends GObject.GObject {
             return null;
         return getObject(ptr, Texture);
     }
+    /**
+     * Finishes an asynchronous clipboard read.
+     *
+     * See [method@Gdk.Clipboard.read_value_async].
+     * @param result - a `GAsyncResult`
+     */
     readValueFinish(result) {
         const error = { value: null };
         const ptr = call("libgtk-4.so.1", "gdk_clipboard_read_value_finish", [
@@ -192,6 +256,21 @@ export class Clipboard extends GObject.GObject {
         }
         return getObject(ptr, GObject.Value);
     }
+    /**
+     * Sets a new content provider on @clipboard.
+     *
+     * The clipboard will claim the `GdkDisplay`'s resources and advertise
+     * these new contents to other applications.
+     *
+     * In the rare case of a failure, this function will return %FALSE. The
+     * clipboard will then continue reporting its old contents and ignore
+     * @provider.
+     *
+     * If the contents are read by either an external application or the
+     * @clipboard's read functions, `clipboard` will select the best format to
+     * transfer the contents and then request that format from @provider.
+     * @param provider - the new contents of `clipboard`   or %NULL to clear the clipboard
+     */
     setContent(provider) {
         return call("libgtk-4.so.1", "gdk_clipboard_set_content", [
             {
@@ -205,6 +284,10 @@ export class Clipboard extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Sets the `clipboard` to contain the given @value.
+     * @param value - a `GValue` to set
+     */
     setValue(value) {
         call("libgtk-4.so.1", "gdk_clipboard_set_value", [
             {
@@ -222,6 +305,12 @@ export class Clipboard extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Finishes an asynchronous clipboard store.
+     *
+     * See [method@Gdk.Clipboard.store_async].
+     * @param result - a `GAsyncResult`
+     */
     storeFinish(result) {
         const error = { value: null };
         const _result = call("libgtk-4.so.1", "gdk_clipboard_store_finish", [

package/dist/generated/gdk/color-state.d.ts

@@ -1,17 +1,113 @@
 import { CicpParams } from "./cicp-params.js";
+/**
+ * Provides information to interpret colors and pixels in a variety of ways.
+ *
+ * They are also known as
+ * [*color spaces*](https://en.wikipedia.org/wiki/Color_space).
+ *
+ * Crucially, GTK knows how to convert colors from one color
+ * state to another.
+ *
+ * `GdkColorState` objects are immutable and therefore threadsafe.
+ */
 export declare class ColorState {
     ptr: unknown;
     constructor();
     protected createPtr(_init: Record<string, unknown>): unknown;
+    /**
+     * Returns the color state object representing the oklab color space.
+     *
+     * This is a perceptually uniform color state.
+     */
     static getOklab(): ColorState;
+    /**
+     * Returns the color state object representing the oklch color space.
+     *
+     * This is the polar variant of oklab, in which the hue is encoded as
+     * a polar coordinate.
+     */
     static getOklch(): ColorState;
+    /**
+     * Returns the color state object representing the linear rec2100 color space.
+     *
+     * This color state uses the primaries defined by BT.2020-2 and BT.2100-0 and a linear
+     * transfer function.
+     *
+     * It is equivalent to the Cicp tuple 9/8/0/1.
+     *
+     * See e.g. [the CSS HDR Module](https://drafts.csswg.org/css-color-hdr/#valdef-color-rec2100-linear)
+     * for details about this colorstate.
+     */
     static getRec2100Linear(): ColorState;
+    /**
+     * Returns the color state object representing the rec2100-pq color space.
+     *
+     * This color state uses the primaries defined by BT.2020-2 and BT.2100-0 and the transfer
+     * function defined by SMPTE ST 2084 and BT.2100-2.
+     *
+     * It is equivalent to the Cicp tuple 9/16/0/1.
+     *
+     * See e.g. [the CSS HDR Module](https://drafts.csswg.org/css-color-hdr/#valdef-color-rec2100-pq)
+     * for details about this colorstate.
+     */
     static getRec2100Pq(): ColorState;
+    /**
+     * Returns the color state object representing the sRGB color space.
+     *
+     * This color state uses the primaries defined by BT.709-6 and the transfer function
+     * defined by IEC 61966-2-1.
+     *
+     * It is equivalent to the Cicp tuple 1/13/0/1.
+     *
+     * See e.g. [the CSS Color Module](https://www.w3.org/TR/css-color-4/#predefined-sRGB)
+     * for details about this colorstate.
+     */
     static getSrgb(): ColorState;
+    /**
+     * Returns the color state object representing the linearized sRGB color space.
+     *
+     * This color state uses the primaries defined by BT.709-6 and a linear transfer function.
+     *
+     * It is equivalent to the Cicp tuple 1/8/0/1.
+     *
+     * See e.g. [the CSS Color Module](https://www.w3.org/TR/css-color-4/#predefined-sRGB-linear)
+     * for details about this colorstate.
+     */
     static getSrgbLinear(): ColorState;
+    /**
+     * Create a [class@Gdk.CicpParams] representing the colorstate.
+     *
+     * It is not guaranteed that every `GdkColorState` can be
+     * represented with Cicp parameters. If that is the case,
+     * this function returns `NULL`.
+     */
     createCicpParams(): CicpParams | null;
+    /**
+     * Compares two `GdkColorStates` for equality.
+     *
+     * Note that this function is not guaranteed to be perfect and two objects
+     * describing the same color state may compare not equal. However, different
+     * color states will never compare equal.
+     * @param other - another `GdkColorStatee`
+     */
     equal(other: ColorState): boolean;
+    /**
+     * Compares two `GdkColorStates` for equivalence.
+     *
+     * Two objects that represent the same color state should be equivalent,
+     * even though they may not be equal in the sense of [method@Gdk.ColorState.equal].
+     * @param other - another `GdkColorStatee`
+     */
     equivalent(other: ColorState): boolean;
+    /**
+     * Increase the reference count of @self.
+     */
     ref(): ColorState;
+    /**
+     * Decrease the reference count of @self.
+     *
+     * Unless `self` is static, it will be freed
+     * when the reference count reaches zero.
+     */
     unref(): void;
 }