From 3049f5b5ee39bf1fb6a8a64f37f06ae976d65aef Mon Sep 17 00:00:00 2001
From: Mark Callow <2244683+MarkCallow@users.noreply.github.com>
Date: Wed, 13 Sep 2023 09:38:13 +0900
Subject: [PATCH] Document convert_primaries option in toktx. (#765)
---
tools/toktx/toktx.cc | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)
diff --git a/tools/toktx/toktx.cc b/tools/toktx/toktx.cc
index 58e4ae9286..5b28037e0b 100644
--- a/tools/toktx/toktx.cc
+++ b/tools/toktx/toktx.cc
@@ -252,6 +252,17 @@ Create a KTX file from JPEG, PNG or netpbm format files.
@b --assign_oetf are specified, conversion will be performed from the
assigned transfer function to the transfer function specified by this
option, if different.
+
--convert_primaries <primaries>
+ Convert the image images to the specified color primaries, if
+ different from the color primaries of the input file(s) or the one
+ specified by --assign-primaries. If both this and --assign-primaries
+ are specified, conversion will be performed from the assigned primaries
+ to the primaries specified by this option, if different. This option is
+ not allowed to be specified when --assign-primaries is set to 'none'.
+ Case insensitive.
+ Possible options are:
+ bt709 | srgb | bt601-ebu | bt601-smpte | bt2020 | ciexyz | aces |
+ acescc | ntsc1953 | pal525 | displayp3 | adobergb
--linear
Deprecated. Use @b --assign_oetf linear.
--srgb
@@ -632,6 +643,17 @@ toktxApp::usage()
" --assign_oetf are specified, conversion will be performed from\n"
" the assigned transfer function to the transfer function specified\n"
" by this option, if different.\n"
+ " --convert_primaries \n"
+ " Convert the image image(s) to the specified color primaries,\n"
+ " if different from the color primaries of the input file(s) or the\n"
+ " one specified by --assign-primaries. If both this and\n"
+ " --assign-primaries are specified, conversion will be performed\n"
+ " from the assigned primaries to the primaries specified by this\n"
+ " option, if different. This option is not allowed to be specified\n"
+ " when --assign-primaries is set to 'none'. Case insensitive.\n"
+ " Possible options are: bt709 | srgb | bt601-ebu | bt601-smpte |\n"
+ " bt2020 | ciexyz | aces | acescc | ntsc1953 | pal525 |\n"
+ " displayp3 | adobergb.\n"
" --linear Deprecated. Use --assign_oetf linear.\n"
" --srgb Deprecated. Use --assign_oetf srgb.\n"
" --swizzle \n"