diff options
| author | William Joye <wjoye@cfa.harvard.edu> | 2017-01-03 21:52:18 (GMT) |
|---|---|---|
| committer | William Joye <wjoye@cfa.harvard.edu> | 2017-01-03 21:52:18 (GMT) |
| commit | 4302a869f0212a3e4878e66a7260b434f6584476 (patch) | |
| tree | e6976e66edf648406e32b092395121e045301692 /tkimg/doc/img-sgi.man | |
| parent | a780057cc1b51dd3a557549c3cf2431f09136c0d (diff) | |
| parent | 60d692811c12788ed4468d5ff680633304e8f641 (diff) | |
| download | blt-4302a869f0212a3e4878e66a7260b434f6584476.zip blt-4302a869f0212a3e4878e66a7260b434f6584476.tar.gz blt-4302a869f0212a3e4878e66a7260b434f6584476.tar.bz2 | |
Merge commit '60d692811c12788ed4468d5ff680633304e8f641' as 'tkimg'
Diffstat (limited to 'tkimg/doc/img-sgi.man')
| -rwxr-xr-x | tkimg/doc/img-sgi.man | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/tkimg/doc/img-sgi.man b/tkimg/doc/img-sgi.man new file mode 100755 index 0000000..c50f3b2 --- /dev/null +++ b/tkimg/doc/img-sgi.man @@ -0,0 +1,76 @@ +[comment {-*- tcl -*- doctools}]
+[vset FORMATNAME sgi]
+[vset FORMATFULLNAME {SGI Native Format}]
+
+[include format-header.inc]
+
+This handler provides new additional configuration options. See
+section [sectref {SGI OPTIONS}] for more detailed explanations.
+
+
+[include format-middle.inc]
+
+In addition the value for the option is treated as list and may
+contain any of the special options listed in section
+
+[sectref {SGI OPTIONS}].
+
+[list_end]
+
+
+[section {SUPPORTED SGI TYPES}]
+
+[example_begin]
+ 24-bit pixels: True-color (RGB, each channel 8 bit).
+ 32-bit pixels: True-color with alpha channel (RGBA, each channel 8 bit).
+ 48-bit pixels: True-color (RGB, each channel 16 bit).
+ 64-bit pixels: True-color with alpha channel (RGBA, each channel 16 bit).
+
+ List of currently supported features:
+
+ Type | Read | Write |
+ | -file | -data | -file | -data |
+ ----------------------------------------
+ 24-bit | Yes | Yes* | Yes | Yes* |
+ 32-bit | Yes | Yes* | Yes | Yes* |
+ 48-bit | Yes | Yes* | No | No |
+ 64-bit | Yes | Yes* | No | No |
+
+ *: Implemented by reading/writing from/to a temporary file. This will
+ be slow for larger images.
+
+ All images types may be either uncompressed or run-length encoded.
+[example_end]
+
+
+[section {SGI OPTIONS}]
+
+The handler provides the following options:
+
+[list_begin definitions]
+
+[lst_item "[option -verbose] [arg bool]"]
+
+This option is supported for reading and writing.
+[nl]
+If set to [const true], additional information about the loaded/stored image
+is printed to stdout. Default is [const false].
+
+[lst_item "[option -compression] [arg type]"]
+
+This option is supported for writing only.
+[nl]
+Set the compression mode to either [const none] or [const rle].
+Default is [const rle].
+
+[lst_item "[option -matte] [arg bool]"]
+
+This option is supported for reading and writing.
+[nl]
+If set to [const false], a matte (alpha) channel is ignored
+during reading or writing. Default is [const true].
+
+[list_end]
+
+[list_begin definitions]
+[include format-footer.inc]
|