libraries/perceptualcolor/README.md

0001 <!--
0002 SPDX-FileCopyrightText: Lukas Sommer <sommerluk@gmail.com>
0003 SPDX-License-Identifier: BSD-2-Clause OR MIT
0004 -->
0005
0006 <!--
0007 NOTE This file serves at the same time as description
0008 on Github and as main page for Doxygen documentation. See
0009 https://community.kde.org/Frameworks/Frameworks_Documentation_Policy#README.md
0010 for recommended document style.
0011 -->
0012
0013 # PerceptualColor
0014
0015 This library provides Qt GUI components for choosing colors, with a
0016 focus on an intuitive and perceptually uniform presentation.
0017
0018 ## Introduction
0019
0020 The GUI widgets in PerceptualColor are based on the LCH color model, which
0021 is known to reflect human perception better than RGB or its variants like
0022 HSV.  This leads to a highly intuitive user interface that is more
0023 user-friendly and easier to navigate. Moreover, the widgets can be used
0024 effectively without any prerequisite knowledge of the LCH color model
0025 by the users.
0026
0027 ![](docs/pics/ColorDialog.png "ColorDialog")
0028
0029 ![](docs/pics/ColorDialogTab1.png "ColorDialog")
0030
0031 ![](docs/pics/ColorDialogTab2.png "ColorDialog")
0032
0033 ## Features
0034
0035 This library:
0036
0037 - Provides complete documentation for the public API (as well as for the
0038   internal API and source code itself).
0039 - Is cross-platform. It does not use platform-specific code nor rely on a
0040   specific byte order. CI-tested on Linux, Windows, FreeBSD.
0041 - Provides internationalization and localization, including right-to-left
0042   layouts.
0043 - Provides high-DPI support.
0044 - Uses QStyle wherever possible.
0045 - Provides support for Qt style sheets where it makes sense.
0046 - Has support for both pointer devices (mouse, touchpad, etc.) *and*
0047   keyboard navigation in the widgets.
0048 - Has a permissive license.
0049 - Can be built as either a static or a shared/dynamic library.
0050 - Has basic support for accessibility.
0051 - Is developed with unit tests.
0052 - Links only to Qt and LittleCMS, making it a Tier 1 library.
0053 <!-- (ColorDialog’s screen color picker feature depends on Qt’s internals.)
0054 - Uses only the public API of Qt and LittleCMS, and no private
0055   features of these libraries.
0056 -->
0057
0058 ## Links
0059
0060 - [Online API documentation](https://api.kde.org/perceptualcolor/html/index.html)
0061 - [GIT Repository on invent.kde.org](https://invent.kde.org/libraries/perceptualcolor)