@pixerate/editor 0.125.0 → 0.127.0

package/dist/paint-editor/index.d.ts

@@ -3,21 +3,19 @@ import { D as Dab, C as CoverageMap, B as BrushSettings, e as StrokePoint, g as
 export { v as DEFAULT_FLOW, w as DEFAULT_PAINT_GRADIENT, x as DEFAULT_PAINT_GRADIENT_MAPPING, y as DEFAULT_WET_PARAMS, z as MAX_BRUSH_SIZE, A as PAINT_COLOR_JSON_SCHEMA, E as PAINT_GRADIENT_FULL_SPEED, F as PAINT_GRADIENT_JSON_SCHEMA, G as PAINT_GRADIENT_KIT, H as PAINT_GRADIENT_MAPPINGS, I as PAINT_GRADIENT_MAPPING_LABELS, J as PAINT_GRADIENT_PRESETS, K as PAINT_GRADIENT_REPEATS, L as PAINT_GRADIENT_REPEAT_LABELS, N as PAINT_GRADIENT_SPACES, O as PAINT_GRADIENT_SPACE_LABELS, Q as PAINT_SOURCE_JSON_SCHEMA, U as PaintColorSource, V as PaintDabParams, X as PaintGradientKit, Y as PaintGradientMapping, Z as PaintGradientMappingKind, _ as PaintGradientRepeat, $ as PaintGradientSample, a0 as PaintGradientSampler, a1 as PaintGradientSpace, a2 as PaintGradientStop, a3 as PaintRgb, a4 as PaintSourceError, a5 as WET_FLOW_KINDS, a6 as WET_PARAM_KEYS, a7 as WetFlowKind, a8 as WetSupport, a9 as addPaintGradientStop, aa as hash2, ab as hexToPaintRgb, ac as isGradientPaint, ad as mix32, ae as normalizeFlow, af as normalizeHexColor, ag as normalizeWetParams, ah as paintGradientMappingFor, ai as paintSourceColor, aj as paintSourceCss, ak as parsePaintSource, al as rand01, am as readPaintSource, an as removePaintGradientStop, ao as resolvePaintGradient, ap as reversePaintGradient, aq as scalePaintGradient, ar as solidPaint, as as updatePaintGradientStop, at as wetSupport } from '../rand-DtazXGOB.js';
 import { R as RasterRect, T as TiledSurface, a as BlendMode, b as BlendModeInfo } from '../surface-1MRncXpF.js';
 export { B as BLEND_MODES, P as PAINTERLY_BLEND_MODES, i as Tile, v as isBlendMode, w as isPainterlyBlendMode, I as standardBlendMode } from '../surface-1MRncXpF.js';
-import { I as ImageEditorAssetStore, S as SerializedLayer, P as PsdExportResult } from '../export-DAyPY94f.js';
-import { V as VideoProject, D as VideoFfmpegExport } from '../export-C1s4eolZ.js';
+import { e as EffectValue, E as EffectProvider, f as EffectDescription, a as EffectRenderRequest, b as EffectPixels, v as EffectsSlot } from '../helpers-CPWcK504.js';
+import { I as ImageEditorAssetStore, S as SerializedLayer, P as PsdExportResult } from '../export-PGhOpDmz.js';
+import { V as VideoProject, D as VideoFfmpegExport } from '../export-ClPKUB-v.js';
 import { g as PresenceStore, e as PresenceClock, d as PresenceActorInfo, c as PresenceActor, f as PresenceState } from '../presence-Cb6WhcrQ.js';
 import { a as AgentToolProvider, A as AgentTool } from '../registry-D-4fit9C.js';
 import '../types-CwMPoRMU.js';
-import '../builtin-CY97ppKM.js';
-import '../bezier-CWv6LQal.js';
-import '../brushTypes-IG7ZZjIN.js';
-import '../gradient-KDfCvhuj.js';
-import '../warp-k_PdtXOG.js';
-import '../helpers-BBLlekuM.js';
 import '../schema-Di0CS6Pe.js';
-import '../behavior-Ymbld6jL.js';
+import '../evaluate-BbCeF6pt.js';
 import '../easing-lM0Xo9Ni.js';
-import '../evaluate-CfmT6xA3.js';
+import '../builtin-CY97ppKM.js';
+import '../bezier-DWI5MEkI.js';
+import '../brushTypes-IG7ZZjIN.js';
+import '../warp-q8FK5HHi.js';
 
 /**
  * Seeded, deterministic noise for paper grain and brush jitter (photocraft's counter-based
@@ -1448,6 +1446,96 @@ declare function thickToJSON(ch: ThickChannels): SavedThickChannels | null;
 /** Saved form → channels; throws a sentence when it cannot be read. */
 declare function thickFromJSON(raw: unknown): ThickChannels;
 
+/**
+ * Provider effects in the paint editor (see `@pixerate/editor/effects`):
+ *
+ * - **Effect paper**: a generator drawn over the paper, under the paint (multiplied by default, so
+ *   the paper's grain and colour still show). It is part of the document: undo, save and export.
+ * - **Effect layers**: pixel layers drawn by a generator, overlay or title effect. The layer keeps
+ *   its effect, so it can be drawn again with new values; painting on it works as on any layer.
+ * - **Effect fills**: a generator, overlay or title effect composited onto a layer's pixels.
+ * - **Light on dried paint**: a filter effect (light, glow, grade) run on a layer's paint and baked
+ *   in. Wet paint is dried first, in the same undo step; thick paint keeps its relief.
+ *
+ * Effects render asynchronously, so each change renders first and commits after (one undo step).
+ */
+
+/** Which uses each place in the paint editor takes. */
+declare const PAINT_EFFECT_PLACES: {
+    /** Effect paper: drawn over the whole sheet. */
+    readonly paper: readonly ["generator"];
+    /** An effect layer: drawn at the canvas size. */
+    readonly layer: readonly ["generator", "overlay", "title"];
+    /** An effect fill: composited onto a layer's pixels. */
+    readonly fill: readonly ["generator", "overlay", "title"];
+    /** Light (or any filter) on a layer's dried paint. */
+    readonly light: readonly ["filter"];
+};
+type PaintEffectPlace = keyof typeof PAINT_EFFECT_PLACES;
+/** Refuses an effect that cannot go in `place`, saying what to use instead. */
+declare function checkPaintEffectPlace(d: EffectDescription, place: PaintEffectPlace): void;
+/** The provider effect a layer or the paper is drawn from. */
+interface PaintEffectSource {
+    effect: string;
+    /** The provider's id when it was drawn. */
+    provider?: string;
+    /** The effect's name when it was drawn (for placeholders without the provider). */
+    name?: string;
+    /** Every control value. */
+    values: Record<string, EffectValue>;
+    /** Which moment of an animated effect, in ms (missing: 0). */
+    time?: number;
+}
+/** Blend modes effect paper draws with. */
+declare const PAPER_EFFECT_BLENDS: readonly ["multiply", "normal", "overlay", "soft-light", "screen", "color"];
+type PaperEffectBlend = (typeof PAPER_EFFECT_BLENDS)[number];
+/** Effect paper: its effect, how it is drawn over the sheet, and its rendered pixels. */
+interface PaintPaperEffect extends PaintEffectSource {
+    /** 0..1 (default 1). */
+    opacity: number;
+    /** How it draws over the paper (default `multiply`, which keeps the paper's grain and colour). */
+    blend: PaperEffectBlend;
+    /** Canvas-sized straight-alpha RGBA. */
+    image: {
+        width: number;
+        height: number;
+        data: Uint8ClampedArray;
+    };
+    /** Changes whenever the pixels change (render caches key on it). */
+    version: number;
+}
+/** A new version number for effect paper pixels. */
+declare function nextPaperEffectVersion(): number;
+/** Over-composites `top` onto `base` at `opacity` (straight alpha, same size). */
+declare function overPixels(base: Uint8ClampedArray, top: ArrayLike<number>, opacity?: number): Uint8ClampedArray;
+/** Mixes `after` back towards `before` by `1 - amount` (for a filter at partial strength), keeping `before`'s alpha. */
+declare function mixPixels(before: Uint8ClampedArray, after: ArrayLike<number>, amount: number): Uint8ClampedArray;
+/**
+ * Renders effects for one paint editor through a small renderer pool (GPU providers hold a
+ * graphics context per renderer). Output always has the asked size.
+ */
+declare class PaintEffectsRenderer {
+    private readonly pool;
+    private readonly descriptions;
+    private provider;
+    /** Forgets cached descriptions and renderers when the provider changes. */
+    follow(provider: EffectProvider | null): void;
+    describe(provider: EffectProvider, id: string): Promise<EffectDescription>;
+    render(provider: EffectProvider, id: string, size: {
+        width: number;
+        height: number;
+    }, request: EffectRenderRequest): Promise<EffectPixels>;
+    dispose(): void;
+}
+/** A saved effect source, or `null` when it is not one. */
+declare function readPaintEffectSource(raw: unknown): PaintEffectSource | null;
+/** Effect paper as saved: its settings and its pixels as a PNG data URL. */
+declare function paperEffectToJSON(p: PaintPaperEffect): Record<string, unknown>;
+/** Reads saved effect paper for a `width × height` canvas (throws saying what is wrong). */
+declare function paperEffectFromJSON(raw: unknown, width: number, height: number): PaintPaperEffect;
+/** Effect layers as saved (layer id → effect). */
+declare function effectLayersToJSON(map: Readonly<Record<string, PaintEffectSource>>, keep: (id: string) => boolean): Record<string, PaintEffectSource> | undefined;
+
 /**
  * The paint editor's document: a canvas (size and resolution), a paper, and the shared raster
  * layer stack (`@pixerate/editor/raster`: pixel layers and groups with masks, clipping, locks and
@@ -1489,6 +1577,10 @@ interface PaintDocumentState {
     stickers?: Readonly<Record<string, Sticker[]>>;
     /** Thick paint: each layer's height and material channels (layers without relief are missing). */
     thick?: Readonly<Record<string, ThickChannels>>;
+    /** Effect layers: the provider effect each one is drawn from (layers that are gone are ignored). */
+    effectLayers?: Readonly<Record<string, PaintEffectSource>>;
+    /** Effect paper: a provider generator drawn over the paper, under the paint. */
+    paperEffect?: PaintPaperEffect;
 }
 /** A change a replay repeats besides strokes, recorded with how many strokes came before it. */
 interface PaintEvent {
@@ -1742,14 +1834,14 @@ interface PaperNode extends CompositorLayer {
         elevation: number;
     };
 }
