README.md 2.55 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.

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

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

24
25
26
- [color.rst](doc/color.rst) is the rest of the documentations as a work in
  progress.

27
28
29
30
31
32
33
34
35
36
37
38
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
## 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.

## Conduct

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