@pixerate/editor 0.245.0 → 0.248.0

package/dist/paint-editor/controller.d.cts

@@ -15,6 +15,8 @@ import { type MixerLoad } from '../paint/mixer.cjs';
 import { type PaintSource } from '../paint/gradient-paint.cjs';
 import { type BlendMode } from '../raster/blend.cjs';
 import { type LayerLocks } from '../raster/layers.cjs';
+import { type LayerEffect, type LayerEffectKind, type LayerEffects } from '../raster/effects/model.cjs';
+import type { EffectPattern } from '../raster/effects/patterns.cjs';
 import { TiledSurface, type RasterRect, type Tile } from '../raster/surface.cjs';
 import { type PaintBrushInput, type BrushLibraryFile, type PaintBrush } from './brushes.cjs';
 import { type PaintCanvas, type PaintDocumentState, type PaintLayer } from './document.cjs';
@@ -44,7 +46,6 @@ import type { EffectDescription, EffectProvider, EffectValue } from '../effects/
 import { type PaintEffectPaint } from './effect-paint.cjs';
 import { type PaintEffectPlace, type PaintEffectSource, type PaintPaperEffect, type PaperEffectBlend } from './effects.cjs';
 import { type PaintLighting } from './thick.cjs';
-/** A refusal with a message that says what is wrong and how to fix it. */
 export declare class PaintEditorError extends Error {
     constructor(message: string);
 }
@@ -172,6 +173,8 @@ export interface PaintLayerInfo {
     depth: number;
     /** A live stroke layer (its pixels are drawn from its strokes, which stay editable): how many strokes it has. */
     liveStrokes?: number;
+    /** How many live layer effects (glows, shadows, strokes…) it has, when any (`getLayerEffects`). */
+    effects?: number;
 }
 export interface PaintStrokeInit {
     /** Default the active layer. */
@@ -453,6 +456,36 @@ export declare class PaintEditorController {
         parentId?: string | null;
     }): PaintLayerInfo;
     updateLayer(id: string, update: LayerUpdate): PaintLayerInfo;
