Class Canvas

Hierarchy

Cell<V>
- Canvas (View Summary)

Index

Accessors

Constructors

Methods

blur brighterThan brightness chroma crop derive downsample flipH grayscale invert lens meanColor merge peek spring through coerce derive is lens pin

Properties

_t name value traits

Accessors

dimensions

get dimensions(): Vec
Dimensions (w, h) as a read-only Vec.

Returns Vec
- Defined in src/core/values/canvas.ts:514

Constructors

constructor

new Canvas(v?: Raster): Canvas
Parameters
- v: Raster = ...
Returns Canvas
Overrides Cell.constructor
- Defined in src/core/values/canvas.ts:193

Methods

blur

blur(radius: Val<number>): this
Gaussian blur (reactive radius). The backward pass runs an iterated Richardson–Lucy deconvolution seeded from the source (x ← x · H(target / H(x))), so untouched regions stay fixed. PutGet, not exact GetPut.
Parameters
- radius: Val<number>
Returns this
- Defined in src/core/values/canvas.ts:403

brighterThan

brighterThan(threshold: Val<number>): Writable<Bool>
Mean luma ≥ threshold (0–1) as a writable Bool; flipping the bit auto-exposes by iterating the gain until the mean crosses the threshold.
Parameters
- threshold: Val<number>
Returns Writable<Bool>
- Defined in src/core/values/canvas.ts:475

brightness

brightness(k: Val<number>): this
Multiply RGB by reactive k (alpha preserved). Invertible while k ≠ 0.
Parameters
- k: Val<number>
Returns this
- Defined in src/core/values/canvas.ts:223

chroma

chroma(): Writable<Canvas>
Chroma view: (r−Y, g−Y, b−Y) on a mid-grey base, complement is the luma Y. Editing it rewrites hue while keeping the original brightness.

Returns Writable<Canvas>
- Defined in src/core/values/canvas.ts:273

crop

crop(
 x: Val<number>,
 y: Val<number>,
 w: Val<number>,
 h: Val<number>,
): Writable<Canvas>
Sub-rectangle view (reactive x,y,w,h). Editing the crop composites back into the source; the surround reads straight from the parent.
Parameters
- x: Val<number>
- y: Val<number>
- w: Val<number>
- h: Val<number>
Returns Writable<Canvas>
- Defined in src/core/values/canvas.ts:303

derive

derive(this: Cell<Raster>, fn: (v: Raster) => Raster): this
Read-only same-type view: the RO dual of the endo .lens. For a cross-type view use the typed static Target.derive(src, fn).
Parameters
- this: Cell<Raster>
- fn: (v: Raster) => Raster
Returns this
Inherited from Cell.derive
- Defined in src/core/cell.ts:885

downsample

downsample(factor: number): Writable<Canvas>
Box-downsampled thumbnail (integer factor). Complement is the Laplacian residual source − up(down(source)); editing the thumbnail reconstructs full-res detail on top of the edit.
Parameters
- factor: number
Returns Writable<Canvas>
- Defined in src/core/values/canvas.ts:342

flipH

flipH(): this
Horizontal flip.

Returns this
- Defined in src/core/values/canvas.ts:210

grayscale

grayscale(): Writable<Canvas>
Grayscale (Rec.601 luma) view; the complement is the per-pixel chroma residual (r−Y, g−Y, b−Y), so editing the gray view recolours the source.

Returns Writable<Canvas>
- Defined in src/core/values/canvas.ts:243

invert

invert(): this
Per-channel invert (alpha preserved).

Returns this
- Defined in src/core/values/canvas.ts:198

lens

lens(
 this: Cell<Raster>,
 fwd: (v: Raster) => Raster,
 bwd: (target: Raster, current: Raster) => Raster,
): this
Endomorphic lens. A 2-arg bwd(view, current) consults the current source; a 1-arg bwd(view) reconstructs it from the view alone.
Parameters
- this: Cell<Raster>
- fwd: (v: Raster) => Raster
- bwd: (target: Raster, current: Raster) => Raster
Returns this
Inherited from Cell.lens
- Defined in src/core/cell.ts:879

