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 - OpenEXR (exr)
0020 - Photoshop documents (psd, psb, pdd, psdt)
0021 - Radiance HDR (hdr)
0022 - Sun Raster (ras)
0023
0024 The following image formats have read and write support:
0025
0026 - AV1 Image File Format (AVIF)
0027 - Encapsulated PostScript (eps)
0028 - JPEG XL (jxl)
0029 - Personal Computer Exchange (pcx)
0030 - Quite OK Image format (qoi)
0031 - SGI images (rgb, rgba, sgi, bw)
0032 - Softimage PIC (pic)
0033 - Targa (tga): supports more formats than Qt's version
0034 - XView (xv)
0035
0036 ## Contributing
0037
0038 See the QImageIOPlugin documentation for information on how to write a
0039 new plugin.
0040
0041 The main difference between this framework and the qimageformats module
0042 of Qt is the license.  As such, if you write an imageformat plugin and
0043 you are willing to sign the Qt Project contributor agreement, it may be
0044 better to submit the plugin directly to the Qt Project.
0045
0046 Note that the imageformat plugins provided by this module also provide a
0047 desktop file.  This is for the benefit of KImageIO in the KDE4 Support
0048 framework.
0049
0050 ## Duplicated Plugins
0051
0052 The TGA plugin supports more formats than Qt's own TGA plugin;
0053 specifically, the one provided here supports indexed, greyscale and RLE
0054 images (types 1-3 and 9-11), while Qt's plugin only supports type 2
0055 (RGB) files.
0056
0057 The code for this cannot be contributed upstream directly because of
0058 licensing.  If anyone were willing to write fresh code to improve Qt's
0059 TGA plugin, it would allow the TGA plugin in this framework to be
0060 removed.
0061
0062 ## License
0063
0064 This framework is licensed under the
0065 [LGPLv2.1](http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html#SEC1).
0066
0067 The CMake code in this framework is licensed under the
0068 [BSD license](http://opensource.org/licenses/BSD-3-Clause).
0069