frameworks/kimageformats/README.md

0001 # KImageFormats
0002
0003 Plugins to allow QImage to support extra file formats.
0004
0005 ## Introduction
0006
0007 This framework provides additional image format plugins for QtGui.  As
0008 such it is not required for the compilation of any other software, but
0009 may be a runtime requirement for Qt-based software to support certain
0010 image formats.
0011
0012 ## Formats
0013
0014 The following image formats have read-only support:
0015
0016 - Animated Windows cursors (ani)
0017 - Camera RAW images (arw, cr2, cr3, dcs, dng, ...)
0018 - Gimp (xcf)
0019 - Krita (kra)
0020 - OpenRaster (ora)
0021 - Photoshop documents (psd, psb, pdd, psdt)
0022 - Radiance HDR (hdr)
0023 - Sun Raster (im1, im8, im24, im32, ras, sun)
0024
0025 The following image formats have read and write support:
0026
0027 - AV1 Image File Format (AVIF)
0028 - Encapsulated PostScript (eps)
0029 - High Efficiency Image File Format (heif). Can be enabled with the KIMAGEFORMATS_HEIF build option.
0030 - JPEG XL (jxl)
0031 - OpenEXR (exr)
0032 - Personal Computer Exchange (pcx)
0033 - Quite OK Image format (qoi)
0034 - SGI images (rgb, rgba, sgi, bw)
0035 - Softimage PIC (pic)
0036 - Targa (tga): supports more formats than Qt's version
0037
0038 ## Contributing
0039
0040 See the QImageIOPlugin documentation for information on how to write a
0041 new plugin.
0042
0043 The main difference between this framework and the qimageformats module
0044 of Qt is the license.  As such, if you write an imageformat plugin and
0045 you are willing to sign the Qt Project contributor agreement, it may be
0046 better to submit the plugin directly to the Qt Project.
0047
0048 ## Duplicated Plugins
0049
0050 The TGA plugin supports more formats than Qt's own TGA plugin;
0051 specifically, the one provided here supports indexed, greyscale and RLE
0052 images (types 1-3 and 9-11), while Qt's plugin only supports type 2
0053 (RGB) files.
0054
0055 The code for this cannot be contributed upstream directly because of
0056 licensing.  If anyone were willing to write fresh code to improve Qt's
0057 TGA plugin, it would allow the TGA plugin in this framework to be
0058 removed.
0059
0060 ## License
0061
0062 This framework is licensed under the
0063 [LGPLv2.1](http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html#SEC1).
0064
0065 The CMake code in this framework is licensed under the
0066 [BSD license](http://opensource.org/licenses/BSD-3-Clause).
0067