-/** A view-only RGBA image under the paint (the tracing image), drawn at its opacity. */
+/** An RGBA image under the paint (the tracing image, effect paper), drawn at its opacity and blend. */
 interface ImageNode extends CompositorLayer {
     type: 'image';
     id: string;
     name: string;
     visible: boolean;
     opacity: number;
-    blend: 'normal';
+    blend: string;
     /** Canvas-sized RGBA. */
     image: {
         width: number;
@@ -1762,6 +1854,7 @@ interface ImageNode extends CompositorLayer {
 type ViewLayer = PaintLayer | PaperNode | ImageNode;
 declare const PAPER_NODE_ID = "__paper";
 declare const TRACING_NODE_ID = "__tracing";
+declare const PAPER_EFFECT_NODE_ID = "__paper_effect";
 declare function paperKey(p: PaperSettings, light?: {
     azimuth: number;
     elevation: number;
@@ -2516,6 +2609,10 @@ declare class PaintEditorController {
     private liveThick;
     /** Set while an operation that changes wet paint runs: the simulation before it (for undo). */
     private wetOp;
+    /** The effects provider slot (see `setEffectsProvider`). */
+    readonly effects: EffectsSlot;
+    private readonly effectsRenderer;
+    private paperEffectNodeCache;
     constructor(options?: PaintEditorOptions);
     subscribe(listener: () => void): () => void;
     private emit;
@@ -2529,6 +2626,11 @@ declare class PaintEditorController {
     takeDirty(): RasterRect[] | 'all';
     private requireIdle;
     private commit;
+    /**
+     * Commits `next` as a new undo step, or with `commitToHistory` false folds it into the last step
+     * when that step has the same label (the later values of one slider drag).
+     */
+    private commitOrAmend;
     /** Keeps the wet snapshots in history within the wet undo memory, dropping the oldest. */
     private trimWetHistory;
     /** Throws when wet paint is mid-step (a batch in worker threads); `wetIdle()` waits for it. */
@@ -2606,6 +2708,117 @@ declare class PaintEditorController {
         bounds: RasterRect;
     };
     private applyCoverage;
+    /** The registered effects provider, or `null`. */
+    get effectsProvider(): EffectProvider | null;
+    /** Registers (or with `null` removes) the effects provider. Not an edit: no undo step. */
+    setEffectsProvider(provider: EffectProvider | null): void;
+    /** Registers `provider` and returns a function that removes it again (if it is still the one set). */
+    useEffects(provider: EffectProvider): () => void;
+    /** The provider's description of an effect, checked for `place` (rejects without a provider or for an unknown id). */
+    describeEffect(effect: string, place?: PaintEffectPlace): Promise<EffectDescription>;
+    /** Every effect layer (top first) with its effect. */
+    listEffectLayers(): {
+        layerId: string;
+        name: string;
+        source: PaintEffectSource;
+    }[];
+    /** The effect a layer is drawn from, or `undefined` for other layers. */
+    getEffectLayer(layerId: string): PaintEffectSource | undefined;
+    /** The effect paper (without its pixels), or `null`. */
+    getPaperEffect(): Omit<PaintPaperEffect, 'image' | 'version'> | null;
+    /** Values over `base` (`null` resets a control to its default), checked against the effect's controls. */
+    private effectValues;
+    /** Renders a generator, overlay or title effect at the canvas size. */
+    private renderEffectCanvas;
+    private sourceOf;
+    private checkTime;
+    private checkOpacity;
+    /** A pixel layer that takes effect pixels: unlocked, visible, no sticker layer, no wet paint. */
+    private effectTarget;
+    /** After an effect rendered: the layer must be as it was when the render started. */
+    private sameLayerAfterRender;
+    /** The canvas rectangle in a layer's own coordinates. */
+    private canvasRectOf;
+    /**
+     * Sets the effect paper: a provider generator drawn over the paper and under the paint, at the
+     * canvas size (`multiply` by default, so the paper's colour and grain still show). `null` removes
+     * it. One undo step. Returns the effect paper (without pixels), or `null`.
+     */
+    setPaperEffect(effect: string | null, options?: {
+        values?: Record<string, EffectValue>;
+        opacity?: number;
+        blend?: PaperEffectBlend;
+        time?: number;
+    }): Promise<ReturnType<PaintEditorController['getPaperEffect']>>;
+    /**
+     * Changes the effect paper: new control `values` (merged over its own; `null` resets one) or
+     * `time` draw it again at the canvas size; `opacity` and `blend` only change how it is drawn.
+     * One undo step; with `commitToHistory` false it joins the previous effect paper step (a slider
+     * drag). Returns the effect paper (without pixels).
+     */
+    updatePaperEffect(changes: {
+        values?: Record<string, EffectValue | null>;
+        opacity?: number;
+        blend?: PaperEffectBlend;
+        time?: number;
+    }, commitToHistory?: boolean): Promise<NonNullable<ReturnType<PaintEditorController['getPaperEffect']>>>;
+    /**
+     * Adds an effect layer above the active layer (or `aboveId`): a pixel layer drawn by a provider
+     * generator, overlay or title effect at the canvas size. It keeps its effect, so
+     * `updateEffectLayer` draws it again. One undo step. Returns the layer and its effect.
+     */
+    addEffectLayer(effect: string, options?: {
+        values?: Record<string, EffectValue>;
+        name?: string;
+        aboveId?: string;
+        opacity?: number;
+        blend?: BlendMode;
+        time?: number;
+    }): Promise<{
+        layer: PaintLayerInfo;
+        source: PaintEffectSource;
+    }>;
+    /**
+     * Draws an effect layer again with new `values` (merged over its own; `null` resets one) or
+     * `time`, at the canvas size, replacing its pixels (paint on it is lost). One undo step; with
+     * `commitToHistory` false it joins the previous effect layer step (a slider drag).
+     */
+    updateEffectLayer(layerId: string, changes: {
+        values?: Record<string, EffectValue | null>;
+        time?: number;
+    }, commitToHistory?: boolean): Promise<PaintEffectSource>;
+    /** Turns an effect layer into a plain pixel layer, keeping its pixels (one undo step). */
+    rasterizeEffectLayer(layerId: string): PaintLayerInfo;
+    /**
+     * Fills a layer with a provider generator, overlay or title effect: its pixels, rendered at the
+     * canvas size, are composited onto the layer's paint at `opacity` (only where it is already
+     * painted with `lockTransparency`, or when the layer's transparency is locked). One undo step.
+     */
+    fillLayerWithEffect(effect: string, options?: {
+        layerId?: string;
+        values?: Record<string, EffectValue>;
+        opacity?: number;
+        time?: number;
+        lockTransparency?: boolean;
+    }): Promise<{
+        layerId: string;
+        source: PaintEffectSource;
+    }>;
+    /**
+     * Runs a filter effect (light, glow, colour grade …) on a layer's dried paint and bakes it in, at
+     * `amount` strength (0..1, default 1). Transparent areas stay transparent; thick paint keeps its
+     * relief, and an effect with a `height` input gets the relief as a height map. Wet paint is
+     * refused (dry it first). One undo step.
+     */
+    applyLightEffect(layerId: string | undefined, effect: string, options?: {
+        values?: Record<string, EffectValue>;
+        amount?: number;
+        time?: number;
+    }): Promise<{
+        layerId: string;
+        source: PaintEffectSource;
+        amount: number;
+    }>;
     private findBrush;
     /** A library brush by id (`undefined` when unknown). */
     getBrush(id: string): PaintBrush | undefined;
@@ -2864,6 +3077,8 @@ declare class PaintEditorController {
     private currentLayers;
     /** View-only layers between the paper and the paint (the painting guides add the tracing image). */
     protected underlayLayers(): ViewLayer[];
+    /** The effect paper as a compositor layer (one object per effect paper, so caches hold). */
+    private paperEffectNode;
     /** The tracing image resampled onto the canvas (cached until it or the canvas changes). */
     private tracingNode;
     /** The layers with every wet layer dried where it is (what saving and exporting see). */
@@ -3496,4 +3711,24 @@ declare function createPaintReplayTools(c: PaintEditorController): AgentTool[];
 
 declare function createPaintStickerTools(c: PaintEditorController): AgentTool[];
 
-export { type Affine, BLEND_MENU_GROUPS, BRUSH_ID, BRUSH_ROTATIONS, BRUSH_SLIDERS, BUILTIN_BRUSHES, type BlendMenuGroup, BlendMode, BlendModeInfo, type BristleSettings, BristleStroke, type BrushBehavior, type BrushBehaviorInput, type BrushDynamics, type BrushEngineControls, type BrushLibraryFile, type BrushRotation, type BrushThumbnail, type ColorWheel, type CoverageStroke, DEFAULT_BEHAVIOR, DEFAULT_BRISTLE, DEFAULT_BRUSH_ID, DEFAULT_DPI, DEFAULT_DYNAMICS, DEFAULT_IMPASTO, DEFAULT_LIGHTING, DEFAULT_MULTI_COLOR, DEFAULT_PAPER, DEFAULT_PARTICLE, DEFAULT_STICKER, DEFAULT_SWATCHES, DEFAULT_VIEW, DEFAULT_WET_BRUSH, DryStroke, type DryStrokeOptions, type FillLayerOptions, GPU_LEAD, GRAIN_PATTERNS, GRAIN_TILE, type GrainPattern, type GrainTuning, HARMONY_KINDS, type Hand, type HarmonyColor, type HarmonyKind, IDENTITY_AFFINE, IDENTITY_COPY, IMPASTO_TOOLS, IMPASTO_TOOL_LABELS, type ImageEncoder, type ImageFormat, type ImageNode, type ImpastoSettings, type ImpastoTool, LIGHT_SLIDERS, type LayerUpdate, type Linear2, LitCache, type LoadedPaintDocument, MAX_CANVAS_SIDE, MAX_COORDINATE, MAX_IMAGE_SIDE, MAX_ZOOM, MIN_CANVAS_SIDE, MIN_ZOOM, MIXING_PAD_HEIGHT, MIXING_PAD_WIDTH, MULTI_COLOR_MODES, MixingPad, type MixingPadTool, type MultiColorMode, type MultiColorSettings, PAD_SAMPLE_SIZES, PAINT_BRUSH_CATEGORIES, PAINT_BRUSH_ENGINES, PAINT_FORMAT, PAINT_SCHEMA_VERSION, PAINT_TOOLS, PAPER_FAMILIES, PAPER_LIBRARY, PAPER_NODE_ID, PAPER_SLIDERS, PARTICLE_KINDS, PARTICLE_KIND_LABELS, PARTICLE_RENDERS, PARTICLE_RENDER_LABELS, type PadMixOptions, type PadMixPart, type Paint2DContext, type PaintAgentCommand, type PaintAssetStore, type PaintBrush, type PaintBrushCategory, type PaintBrushEngine, type PaintBrushInput, type PaintCanvas, PaintCanvasPresenter, PaintDabStroke, type PaintDabStrokeOptions, PaintDirector, type PaintDirectorOptions, PaintDocumentError, type PaintDocumentExtensions, type PaintDocumentState, PaintEditorController, PaintEditorError, type PaintEditorOptions, type PaintEditorState, type PaintEditorToolProviderOptions, type PaintEvent, PaintGesture, PaintGradientSource, type PaintGroupLayer, type PaintGuides, type PaintLayer, type PaintLayerInfo, type PaintLighting, type PaintPerformanceResult, type PaintPixelLayer, type PaintPointerEvent, PaintPresence, type PaintPresenceActor, type PaintPresenceState, type PaintReplayOptions, PaintSource, type PaintStrokeInit, type PaintStrokeResult, PaintStrokeSession, type PaintTool, type PaintView, type PaintWetHost, PaintWetLayers, type PaintWetOptions, type PaintWetStateInfo, type PaperFamily, PaperGrain, type PaperNode, type PaperSettings, type PaperTiling, type ParticleKind, type ParticleRender, type ParticleSettings, ParticleStroke, type PenDab, PenDabWalker, type PenPoint, PenSmoother, type PerspectiveGuide, PerspectiveSnapper, type PixelImage, type Point2, type PointerSample, type ProceduralStrokeOptions, type RecordedStroke, type ReferenceImage, type RenderOptions, type ReplayFrame, type ReplayOptions, type Rgb255, SNAP_DECIDE_DISTANCE, STAMP_KINDS, STAMP_LABELS, STENCIL_KINDS, STENCIL_SHAPES, STICKER_SLIDERS, SYMMETRY_MODES, type SavedMixingPadInfo, type SavedThickChannels, type SerializeOptions, type SerializedPaintDocument, type SliderControl, type StampKind, type Stencil, type StencilInput, type StencilKind, type StencilShape, StencilSnapper, type Sticker, type StickerSettings, StickerSpray, type StickerSprayInit, type StrokeCopy, type StrokeSessionHost, type StrokeSessionInit, type StrokeVariation, type Swatch, type SymmetryGuide, type SymmetryMode, TRACING_NODE_ID, type ThickChannels, ThickStrokeDriver, type ThickStrokeInit, TileableNoise, type TimeLapse, type TimeLapseOptions, type TracingImage, type ViewLayer, type ViewportBox, WET_GPU_MODES, WET_GPU_OPTIONS, WET_MEDIA, WET_MEDIUM_LABELS, WET_MEDIUM_PARAMS, WET_PARAM_SCHEMA, WET_PARAM_SLIDERS, WET_SPEED_SLIDER, WET_TILT_SLIDERS, WET_TOOLS, WET_TOOL_LABELS, WetBackendInfo, type WetBrushSettings, type WetEngineInfo, type WetEvent, WetFlowSpec, type WetGpuMode, type WetLayerInfo, type WetLayerSettings, type WetMediumKind, WetParams, WetStrokeDriver, type WetStrokeInit, WetTilt, type WetTool, affineCopy, applyAffine, brushEngineControls, brushLoadColor, brushLoadForStroke, brushTakesPaint, brushToJSON, buildTimeLapse, clonePaper, colorHarmony, composeAffine, contactSheet, createPaintCompositor, createPaintDocument, createPaintEditorToolProvider, createPaintLayer, createPaintReplayTools, createPaintStickerTools, createPaintThickTools, createPaintWetTools, decodeImageBlob, defaultGuides, defaultImageEncoder, deserializePaintDocument, deserializePaintDocumentAsync, documentExtensions, documentToScreen, downloadBytes, downsampleRgba, drawSticker, drawWaterOverlay, emptiedLayers, emptyThickChannels, fitZoom, grainCatch, grainHeights, guideOverlay, handlePaintShortcut, hexToRgb8, hslToRgb, hsvToRgb, hueToWheel, invertAffine, isPalmTouch, isWetBrush, isWetCapable, lightTile, lightingKey, mapPenPoint, mixerLoadForStroke, mixerTip, multiColorForDab, multiColorGradient, multiColorPalette, multiColorSliders, multiColorToPaint, newPaintLayerId, normalizeBehavior, normalizeBristle, normalizeBrushStroke, normalizeCanvas, normalizeDynamics, normalizeImpasto, normalizeLighting, normalizeMultiColor, normalizePaintBrush, normalizePaper, normalizeParticle, normalizePerspective, normalizeRotation, normalizeStencil, normalizeStickerSettings, normalizeStickerUpdate, normalizeSymmetry, normalizeView, normalizeWetBrush, padSampleRadius, paintToMultiColor, paperGrain, paperKey, paperNode, paperPreset, parseBrushLibrary, parseHexColor, patchBrushValue, patchPath, penOrientation, perspectiveDirections, perspectiveGuideLines, pointerToPenPoint, quickStencil, randSigned, readPath, readSwatch, reliefInfo, renderBrushThumbnail, renderColorWheel, renderPaper, renderStickers, replayFrame, replayItems, replayPainting, rgbToHexColor, rgbToHsl, rgbToHsv, samplePressure, scaleStencil, screenToDocument, seedFromString, serializePaintDocument, serializePaintDocumentExternal, stampCoverage, startWetClock, stencilMask, stencilOutline, stickerRect, stickerSurface, strokeBounds, strokeDuration, strokeSchedule, sweepPath, symmetryAxisAngles, symmetryAxisSegments, symmetryCopies, thickFromJSON, thickToJSON, thumbnailStroke, tiltToOrientation, timeLapseVideo, timeLapseZip, toStrokePoint, toggleStamp, usesPaintExchange, variationAffine, varyStroke, viewCssTransform, viewMatrix, viewPenToDocument, wetEngineSummary, wetPaperInput, wetPigmentOf, wheelAngle, wheelPick, wheelPoint, wheelToHue };
+/**
+ * Agent tools for provider effects in the paint editor: the shared effect tools, where
+ * `apply_effect` runs a filter (light, glow, grade) on a layer's dried paint and bakes it in, and
+ * the target `paper` is the effect paper; plus `set_paper_effect`, `add_effect_layer` and
+ * `fill_layer_with_effect`.
+ */
+
+interface PaintEffectsToolProviderOptions {
+    /** Provider id (unique per registry). Default `paint-effects`. */
+    id?: string;
+    /** Always prefix tool names with `<namespace>__`. */
+    namespace?: string;
+    /** The painting cannot be edited: write tools are hidden. A string is the reason. */
+    readOnly?: boolean | string | (() => boolean | string);
+}
+/** The target id of the effect paper. */
+declare const PAPER_TARGET = "paper";
+/** The effect tools for a paint editor (see the module comment). */
+declare function createPaintEffectsToolProvider(controller: PaintEditorController, options?: PaintEffectsToolProviderOptions): AgentToolProvider;
+
+export { type Affine, BLEND_MENU_GROUPS, BRUSH_ID, BRUSH_ROTATIONS, BRUSH_SLIDERS, BUILTIN_BRUSHES, type BlendMenuGroup, BlendMode, BlendModeInfo, type BristleSettings, BristleStroke, type BrushBehavior, type BrushBehaviorInput, type BrushDynamics, type BrushEngineControls, type BrushLibraryFile, type BrushRotation, type BrushThumbnail, type ColorWheel, type CoverageStroke, DEFAULT_BEHAVIOR, DEFAULT_BRISTLE, DEFAULT_BRUSH_ID, DEFAULT_DPI, DEFAULT_DYNAMICS, DEFAULT_IMPASTO, DEFAULT_LIGHTING, DEFAULT_MULTI_COLOR, DEFAULT_PAPER, DEFAULT_PARTICLE, DEFAULT_STICKER, DEFAULT_SWATCHES, DEFAULT_VIEW, DEFAULT_WET_BRUSH, DryStroke, type DryStrokeOptions, type FillLayerOptions, GPU_LEAD, GRAIN_PATTERNS, GRAIN_TILE, type GrainPattern, type GrainTuning, HARMONY_KINDS, type Hand, type HarmonyColor, type HarmonyKind, IDENTITY_AFFINE, IDENTITY_COPY, IMPASTO_TOOLS, IMPASTO_TOOL_LABELS, type ImageEncoder, type ImageFormat, type ImageNode, type ImpastoSettings, type ImpastoTool, LIGHT_SLIDERS, type LayerUpdate, type Linear2, LitCache, type LoadedPaintDocument, MAX_CANVAS_SIDE, MAX_COORDINATE, MAX_IMAGE_SIDE, MAX_ZOOM, MIN_CANVAS_SIDE, MIN_ZOOM, MIXING_PAD_HEIGHT, MIXING_PAD_WIDTH, MULTI_COLOR_MODES, MixingPad, type MixingPadTool, type MultiColorMode, type MultiColorSettings, PAD_SAMPLE_SIZES, PAINT_BRUSH_CATEGORIES, PAINT_BRUSH_ENGINES, PAINT_EFFECT_PLACES, PAINT_FORMAT, PAINT_SCHEMA_VERSION, PAINT_TOOLS, PAPER_EFFECT_BLENDS, PAPER_EFFECT_NODE_ID, PAPER_FAMILIES, PAPER_LIBRARY, PAPER_NODE_ID, PAPER_SLIDERS, PAPER_TARGET, PARTICLE_KINDS, PARTICLE_KIND_LABELS, PARTICLE_RENDERS, PARTICLE_RENDER_LABELS, type PadMixOptions, type PadMixPart, type Paint2DContext, type PaintAgentCommand, type PaintAssetStore, type PaintBrush, type PaintBrushCategory, type PaintBrushEngine, type PaintBrushInput, type PaintCanvas, PaintCanvasPresenter, PaintDabStroke, type PaintDabStrokeOptions, PaintDirector, type PaintDirectorOptions, PaintDocumentError, type PaintDocumentExtensions, type PaintDocumentState, PaintEditorController, PaintEditorError, type PaintEditorOptions, type PaintEditorState, type PaintEditorToolProviderOptions, type PaintEffectPlace, type PaintEffectSource, PaintEffectsRenderer, type PaintEffectsToolProviderOptions, type PaintEvent, PaintGesture, PaintGradientSource, type PaintGroupLayer, type PaintGuides, type PaintLayer, type PaintLayerInfo, type PaintLighting, type PaintPaperEffect, type PaintPerformanceResult, type PaintPixelLayer, type PaintPointerEvent, PaintPresence, type PaintPresenceActor, type PaintPresenceState, type PaintReplayOptions, PaintSource, type PaintStrokeInit, type PaintStrokeResult, PaintStrokeSession, type PaintTool, type PaintView, type PaintWetHost, PaintWetLayers, type PaintWetOptions, type PaintWetStateInfo, type PaperEffectBlend, type PaperFamily, PaperGrain, type PaperNode, type PaperSettings, type PaperTiling, type ParticleKind, type ParticleRender, type ParticleSettings, ParticleStroke, type PenDab, PenDabWalker, type PenPoint, PenSmoother, type PerspectiveGuide, PerspectiveSnapper, type PixelImage, type Point2, type PointerSample, type ProceduralStrokeOptions, type RecordedStroke, type ReferenceImage, type RenderOptions, type ReplayFrame, type ReplayOptions, type Rgb255, SNAP_DECIDE_DISTANCE, STAMP_KINDS, STAMP_LABELS, STENCIL_KINDS, STENCIL_SHAPES, STICKER_SLIDERS, SYMMETRY_MODES, type SavedMixingPadInfo, type SavedThickChannels, type SerializeOptions, type SerializedPaintDocument, type SliderControl, type StampKind, type Stencil, type StencilInput, type StencilKind, type StencilShape, StencilSnapper, type Sticker, type StickerSettings, StickerSpray, type StickerSprayInit, type StrokeCopy, type StrokeSessionHost, type StrokeSessionInit, type StrokeVariation, type Swatch, type SymmetryGuide, type SymmetryMode, TRACING_NODE_ID, type ThickChannels, ThickStrokeDriver, type ThickStrokeInit, TileableNoise, type TimeLapse, type TimeLapseOptions, type TracingImage, type ViewLayer, type ViewportBox, WET_GPU_MODES, WET_GPU_OPTIONS, WET_MEDIA, WET_MEDIUM_LABELS, WET_MEDIUM_PARAMS, WET_PARAM_SCHEMA, WET_PARAM_SLIDERS, WET_SPEED_SLIDER, WET_TILT_SLIDERS, WET_TOOLS, WET_TOOL_LABELS, WetBackendInfo, type WetBrushSettings, type WetEngineInfo, type WetEvent, WetFlowSpec, type WetGpuMode, type WetLayerInfo, type WetLayerSettings, type WetMediumKind, WetParams, WetStrokeDriver, type WetStrokeInit, WetTilt, type WetTool, affineCopy, applyAffine, brushEngineControls, brushLoadColor, brushLoadForStroke, brushTakesPaint, brushToJSON, buildTimeLapse, checkPaintEffectPlace, clonePaper, colorHarmony, composeAffine, contactSheet, createPaintCompositor, createPaintDocument, createPaintEditorToolProvider, createPaintEffectsToolProvider, createPaintLayer, createPaintReplayTools, createPaintStickerTools, createPaintThickTools, createPaintWetTools, decodeImageBlob, defaultGuides, defaultImageEncoder, deserializePaintDocument, deserializePaintDocumentAsync, documentExtensions, documentToScreen, downloadBytes, downsampleRgba, drawSticker, drawWaterOverlay, effectLayersToJSON, emptiedLayers, emptyThickChannels, fitZoom, grainCatch, grainHeights, guideOverlay, handlePaintShortcut, hexToRgb8, hslToRgb, hsvToRgb, hueToWheel, invertAffine, isPalmTouch, isWetBrush, isWetCapable, lightTile, lightingKey, mapPenPoint, mixPixels, mixerLoadForStroke, mixerTip, multiColorForDab, multiColorGradient, multiColorPalette, multiColorSliders, multiColorToPaint, newPaintLayerId, nextPaperEffectVersion, normalizeBehavior, normalizeBristle, normalizeBrushStroke, normalizeCanvas, normalizeDynamics, normalizeImpasto, normalizeLighting, normalizeMultiColor, normalizePaintBrush, normalizePaper, normalizeParticle, normalizePerspective, normalizeRotation, normalizeStencil, normalizeStickerSettings, normalizeStickerUpdate, normalizeSymmetry, normalizeView, normalizeWetBrush, overPixels, padSampleRadius, paintToMultiColor, paperEffectFromJSON, paperEffectToJSON, paperGrain, paperKey, paperNode, paperPreset, parseBrushLibrary, parseHexColor, patchBrushValue, patchPath, penOrientation, perspectiveDirections, perspectiveGuideLines, pointerToPenPoint, quickStencil, randSigned, readPaintEffectSource, readPath, readSwatch, reliefInfo, renderBrushThumbnail, renderColorWheel, renderPaper, renderStickers, replayFrame, replayItems, replayPainting, rgbToHexColor, rgbToHsl, rgbToHsv, samplePressure, scaleStencil, screenToDocument, seedFromString, serializePaintDocument, serializePaintDocumentExternal, stampCoverage, startWetClock, stencilMask, stencilOutline, stickerRect, stickerSurface, strokeBounds, strokeDuration, strokeSchedule, sweepPath, symmetryAxisAngles, symmetryAxisSegments, symmetryCopies, thickFromJSON, thickToJSON, thumbnailStroke, tiltToOrientation, timeLapseVideo, timeLapseZip, toStrokePoint, toggleStamp, usesPaintExchange, variationAffine, varyStroke, viewCssTransform, viewMatrix, viewPenToDocument, wetEngineSummary, wetPaperInput, wetPigmentOf, wheelAngle, wheelPick, wheelPoint, wheelToHue };