pauljd/vectorcraft
1
0
Fork 0
mirror of https://github.com/storytold/vectorcraft.git synced 2026-11-09 09:33:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #6283 from dotCooCoo/fix/plugin-pixels-omitted-doc

Browse Source 
Plug-ins: docs say when pixelsOmitted is set
This commit is contained in:
BFlat
2026-11-09 13:52:48 +08:00
committed by GitHub
parent fbf43fccf0 2f42feb848
commit 03b4c9568b
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/plugins.md
+5 -1
View File
@@ -527,7 +527,11 @@ In this example the character and paragraph styles are cut short; a filter gets
`pixelsOmitted: false`. A CMYK image's pixels are its inks through the working CMYK profile. The pixels of all the
images in one input take at most 16 MiB in base64. A larger image, one whose pixels don't fit what the images before
it in paint order left, and a linked image (`linked: true`) have
`pixelsOmitted: true` and no pixels; the host checks an image's size before it decodes the image. The host never
`pixelsOmitted: true` and no pixels; the host checks an image's size before it decodes the image. An image of any
size also has `pixelsOmitted: true` when its data is missing from the document, when its width or height is 0, when
its data cannot be decoded (or needs more than 64 MiB of decoder memory, or is a TIFF the host rejects as too
large), or when the dimensions in its data differ from `pixelSize`. A plug-in checks `pixelsOmitted` before it
reads `pixelsBase64`, which is present only when `pixelsOmitted` is `false`. The host never
reads a linked image's file for a filter and never gives its path.
- A symbol instance (`"symbolInstance"`): `symbolId` is the name of the symbol it shows, with `missing: true` when the
document has no symbol of that name. `overrides` is `{}`.