meanColor

meanColor(): Writable<Color>
Mean colour (0–1) as a writable Color; the GPU reduces, a write shifts every pixel by the delta.

Returns Writable<Color>
- Defined in src/core/values/canvas.ts:452

merge

merge(this: Cell<Raster>, fold?: MergeFold<Raster>): Cell<Raster>
Backward fan-in: forwards its parent's value unchanged; on write, folds N contributors into one value. fold defaults to last-writer-wins.
Parameters
- this: Cell<Raster>
- Optionalfold: MergeFold<Raster>
Returns Cell<Raster>
Inherited from Cell.merge
- Defined in src/core/cell.ts:914

peek

peek(): Raster
Returns Raster
Inherited from Cell.peek
- Defined in src/core/cell.ts:864

spring

spring(opts?: SpringOpts): Spring
GPU per-pixel spring driver seeded from this value's texture. The host steps it and writes current() back each frame.
Parameters
- Optionalopts: SpringOpts
Returns Spring
- Defined in src/core/values/canvas.ts:520

through

through(this: Cell<Raster>, o: Optic<Raster, B>): Writable<Cell>
Apply optic value(s) as a writable lens: c.through(o) ≡ lens(c, o.get, o.put); multiple optics compose left-to-right (c.through(a, b) = a then b). Cross-type, unlike the endomorphic instance .lens.
Type Parameters
- B
Parameters
- this: Cell<Raster>
- o: Optic<Raster, B>
Returns Writable<Cell>
Inherited from Cell.through
- Defined in src/core/cell.ts:892
through<B, C>(
 this: Cell<Raster>,
 o1: Optic<Raster, B>,
 o2: Optic<B, C>,
): Writable<Cell<C>>
Apply optic value(s) as a writable lens: c.through(o) ≡ lens(c, o.get, o.put); multiple optics compose left-to-right (c.through(a, b) = a then b). Cross-type, unlike the endomorphic instance .lens.
Type Parameters
- B
- C
Parameters
- this: Cell<Raster>
- o1: Optic<Raster, B>
- o2: Optic<B, C>
Returns Writable<Cell<C>>
Inherited from Cell.through
- Defined in src/core/cell.ts:893
through<B, C, D>(
 this: Cell<Raster>,
 o1: Optic<Raster, B>,
 o2: Optic<B, C>,
 o3: Optic<C, D>,
): Writable<Cell<D>>
Apply optic value(s) as a writable lens: c.through(o) ≡ lens(c, o.get, o.put); multiple optics compose left-to-right (c.through(a, b) = a then b). Cross-type, unlike the endomorphic instance .lens.
Type Parameters
- B
- C
- D
Parameters
- this: Cell<Raster>
- o1: Optic<Raster, B>
- o2: Optic<B, C>
- o3: Optic<C, D>
Returns Writable<Cell<D>>
Inherited from Cell.through
- Defined in src/core/cell.ts:894

`Static`coerce

coerce<C extends AnyCellCtor>(
this: C,
v: Val<Inner<InstanceType<C>>>,
): InstanceType<C>
Coerce Val<Inner<Cls>> → Cls: instance → identity, RO cell → tracked derive, literal → fresh seed.
Type Parameters
- C extends AnyCellCtor
Parameters
- this: C
- v: Val<Inner<InstanceType<C>>>
Returns InstanceType<C>
Inherited from Cell.coerce
- Defined in src/core/cell.ts:987

`Static`derive

