README.md 3.51 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
# Color management and HDR documentation for FOSS graphics

Documentation in [this repository](https://gitlab.freedesktop.org/pq/color-and-hdr)
is intended to help with the design and implementation of color
management and HDR support on FOSS graphincs stacks, including
Mesa (EGL, Vulkan WSI), Linux (DRM KMS), Wayland (compositors and
applications), and even X11.

This is not an archive of proprietary documents like SMPTE, ITU, or VESA
specifications. All content must follow the [license](LICENSE).

12
13
14
15
16
## Contents

- [Wayland Color Management and HDR Design Goals](doc/design_goals.rst)
  describes the expectations and use cases that Wayland should meet.

Pekka Paalanen's avatar
Pekka Paalanen committed
17
18
- [Color Pipeline Overview](doc/winsys_color_pipeline.rst) compares the
  X11 and Wayland color pipelines, and explains how a Wayland
19
20
  compositor relates to display calibration.

21
22
23
- [Well-Known EOTFs, chromaticities and whitepoints](doc/well_known.rst)
  with links to specifications.

Pekka Paalanen's avatar
Pekka Paalanen committed
24
25
- [High Dynamic Range](doc/winsys_hdr.rst) in Wayland. Work in progress.

26
27
- [Glossary](doc/glossary.rst)

Pekka Paalanen's avatar
Pekka Paalanen committed
28
- [Todo](doc/todo.rst) contains random notes.
29

Pekka Paalanen's avatar
Pekka Paalanen committed
30
31
32
- [A Pixel's Color](doc/pixels_color.md) is an introduction to
  understanding pixel values and color.

33
34
35
- [Tools](doc/tools.rst) contains a list of tools that can be used to inspect
  and modify color management and display attributes on Linux.

36
37
38
- [Power](doc/power.rst) talks about the power implications of color-managed
  and HDR

39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
## History

Originally this documentation was started to better explain how
[Wayland color management extension](https://gitlab.freedesktop.org/wayland/wayland-protocols/-/merge_requests/14)
should be used and what it means.

Widening community interestests particularly in HDR prompted for moving
the documentation into this separate repository to allow a more
streamlined way of contributing to it.

For now, this project lives in a personal space, but if it gets more
traction, moving it into an independent Gitlab group is possible without
losing any Issues or MRs.

## Releases

No releases are made from this repository. Use date or the git hash to
refer to specific revisions of the contents.

## Contributing

Open Issues and Merge Requests in Gitlab as usual. Use your own forked
repository for MR branches (@pq is exempt as long as this repository is
hosted in his personal Gitlab group). Each commit must carry
Signed-off-by tag to denote that the submitter adheres to
[Developer Certificate of Origin 1.1](https://developercertificate.org/).

All merge requests need to be accepted by at least one other person with
Developer or higher access level.

Reporter level access can be given by invite without any particular
requirements.

Developer access can be given on request, provided the person is
actively participating in discussions and has contributed an accepted
MR.

Maintainer access is given on Maintainers' collective discretion.

78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
### Images

Please, also contribute the "sources" (e.g. SVG) of images if
reasonable, even when the image used by the document is an exported one,
e.g. PNG.

### Writing mathematics

If you want to typeset mathematics, use Gitlab flavored Markdown and its
[mathematics support](https://gitlab.freedesktop.org/help/user/markdown#math).
It uses [KaTeX](https://katex.org/) which supports
[a subset of LaTeX](https://katex.org/docs/supported.html).

[KaTeX demo](https://katex.org/#demo) may be helpful for polishing your
markup without needing to push to and view in Gitlab all the time.

94
95
96
97
## Conduct

This project follows
[the freedesktop.org Contributor Covenant](https://www.freedesktop.org/wiki/CodeOfConduct).
Pekka Paalanen's avatar
Pekka Paalanen committed
98