X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=docs%2Fimages2.md;h=26268cf5d884c7a5b0f9276ebfac682180f0f15b;hb=686d4da2d2ecc203d5f8b524225a4327777825be;hp=c1f9bfd3fd3bcc4bec64d2c8805f91a55b97dcf9;hpb=466f45f3d63ed126bb21e1e4e162585970b4deac;p=nikiroo-utils.git diff --git a/docs/images2.md b/docs/images2.md index c1f9bfd..26268cf 100644 --- a/docs/images2.md +++ b/docs/images2.md @@ -217,17 +217,17 @@ For the OSC 1 3 3 8 sequence: The keys for the key-value pairs that must be supported by the terminal are listed below: -| Key | Default Value | Description | -|--------------|---------------|----------------------------------------------| -| type | "image/rgb" | mime-type describing data field | -| width | 1 | Number of Cells or pixels wide to display in | -| height | 1 | Number of Cells or pixels high to display in | -| scale | "none" | Scale/zoom option, see below | -| sourceX | 0 | Media source X position to display | -| sourceY | 0 | Media source Y position to display | -| sourceWidth | "auto" | Media width in pixels to display | -| sourceHeight | "auto" | Media height in pixels to display | -| scroll | 0 | If 0, scroll the display if needed | +| Key | Default Value | Description | +|--------------|---------------|---------------------------------------| +| type | "image/rgb" | mime-type describing data field | +| width | 1 | Number of Cell columns to display in | +| height | 1 | Number of Cells rows to display in | +| scale | "none" | Scale/zoom option, see below | +| sourceX | 0 | Media source X position to display | +| sourceY | 0 | Media source Y position to display | +| sourceWidth | "auto" | Media width in pixels to display | +| sourceHeight | "auto" | Media height in pixels to display | +| scroll | 0 | If 0, scroll the display if needed | A terminal may support additional keys. If a key is specified but not supported by the terminal, then it is ignored without error. @@ -346,10 +346,12 @@ Cached Images - New Sequences A terminal with cached images feature must support the following new sequences: -| Sequence | Command | Description | -|--------------------------------------|-----------|-------------------------| -| OSC 1 3 4 0 ; F i l e = {args} : {data} BEL | CSTORE | Display media at (x, y) | -| OSC 1 3 4 1 ; Pi ; {args} ST | CDISPLAY | Display media at (x, y) | +| Sequence | Command | Description | +|--------------------------------------|-----------|--------------------------| +| OSC 1 3 4 0 ; F i l e = {args} : {data} BEL | CSTORE | Store image in cache | +| OSC 1 3 4 0 ; F i l e = {args} : {data} ST | CSTORE | Store image in cache | +| OSC 1 3 4 1 ; Pi ; {args} BEL | CDISPLAY | Display image at (x, y) | +| OSC 1 3 4 1 ; Pi ; {args} ST | CDISPLAY | Display image at (x, y) | @@ -461,17 +463,17 @@ For the CDISPLAY command: The keys for the key-value pairs that must be supported by the terminal are listed below: -| Key | Default Value | Description | -|--------------|---------------|----------------------------------------------| -| id | 0 | ID to refer to the image | -| width | 1 | Number of Cells or pixels wide to display in | -| height | 1 | Number of Cells or pixels high to display in | -| scale | "none" | Scale/zoom option, see below | -| sourceX | 0 | Media source X position to display | -| sourceY | 0 | Media source Y position to display | -| sourceWidth | "auto" | Media width in pixels to display | -| sourceHeight | "auto" | Media height in pixels to display | -| scroll | 0 | If 1, scroll the display if needed | +| Key | Default Value | Description | +|--------------|---------------|---------------------------------------| +| id | 0 | ID to refer to the image | +| width | 1 | Number of Cell columns to display in | +| height | 1 | Number of Cells rows to display in | +| scale | "none" | Scale/zoom option, see below | +| sourceX | 0 | Media source X position to display | +| sourceY | 0 | Media source Y position to display | +| sourceWidth | "auto" | Media width in pixels to display | +| sourceHeight | "auto" | Media height in pixels to display | +| scroll | 0 | If 1, scroll the display if needed | A terminal may support additional keys. If a key is specified but not supported by the terminal, then it is ignored without error. @@ -510,3 +512,13 @@ is displayed, and the cursor does not move. "sourceWidth" and "sourceHeight" can be "auto", which means use the maximum available width/height (given sourceX/sourceY) from the media's inherent dimensions. + + + +Miscellaneous Items +------------------- + +"image/rgb" and "image/rgba" also need width/height fields. Propose +to specify them as 16-bit unsigned ints, followed by 24-bit or 32-bit +data. If data is short, then the rest of the image is assumed to be +current background color (like sixel raster attributes).