derive<C extends AnyCellCtor, P>(
 this: C,
 parent: Read,
 fn: (v: P) => Inner<InstanceType<C>>,
): InstanceType<C>
Read-only typed view. Cls.derive(parent, fn) (1-input), Cls.derive(parents, fn) (N-input), or Cls.derive(fn) (closure). Polymorphic-this: Vec.derive(...) → Vec.
Type Parameters
- C extends AnyCellCtor
- P
Parameters
- this: C
- parent: Read
- fn: (v: P) => Inner<InstanceType<C>>
Returns InstanceType<C>
Inherited from Cell.derive
- Defined in src/core/cell.ts:932
derive<C extends AnyCellCtor, P extends readonly Read<unknown>[]>(
 this: C,
 parents: P,
 fn: (vals: ReadValues) => Inner<InstanceType<C>>,
): InstanceType<C>
Read-only typed view. Cls.derive(parent, fn) (1-input), Cls.derive(parents, fn) (N-input), or Cls.derive(fn) (closure). Polymorphic-this: Vec.derive(...) → Vec.
Type Parameters
- C extends AnyCellCtor
- P extends readonly Read<unknown>[]
Parameters
- this: C
- parents: P
- fn: (vals: ReadValues) => Inner<InstanceType<C>>
Returns InstanceType<C>
Inherited from Cell.derive
- Defined in src/core/cell.ts:937
derive<C extends AnyCellCtor>(
this: C,
fn: () => Inner<InstanceType<C>>,
): InstanceType<C>
Read-only typed view. Cls.derive(parent, fn) (1-input), Cls.derive(parents, fn) (N-input), or Cls.derive(fn) (closure). Polymorphic-this: Vec.derive(...) → Vec.
Type Parameters
- C extends AnyCellCtor
Parameters
- this: C
- fn: () => Inner<InstanceType<C>>
Returns InstanceType<C>
Inherited from Cell.derive
- Defined in src/core/cell.ts:942

`Static`is

is<C extends AnyCellCtor>(this: C, v: unknown): v is InstanceType<C>
Type predicate against this class: Vec.is(x) narrows x to Vec. Inherited static; works for any subclass via polymorphic this.
Type Parameters
- C extends AnyCellCtor
Parameters
- this: C
- v: unknown
Returns v is InstanceType<C>
Inherited from Cell.is
- Defined in src/core/cell.ts:981

`Static`lens

lens<C extends AnyCellCtor, P>(
 this: C,
 parent: Read,
 fwd: (v: P) => Inner<InstanceType<C>>,
 bwd: (target: Inner<InstanceType<C>>, v: P) => P,
): Writable<InstanceType<C>>
Writable lens. Cls.lens(parent, fwd, bwd) for one input, Cls.lens(parents, fwd, bwd) for N; a 2-arg bwd reads the source, a 1-arg bwd reconstructs it. Cls.lens(parent(s), spec) builds a complement-carrying lens from { init, step, fwd, bwd }.
Type Parameters
- C extends AnyCellCtor
- P
Parameters
- this: C
- parent: Read
- fwd: (v: P) => Inner<InstanceType<C>>
- bwd: (target: Inner<InstanceType<C>>, v: P) => P
Returns Writable<InstanceType<C>>
Inherited from Cell.lens
- Defined in src/core/cell.ts:952
lens<C extends AnyCellCtor, P extends readonly Read<unknown>[]>(
 this: C,
 parents: P,
 fwd: (vals: ReadValues) => Inner<InstanceType<C>>,
 bwd: (
 target: Inner<InstanceType<C>>,
 vals: ReadValues,
 ) => BackUpdates<ReadValuesOrSkip>,
): Writable<InstanceType<C>>
Writable lens. Cls.lens(parent, fwd, bwd) for one input, Cls.lens(parents, fwd, bwd) for N; a 2-arg bwd reads the source, a 1-arg bwd reconstructs it. Cls.lens(parent(s), spec) builds a complement-carrying lens from { init, step, fwd, bwd }.
Type Parameters
- C extends AnyCellCtor
- P extends readonly Read<unknown>[]
Parameters
- this: C
- parents: P
- fwd: (vals: ReadValues) => Inner<InstanceType<C>>
- bwd: (
 target: Inner<InstanceType<C>>,
 vals: ReadValues,
 ) => BackUpdates<ReadValuesOrSkip>
