Skip to content

docs(color): Use color interop IDs and new views instead of legacy names #5388

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lgritz merged 2 commits into from
Aug 11, 2026
Merged

docs(color): Use color interop IDs and new views instead of legacy names #5388

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e085a54
docs(color): Use color interop IDs and new views instead of legacy names
brechtvl Aug 9, 2026
7f28ee5
Change display name to match ACES configs
brechtvl Aug 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/doc/builtinplugins.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@ tiles.
- Version of the BMP file format
* - ``oiio:ColorSpace``
- string
- currently, it is always ``"sRGB"`` (we presume all BMP files are sRGB)
- currently, it is always ``"srgb_rec709_display"`` or
``"srgb_rec709_scene"`` (we presume all BMP files are sRGB)

**Configuration settings for BMP input**

Expand Down
18 changes: 10 additions & 8 deletions src/doc/imagebufalgo.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2971,16 +2971,18 @@ Color space conversion
.. code-tab:: c++

ImageBuf Src ("tahoe.jpg");
ImageBuf Dst = ImageBufAlgo::colorconvert (Src, "sRGB", "acescg", true);
ImageBuf Dst = ImageBufAlgo::colorconvert (Src, "srgb_rec709_scene",
"lin_ap1_scene", true);

.. code-tab:: py

Src = ImageBuf("tahoe.jpg")
Dst = ImageBufAlgo.colorconvert (Src, "sRGB", "acescg", True)
Dst = ImageBufAlgo.colorconvert (Src, "srgb_rec709_scene",
"lin_ap1_scene", True)

.. code-tab:: bash oiiotool

oiiotool tahoe.jpg --colorconvert sRGB acescg -o tahoe_acescg.exr
oiiotool tahoe.jpg --colorconvert srgb_rec709_scene lin_ap1_scene -o tahoe_acescg.exr

|

Expand Down Expand Up @@ -3072,18 +3074,18 @@ Color space conversion
.. code-tab:: c++

ImageBuf Src ("tahoe.exr");
ImageBuf Dst = ImageBufAlgo::ociodisplay (Src, "sRGB", "Film", "lnf",
"", true, "SHOT", "pe0012");
ImageBuf Dst = ImageBufAlgo::ociodisplay (Src, "sRGB - Display", "ACES 2.0 - SDR 100 nits (Rec.709)",
"lin_rec709_scene", "", true, "SHOT", "pe0012");

.. code-tab:: py

Src = ImageBuf("tahoe.jpg")
Dst = ImageBufAlgo.ociodisplay (Src, "sRGB", "Film", "lnf",
"", True, "SHOT", "pe0012")
Dst = ImageBufAlgo.ociodisplay (Src, "sRGB - Display", "ACES 2.0 - SDR 100 nits (Rec.709)",
"lin_rec709_scene", "", True, "SHOT", "pe0012")

.. code-tab:: bash oiiotool

oiiotool tahoe.jpg --ociodisplay:from=lnf:unpremult=1:key=SHOT:value=pe0012 sRGB Film -o out.exr
oiiotool tahoe.jpg --ociodisplay:from=lin_rec709_scene:unpremult=1:key=SHOT:value=pe0012 sRGB "ACES 2.0 - SDR 100 nits (Rec.709)" -o out.exr

|

Expand Down
8 changes: 5 additions & 3 deletions src/doc/pythonbindings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3700,7 +3700,8 @@ Color manipulation
.. code-block:: python

Src = ImageBuf ("tahoe.jpg")
Dst = ImageBufAlgo.colorconvert (Src, "sRGB", "scene_linear")
Dst = ImageBufAlgo.colorconvert (Src, "srgb_rec709_scene",
"scene_linear")



Expand Down Expand Up @@ -3750,8 +3751,9 @@ Color manipulation
.. code-block:: python

Src = ImageBuf ("tahoe.exr")
Dst = ImageBufAlgo.ociodisplay (Src, "sRGB", "Film", "lnf",
context_key="SHOT", context_value="pe0012")
Dst = ImageBufAlgo.ociodisplay (Src, "sRGB - Display", "ACES 2.0 - SDR 100 nits (Rec.709)",
"lin_rec709_scene",
context_key="SHOT", context_value="pe0012")



Expand Down
10 changes: 7 additions & 3 deletions src/doc/stdmetadata.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,9 +149,13 @@ Color information
- `"lin_ap1_scene"`, `"ACEScg"` : ACEScg color space encoding.
- `"lin_ap0_scene"` : ACES2065-1, the recommended ACES space for
interchange and archiving.
- `"srgb_rec709_scene"` : Using standard (piecewise) sRGB response and
primaries. The token `"sRGB"` is treated as a synonym.
- `"g22_rec709_scene"` : Rec709/sRGB primaries, but using a response curve
- `"srgb_rec709_display"` : Using standard (piecewise) sRGB response and
primaries.
- `"srgb_rec709_scene"` : Same response and primaries as
`"srgb_rec709_display"` but for scene referred images. The token `"sRGB"`
is treated as a synonym, but it is recommended to use the more specific
interop ID.
- `"g22_rec709_display"` : Rec709/sRGB primaries, but using a response curve
corresponding to gamma 2.2.

Additionally, `"scene_linear"` is a role that is appropriate for color
Expand Down