Node / Images Shapes · guide
Images & shapes (createImage) — overview
Current Apexify.js 6.0.0 documentation for Images & shapes (createImage) — overview.
await painter.createImage(images, canvasBuffer, options?) draws bitmaps (paths, URLs, buffers) or vector shapes (rectangle, circle, star, …) onto an existing canvas produced by createCanvas (or any Buffer / CanvasResults with compatible dimensions).
What you pass in
| Argument | Role |
|---|---|
images | One ImageProperties object or an array (drawn in order). |
canvasBuffer | Buffer PNG from createCanvas, or { buffer } (CanvasResults). |
options | Optional CreateImageOptions — isGrouped + groupTransform for treating several layers as one transformed unit. |
Return value: Promise<Buffer> — full canvas PNG after compositing.
Mental model
- Build a base with
createCanvas(size + backgrounds). - Call
createImageto composite one or more layers on top (each layer =ImageProperties). - Chain
createText, morecreateImage,save, etc., as needed.
Whole-file resize / crop / stitch outside compositing: Raster, batch & output — painter.image (chapters 04–07).
Topics (read in order)
| # | Page | Covers |
|---|---|---|
| 1 | Basics — source, box, fit | source, x/y, width/height, inherit, fit, align |
| 2 | Shapes reference | Every ShapeType, shape fields, stroke/shadow quirks (heart, star) |
| 3 | Styling, clip & blend | rotation, opacity, blur, borderRadius, clipPath, boxBackground, blendMode |
| 4 | Shadow & stroke on layers | shadow, stroke on bitmap boxes vs shapes |
| 5 | Professional filters | ImageFilter types, filterIntensity, filterOrder (pre / post) |
| 6 | Mask & distortion | mask, distortion, meshWarp — what works today |
| 7 | Cinematic effects | effects — vignette, lens flare, chromatic aberration, grain |
| 8 | Grouped layers | isGrouped, groupTransform — pivots, filters, limits |
| 9 | Paint order (reference) | Exact pipeline inside ImageCreator |
Where the code lives
| Piece | Package / entry |
|---|---|
| Public API | apexify.js — createImage, ImageCreator, and ImageProperties |
| Types | Exported from apexify.js — ImageProperties, CreateImageOptions, ImageFilter, ShapeType, etc. |