+    /** A layer's live effects (an empty, enabled list when it has none). */
+    getLayerEffects(id: string): LayerEffects;
+    /**
+     * Adds a live effect of `kind` (outer and inner glow, drop and inner shadow, stroke, bevel &
+     * emboss, satin, colour / gradient / pattern overlay) with Photoshop's defaults and `settings`
+     * applied, at `index` in the layer's list (default the end). The effect is drawn from the
+     * layer's pixels when it is composited, so it follows later painting. One undo step.
+     */
+    addLayerEffect(id: string, kind: LayerEffectKind, settings?: Record<string, unknown>, index?: number): {
+        effect: LayerEffect;
+        effects: LayerEffects;
+    };
+    /**
+     * Changes one effect: only the given settings (nested objects replace whole; `null` removes an
+     * optional contour or texture). One undo step, or with `commitToHistory` false folded into the
+     * last change of this effect (a slider drag). Returns the layer's effects.
+     */
+    updateLayerEffect(id: string, effectId: string, changes: Record<string, unknown>, commitToHistory?: boolean): LayerEffects;
+    /** Removes one effect (one undo step). Returns the layer's remaining effects. */
+    removeLayerEffect(id: string, effectId: string): LayerEffects;
+    /** Turns all of a layer's effects on or off and, when given, sets Scale Effects (0.01..10). One undo step. */
+    setLayerEffectsEnabled(id: string, enabled: boolean, scale?: number, commitToHistory?: boolean): LayerEffects;
+    /** Replaces a layer's effects, validated (`null` removes them). One undo step. Returns the effects. */
+    setLayerEffects(id: string, effects: LayerEffects | null, commitToHistory?: boolean): LayerEffects;
+    /** Document patterns for pattern effects besides the built-in ones: none (paint documents bring none). */
+    getDocumentPatterns(): EffectPattern[];
+    private effectsLayer;
+    private requireEffect;
+    /** Writes a layer's effects (dropped when empty, enabled and unscaled), as an undo step or folded into the last one. */
+    private writeLayerEffects;
     removeLayer(id: string): {
         removed: string;
         activeLayerId: string | null;

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

@@ -15,6 +15,8 @@ import { type MixerLoad } from '../paint/mixer.js';
 import { type PaintSource } from '../paint/gradient-paint.js';
 import { type BlendMode } from '../raster/blend.js';
 import { type LayerLocks } from '../raster/layers.js';
+import { type LayerEffect, type LayerEffectKind, type LayerEffects } from '../raster/effects/model.js';
+import type { EffectPattern } from '../raster/effects/patterns.js';
 import { TiledSurface, type RasterRect, type Tile } from '../raster/surface.js';
 import { type PaintBrushInput, type BrushLibraryFile, type PaintBrush } from './brushes.js';
 import { type PaintCanvas, type PaintDocumentState, type PaintLayer } from './document.js';
@@ -44,7 +46,6 @@ import type { EffectDescription, EffectProvider, EffectValue } from '../effects/
 import { type PaintEffectPaint } from './effect-paint.js';
 import { type PaintEffectPlace, type PaintEffectSource, type PaintPaperEffect, type PaperEffectBlend } from './effects.js';
 import { type PaintLighting } from './thick.js';
-/** A refusal with a message that says what is wrong and how to fix it. */
 export declare class PaintEditorError extends Error {
     constructor(message: string);
 }
@@ -172,6 +173,8 @@ export interface PaintLayerInfo {
     depth: number;
     /** A live stroke layer (its pixels are drawn from its strokes, which stay editable): how many strokes it has. */
     liveStrokes?: number;
+    /** How many live layer effects (glows, shadows, strokes…) it has, when any (`getLayerEffects`). */
+    effects?: number;
 }
 export interface PaintStrokeInit {
     /** Default the active layer. */
@@ -453,6 +456,36 @@ export declare class PaintEditorController {
         parentId?: string | null;
     }): PaintLayerInfo;
     updateLayer(id: string, update: LayerUpdate): PaintLayerInfo;
+    /** A layer's live effects (an empty, enabled list when it has none). */
+    getLayerEffects(id: string): LayerEffects;
+    /**
+     * Adds a live effect of `kind` (outer and inner glow, drop and inner shadow, stroke, bevel &
+     * emboss, satin, colour / gradient / pattern overlay) with Photoshop's defaults and `settings`
+     * applied, at `index` in the layer's list (default the end). The effect is drawn from the
+     * layer's pixels when it is composited, so it follows later painting. One undo step.
+     */
+    addLayerEffect(id: string, kind: LayerEffectKind, settings?: Record<string, unknown>, index?: number): {
+        effect: LayerEffect;
+        effects: LayerEffects;
+    };
+    /**
+     * Changes one effect: only the given settings (nested objects replace whole; `null` removes an
+     * optional contour or texture). One undo step, or with `commitToHistory` false folded into the
+     * last change of this effect (a slider drag). Returns the layer's effects.
+     */
+    updateLayerEffect(id: string, effectId: string, changes: Record<string, unknown>, commitToHistory?: boolean): LayerEffects;
+    /** Removes one effect (one undo step). Returns the layer's remaining effects. */
+    removeLayerEffect(id: string, effectId: string): LayerEffects;
+    /** Turns all of a layer's effects on or off and, when given, sets Scale Effects (0.01..10). One undo step. */
+    setLayerEffectsEnabled(id: string, enabled: boolean, scale?: number, commitToHistory?: boolean): LayerEffects;
+    /** Replaces a layer's effects, validated (`null` removes them). One undo step. Returns the effects. */
+    setLayerEffects(id: string, effects: LayerEffects | null, commitToHistory?: boolean): LayerEffects;
+    /** Document patterns for pattern effects besides the built-in ones: none (paint documents bring none). */
+    getDocumentPatterns(): EffectPattern[];
+    private effectsLayer;
+    private requireEffect;
+    /** Writes a layer's effects (dropped when empty, enabled and unscaled), as an undo step or folded into the last one. */
+    private writeLayerEffects;
     removeLayer(id: string): {
         removed: string;
         activeLayerId: string | null;