Returns Writable<InstanceType<C>>
Inherited from Cell.lens
- Defined in src/core/cell.ts:958
lens<C extends AnyCellCtor, P, Cm>(
 this: C,
 parent: Read,
 spec: StatefulLensSpec1<P, Inner<InstanceType<C>>, Cm>,
): Writable<InstanceType<C>>
Writable lens. Cls.lens(parent, fwd, bwd) for one input, Cls.lens(parents, fwd, bwd) for N; a 2-arg bwd reads the source, a 1-arg bwd reconstructs it. Cls.lens(parent(s), spec) builds a complement-carrying lens from { init, step, fwd, bwd }.
Type Parameters
- C extends AnyCellCtor
- P
- Cm
Parameters
- this: C
- parent: Read
- spec: StatefulLensSpec1<P, Inner<InstanceType<C>>, Cm>
Returns Writable<InstanceType<C>>
Inherited from Cell.lens
- Defined in src/core/cell.ts:964
lens<C extends AnyCellCtor, P extends readonly Read<unknown>[], Cm>(
 this: C,
 parents: P,
 spec: StatefulLensSpec<ReadValues, Inner<InstanceType<C>>, Cm>,
): Writable<InstanceType<C>>
Writable lens. Cls.lens(parent, fwd, bwd) for one input, Cls.lens(parents, fwd, bwd) for N; a 2-arg bwd reads the source, a 1-arg bwd reconstructs it. Cls.lens(parent(s), spec) builds a complement-carrying lens from { init, step, fwd, bwd }.
Type Parameters
- C extends AnyCellCtor
- P extends readonly Read<unknown>[]
- Cm
Parameters
- this: C
- parents: P
- spec: StatefulLensSpec<ReadValues, Inner<InstanceType<C>>, Cm>
Returns Writable<InstanceType<C>>
Inherited from Cell.lens
- Defined in src/core/cell.ts:969

`Static`pin

pin<C extends AnyCellCtor>(
this: C,
v: Inner<InstanceType<C>>,
): Writable<InstanceType<C>>
Writable-shaped constant: always reads v, absorbs writes (parentless sink lens), for APIs demanding bidirectionality.
Type Parameters
- C extends AnyCellCtor
Parameters
- this: C
- v: Inner<InstanceType<C>>
Returns Writable<InstanceType<C>>
Inherited from Cell.pin
- Defined in src/core/cell.ts:1000

Properties

`Readonly`_t

_t: { equals: (a: Raster, b: Raster) => boolean }

name

name: string | undefined

Optional debug label (cell(0, { name })); used by errors and graph dumps.

`Readonly`value

value: Raster

`Static`traits

traits: { equals: (a: Raster, b: Raster) => boolean } = ...

Class Canvas

Hierarchy

Index

Accessors

Constructors

Methods

Properties

Accessors

dimensions

Returns Vec

Constructors

constructor

Parameters

Returns Canvas

Methods

blur

Parameters

Returns this

brighterThan

Parameters

Returns Writable<Bool>

brightness

Parameters

Returns this

chroma

Returns Writable<Canvas>

crop

Parameters

Returns Writable<Canvas>

derive

Parameters

Returns this

downsample

Parameters

Returns Writable<Canvas>

flipH

Returns this

grayscale

Returns Writable<Canvas>

invert

Returns this

lens

Parameters

Returns this

meanColor

Returns Writable<Color>

merge

Parameters

Returns Cell<Raster>

peek

Returns Raster

spring

Parameters

Returns Spring

through

Type Parameters

Parameters

Returns Writable<Cell<B>>

Type Parameters

Parameters

Returns Writable<Cell<C>>

Type Parameters

Parameters

Returns Writable<Cell<D>>

Staticcoerce

Type Parameters

Parameters

Returns InstanceType<C>

Staticderive

Type Parameters

Parameters

Returns InstanceType<C>

Type Parameters

Parameters

Returns InstanceType<C>

Type Parameters

Parameters

Returns InstanceType<C>

Staticis

Type Parameters

`Static`coerce

`Static`derive

`Static`is

`Static`lens

`Static`pin

`Readonly`_t

`Readonly`value

`Static`traits