Scripting API

The node library as functions inside the JavaScript node. Generate, filter, and blend images in code.

Inside a JavaScript node, magerie.generators and magerie.ops put the node library at your fingertips as plain functions. Anything you can wire up as nodes, you can also write as a line of code:

//@output image out

let { noise } = magerie.generators
let { mul, blur } = magerie.ops

let a = noise("voronoi", 234234)
let b = noise("simplex", { scale: 2.4 })
out.value = blur(mul(a, b), 4)

Results are images. Pass them to other ops, assign one to an image output to feed the graph, or ctx.drawImage(img, x, y) it inside a draw recipe. The editor autocompletes every function with its full signature and options.

Calling ops#

Every function follows one convention:

1. Images first. Filters take one (blur(img, ...)), blends and warps take two (mul(a, b)).
2. A kind string, when the op has modes: noise("voronoi"), blend(a, b, "screen"), invert(img, "g").
3. A primary number: the seed for noise, radius for blur, opacity for blends, gamma for levels.
4. An options object for everything else: noise("voronoi", 7, { scale: 4, octaves: 6 }). Options are validated: unknown names and bad enum values throw with the valid choices listed, numbers clamp to their slider ranges.

Ops with a -> { ... } in their signature produce several images at once. Destructure the result: let { r, g, b } = channelSplit(img). Each member is a normal image you can pass along or dispose() independently.

Calls are cached per node: the same call with the same inputs reuses its texture instead of re-rendering, so calling ops inside a per-frame draw recipe is free as long as the parameters hold still. Everything a script creates is freed automatically the next time the node runs.

Errors land on the node itself: a typo like noise({ sclae: 2 }) shows the message on the node's error strip when you press Run.

magerie.generators#

noise(type?, seed?, opts?)#

Generates procedural noise textures using various algorithms

gradient(type?, opts?)#

Generates color gradients in various styles

solidColor(color?, opts?)#

Generates a solid color fill

sdfShape(shape?, size?, opts?)#

Generates signed distance field shapes with configurable geometry and colors as a colored image

pattern(type?, scale?, opts?)#

Generates procedural patterns like checkerboard, stripes, dots, and grid

scatter(stamp, layout?, count?, opts?) -> { image, id }#

Stamps copies of an input image across the output (random or grid layout), with per-instance random scale / rotation / opacity. Also emits a per-instance ID map for downstream variation.

magerie.ops#

blend(a, b, mode?, opacity?, opts?)#

Combines two images using various blend modes

mul(a, b, opacity?, opts?)#

Blend a and b with mode "multiply" (fixed: mode="multiply")

add(a, b, opacity?, opts?)#

Blend a and b with mode "add" (fixed: mode="add")

sub(a, b, opacity?, opts?)#

Blend a and b with mode "subtract" (fixed: mode="subtract")

screen(a, b, opacity?, opts?)#

Blend a and b with mode "screen" (fixed: mode="screen")

overlay(a, b, opacity?, opts?)#

Blend a and b with mode "overlay" (fixed: mode="overlay")

darken(a, b, opacity?, opts?)#

Blend a and b with mode "darken" (fixed: mode="darken")

lighten(a, b, opacity?, opts?)#

Blend a and b with mode "lighten" (fixed: mode="lighten")

difference(a, b, opacity?, opts?)#

Blend a and b with mode "difference" (fixed: mode="difference")

blur(img, radius?, opts?)#

Applies Gaussian blur to soften an image

levels(img, gamma?, opts?)#

Adjusts input/output black and white points with gamma correction

colorAdjust(img, opts?)#

Adjusts brightness, contrast, saturation, and hue

sharpen(img, amount?, opts?)#

Enhances edge detail using unsharp mask

transform(img, opts?)#

Applies geometric transformations to an image

invert(img, channels?, opts?)#

Inverts image colors to create a negative

threshold(img, threshold?, opts?)#

Converts image to black and white based on brightness threshold

gradientMap(img, opts?)#

Remaps image luminance to a user-defined color gradient

hslAdjust(img, hue?, opts?)#

Adjusts hue, saturation, and lightness with optional per-hue targeting

tile(img, repeatX?, opts?)#

Tiles/repeats an image across the output

crop(img, opts?)#

Crops image to a rectangular sub-region

warp(src, displacement, strength?, opts?)#

Displaces pixels using a displacement map

mask(img, mask, opts?)#

Uses a grayscale mask to modulate the alpha channel

channelSplit(img) -> { r, g, b, a }#

Splits an image into its R, G, B, A channels as separate grayscale images

colorSpaceDecompose(img, colorSpace?, opts?) -> { c1, c2, c3, a }#

Splits an image into channels of HSL, HSV, LAB, or OKLCH color spaces

Next#

• Code Nodes: the JavaScript node's execution model, directives, and draw recipes