@pixerate/editor 0.254.1 → 0.256.0

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

@@ -45,6 +45,8 @@ import { type BuiltinProfileId, type ColorSpace, type Intent } from '../cms/inde
 import { type ProofSetup } from './color-management.cjs';
 import type { EffectPattern } from '../raster/effects/patterns.cjs';
 import { type GlobalLight, type LayerEffect, type LayerEffectKind, type LayerEffects } from '../raster/effects/model.cjs';
+import { type BrushLibrary, type BrushLibraryEntry } from '../brushes/library.cjs';
+import { type ImageBrushPreset } from './brush-presets.cjs';
 /** What `getSmartObject` reports. */
 export interface SmartObjectInfo {
     layerId: string;
@@ -268,6 +270,8 @@ export interface PaintOptions {
     cloneSource: CloneSource | null;
     /** Clone Source panel: how cloned pixels are scaled, flipped and rotated (identity by default). */
     cloneTransform: CloneTransform;
+    /** The brush preset the brush settings came from (`setBrushPreset`), until they are changed by hand; `null` for none. */
+    brushPreset?: string | null;
 }
 /** Where the Clone Stamp and Healing Brush sample from. */
 export interface CloneSource {
@@ -1569,6 +1573,17 @@ export declare class ImageEditorController {
         maxSide?: number;
         mask?: boolean;
     }): string | null;
+    /** The brush library the brush presets come from (shared with other editors when the host passes one). */
+    readonly brushLibrary: BrushLibrary;
+    /** The brushes this editor can paint with (`IMAGE_PROFILE`): built-in presets, then saved brushes. */
+    listBrushPresets(): Promise<BrushLibraryEntry[]>;
+    /**
+     * Paints with a brush from the brush library: sets the paint tool it needs (brush, Mixer Brush
+     * or eraser), its brush and mixer settings and, for a brush with its own gradient, the paint.
+     * View state, no undo. Throws for an unknown id (with the closest ones) or a brush the image
+     * editor can't paint (wet, thick, particles, stickers, light), saying why.
+     */
+    setBrushPreset(id: string): Promise<ImageBrushPreset>;
     /** Brush settings, colours and tool options of the paint tools (view state, no undo). */
     setPaintOptions(options: Partial<Omit<PaintOptions, 'brush' | 'mixer' | 'mixerLoad' | 'retouch' | 'cloneSource' | 'cloneTransform'>> & {
         brush?: Partial<BrushSettings>;

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

@@ -45,6 +45,8 @@ import { type BuiltinProfileId, type ColorSpace, type Intent } from '../cms/inde
 import { type ProofSetup } from './color-management.js';
 import type { EffectPattern } from '../raster/effects/patterns.js';
 import { type GlobalLight, type LayerEffect, type LayerEffectKind, type LayerEffects } from '../raster/effects/model.js';
+import { type BrushLibrary, type BrushLibraryEntry } from '../brushes/library.js';
+import { type ImageBrushPreset } from './brush-presets.js';
 /** What `getSmartObject` reports. */
 export interface SmartObjectInfo {
     layerId: string;
@@ -268,6 +270,8 @@ export interface PaintOptions {
     cloneSource: CloneSource | null;
     /** Clone Source panel: how cloned pixels are scaled, flipped and rotated (identity by default). */
     cloneTransform: CloneTransform;
+    /** The brush preset the brush settings came from (`setBrushPreset`), until they are changed by hand; `null` for none. */
+    brushPreset?: string | null;
 }
 /** Where the Clone Stamp and Healing Brush sample from. */
 export interface CloneSource {
@@ -1569,6 +1573,17 @@ export declare class ImageEditorController {
         maxSide?: number;
         mask?: boolean;
     }): string | null;
+    /** The brush library the brush presets come from (shared with other editors when the host passes one). */
+    readonly brushLibrary: BrushLibrary;
+    /** The brushes this editor can paint with (`IMAGE_PROFILE`): built-in presets, then saved brushes. */
+    listBrushPresets(): Promise<BrushLibraryEntry[]>;
+    /**
+     * Paints with a brush from the brush library: sets the paint tool it needs (brush, Mixer Brush
+     * or eraser), its brush and mixer settings and, for a brush with its own gradient, the paint.
+     * View state, no undo. Throws for an unknown id (with the closest ones) or a brush the image
+     * editor can't paint (wet, thick, particles, stickers, light), saying why.
+     */
+    setBrushPreset(id: string): Promise<ImageBrushPreset>;
     /** Brush settings, colours and tool options of the paint tools (view state, no undo). */
     setPaintOptions(options: Partial<Omit<PaintOptions, 'brush' | 'mixer' | 'mixerLoad' | 'retouch' | 'cloneSource' | 'cloneTransform'>> & {
         brush?: Partial<BrushSettings>;