schemaxisImagemagick operation reference
Generated from the current declarations. Do not edit this file by hand.
Types, limits and defaults below describe resolved values. Runtime expressions must produce these types. Unknown options are rejected; defaults apply only when omitted. Constructor options must be constant after document composition.
Index#
raster#
Run the raster preparation recipe: crop, integer magnification, quarter turns, explicit alpha and optional indexed sheet.
Common mistakes and assumptions:
- Encoded sRGB sample arithmetic; no colour management, smoothing, scripts or visual text labels.
- Only bounded RGB/RGBA8 PNG with exact independent pixel qualification.
Native binding: magick: -crop +repage -sample -rotate -alpha remove; -compose Copy -composite; PNG coder. Output kind: ["image","text"].
Inputs: none.
| Option | Meaning | Type / constraints | Default |
|---|---|---|---|
images |
List 1–8 images in output order. Each becomes image-NN.png and one sheet tile if a sheet is enabled. Combined input and output budgets apply. | {"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":40,"required":true},"source":{"type":"string","minLength":1,"maxLength":4096,"required":true},"crop":{"type":"object","properties":{"x":{"type":"integer","minimum":0,"maximum":4096,"required":true},"y":{"type":"integer","minimum":0,"maximum":4096,"required":true},"width":{"type":"integer","minimum":1,"maximum":4096,"required":true},"height":{"type":"integer","minimum":1,"maximum":4096,"required":true}}},"scale":{"type":"integer","minimum":1,"maximum":8,"default":1},"quarterTurns":{"type":"integer","minimum":0,"maximum":3,"default":0}}},"minItems":1,"maxItems":8} |
required |
colourPolicy |
require-srgb, the default, requires an sRGB chunk or standard matching gAMA+cHRM. assume-srgb also admits untagged encoded samples and records that explicit assumption. | {"type":"enum","values":["require-srgb","assume-srgb"]} |
"require-srgb" |
alpha |
preserve, the default, retains every RGBA sample including hidden RGB at zero alpha. flatten replaces alpha with 255 using the chosen RGB background. | {"type":"enum","values":["preserve","flatten"]} |
"preserve" |
background |
Choose the RGB background for flatten as three encoded sRGB byte channels [red,green,blue]. Default [255,255,255] is white. | {"type":"array","items":{"type":"integer","minimum":0,"maximum":255},"minItems":3,"maxItems":3} |
[255,255,255] |
sheet |
Optionally publish a row-major contact sheet and JSON index. Tiles occupy equal cells based on the largest prepared dimensions. Omitting sheet publishes individual images only. | {"type":"object","properties":{"columns":{"type":"integer","minimum":1,"maximum":8,"default":2},"padding":{"type":"integer","minimum":0,"maximum":64,"default":8},"background":{"type":"array","items":{"type":"integer","minimum":0,"maximum":255},"minItems":3,"maxItems":3,"default":[255,255,255]}}} |
omitted |