From 388b121a42313ee36bc9e1110ff3dd2eb65a0dba Mon Sep 17 00:00:00 2001 From: Craig Zerouni Date: Sat, 21 Sep 2024 14:49:01 -0700 Subject: [PATCH 1/6] A few quick fixes --- docs/quick_start/installation.rst | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/quick_start/installation.rst b/docs/quick_start/installation.rst index a2e74f8175..5fe859fca5 100644 --- a/docs/quick_start/installation.rst +++ b/docs/quick_start/installation.rst @@ -88,7 +88,7 @@ If you need the extra command-line tools, you'll need to install :ref:`from sour However, the Python binding can be installed as described in the :ref:`Python` section. MacOS using Homebrew -******************* +******************** You can use the Homebrew package manager to install OpenColorIO on macOS. @@ -264,9 +264,7 @@ Enabling optional components CMake Options +++++++++++++ -There are many options available in `CMake. - -`_ +There are many options available in `CMake. `_ Several of the most common ones are: From 4d0a94b8c0161514c6e1a646ef62afe216f6b248 Mon Sep 17 00:00:00 2001 From: Craig Zerouni Date: Sat, 21 Sep 2024 15:59:40 -0700 Subject: [PATCH 2/6] Formatting fixes to avoid warnings --- docs/concepts/overview/internal_architecture.rst | 7 ++----- docs/concepts/publications/publications.rst | 16 ++++++++-------- docs/guides/using_ocio/compatible_software.rst | 2 +- docs/index.rst | 4 ++-- docs/quick_start/installation.rst | 6 +++--- 5 files changed, 16 insertions(+), 19 deletions(-) diff --git a/docs/concepts/overview/internal_architecture.rst b/docs/concepts/overview/internal_architecture.rst index 387aa724a1..990acb92c9 100644 --- a/docs/concepts/overview/internal_architecture.rst +++ b/docs/concepts/overview/internal_architecture.rst @@ -212,11 +212,8 @@ An Example Let us consider the internal steps when getProcessor() is called to convert from ColorSpace 'adx10' to ColorSpace 'aces': -* The first step is to turn this ColorSpace conversion into an ordered list of transforms. -We do this by creating a single list of the conversions from 'adx10' to reference, and then -adding the transforms required to go from reference to 'aces'. -* The Transform list is then converted into a list of ops. It is during this stage luts, -are loaded, etc. +* The first step is to turn this ColorSpace conversion into an ordered list of transforms. We do this by creating a single list of the conversions from 'adx10' to reference, and then adding the transforms required to go from reference to 'aces'. +* The Transform list is then converted into a list of ops. It is during this stage luts, are loaded, etc. CPU CODE PATH diff --git a/docs/concepts/publications/publications.rst b/docs/concepts/publications/publications.rst index a3e8dbc149..8b6ed728ba 100644 --- a/docs/concepts/publications/publications.rst +++ b/docs/concepts/publications/publications.rst @@ -7,11 +7,11 @@ Presentations & Publications ============================ -* ASWF Open Source Days 2023 `video `_ +* ASWF Open Source Days 2023 `video `__ -* OCIO wins the Pipeline Tool award at DigiPro 2022! `video `_ +* OCIO wins the Pipeline Tool award at DigiPro 2022! `video `__ -* ASWF Open Source Days 2022 `video `_ +* ASWF Open Source Days 2022 `video `__ * HPA Tech Retreat 2022 "Color Processing with OCIO v2 and the Academy/ASC Common LUT Format" `Slides & Tutorial `_ @@ -20,14 +20,14 @@ Presentations & Publications `article `_ * SIGGRAPH 2021 course "Color management with OpenColorIO V2" - `video `__ `PDF `__ `ACM `_ + `video `__ `PDF `__ `ACM `__ -* ASWF Open Source Days 2021 `video `_ +* ASWF Open Source Days 2021 `video `__ -* DigiPro 2020 "The ASWF takes OpenColorIO to the Next Level" `video `__ `PDF `__ `ACM `_ +* DigiPro 2020 "The ASWF takes OpenColorIO to the Next Level" `video `__ `PDF `__ `ACM `__ -* ASWF Open Source Days 2020 `video `_ +* ASWF Open Source Days 2020 `video `__ -* ASWF Open Source Days 2019 `video `_ +* ASWF Open Source Days 2019 `video `__ * `Cinematic Color `_ diff --git a/docs/guides/using_ocio/compatible_software.rst b/docs/guides/using_ocio/compatible_software.rst index 9bfe1ebf10..29b409d949 100644 --- a/docs/guides/using_ocio/compatible_software.rst +++ b/docs/guides/using_ocio/compatible_software.rst @@ -335,7 +335,7 @@ Website : ``__ Photoshop (beta) -********* +**************** OCIO can be enabled via a technology preview checkbox in preferences. For more details see `OpenColorIO and 32-bit Editing now available in Photoshop Beta `__. Photoshop diff --git a/docs/index.rst b/docs/index.rst index 1a8a4a9a61..2441cf6987 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -43,7 +43,7 @@ Accessing Other Versions ************************ You are reading the documentation for OCIO v2. The documentation for the earlier -1.x series of releases is available `here `_. +1.x series of releases is available `here `__. Community @@ -70,7 +70,7 @@ Slack There is an OpenColorIO Slack workspace at: ``_. -New users may join the workspace from `here `_. +New users may join the workspace from `here `__. Search diff --git a/docs/quick_start/installation.rst b/docs/quick_start/installation.rst index 5fe859fca5..b597a3297c 100644 --- a/docs/quick_start/installation.rst +++ b/docs/quick_start/installation.rst @@ -26,14 +26,14 @@ Python If you only need the Python binding and command-line tools, the simplest solution is to take advantage of the pre-built wheels in the Python Package Index (PyPI) -`here `_. It can be installed as follows, once you +`here `__. It can be installed as follows, once you have Python installed. **PyPI**:: pip install opencolorio -The pre-built wheels are listed `here `_. Note that +The pre-built wheels are listed `here `__. Note that source code is provided, so it may be possible for ``pip`` to compile the binding on your machine if the matrix of Python version and platform version does not have the combination you need. More detailed instructions are available for how to use @@ -529,7 +529,7 @@ Note: For other user facing environment variables, see :ref:`using_env_vars`. It is recommended to build OFX plugins in static mode (``BUILD_SHARED_LIBS=OFF``) to avoid any issue loading the OpenColorIO library from the plugin once it has been moved. Otherwise, please make sure - the shared OpenColorIO lib (*.so, *.dll, *.dylib) is visible from the + the shared OpenColorIO lib (\*.so, \*.dll, \*.dylib) is visible from the plugin by mean of ``PATH``, ``LD_LIBRARY_PATH`` or ``DYLD_LIBRARY_PATH`` for Windows, Linux and macOS respectively. For systems that supports it, it is also possible to edit the RPATH of the plugin to add the location of From 9474334c8b8dc6cd2a9bccc1b9403c5ae54df72f Mon Sep 17 00:00:00 2001 From: Craig Zerouni Date: Sat, 21 Sep 2024 16:15:43 -0700 Subject: [PATCH 3/6] More exclusions --- docs/conf.py | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 6a2921a4cf..832df82a6a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -86,7 +86,16 @@ } master_doc = "index" -exclude_patterns = ["build", "*-prefix", "api/python", "site"] +exclude_patterns = [ + "INSTALL.md", + "*.txt", + "README*", + "CHANGELOG.md", + "build", + "*-prefix", + "api/python", + "site" +] rst_prolog = """ .. |OCIO| replace:: *OCIO* From 9ecf7b045ffca03938962354e1a7220ea6454313 Mon Sep 17 00:00:00 2001 From: Craig Zerouni Date: Thu, 26 Sep 2024 13:43:00 -0700 Subject: [PATCH 4/6] Add missing file to toc --- docs/concepts/_index.rst | 2 +- docs/concepts/overview/internal_architecture.rst | 4 ++-- docs/concepts/overview/overview.rst | 2 ++ docs/toc_redirect.rst | 2 +- 4 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/concepts/_index.rst b/docs/concepts/_index.rst index 4d261fa159..f04846ca71 100644 --- a/docs/concepts/_index.rst +++ b/docs/concepts/_index.rst @@ -9,4 +9,4 @@ Concepts :caption: Concepts overview/overview - publications/publications \ No newline at end of file + publications/publications diff --git a/docs/concepts/overview/internal_architecture.rst b/docs/concepts/overview/internal_architecture.rst index 990acb92c9..233bdf8994 100644 --- a/docs/concepts/overview/internal_architecture.rst +++ b/docs/concepts/overview/internal_architecture.rst @@ -2,8 +2,8 @@ SPDX-License-Identifier: CC-BY-4.0 Copyright Contributors to the OpenColorIO Project. -Internal Architecture Overview -============================== +Internal Architecture +===================== .. warning:: This section is from OCIO v1 and has not been updated yet. diff --git a/docs/concepts/overview/overview.rst b/docs/concepts/overview/overview.rst index 2aab73368c..0157ce1a24 100644 --- a/docs/concepts/overview/overview.rst +++ b/docs/concepts/overview/overview.rst @@ -9,6 +9,8 @@ Overview .. include:: introduction.rst +.. include:: configuration_files.rst + .. include:: internal_architecture.rst .. include:: glossary.rst diff --git a/docs/toc_redirect.rst b/docs/toc_redirect.rst index 2dd5537956..13ffcfc8ab 100644 --- a/docs/toc_redirect.rst +++ b/docs/toc_redirect.rst @@ -40,4 +40,4 @@ .. toctree:: :hidden: - aswf/_index \ No newline at end of file + aswf/_index From 78daac62a4d13c94e9597fbefeceef4a6608f428 Mon Sep 17 00:00:00 2001 From: Craig Zerouni Date: Fri, 27 Sep 2024 15:14:01 -0700 Subject: [PATCH 5/6] Updated docs related to contributing. Rebuilt frozen docs Cleaned up a few Sphinx warnings. Signed-off-by: Craig Zerouni --- .../frozen/pyopencolorio_allocation.rst | 37 - .../pyopencolorio_allocationfromstring.rst | 8 - .../pyopencolorio_allocationtostring.rst | 8 - .../pyopencolorio_allocationtransform.rst | 56 - .../api/python/frozen/pyopencolorio_baker.rst | 181 --- .../python/frozen/pyopencolorio_bitdepth.rst | 81 - .../pyopencolorio_bitdepthfromstring.rst | 8 - .../frozen/pyopencolorio_bitdepthisfloat.rst | 8 - .../frozen/pyopencolorio_bitdepthtoint.rst | 8 - .../frozen/pyopencolorio_bitdepthtostring.rst | 8 - .../frozen/pyopencolorio_boolfromstring.rst | 8 - .../frozen/pyopencolorio_booltostring.rst | 8 - .../frozen/pyopencolorio_builtintransform.rst | 54 - ...pyopencolorio_builtintransformregistry.rst | 60 - .../python/frozen/pyopencolorio_cdlstyle.rst | 37 - .../pyopencolorio_cdlstylefromstring.rst | 8 - .../frozen/pyopencolorio_cdlstyletostring.rst | 8 - .../frozen/pyopencolorio_cdltransform.rst | 151 -- .../frozen/pyopencolorio_channelordering.rst | 53 - .../frozen/pyopencolorio_clearallcaches.rst | 15 - .../frozen/pyopencolorio_colorspace.rst | 255 --- .../pyopencolorio_colorspacedirection.rst | 30 - .../pyopencolorio_colorspacehelpers.rst | 2 +- .../pyopencolorio_colorspacemenuhelper.rst | 32 +- ...pyopencolorio_colorspacemenuparameters.rst | 47 +- .../frozen/pyopencolorio_colorspaceset.rst | 159 -- .../pyopencolorio_colorspacetransform.rst | 64 - .../pyopencolorio_colorspacevisibility.rst | 37 - ...opencolorio_combinetransformdirections.rst | 8 - .../python/frozen/pyopencolorio_config.rst | 1387 ----------------- .../python/frozen/pyopencolorio_context.rst | 191 --- .../frozen/pyopencolorio_cpuprocessor.rst | 39 +- .../pyopencolorio_displayviewhelpers.rst | 8 +- .../pyopencolorio_displayviewtransform.rst | 88 -- .../frozen/pyopencolorio_dynamicproperty.rst | 105 -- .../pyopencolorio_dynamicpropertytype.rst | 60 - .../frozen/pyopencolorio_environmentmode.rst | 37 - ...yopencolorio_environmentmodefromstring.rst | 8 - .../pyopencolorio_environmentmodetostring.rst | 8 - .../python/frozen/pyopencolorio_exception.rst | 13 - .../pyopencolorio_exceptionmissingfile.rst | 12 - .../pyopencolorio_exponenttransform.rst | 75 - ...pencolorio_exponentwithlineartransform.rst | 95 -- .../pyopencolorio_exposurecontraststyle.rst | 39 - ...olorio_exposurecontraststylefromstring.rst | 8 - ...ncolorio_exposurecontraststyletostring.rst | 8 - ...yopencolorio_exposurecontrasttransform.rst | 160 -- .../python/frozen/pyopencolorio_filerules.rst | 181 --- .../frozen/pyopencolorio_filetransform.rst | 101 -- .../pyopencolorio_fixedfunctionstyle.rst | 109 -- ...encolorio_fixedfunctionstylefromstring.rst | 8 - ...opencolorio_fixedfunctionstyletostring.rst | 8 - .../pyopencolorio_fixedfunctiontransform.rst | 64 - .../frozen/pyopencolorio_formatmetadata.rst | 184 --- .../frozen/pyopencolorio_getenvvariable.rst | 10 - ...encolorio_getinversetransformdirection.rst | 8 - .../frozen/pyopencolorio_getlogginglevel.rst | 12 - .../frozen/pyopencolorio_getversion.rst | 12 - .../frozen/pyopencolorio_getversionhex.rst | 12 - .../frozen/pyopencolorio_gpulanguage.rst | 74 - .../pyopencolorio_gpulanguagefromstring.rst | 8 - .../pyopencolorio_gpulanguagetostring.rst | 8 - .../frozen/pyopencolorio_gpuprocessor.rst | 9 +- .../frozen/pyopencolorio_gpushadercreator.rst | 278 ---- .../frozen/pyopencolorio_gpushaderdesc.rst | 568 ------- .../pyopencolorio_gradingbsplinecurve.rst | 60 - .../pyopencolorio_gradingcontrolpoint.rst | 28 - .../frozen/pyopencolorio_gradingprimary.rst | 82 - .../pyopencolorio_gradingprimarytransform.rst | 93 -- .../frozen/pyopencolorio_gradingrgbcurve.rst | 38 - ...pyopencolorio_gradingrgbcurvetransform.rst | 114 -- .../frozen/pyopencolorio_gradingrgbm.rst | 36 - .../frozen/pyopencolorio_gradingrgbmsw.rst | 46 - .../frozen/pyopencolorio_gradingstyle.rst | 39 - .../pyopencolorio_gradingstylefromstring.rst | 8 - .../pyopencolorio_gradingstyletostring.rst | 8 - .../frozen/pyopencolorio_gradingtone.rst | 44 - .../pyopencolorio_gradingtonetransform.rst | 99 -- .../frozen/pyopencolorio_grouptransform.rst | 137 -- .../python/frozen/pyopencolorio_imagedesc.rst | 56 - .../frozen/pyopencolorio_interpolation.rst | 77 - .../pyopencolorio_interpolationfromstring.rst | 8 - .../pyopencolorio_interpolationtostring.rst | 8 - .../pyopencolorio_isenvvariablepresent.rst | 10 - .../pyopencolorio_legacyviewingpipeline.rst | 33 +- .../pyopencolorio_logaffinetransform.rst | 95 -- .../pyopencolorio_logcameratransform.rst | 125 -- .../frozen/pyopencolorio_logginglevel.rst | 51 - .../pyopencolorio_logginglevelfromstring.rst | 8 - .../pyopencolorio_loggingleveltostring.rst | 8 - .../frozen/pyopencolorio_logmessage.rst | 10 - .../frozen/pyopencolorio_logtransform.rst | 62 - docs/api/python/frozen/pyopencolorio_look.rst | 64 - .../frozen/pyopencolorio_looktransform.rst | 72 - .../frozen/pyopencolorio_lut1dhueadjust.rst | 39 - .../frozen/pyopencolorio_lut1dtransform.rst | 140 -- .../frozen/pyopencolorio_lut3dtransform.rst | 108 -- .../frozen/pyopencolorio_matrixtransform.rst | 131 -- .../pyopencolorio_mixingcolorspacemanager.rst | 47 +- .../frozen/pyopencolorio_mixingslider.rst | 13 +- .../frozen/pyopencolorio_namedtransform.rst | 158 -- ...pyopencolorio_namedtransformvisibility.rst | 37 - .../frozen/pyopencolorio_negativestyle.rst | 46 - .../pyopencolorio_negativestylefromstring.rst | 8 - .../pyopencolorio_negativestyletostring.rst | 8 - .../pyopencolorio_optimizationflags.rst | 214 --- .../frozen/pyopencolorio_packedimagedesc.rst | 95 -- .../frozen/pyopencolorio_planarimagedesc.rst | 95 -- .../python/frozen/pyopencolorio_processor.rst | 46 +- .../pyopencolorio_processorcacheflags.rst | 46 - .../pyopencolorio_processormetadata.rst | 29 +- .../frozen/pyopencolorio_rangestyle.rst | 32 - .../pyopencolorio_rangestylefromstring.rst | 8 - .../pyopencolorio_rangestyletostring.rst | 8 - .../frozen/pyopencolorio_rangetransform.rst | 195 --- .../pyopencolorio_referencespacetype.rst | 32 - ...pyopencolorio_resetcomputehashfunction.rst | 8 - ...ncolorio_resettodefaultloggingfunction.rst | 8 - .../frozen/pyopencolorio_rgbcurvetype.rst | 53 - ...pyopencolorio_searchreferencespacetype.rst | 37 - .../pyopencolorio_setcomputehashfunction.rst | 14 - .../frozen/pyopencolorio_setenvvariable.rst | 11 - .../pyopencolorio_setloggingfunction.rst | 13 - .../frozen/pyopencolorio_setlogginglevel.rst | 10 - .../frozen/pyopencolorio_systemmonitors.rst | 38 - .../python/frozen/pyopencolorio_transform.rst | 34 - .../pyopencolorio_transformdirection.rst | 30 - ...encolorio_transformdirectionfromstring.rst | 10 - ...opencolorio_transformdirectiontostring.rst | 8 - .../frozen/pyopencolorio_transformtype.rst | 170 -- .../frozen/pyopencolorio_uniformdatatype.rst | 60 - .../frozen/pyopencolorio_unsetenvvariable.rst | 11 - .../frozen/pyopencolorio_viewingrules.rst | 160 -- .../frozen/pyopencolorio_viewtransform.rst | 124 -- .../pyopencolorio_viewtransformdirection.rst | 30 - .../python/frozen/pyopencolorio_viewtype.rst | 30 - docs/conf.py | 2 +- .../contributing/documentation_guidelines.rst | 47 +- .../contributing/doxygen_style_guide.rst | 4 +- 139 files changed, 203 insertions(+), 9197 deletions(-) delete mode 100644 docs/api/python/frozen/pyopencolorio_allocation.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_allocationfromstring.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_allocationtostring.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_allocationtransform.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_baker.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_bitdepth.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_bitdepthfromstring.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_bitdepthisfloat.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_bitdepthtoint.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_bitdepthtostring.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_boolfromstring.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_booltostring.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_builtintransform.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_builtintransformregistry.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_cdlstyle.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_cdlstylefromstring.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_cdlstyletostring.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_cdltransform.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_channelordering.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_clearallcaches.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_colorspace.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_colorspacedirection.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_colorspaceset.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_colorspacetransform.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_colorspacevisibility.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_combinetransformdirections.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_config.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_context.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_displayviewtransform.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_dynamicproperty.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_dynamicpropertytype.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_environmentmode.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_environmentmodefromstring.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_environmentmodetostring.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_exception.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_exceptionmissingfile.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_exponenttransform.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_exponentwithlineartransform.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_exposurecontraststyle.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_exposurecontraststylefromstring.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_exposurecontraststyletostring.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_exposurecontrasttransform.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_filerules.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_filetransform.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_fixedfunctionstyle.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_fixedfunctionstylefromstring.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_fixedfunctionstyletostring.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_fixedfunctiontransform.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_formatmetadata.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_getenvvariable.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_getinversetransformdirection.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_getlogginglevel.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_getversion.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_getversionhex.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_gpulanguage.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_gpulanguagefromstring.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_gpulanguagetostring.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_gpushadercreator.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_gpushaderdesc.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_gradingbsplinecurve.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_gradingcontrolpoint.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_gradingprimary.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_gradingprimarytransform.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_gradingrgbcurve.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_gradingrgbcurvetransform.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_gradingrgbm.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_gradingrgbmsw.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_gradingstyle.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_gradingstylefromstring.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_gradingstyletostring.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_gradingtone.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_gradingtonetransform.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_grouptransform.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_imagedesc.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_interpolation.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_interpolationfromstring.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_interpolationtostring.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_isenvvariablepresent.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_logaffinetransform.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_logcameratransform.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_logginglevel.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_logginglevelfromstring.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_loggingleveltostring.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_logmessage.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_logtransform.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_look.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_looktransform.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_lut1dhueadjust.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_lut1dtransform.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_lut3dtransform.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_matrixtransform.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_namedtransform.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_namedtransformvisibility.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_negativestyle.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_negativestylefromstring.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_negativestyletostring.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_optimizationflags.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_packedimagedesc.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_planarimagedesc.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_processorcacheflags.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_rangestyle.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_rangestylefromstring.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_rangestyletostring.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_rangetransform.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_referencespacetype.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_resetcomputehashfunction.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_resettodefaultloggingfunction.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_rgbcurvetype.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_searchreferencespacetype.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_setcomputehashfunction.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_setenvvariable.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_setloggingfunction.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_setlogginglevel.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_systemmonitors.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_transform.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_transformdirection.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_transformdirectionfromstring.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_transformdirectiontostring.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_transformtype.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_uniformdatatype.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_unsetenvvariable.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_viewingrules.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_viewtransform.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_viewtransformdirection.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_viewtype.rst diff --git a/docs/api/python/frozen/pyopencolorio_allocation.rst b/docs/api/python/frozen/pyopencolorio_allocation.rst deleted file mode 100644 index 673e1fd072..0000000000 --- a/docs/api/python/frozen/pyopencolorio_allocation.rst +++ /dev/null @@ -1,37 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: Allocation - :module: PyOpenColorIO - - Members: - - ALLOCATION_UNKNOWN : - - ALLOCATION_UNIFORM : - - ALLOCATION_LG2 : - - .. py:method:: name() -> str - :property: - - .. py:attribute:: Allocation.ALLOCATION_LG2 - :module: PyOpenColorIO - :value: - - - .. py:attribute:: Allocation.ALLOCATION_UNIFORM - :module: PyOpenColorIO - :value: - - - .. py:attribute:: Allocation.ALLOCATION_UNKNOWN - :module: PyOpenColorIO - :value: - - - .. py:property:: Allocation.value - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_allocationfromstring.rst b/docs/api/python/frozen/pyopencolorio_allocationfromstring.rst deleted file mode 100644 index 139fec379f..0000000000 --- a/docs/api/python/frozen/pyopencolorio_allocationfromstring.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: AllocationFromString(str: str) -> PyOpenColorIO.Allocation - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_allocationtostring.rst b/docs/api/python/frozen/pyopencolorio_allocationtostring.rst deleted file mode 100644 index cdd396f39b..0000000000 --- a/docs/api/python/frozen/pyopencolorio_allocationtostring.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: AllocationToString(allocation: PyOpenColorIO.Allocation) -> str - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_allocationtransform.rst b/docs/api/python/frozen/pyopencolorio_allocationtransform.rst deleted file mode 100644 index 3c2cc65619..0000000000 --- a/docs/api/python/frozen/pyopencolorio_allocationtransform.rst +++ /dev/null @@ -1,56 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: AllocationTransform - :module: PyOpenColorIO - - Forward direction wraps the 'expanded' range into the specified, often compressed, range. - - - .. py:method:: AllocationTransform.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.AllocationTransform) -> None - - 2. __init__(self: PyOpenColorIO.AllocationTransform, allocation: PyOpenColorIO.Allocation = , vars: List[float] = [], direction: PyOpenColorIO.TransformDirection = ) -> None - - - .. py:method:: AllocationTransform.getAllocation(self: PyOpenColorIO.AllocationTransform) -> PyOpenColorIO.Allocation - :module: PyOpenColorIO - - - .. py:method:: AllocationTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection - :module: PyOpenColorIO - - - .. py:method:: AllocationTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType - :module: PyOpenColorIO - - - .. py:method:: AllocationTransform.getVars(self: PyOpenColorIO.AllocationTransform) -> List[float] - :module: PyOpenColorIO - - - .. py:method:: AllocationTransform.setAllocation(self: PyOpenColorIO.AllocationTransform, allocation: PyOpenColorIO.Allocation) -> None - :module: PyOpenColorIO - - - .. py:method:: AllocationTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None - :module: PyOpenColorIO - - Note that this only affects the evaluation and not the values stored in the object. - - - .. py:method:: AllocationTransform.setVars(self: PyOpenColorIO.AllocationTransform, vars: List[float]) -> None - :module: PyOpenColorIO - - - .. py:method:: AllocationTransform.validate(self: PyOpenColorIO.Transform) -> None - :module: PyOpenColorIO - - Will throw if data is not valid. - diff --git a/docs/api/python/frozen/pyopencolorio_baker.rst b/docs/api/python/frozen/pyopencolorio_baker.rst deleted file mode 100644 index 48721c0fef..0000000000 --- a/docs/api/python/frozen/pyopencolorio_baker.rst +++ /dev/null @@ -1,181 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: Baker - :module: PyOpenColorIO - - In certain situations it is necessary to serialize transforms into a variety of application specific LUT formats. Note that not all file formats that may be read also support baking. - - **Usage Example:** *Bake a CSP sRGB viewer LUT* - - .. code-block:: cpp - - OCIO::ConstConfigRcPtr config = OCIO::Config::CreateFromEnv(); - OCIO::BakerRcPtr baker = OCIO::Baker::Create(); - baker->setConfig(config); - baker->setFormat("csp"); - baker->setInputSpace("lnf"); - baker->setShaperSpace("log"); - baker->setTargetSpace("sRGB"); - auto & metadata = baker->getFormatMetadata(); - metadata.addChildElement(:ref:`OCIO::METADATA_DESCRIPTION`, "A first comment"); - metadata.addChildElement(:ref:`OCIO::METADATA_DESCRIPTION`, "A second comment"); - std::ostringstream out; - baker->bake(out); // fresh bread anyone! - std::cout << out.str(); - - - .. py:method:: Baker.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.Baker) -> None - - Create a new :ref:`Baker`. - - 2. __init__(self: PyOpenColorIO.Baker, config: PyOpenColorIO.Config, format: str, inputSpace: str, targetSpace: str, looks: str = '', cubeSize: int = -1, shaperSpace: str = '', shaperSize: int = -1) -> None - - Create a new :ref:`Baker`. - - - .. py:method:: Baker.bake(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. bake(self: PyOpenColorIO.Baker, fileName: str) -> None - - 2. bake(self: PyOpenColorIO.Baker) -> str - - Bake the LUT into the output stream. - - - .. py:method:: Baker.getConfig(self: PyOpenColorIO.Baker) -> PyOpenColorIO.Config - :module: PyOpenColorIO - - - .. py:method:: Baker.getCubeSize(self: PyOpenColorIO.Baker) -> int - :module: PyOpenColorIO - - - .. py:method:: Baker.getDisplay(self: PyOpenColorIO.Baker) -> str - :module: PyOpenColorIO - - - .. py:method:: Baker.getFormat(self: PyOpenColorIO.Baker) -> str - :module: PyOpenColorIO - - - .. py:method:: Baker.getFormatMetadata(self: PyOpenColorIO.Baker) -> PyOpenColorIO.FormatMetadata - :module: PyOpenColorIO - - - .. py:method:: Baker.getFormats() -> PyOpenColorIO.Baker.FormatIterator - :module: PyOpenColorIO - :staticmethod: - - - .. py:method:: Baker.getInputSpace(self: PyOpenColorIO.Baker) -> str - :module: PyOpenColorIO - - - .. py:method:: Baker.getLooks(self: PyOpenColorIO.Baker) -> str - :module: PyOpenColorIO - - - .. py:method:: Baker.getShaperSize(self: PyOpenColorIO.Baker) -> int - :module: PyOpenColorIO - - - .. py:method:: Baker.getShaperSpace(self: PyOpenColorIO.Baker) -> str - :module: PyOpenColorIO - - - .. py:method:: Baker.getTargetSpace(self: PyOpenColorIO.Baker) -> str - :module: PyOpenColorIO - - - .. py:method:: Baker.getView(self: PyOpenColorIO.Baker) -> str - :module: PyOpenColorIO - - - .. py:method:: Baker.setConfig(self: PyOpenColorIO.Baker, config: PyOpenColorIO.Config) -> None - :module: PyOpenColorIO - - Set the config to use. - - - .. py:method:: Baker.setCubeSize(self: PyOpenColorIO.Baker, cubeSize: int) -> None - :module: PyOpenColorIO - - Override the main LUT (3d or 1d) sample size. Default value is -1, which allows each format to use its own most appropriate size. - - - .. py:method:: Baker.setDisplayView(self: PyOpenColorIO.Baker, display: str, view: str) -> None - :module: PyOpenColorIO - - Set the display and view to apply during the baking. Must not be used if setTargetSpace is used. - - - .. py:method:: Baker.setFormat(self: PyOpenColorIO.Baker, formatName: str) -> None - :module: PyOpenColorIO - - Set the LUT output format. - - - .. py:method:: Baker.setInputSpace(self: PyOpenColorIO.Baker, inputSpace: str) -> None - :module: PyOpenColorIO - - Set the input :ref:`ColorSpace` that the LUT will be applied to. - - - .. py:method:: Baker.setLooks(self: PyOpenColorIO.Baker, looks: str) -> None - :module: PyOpenColorIO - - Set the looks to be applied during baking. Looks is a potentially comma (or colon) delimited list of lookNames, where +/- prefixes are optionally allowed to denote forward/inverse look specification. (And forward is assumed in the absence of either). - - - .. py:method:: Baker.setShaperSize(self: PyOpenColorIO.Baker, shaperSize: int) -> None - :module: PyOpenColorIO - - Override the default shaper LUT size. Default value is -1, which allows each format to use its own most appropriate size. For the CLF format, the default uses a half-domain LUT1D (which is ideal for scene-linear inputs). - - - .. py:method:: Baker.setShaperSpace(self: PyOpenColorIO.Baker, shaperSpace: str) -> None - :module: PyOpenColorIO - - Set an *optional* :ref:`ColorSpace` to shape the incoming values of the LUT. When baking 3DLUT, this will correspond to the 1D shaper used to normalise incoming values to the unit range. When baking 1D LUT, this will be used to determine the input range of the LUT. - - - .. py:method:: Baker.setTargetSpace(self: PyOpenColorIO.Baker, targetSpace: str) -> None - :module: PyOpenColorIO - - Set the target (i.e., output) color space for the LUT. Must not be used if setDisplayView is used. - - -.. py:class:: FormatIterator - :module: PyOpenColorIO.Baker - - Iterator on LUT baker Formats. - - Each item is a tuple containing format name and format extension. - - - .. py:method:: FormatIterator.__getitem__(self: PyOpenColorIO.Baker.FormatIterator, arg0: int) -> tuple - :module: PyOpenColorIO.Baker - - - .. py:method:: FormatIterator.__iter__(self: PyOpenColorIO.Baker.FormatIterator) -> PyOpenColorIO.Baker.FormatIterator - :module: PyOpenColorIO.Baker - - - .. py:method:: FormatIterator.__len__(self: PyOpenColorIO.Baker.FormatIterator) -> int - :module: PyOpenColorIO.Baker - - - .. py:method:: FormatIterator.__next__(self: PyOpenColorIO.Baker.FormatIterator) -> tuple - :module: PyOpenColorIO.Baker - diff --git a/docs/api/python/frozen/pyopencolorio_bitdepth.rst b/docs/api/python/frozen/pyopencolorio_bitdepth.rst deleted file mode 100644 index 982778f0b8..0000000000 --- a/docs/api/python/frozen/pyopencolorio_bitdepth.rst +++ /dev/null @@ -1,81 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: BitDepth - :module: PyOpenColorIO - - Used in a configuration file to indicate the bit-depth of a color space, and by the :ref:`Processor` to specify the input and output bit-depths of images to process. Note that :ref:`Processor` only supports: UINT8, UINT10, UINT12, UINT16, F16 and F32. - - Members: - - BIT_DEPTH_UNKNOWN : - - BIT_DEPTH_UINT8 : - - BIT_DEPTH_UINT10 : - - BIT_DEPTH_UINT12 : - - BIT_DEPTH_UINT14 : - - BIT_DEPTH_UINT16 : - - BIT_DEPTH_UINT32 : Here for historical reason but that's not supported. - - BIT_DEPTH_F16 : - - BIT_DEPTH_F32 : - - .. py:method:: name() -> str - :property: - - .. py:attribute:: BitDepth.BIT_DEPTH_F16 - :module: PyOpenColorIO - :value: - - - .. py:attribute:: BitDepth.BIT_DEPTH_F32 - :module: PyOpenColorIO - :value: - - - .. py:attribute:: BitDepth.BIT_DEPTH_UINT10 - :module: PyOpenColorIO - :value: - - - .. py:attribute:: BitDepth.BIT_DEPTH_UINT12 - :module: PyOpenColorIO - :value: - - - .. py:attribute:: BitDepth.BIT_DEPTH_UINT14 - :module: PyOpenColorIO - :value: - - - .. py:attribute:: BitDepth.BIT_DEPTH_UINT16 - :module: PyOpenColorIO - :value: - - - .. py:attribute:: BitDepth.BIT_DEPTH_UINT32 - :module: PyOpenColorIO - :value: - - - .. py:attribute:: BitDepth.BIT_DEPTH_UINT8 - :module: PyOpenColorIO - :value: - - - .. py:attribute:: BitDepth.BIT_DEPTH_UNKNOWN - :module: PyOpenColorIO - :value: - - - .. py:property:: BitDepth.value - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_bitdepthfromstring.rst b/docs/api/python/frozen/pyopencolorio_bitdepthfromstring.rst deleted file mode 100644 index 1480a4fbc1..0000000000 --- a/docs/api/python/frozen/pyopencolorio_bitdepthfromstring.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: BitDepthFromString(str: str) -> PyOpenColorIO.BitDepth - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_bitdepthisfloat.rst b/docs/api/python/frozen/pyopencolorio_bitdepthisfloat.rst deleted file mode 100644 index e939b924f7..0000000000 --- a/docs/api/python/frozen/pyopencolorio_bitdepthisfloat.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: BitDepthIsFloat(bitDepth: PyOpenColorIO.BitDepth) -> bool - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_bitdepthtoint.rst b/docs/api/python/frozen/pyopencolorio_bitdepthtoint.rst deleted file mode 100644 index 751498c402..0000000000 --- a/docs/api/python/frozen/pyopencolorio_bitdepthtoint.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: BitDepthToInt(bitDepth: PyOpenColorIO.BitDepth) -> int - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_bitdepthtostring.rst b/docs/api/python/frozen/pyopencolorio_bitdepthtostring.rst deleted file mode 100644 index 2aca2f39fd..0000000000 --- a/docs/api/python/frozen/pyopencolorio_bitdepthtostring.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: BitDepthToString(bitDepth: PyOpenColorIO.BitDepth) -> str - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_boolfromstring.rst b/docs/api/python/frozen/pyopencolorio_boolfromstring.rst deleted file mode 100644 index 9907e10ece..0000000000 --- a/docs/api/python/frozen/pyopencolorio_boolfromstring.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: BoolFromString(str: str) -> bool - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_booltostring.rst b/docs/api/python/frozen/pyopencolorio_booltostring.rst deleted file mode 100644 index 31de782aa6..0000000000 --- a/docs/api/python/frozen/pyopencolorio_booltostring.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: BoolToString(value: bool) -> str - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_builtintransform.rst b/docs/api/python/frozen/pyopencolorio_builtintransform.rst deleted file mode 100644 index 9f9f5ca9c9..0000000000 --- a/docs/api/python/frozen/pyopencolorio_builtintransform.rst +++ /dev/null @@ -1,54 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: BuiltinTransform - :module: PyOpenColorIO - - A built-in transform is similar to a :ref:`FileTransform`, but without the file. OCIO knows how to build a set of commonly used transforms on-demand, thus avoiding the need for external files and simplifying config authoring. - - - .. py:method:: BuiltinTransform.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.BuiltinTransform) -> None - - 2. __init__(self: PyOpenColorIO.BuiltinTransform, style: str = 'IDENTITY', direction: PyOpenColorIO.TransformDirection = ) -> None - - - .. py:method:: BuiltinTransform.getDescription(self: PyOpenColorIO.BuiltinTransform) -> str - :module: PyOpenColorIO - - - .. py:method:: BuiltinTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection - :module: PyOpenColorIO - - - .. py:method:: BuiltinTransform.getStyle(self: PyOpenColorIO.BuiltinTransform) -> str - :module: PyOpenColorIO - - - .. py:method:: BuiltinTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType - :module: PyOpenColorIO - - - .. py:method:: BuiltinTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None - :module: PyOpenColorIO - - Note that this only affects the evaluation and not the values stored in the object. - - - .. py:method:: BuiltinTransform.setStyle(self: PyOpenColorIO.BuiltinTransform, style: str) -> None - :module: PyOpenColorIO - - Select an existing built-in transform style from the list accessible through :cpp:class:`:ref:`BuiltinTransformRegistry``. The style is the ID string that identifies which transform to apply. - - - .. py:method:: BuiltinTransform.validate(self: PyOpenColorIO.Transform) -> None - :module: PyOpenColorIO - - Will throw if data is not valid. - diff --git a/docs/api/python/frozen/pyopencolorio_builtintransformregistry.rst b/docs/api/python/frozen/pyopencolorio_builtintransformregistry.rst deleted file mode 100644 index be93f40fe8..0000000000 --- a/docs/api/python/frozen/pyopencolorio_builtintransformregistry.rst +++ /dev/null @@ -1,60 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: BuiltinTransformRegistry - :module: PyOpenColorIO - - The built-in transform registry contains all the existing built-in transforms which can be used by a configuration (version 2 or higher only). - - - .. py:method:: BuiltinTransformRegistry.__init__(self: PyOpenColorIO.BuiltinTransformRegistry) -> None - :module: PyOpenColorIO - - Get the current built-in transform registry. - - - .. py:method:: BuiltinTransformRegistry.getBuiltins(self: PyOpenColorIO.BuiltinTransformRegistry) -> PyOpenColorIO.BuiltinTransformRegistry.BuiltinIterator - :module: PyOpenColorIO - - -.. py:class:: BuiltinStyleIterator - :module: PyOpenColorIO.BuiltinTransformRegistry - - - .. py:method:: BuiltinStyleIterator.__getitem__(self: PyOpenColorIO.BuiltinTransformRegistry.BuiltinStyleIterator, arg0: int) -> str - :module: PyOpenColorIO.BuiltinTransformRegistry - - - .. py:method:: BuiltinStyleIterator.__iter__(self: PyOpenColorIO.BuiltinTransformRegistry.BuiltinStyleIterator) -> PyOpenColorIO.BuiltinTransformRegistry.BuiltinStyleIterator - :module: PyOpenColorIO.BuiltinTransformRegistry - - - .. py:method:: BuiltinStyleIterator.__len__(self: PyOpenColorIO.BuiltinTransformRegistry.BuiltinStyleIterator) -> int - :module: PyOpenColorIO.BuiltinTransformRegistry - - - .. py:method:: BuiltinStyleIterator.__next__(self: PyOpenColorIO.BuiltinTransformRegistry.BuiltinStyleIterator) -> str - :module: PyOpenColorIO.BuiltinTransformRegistry - - -.. py:class:: BuiltinIterator - :module: PyOpenColorIO.BuiltinTransformRegistry - - - .. py:method:: BuiltinIterator.__getitem__(self: PyOpenColorIO.BuiltinTransformRegistry.BuiltinIterator, arg0: int) -> tuple - :module: PyOpenColorIO.BuiltinTransformRegistry - - - .. py:method:: BuiltinIterator.__iter__(self: PyOpenColorIO.BuiltinTransformRegistry.BuiltinIterator) -> PyOpenColorIO.BuiltinTransformRegistry.BuiltinIterator - :module: PyOpenColorIO.BuiltinTransformRegistry - - - .. py:method:: BuiltinIterator.__len__(self: PyOpenColorIO.BuiltinTransformRegistry.BuiltinIterator) -> int - :module: PyOpenColorIO.BuiltinTransformRegistry - - - .. py:method:: BuiltinIterator.__next__(self: PyOpenColorIO.BuiltinTransformRegistry.BuiltinIterator) -> tuple - :module: PyOpenColorIO.BuiltinTransformRegistry - diff --git a/docs/api/python/frozen/pyopencolorio_cdlstyle.rst b/docs/api/python/frozen/pyopencolorio_cdlstyle.rst deleted file mode 100644 index 8130dbb3f3..0000000000 --- a/docs/api/python/frozen/pyopencolorio_cdlstyle.rst +++ /dev/null @@ -1,37 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: CDLStyle - :module: PyOpenColorIO - - Members: - - CDL_ASC : ASC CDL specification v1.2. - - CDL_NO_CLAMP : CDL that does not clamp. - - CDL_TRANSFORM_DEFAULT : - - .. py:method:: name() -> str - :property: - - .. py:attribute:: CDLStyle.CDL_ASC - :module: PyOpenColorIO - :value: - - - .. py:attribute:: CDLStyle.CDL_NO_CLAMP - :module: PyOpenColorIO - :value: - - - .. py:attribute:: CDLStyle.CDL_TRANSFORM_DEFAULT - :module: PyOpenColorIO - :value: - - - .. py:property:: CDLStyle.value - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_cdlstylefromstring.rst b/docs/api/python/frozen/pyopencolorio_cdlstylefromstring.rst deleted file mode 100644 index dd20c3a311..0000000000 --- a/docs/api/python/frozen/pyopencolorio_cdlstylefromstring.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: CDLStyleFromString(str: str) -> PyOpenColorIO.CDLStyle - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_cdlstyletostring.rst b/docs/api/python/frozen/pyopencolorio_cdlstyletostring.rst deleted file mode 100644 index 81f65d6fd7..0000000000 --- a/docs/api/python/frozen/pyopencolorio_cdlstyletostring.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: CDLStyleToString(style: PyOpenColorIO.CDLStyle) -> str - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_cdltransform.rst b/docs/api/python/frozen/pyopencolorio_cdltransform.rst deleted file mode 100644 index b7be310f53..0000000000 --- a/docs/api/python/frozen/pyopencolorio_cdltransform.rst +++ /dev/null @@ -1,151 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: CDLTransform - :module: PyOpenColorIO - - An implementation of the ASC Color Decision List (CDL), based on the ASC v1.2 specification. - - **ASC_SOP** - - Slope, offset, power:: out = clamp( (in * slope) + offset ) ^ power - - .. note:: - ​ If the config version is 1, negative values are clamped if the power is not 1.0. For config version 2 and higher, the negative handling is controlled by the CDL style. - - - .. py:method:: CDLTransform.CreateFromFile(src: str, id: str) -> PyOpenColorIO.CDLTransform - :module: PyOpenColorIO - :staticmethod: - - Load the CDL from the src .cdl, .cc, or .ccc file. - - .. note:: - The cccid can be the ID of a CDL or the index of the CDL (as string). If cccid is NULL or empty the first CDL is returned. The cccid is case-sensitive. The src must be an absolute path reference, no relative directory or envvar resolution is performed. Throws if file does not contain any CDL or if the specified cccid is not found. - - - .. py:method:: CDLTransform.CreateGroupFromFile(src: str) -> PyOpenColorIO.GroupTransform - :module: PyOpenColorIO - :staticmethod: - - Load all of the CDLs in a .cdl or .ccc file into a single :ref:`GroupTransform`. - - .. note:: - This may be useful as a quicker way for applications to check the contents of each of the CDLs. The src must be an absolute path reference, no relative directory or envvar resolution is performed. - - - .. py:method:: CDLTransform.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.CDLTransform) -> None - - 2. __init__(self: PyOpenColorIO.CDLTransform, direction: PyOpenColorIO.TransformDirection = ) -> None - - 3. __init__(self: PyOpenColorIO.CDLTransform, slope: List[float[3]] = [1.0, 1.0, 1.0], offset: List[float[3]] = [0.0, 0.0, 0.0], power: List[float[3]] = [1.0, 1.0, 1.0], sat: float = 1.0, id: str = '', description: str = '', direction: PyOpenColorIO.TransformDirection = ) -> None - - - .. py:method:: CDLTransform.equals(self: PyOpenColorIO.CDLTransform, other: PyOpenColorIO.CDLTransform) -> bool - :module: PyOpenColorIO - - - .. py:method:: CDLTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection - :module: PyOpenColorIO - - - .. py:method:: CDLTransform.getFirstSOPDescription(self: PyOpenColorIO.CDLTransform) -> str - :module: PyOpenColorIO - - - .. py:method:: CDLTransform.getFormatMetadata(self: PyOpenColorIO.CDLTransform) -> PyOpenColorIO.FormatMetadata - :module: PyOpenColorIO - - - .. py:method:: CDLTransform.getID(self: PyOpenColorIO.CDLTransform) -> str - :module: PyOpenColorIO - - The get/setID methods are now deprecated. The preferred way of interacting with the ID is now via the transform's formatMetadata. - - - .. py:method:: CDLTransform.getOffset(self: PyOpenColorIO.CDLTransform) -> List[float[3]] - :module: PyOpenColorIO - - - .. py:method:: CDLTransform.getPower(self: PyOpenColorIO.CDLTransform) -> List[float[3]] - :module: PyOpenColorIO - - - .. py:method:: CDLTransform.getSOP(self: PyOpenColorIO.CDLTransform) -> List[float[9]] - :module: PyOpenColorIO - - - .. py:method:: CDLTransform.getSat(self: PyOpenColorIO.CDLTransform) -> float - :module: PyOpenColorIO - - - .. py:method:: CDLTransform.getSatLumaCoefs(self: PyOpenColorIO.CDLTransform) -> List[float[3]] - :module: PyOpenColorIO - - These are hard-coded, by spec, to r709. - - - .. py:method:: CDLTransform.getSlope(self: PyOpenColorIO.CDLTransform) -> List[float[3]] - :module: PyOpenColorIO - - - .. py:method:: CDLTransform.getStyle(self: PyOpenColorIO.CDLTransform) -> PyOpenColorIO.CDLStyle - :module: PyOpenColorIO - - - .. py:method:: CDLTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType - :module: PyOpenColorIO - - - .. py:method:: CDLTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None - :module: PyOpenColorIO - - Note that this only affects the evaluation and not the values stored in the object. - - - .. py:method:: CDLTransform.setFirstSOPDescription(self: PyOpenColorIO.CDLTransform, description: str) -> None - :module: PyOpenColorIO - - - .. py:method:: CDLTransform.setID(self: PyOpenColorIO.CDLTransform, id: str) -> None - :module: PyOpenColorIO - - - .. py:method:: CDLTransform.setOffset(self: PyOpenColorIO.CDLTransform, rgb: List[float[3]]) -> None - :module: PyOpenColorIO - - - .. py:method:: CDLTransform.setPower(self: PyOpenColorIO.CDLTransform, rgb: List[float[3]]) -> None - :module: PyOpenColorIO - - - .. py:method:: CDLTransform.setSOP(self: PyOpenColorIO.CDLTransform, vec9: List[float[9]]) -> None - :module: PyOpenColorIO - - - .. py:method:: CDLTransform.setSat(self: PyOpenColorIO.CDLTransform, sat: float) -> None - :module: PyOpenColorIO - - - .. py:method:: CDLTransform.setSlope(self: PyOpenColorIO.CDLTransform, rgb: List[float[3]]) -> None - :module: PyOpenColorIO - - - .. py:method:: CDLTransform.setStyle(self: PyOpenColorIO.CDLTransform, style: PyOpenColorIO.CDLStyle) -> None - :module: PyOpenColorIO - - Use CDL_ASC to clamp values to [0,1] per the ASC spec. Use NO_CLAMP to never clamp values (regardless of whether power is 1.0). The NO_CLAMP option passes negatives through unchanged (like the NEGATIVE_PASS_THRU style of :ref:`ExponentTransform`). The default style is CDL_NO_CLAMP. - - - .. py:method:: CDLTransform.validate(self: PyOpenColorIO.Transform) -> None - :module: PyOpenColorIO - - Will throw if data is not valid. - diff --git a/docs/api/python/frozen/pyopencolorio_channelordering.rst b/docs/api/python/frozen/pyopencolorio_channelordering.rst deleted file mode 100644 index 4163c1fc4b..0000000000 --- a/docs/api/python/frozen/pyopencolorio_channelordering.rst +++ /dev/null @@ -1,53 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: ChannelOrdering - :module: PyOpenColorIO - - Used by :ref:`PackedImageDesc` to indicate the channel ordering of the image to process. - - Members: - - CHANNEL_ORDERING_RGBA : - - CHANNEL_ORDERING_BGRA : - - CHANNEL_ORDERING_ABGR : - - CHANNEL_ORDERING_RGB : - - CHANNEL_ORDERING_BGR : - - .. py:method:: name() -> str - :property: - - .. py:attribute:: ChannelOrdering.CHANNEL_ORDERING_ABGR - :module: PyOpenColorIO - :value: - - - .. py:attribute:: ChannelOrdering.CHANNEL_ORDERING_BGR - :module: PyOpenColorIO - :value: - - - .. py:attribute:: ChannelOrdering.CHANNEL_ORDERING_BGRA - :module: PyOpenColorIO - :value: - - - .. py:attribute:: ChannelOrdering.CHANNEL_ORDERING_RGB - :module: PyOpenColorIO - :value: - - - .. py:attribute:: ChannelOrdering.CHANNEL_ORDERING_RGBA - :module: PyOpenColorIO - :value: - - - .. py:property:: ChannelOrdering.value - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_clearallcaches.rst b/docs/api/python/frozen/pyopencolorio_clearallcaches.rst deleted file mode 100644 index 1e01d698de..0000000000 --- a/docs/api/python/frozen/pyopencolorio_clearallcaches.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: ClearAllCaches() -> None - :module: PyOpenColorIO - - During normal usage, OpenColorIO tends to cache certain global information (such as the contents of LUTs on disk, intermediate results, etc.). Calling this function will flush all such information. The global information are related to LUT file identifications, loaded LUT file content and CDL transforms from loaded CDL files. - - Under normal usage, this is not necessary, but it can be helpful in particular instances, such as designing OCIO profiles, and wanting to re-read luts without restarting. - - .. note:: - The method does not apply to instance specific caches such as the processor cache in a config instance or the GPU and CPU processor caches in a processor instance. Here deleting the instance flushes the cache. - diff --git a/docs/api/python/frozen/pyopencolorio_colorspace.rst b/docs/api/python/frozen/pyopencolorio_colorspace.rst deleted file mode 100644 index 5a6adf8d99..0000000000 --- a/docs/api/python/frozen/pyopencolorio_colorspace.rst +++ /dev/null @@ -1,255 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: ColorSpace - :module: PyOpenColorIO - - The *:ref:`ColorSpace`* is the state of an image with respect to colorimetry and color encoding. Transforming images between different *ColorSpaces* is the primary motivation for this library. - - While a complete discussion of color spaces is beyond the scope of header documentation, traditional uses would be to have *ColorSpaces* corresponding to: physical capture devices (known cameras, scanners), and internal 'convenience' spaces (such as scene linear, logarithmic). - - - .. py:method:: ColorSpace.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.ColorSpace) -> None - - 2. __init__(self: PyOpenColorIO.ColorSpace, referenceSpace: PyOpenColorIO.ReferenceSpaceType) -> None - - 3. __init__(self: PyOpenColorIO.ColorSpace, referenceSpace: PyOpenColorIO.ReferenceSpaceType = , name: str = '', aliases: List[str] = [], family: str = '', encoding: str = '', equalityGroup: str = '', description: str = '', bitDepth: PyOpenColorIO.BitDepth = , isData: bool = False, allocation: PyOpenColorIO.Allocation = , allocationVars: List[float] = [], toReference: PyOpenColorIO.Transform = None, fromReference: PyOpenColorIO.Transform = None, categories: List[str] = []) -> None - - - .. py:method:: ColorSpace.addAlias(self: PyOpenColorIO.ColorSpace, alias: str) -> None - :module: PyOpenColorIO - - Add an alias for the color space name (the aliases may be used as a synonym for the name). Nothing will be added if the alias is already the color space name, one of its aliases, or the argument is null. The aliases must not conflict with existing roles, color space names, named transform names, or other aliases. This is verified when adding the color space to the config. - - - .. py:method:: ColorSpace.addCategory(self: PyOpenColorIO.ColorSpace, category: str) -> None - :module: PyOpenColorIO - - Add a single category. - - .. note:: - Will do nothing if the category already exists. - - - .. py:method:: ColorSpace.clearAliases(self: PyOpenColorIO.ColorSpace) -> None - :module: PyOpenColorIO - - - .. py:method:: ColorSpace.clearCategories(self: PyOpenColorIO.ColorSpace) -> None - :module: PyOpenColorIO - - Clear all the categories. - - - .. py:method:: ColorSpace.getAliases(self: PyOpenColorIO.ColorSpace) -> PyOpenColorIO.ColorSpace.ColorSpaceAliasIterator - :module: PyOpenColorIO - - - .. py:method:: ColorSpace.getAllocation(self: PyOpenColorIO.ColorSpace) -> PyOpenColorIO.Allocation - :module: PyOpenColorIO - - *Allocation* - - If this colorspace needs to be transferred to a limited dynamic range coding space (such as during display with a GPU path), use this allocation to maximize bit efficiency. - - - .. py:method:: ColorSpace.getAllocationVars(self: PyOpenColorIO.ColorSpace) -> List[float] - :module: PyOpenColorIO - - - .. py:method:: ColorSpace.getBitDepth(self: PyOpenColorIO.ColorSpace) -> PyOpenColorIO.BitDepth - :module: PyOpenColorIO - - - .. py:method:: ColorSpace.getCategories(self: PyOpenColorIO.ColorSpace) -> PyOpenColorIO.ColorSpace.ColorSpaceCategoryIterator - :module: PyOpenColorIO - - - .. py:method:: ColorSpace.getDescription(self: PyOpenColorIO.ColorSpace) -> str - :module: PyOpenColorIO - - - .. py:method:: ColorSpace.getEncoding(self: PyOpenColorIO.ColorSpace) -> str - :module: PyOpenColorIO - - *Encodings* - - It is sometimes useful for applications to group color spaces based on how the color values are digitally encoded. For example, images in scene-linear, logarithmic, video, and data color spaces could have different default views. Unlike the Family and EqualityGroup attributes of a color space, the list of Encodings is predefined in the OCIO documentation (rather than being config-specific) to make it easier for applications to utilize. - - Here is an example config entry that could appear under a :ref:`ColorSpace`: - - .. code-block:: cpp - - encoding: scene-linear - - Encoding strings are not case-sensitive. Although users may add their own encodings, the strings will typically come from a fixed set listed in the documentation (similar to roles). - - - .. py:method:: ColorSpace.getEqualityGroup(self: PyOpenColorIO.ColorSpace) -> str - :module: PyOpenColorIO - - Get the :ref:`ColorSpace` group name (used for equality comparisons) This allows no-op transforms between different colorspaces. If an equalityGroup is not defined (an empty string), it will be considered unique (i.e., it will not compare as equal to other ColorSpaces with an empty equality group). - - - .. py:method:: ColorSpace.getFamily(self: PyOpenColorIO.ColorSpace) -> str - :module: PyOpenColorIO - - Get the family, for use in user interfaces (optional) The family string could use a '/' separator to indicate levels to be used by hierarchical menus. - - - .. py:method:: ColorSpace.getName(self: PyOpenColorIO.ColorSpace) -> str - :module: PyOpenColorIO - - - .. py:method:: ColorSpace.getReferenceSpaceType(self: PyOpenColorIO.ColorSpace) -> PyOpenColorIO.ReferenceSpaceType - :module: PyOpenColorIO - - A display color space will use the display-referred reference space. - - - .. py:method:: ColorSpace.getTransform(self: PyOpenColorIO.ColorSpace, direction: PyOpenColorIO.ColorSpaceDirection) -> PyOpenColorIO.Transform - :module: PyOpenColorIO - - *:ref:`Transform`* - - If a transform in the specified direction has been specified, return it. Otherwise return a null ConstTransformRcPtr - - - .. py:method:: ColorSpace.hasCategory(self: PyOpenColorIO.ColorSpace, category: str) -> bool - :module: PyOpenColorIO - - Return true if the category is present. - - A category is used to allow applications to filter the list of color spaces they display in menus based on what that color space is used for. - - Here is an example config entry that could appear under a :ref:`ColorSpace`: - - .. code-block:: cpp - - categories: [ file-io, working-space, basic-3d ] - - The example contains three categories: 'file-io', 'working-space' and 'basic-3d'. - - .. note:: - Category strings are not case-sensitive and the order is not significant. - - There is no limit imposed on length or number. Although users may add their own categories, the strings will typically come from a fixed set listed in the documentation (similar to roles). - - - .. py:method:: ColorSpace.isData(self: PyOpenColorIO.ColorSpace) -> bool - :module: PyOpenColorIO - - *Data* - - ColorSpaces that are data are treated a bit special. Basically, any colorspace transforms you try to apply to them are ignored. (Think of applying a gamut mapping transform to an ID pass). However, the setDataBypass method on :ref:`ColorSpaceTransform` and :ref:`DisplayViewTransform` allow applications to process data when necessary. (Think of sending mattes to an HDR monitor.) - - This is traditionally used for pixel data that represents non-color pixel data, such as normals, point positions, ID information, etc. - - - .. py:method:: ColorSpace.removeAlias(self: PyOpenColorIO.ColorSpace, alias: str) -> None - :module: PyOpenColorIO - - Does nothing if alias is not present. - - - .. py:method:: ColorSpace.removeCategory(self: PyOpenColorIO.ColorSpace, category: str) -> None - :module: PyOpenColorIO - - Remove a category. - - .. note:: - Will do nothing if the category is missing. - - - .. py:method:: ColorSpace.setAllocation(self: PyOpenColorIO.ColorSpace, allocation: PyOpenColorIO.Allocation) -> None - :module: PyOpenColorIO - - - .. py:method:: ColorSpace.setAllocationVars(self: PyOpenColorIO.ColorSpace, vars: List[float]) -> None - :module: PyOpenColorIO - - - .. py:method:: ColorSpace.setBitDepth(self: PyOpenColorIO.ColorSpace, bitDepth: PyOpenColorIO.BitDepth) -> None - :module: PyOpenColorIO - - - .. py:method:: ColorSpace.setDescription(self: PyOpenColorIO.ColorSpace, description: str) -> None - :module: PyOpenColorIO - - - .. py:method:: ColorSpace.setEncoding(self: PyOpenColorIO.ColorSpace, encoding: str) -> None - :module: PyOpenColorIO - - - .. py:method:: ColorSpace.setEqualityGroup(self: PyOpenColorIO.ColorSpace, equalityGroup: str) -> None - :module: PyOpenColorIO - - - .. py:method:: ColorSpace.setFamily(self: PyOpenColorIO.ColorSpace, family: str) -> None - :module: PyOpenColorIO - - Set the family, for use in user interfaces (optional) - - - .. py:method:: ColorSpace.setIsData(self: PyOpenColorIO.ColorSpace, isData: bool) -> None - :module: PyOpenColorIO - - - .. py:method:: ColorSpace.setName(self: PyOpenColorIO.ColorSpace, name: str) -> None - :module: PyOpenColorIO - - If the name is already an alias, that alias is removed. - - - .. py:method:: ColorSpace.setTransform(self: PyOpenColorIO.ColorSpace, transform: PyOpenColorIO.Transform, direction: PyOpenColorIO.ColorSpaceDirection) -> None - :module: PyOpenColorIO - - Specify the transform for the appropriate direction. Setting the transform to null will clear it. - - -.. py:class:: ColorSpaceCategoryIterator - :module: PyOpenColorIO.ColorSpace - - - .. py:method:: ColorSpaceCategoryIterator.__getitem__(self: PyOpenColorIO.ColorSpace.ColorSpaceCategoryIterator, arg0: int) -> str - :module: PyOpenColorIO.ColorSpace - - - .. py:method:: ColorSpaceCategoryIterator.__iter__(self: PyOpenColorIO.ColorSpace.ColorSpaceCategoryIterator) -> PyOpenColorIO.ColorSpace.ColorSpaceCategoryIterator - :module: PyOpenColorIO.ColorSpace - - - .. py:method:: ColorSpaceCategoryIterator.__len__(self: PyOpenColorIO.ColorSpace.ColorSpaceCategoryIterator) -> int - :module: PyOpenColorIO.ColorSpace - - - .. py:method:: ColorSpaceCategoryIterator.__next__(self: PyOpenColorIO.ColorSpace.ColorSpaceCategoryIterator) -> str - :module: PyOpenColorIO.ColorSpace - - -.. py:class:: ColorSpaceAliasIterator - :module: PyOpenColorIO.ColorSpace - - - .. py:method:: ColorSpaceAliasIterator.__getitem__(self: PyOpenColorIO.ColorSpace.ColorSpaceAliasIterator, arg0: int) -> str - :module: PyOpenColorIO.ColorSpace - - - .. py:method:: ColorSpaceAliasIterator.__iter__(self: PyOpenColorIO.ColorSpace.ColorSpaceAliasIterator) -> PyOpenColorIO.ColorSpace.ColorSpaceAliasIterator - :module: PyOpenColorIO.ColorSpace - - - .. py:method:: ColorSpaceAliasIterator.__len__(self: PyOpenColorIO.ColorSpace.ColorSpaceAliasIterator) -> int - :module: PyOpenColorIO.ColorSpace - - - .. py:method:: ColorSpaceAliasIterator.__next__(self: PyOpenColorIO.ColorSpace.ColorSpaceAliasIterator) -> str - :module: PyOpenColorIO.ColorSpace - diff --git a/docs/api/python/frozen/pyopencolorio_colorspacedirection.rst b/docs/api/python/frozen/pyopencolorio_colorspacedirection.rst deleted file mode 100644 index dd0ea99c02..0000000000 --- a/docs/api/python/frozen/pyopencolorio_colorspacedirection.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: ColorSpaceDirection - :module: PyOpenColorIO - - Members: - - COLORSPACE_DIR_TO_REFERENCE : - - COLORSPACE_DIR_FROM_REFERENCE : - - .. py:method:: name() -> str - :property: - - .. py:attribute:: ColorSpaceDirection.COLORSPACE_DIR_FROM_REFERENCE - :module: PyOpenColorIO - :value: - - - .. py:attribute:: ColorSpaceDirection.COLORSPACE_DIR_TO_REFERENCE - :module: PyOpenColorIO - :value: - - - .. py:property:: ColorSpaceDirection.value - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_colorspacehelpers.rst b/docs/api/python/frozen/pyopencolorio_colorspacehelpers.rst index 938855a665..977888f18a 100644 --- a/docs/api/python/frozen/pyopencolorio_colorspacehelpers.rst +++ b/docs/api/python/frozen/pyopencolorio_colorspacehelpers.rst @@ -3,7 +3,7 @@ Copyright Contributors to the OpenColorIO Project. Do not edit! This file was automatically generated by share/docs/frozendoc.py. -.. py:function:: AddColorSpace(config: PyOpenColorIO.Config, name: str, transformFilePath: str, categories: str = '', connectionColorSpaceName: str) -> None +.. py:function:: AddColorSpace(config: PyOpenColorIO.PyOpenColorIO.Config, name: str, transformFilePath: str, categories: str = '', connectionColorSpaceName: str) -> None :module: PyOpenColorIO.ColorSpaceHelpers Add a new color space to the config instance. The output of the userTransform must be in the specified connectionColorSpace. diff --git a/docs/api/python/frozen/pyopencolorio_colorspacemenuhelper.rst b/docs/api/python/frozen/pyopencolorio_colorspacemenuhelper.rst index ad7514adaa..99a350fea8 100644 --- a/docs/api/python/frozen/pyopencolorio_colorspacemenuhelper.rst +++ b/docs/api/python/frozen/pyopencolorio_colorspacemenuhelper.rst @@ -5,6 +5,7 @@ .. py:class:: ColorSpaceMenuHelper :module: PyOpenColorIO + :canonical: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper Helper class to create menus for the content of a config. @@ -15,57 +16,57 @@ The overall ordering of items is: color spaces, named transforms, roles, and additional color spaces. The display color spaces will either come before or after the other color spaces based on where that block of spaces appears in the config. The order of items returned by the menu helper preserves the order of items in the config itself for each type of elements, thus preserving the intent of the config author. For example, if you call getName at idx and idx+1, the name returned at idx+1 will be from farther down in the config than the one at idx as long as both are of the same type. (An application may ask for only the items in one of those blocks if it wants to handle them separately.) If the application makes use of hierarchical menus, that will obviously impose a different order on what the user sees in the menu. Though even with hierarchical menus, applications should try to preserve config ordering (which is equivalent to index ordering) for items within the same sub-menu. - .. py:method:: ColorSpaceMenuHelper.__init__(self: PyOpenColorIO.ColorSpaceMenuHelper, parameters: PyOpenColorIO.ColorSpaceMenuParameters) -> None + .. py:method:: ColorSpaceMenuHelper.__init__(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper, parameters: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters) -> None :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuHelper.getDescription(self: PyOpenColorIO.ColorSpaceMenuHelper, index: int) -> str + .. py:method:: ColorSpaceMenuHelper.getDescription(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper, index: int) -> str :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuHelper.getFamily(self: PyOpenColorIO.ColorSpaceMenuHelper, index: int) -> str + .. py:method:: ColorSpaceMenuHelper.getFamily(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper, index: int) -> str :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuHelper.getHierarchyLevels(self: PyOpenColorIO.ColorSpaceMenuHelper, index: int) -> PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator + .. py:method:: ColorSpaceMenuHelper.getHierarchyLevels(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper, index: int) -> PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuHelper.getIndexFromName(self: PyOpenColorIO.ColorSpaceMenuHelper, name: str) -> int + .. py:method:: ColorSpaceMenuHelper.getIndexFromName(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper, name: str) -> int :module: PyOpenColorIO Get the index of the element of a given name. Return (size_t)-1 name if NULL or empty, or if no element with that name is found. - .. py:method:: ColorSpaceMenuHelper.getIndexFromUIName(self: PyOpenColorIO.ColorSpaceMenuHelper, name: str) -> int + .. py:method:: ColorSpaceMenuHelper.getIndexFromUIName(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper, name: str) -> int :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuHelper.getName(self: PyOpenColorIO.ColorSpaceMenuHelper, index: int) -> str + .. py:method:: ColorSpaceMenuHelper.getName(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper, index: int) -> str :module: PyOpenColorIO Get the color space (or role) name used in the config for this menu item. Will be empty if the index is out of range. - .. py:method:: ColorSpaceMenuHelper.getNameFromUIName(self: PyOpenColorIO.ColorSpaceMenuHelper, name: str) -> str + .. py:method:: ColorSpaceMenuHelper.getNameFromUIName(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper, name: str) -> str :module: PyOpenColorIO Get the color space name from the UI name. - .. py:method:: ColorSpaceMenuHelper.getNumColorSpaces(self: PyOpenColorIO.ColorSpaceMenuHelper) -> int + .. py:method:: ColorSpaceMenuHelper.getNumColorSpaces(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper) -> int :module: PyOpenColorIO Access to the color spaces (or roles). - .. py:method:: ColorSpaceMenuHelper.getUIName(self: PyOpenColorIO.ColorSpaceMenuHelper, index: int) -> str + .. py:method:: ColorSpaceMenuHelper.getUIName(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper, index: int) -> str :module: PyOpenColorIO Get the name to use in the menu UI. This might be different from the config name, for example in the case of roles. Will be empty if the index is out of range. - .. py:method:: ColorSpaceMenuHelper.getUINameFromName(self: PyOpenColorIO.ColorSpaceMenuHelper, name: str) -> str + .. py:method:: ColorSpaceMenuHelper.getUINameFromName(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper, name: str) -> str :module: PyOpenColorIO Get the color space UI name from the name. @@ -73,20 +74,21 @@ .. py:class:: ColorSpaceLevelIterator :module: PyOpenColorIO.ColorSpaceMenuHelper + :canonical: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator - .. py:method:: ColorSpaceLevelIterator.__getitem__(self: PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator, arg0: int) -> str + .. py:method:: ColorSpaceLevelIterator.__getitem__(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator, arg0: int) -> str :module: PyOpenColorIO.ColorSpaceMenuHelper - .. py:method:: ColorSpaceLevelIterator.__iter__(self: PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator) -> PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator + .. py:method:: ColorSpaceLevelIterator.__iter__(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator) -> PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator :module: PyOpenColorIO.ColorSpaceMenuHelper - .. py:method:: ColorSpaceLevelIterator.__len__(self: PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator) -> int + .. py:method:: ColorSpaceLevelIterator.__len__(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator) -> int :module: PyOpenColorIO.ColorSpaceMenuHelper - .. py:method:: ColorSpaceLevelIterator.__next__(self: PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator) -> str + .. py:method:: ColorSpaceLevelIterator.__next__(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator) -> str :module: PyOpenColorIO.ColorSpaceMenuHelper diff --git a/docs/api/python/frozen/pyopencolorio_colorspacemenuparameters.rst b/docs/api/python/frozen/pyopencolorio_colorspacemenuparameters.rst index e197942522..d08c4b441a 100644 --- a/docs/api/python/frozen/pyopencolorio_colorspacemenuparameters.rst +++ b/docs/api/python/frozen/pyopencolorio_colorspacemenuparameters.rst @@ -5,6 +5,7 @@ .. py:class:: ColorSpaceMenuParameters :module: PyOpenColorIO + :canonical: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters Parameters controlling which color spaces appear in menus. @@ -51,12 +52,12 @@ Overloaded function. - 1. __init__(self: PyOpenColorIO.ColorSpaceMenuParameters, config: PyOpenColorIO.Config) -> None + 1. __init__(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters, config: PyOpenColorIO.PyOpenColorIO.Config) -> None - 2. __init__(self: PyOpenColorIO.ColorSpaceMenuParameters, config: PyOpenColorIO.Config, role: str = '', includeColorSpaces: bool = True, searchReferenceSpaceType: PyOpenColorIO.SearchReferenceSpaceType = , includeNamedTransforms: bool = False, appCategories: str = '', encodings: str = '', userCategories: str = '', includeRoles: bool = False) -> None + 2. __init__(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters, config: PyOpenColorIO.PyOpenColorIO.Config, role: str = '', includeColorSpaces: bool = True, searchReferenceSpaceType: PyOpenColorIO.PyOpenColorIO.SearchReferenceSpaceType = , includeNamedTransforms: bool = False, appCategories: str = '', encodings: str = '', userCategories: str = '', includeRoles: bool = False) -> None - .. py:method:: ColorSpaceMenuParameters.addColorSpace(self: PyOpenColorIO.ColorSpaceMenuParameters, colorSpace: str) -> None + .. py:method:: ColorSpaceMenuParameters.addColorSpace(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters, colorSpace: str) -> None :module: PyOpenColorIO Add an additional color space (or named transform) to the menu. @@ -67,99 +68,99 @@ - a newly created color space. Will throw when creating the menu if color space is not part of the config. Nothing is done if it is already part of the menu. It's ok to call this multiple times with the same color space, it will only be added to the menu once. If a role name is passed in, the name in the menu will be the color space name the role points to. - .. py:method:: ColorSpaceMenuParameters.clearAddedColorSpaces(self: PyOpenColorIO.ColorSpaceMenuParameters) -> None + .. py:method:: ColorSpaceMenuParameters.clearAddedColorSpaces(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters) -> None :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuParameters.getAddedColorSpaces(self: PyOpenColorIO.ColorSpaceMenuParameters) -> PyOpenColorIO.ColorSpaceMenuParameters.AddedColorSpaceIterator + .. py:method:: ColorSpaceMenuParameters.getAddedColorSpaces(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters) -> PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters.AddedColorSpaceIterator :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuParameters.getAppCategories(self: PyOpenColorIO.ColorSpaceMenuParameters) -> str + .. py:method:: ColorSpaceMenuParameters.getAppCategories(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters) -> str :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuParameters.getConfig(self: PyOpenColorIO.ColorSpaceMenuParameters) -> PyOpenColorIO.Config + .. py:method:: ColorSpaceMenuParameters.getConfig(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters) -> PyOpenColorIO.PyOpenColorIO.Config :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuParameters.getEncodings(self: PyOpenColorIO.ColorSpaceMenuParameters) -> str + .. py:method:: ColorSpaceMenuParameters.getEncodings(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters) -> str :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuParameters.getIncludeColorSpaces(self: PyOpenColorIO.ColorSpaceMenuParameters) -> bool + .. py:method:: ColorSpaceMenuParameters.getIncludeColorSpaces(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters) -> bool :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuParameters.getIncludeNamedTransforms(self: PyOpenColorIO.ColorSpaceMenuParameters) -> bool + .. py:method:: ColorSpaceMenuParameters.getIncludeNamedTransforms(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters) -> bool :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuParameters.getIncludeRoles(self: PyOpenColorIO.ColorSpaceMenuParameters) -> bool + .. py:method:: ColorSpaceMenuParameters.getIncludeRoles(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters) -> bool :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuParameters.getRole(self: PyOpenColorIO.ColorSpaceMenuParameters) -> str + .. py:method:: ColorSpaceMenuParameters.getRole(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters) -> str :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuParameters.getSearchReferenceSpaceType(self: PyOpenColorIO.ColorSpaceMenuParameters) -> PyOpenColorIO.SearchReferenceSpaceType + .. py:method:: ColorSpaceMenuParameters.getSearchReferenceSpaceType(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters) -> PyOpenColorIO.PyOpenColorIO.SearchReferenceSpaceType :module: PyOpenColorIO Can be used to restrict the search using the ReferenceSpaceType of the color spaces. It has no effect on roles and named transforms. - .. py:method:: ColorSpaceMenuParameters.getUserCategories(self: PyOpenColorIO.ColorSpaceMenuParameters) -> str + .. py:method:: ColorSpaceMenuParameters.getUserCategories(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters) -> str :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuParameters.setAppCategories(self: PyOpenColorIO.ColorSpaceMenuParameters, appCategories: str) -> None + .. py:method:: ColorSpaceMenuParameters.setAppCategories(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters, appCategories: str) -> None :module: PyOpenColorIO App categories is a comma separated list of categories. If appCategories is not NULL and not empty, all color spaces that have one of the categories will be part of the menu. - .. py:method:: ColorSpaceMenuParameters.setConfig(self: PyOpenColorIO.ColorSpaceMenuParameters, config: PyOpenColorIO.Config) -> None + .. py:method:: ColorSpaceMenuParameters.setConfig(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters, config: PyOpenColorIO.PyOpenColorIO.Config) -> None :module: PyOpenColorIO :ref:`Config` is required to be able to create a :ref:`ColorSpaceMenuHelper`. - .. py:method:: ColorSpaceMenuParameters.setEncodings(self: PyOpenColorIO.ColorSpaceMenuParameters, encodings: str) -> None + .. py:method:: ColorSpaceMenuParameters.setEncodings(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters, encodings: str) -> None :module: PyOpenColorIO Encodings is a comma separated list of encodings. When not empty, is retricting the search to color spaces that are using one of the encodings. - .. py:method:: ColorSpaceMenuParameters.setIncludeColorSpaces(self: PyOpenColorIO.ColorSpaceMenuParameters, includeColorSpaces: bool = True) -> None + .. py:method:: ColorSpaceMenuParameters.setIncludeColorSpaces(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters, includeColorSpaces: bool = True) -> None :module: PyOpenColorIO Include all color spaces (or not) to :ref:`ColorSpaceMenuHelper`. Default is to include color spaces. - .. py:method:: ColorSpaceMenuParameters.setIncludeNamedTransforms(self: PyOpenColorIO.ColorSpaceMenuParameters, includeNamedTransforms: bool = True) -> None + .. py:method:: ColorSpaceMenuParameters.setIncludeNamedTransforms(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters, includeNamedTransforms: bool = True) -> None :module: PyOpenColorIO Include all named transforms (or not) to :ref:`ColorSpaceMenuHelper`. Default is not to include named transforms. - .. py:method:: ColorSpaceMenuParameters.setIncludeRoles(self: PyOpenColorIO.ColorSpaceMenuParameters, includeRoles: bool = True) -> None + .. py:method:: ColorSpaceMenuParameters.setIncludeRoles(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters, includeRoles: bool = True) -> None :module: PyOpenColorIO Include all roles (or not) to :ref:`ColorSpaceMenuHelper`. Default is not to include roles. Roles are added after color spaces with an single hierarchy level named "Roles". - .. py:method:: ColorSpaceMenuParameters.setRole(self: PyOpenColorIO.ColorSpaceMenuParameters, role: str) -> None + .. py:method:: ColorSpaceMenuParameters.setRole(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters, role: str) -> None :module: PyOpenColorIO If role is a valid role, other parameters are ignored and menu will contain only that role. - .. py:method:: ColorSpaceMenuParameters.setSearchReferenceSpaceType(self: PyOpenColorIO.ColorSpaceMenuParameters, searchReferenceSpaceType: PyOpenColorIO.SearchReferenceSpaceType) -> None + .. py:method:: ColorSpaceMenuParameters.setSearchReferenceSpaceType(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters, searchReferenceSpaceType: PyOpenColorIO.PyOpenColorIO.SearchReferenceSpaceType) -> None :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuParameters.setUserCategories(self: PyOpenColorIO.ColorSpaceMenuParameters, categories: str) -> None + .. py:method:: ColorSpaceMenuParameters.setUserCategories(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters, categories: str) -> None :module: PyOpenColorIO User categories is a comma separated list of categories. If OCIO_USER_CATEGORIES_ENVVAR env. variable is defined and not empty, this parameter is ignored and the value of the env. variable is used for user categories. diff --git a/docs/api/python/frozen/pyopencolorio_colorspaceset.rst b/docs/api/python/frozen/pyopencolorio_colorspaceset.rst deleted file mode 100644 index a31481df10..0000000000 --- a/docs/api/python/frozen/pyopencolorio_colorspaceset.rst +++ /dev/null @@ -1,159 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: ColorSpaceSet - :module: PyOpenColorIO - - The *:ref:`ColorSpaceSet`* is a set of color spaces (i.e. no color space duplication) which could be the result of :ref:`Config::getColorSpaces` or built from scratch. - - .. note:: - The color spaces are decoupled from the config ones, i.e., any changes to the set itself or to its color spaces do not affect the original color spaces from the configuration. If needed, use :ref:`Config::addColorSpace` to update the configuration. - - - .. py:method:: ColorSpaceSet.__and__(self: PyOpenColorIO.ColorSpaceSet, arg0: PyOpenColorIO.ColorSpaceSet) -> PyOpenColorIO.ColorSpaceSet - :module: PyOpenColorIO - - Perform the intersection of two sets. - - .. note:: - This function provides operations on two color space sets where the result contains copied color spaces and no duplicates. - - :param lcss: - :param rcss: - - - .. py:method:: ColorSpaceSet.__eq__(self: PyOpenColorIO.ColorSpaceSet, arg0: PyOpenColorIO.ColorSpaceSet) -> bool - :module: PyOpenColorIO - - Return true if the two sets are equal. - - .. note:: - The comparison is done on the color space names (not a deep comparison). - - - .. py:method:: ColorSpaceSet.__init__(self: PyOpenColorIO.ColorSpaceSet) -> None - :module: PyOpenColorIO - - Create an empty set of color spaces. - - - .. py:method:: ColorSpaceSet.__ne__(self: PyOpenColorIO.ColorSpaceSet, arg0: PyOpenColorIO.ColorSpaceSet) -> bool - :module: PyOpenColorIO - - Return true if the two sets are different. - - - .. py:method:: ColorSpaceSet.__or__(self: PyOpenColorIO.ColorSpaceSet, arg0: PyOpenColorIO.ColorSpaceSet) -> PyOpenColorIO.ColorSpaceSet - :module: PyOpenColorIO - - Perform the union of two sets. - - .. note:: - This function provides operations on two color space sets where the result contains copied color spaces and no duplicates. - - :param lcss: - :param rcss: - - - .. py:method:: ColorSpaceSet.__sub__(self: PyOpenColorIO.ColorSpaceSet, arg0: PyOpenColorIO.ColorSpaceSet) -> PyOpenColorIO.ColorSpaceSet - :module: PyOpenColorIO - - Perform the difference of two sets. - - .. note:: - This function provides operations on two color space sets where the result contains copied color spaces and no duplicates. - - :param lcss: - :param rcss: - - - .. py:method:: ColorSpaceSet.addColorSpace(self: PyOpenColorIO.ColorSpaceSet, colorSpace: PyOpenColorIO.ColorSpace) -> None - :module: PyOpenColorIO - - Add color space(s). - - .. note:: - If another color space is already registered with the same name, this will overwrite it. This stores a copy of the specified color space(s). Throws if one of the aliases is already assigned as a name or alias to an existing color space. - - - .. py:method:: ColorSpaceSet.addColorSpaces(self: PyOpenColorIO.ColorSpaceSet, colorSpaces: PyOpenColorIO.ColorSpaceSet) -> None - :module: PyOpenColorIO - - - .. py:method:: ColorSpaceSet.clearColorSpaces(self: PyOpenColorIO.ColorSpaceSet) -> None - :module: PyOpenColorIO - - Clear all color spaces. - - - .. py:method:: ColorSpaceSet.getColorSpace(self: PyOpenColorIO.ColorSpaceSet, name: str) -> PyOpenColorIO.ColorSpace - :module: PyOpenColorIO - - .. note:: - Only accepts color space names (i.e. no role name). - - Will return null if the name is not found. - - - .. py:method:: ColorSpaceSet.getColorSpaceNames(self: PyOpenColorIO.ColorSpaceSet) -> PyOpenColorIO.ColorSpaceSet.ColorSpaceNameIterator - :module: PyOpenColorIO - - - .. py:method:: ColorSpaceSet.getColorSpaces(self: PyOpenColorIO.ColorSpaceSet) -> PyOpenColorIO.ColorSpaceSet.ColorSpaceIterator - :module: PyOpenColorIO - - - .. py:method:: ColorSpaceSet.removeColorSpace(self: PyOpenColorIO.ColorSpaceSet, colorSpace: str) -> None - :module: PyOpenColorIO - - Remove color space(s) using color space names (i.e. no role name). - - .. note:: - The removal of a missing color space does nothing. - - - .. py:method:: ColorSpaceSet.removeColorSpaces(self: PyOpenColorIO.ColorSpaceSet, colorSpaces: PyOpenColorIO.ColorSpaceSet) -> None - :module: PyOpenColorIO - - -.. py:class:: ColorSpaceNameIterator - :module: PyOpenColorIO.ColorSpaceSet - - - .. py:method:: ColorSpaceNameIterator.__getitem__(self: PyOpenColorIO.ColorSpaceSet.ColorSpaceNameIterator, arg0: int) -> str - :module: PyOpenColorIO.ColorSpaceSet - - - .. py:method:: ColorSpaceNameIterator.__iter__(self: PyOpenColorIO.ColorSpaceSet.ColorSpaceNameIterator) -> PyOpenColorIO.ColorSpaceSet.ColorSpaceNameIterator - :module: PyOpenColorIO.ColorSpaceSet - - - .. py:method:: ColorSpaceNameIterator.__len__(self: PyOpenColorIO.ColorSpaceSet.ColorSpaceNameIterator) -> int - :module: PyOpenColorIO.ColorSpaceSet - - - .. py:method:: ColorSpaceNameIterator.__next__(self: PyOpenColorIO.ColorSpaceSet.ColorSpaceNameIterator) -> str - :module: PyOpenColorIO.ColorSpaceSet - - -.. py:class:: ColorSpaceIterator - :module: PyOpenColorIO.ColorSpaceSet - - - .. py:method:: ColorSpaceIterator.__getitem__(self: PyOpenColorIO.ColorSpaceSet.ColorSpaceIterator, arg0: int) -> PyOpenColorIO.ColorSpace - :module: PyOpenColorIO.ColorSpaceSet - - - .. py:method:: ColorSpaceIterator.__iter__(self: PyOpenColorIO.ColorSpaceSet.ColorSpaceIterator) -> PyOpenColorIO.ColorSpaceSet.ColorSpaceIterator - :module: PyOpenColorIO.ColorSpaceSet - - - .. py:method:: ColorSpaceIterator.__len__(self: PyOpenColorIO.ColorSpaceSet.ColorSpaceIterator) -> int - :module: PyOpenColorIO.ColorSpaceSet - - - .. py:method:: ColorSpaceIterator.__next__(self: PyOpenColorIO.ColorSpaceSet.ColorSpaceIterator) -> PyOpenColorIO.ColorSpace - :module: PyOpenColorIO.ColorSpaceSet - diff --git a/docs/api/python/frozen/pyopencolorio_colorspacetransform.rst b/docs/api/python/frozen/pyopencolorio_colorspacetransform.rst deleted file mode 100644 index bb918b5deb..0000000000 --- a/docs/api/python/frozen/pyopencolorio_colorspacetransform.rst +++ /dev/null @@ -1,64 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: ColorSpaceTransform - :module: PyOpenColorIO - - - .. py:method:: ColorSpaceTransform.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.ColorSpaceTransform) -> None - - 2. __init__(self: PyOpenColorIO.ColorSpaceTransform, src: str = '', dst: str = '', direction: PyOpenColorIO.TransformDirection = , dataBypass: bool = True) -> None - - - .. py:method:: ColorSpaceTransform.getDataBypass(self: PyOpenColorIO.ColorSpaceTransform) -> bool - :module: PyOpenColorIO - - Data color spaces do not get processed when true (which is the default). - - - .. py:method:: ColorSpaceTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection - :module: PyOpenColorIO - - - .. py:method:: ColorSpaceTransform.getDst(self: PyOpenColorIO.ColorSpaceTransform) -> str - :module: PyOpenColorIO - - - .. py:method:: ColorSpaceTransform.getSrc(self: PyOpenColorIO.ColorSpaceTransform) -> str - :module: PyOpenColorIO - - - .. py:method:: ColorSpaceTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType - :module: PyOpenColorIO - - - .. py:method:: ColorSpaceTransform.setDataBypass(self: PyOpenColorIO.ColorSpaceTransform, dataBypass: bool) -> None - :module: PyOpenColorIO - - - .. py:method:: ColorSpaceTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None - :module: PyOpenColorIO - - Note that this only affects the evaluation and not the values stored in the object. - - - .. py:method:: ColorSpaceTransform.setDst(self: PyOpenColorIO.ColorSpaceTransform, dst: str) -> None - :module: PyOpenColorIO - - - .. py:method:: ColorSpaceTransform.setSrc(self: PyOpenColorIO.ColorSpaceTransform, src: str) -> None - :module: PyOpenColorIO - - - .. py:method:: ColorSpaceTransform.validate(self: PyOpenColorIO.Transform) -> None - :module: PyOpenColorIO - - Will throw if data is not valid. - diff --git a/docs/api/python/frozen/pyopencolorio_colorspacevisibility.rst b/docs/api/python/frozen/pyopencolorio_colorspacevisibility.rst deleted file mode 100644 index f9270be856..0000000000 --- a/docs/api/python/frozen/pyopencolorio_colorspacevisibility.rst +++ /dev/null @@ -1,37 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: ColorSpaceVisibility - :module: PyOpenColorIO - - Members: - - COLORSPACE_ACTIVE : - - COLORSPACE_INACTIVE : - - COLORSPACE_ALL : - - .. py:method:: name() -> str - :property: - - .. py:attribute:: ColorSpaceVisibility.COLORSPACE_ACTIVE - :module: PyOpenColorIO - :value: - - - .. py:attribute:: ColorSpaceVisibility.COLORSPACE_ALL - :module: PyOpenColorIO - :value: - - - .. py:attribute:: ColorSpaceVisibility.COLORSPACE_INACTIVE - :module: PyOpenColorIO - :value: - - - .. py:property:: ColorSpaceVisibility.value - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_combinetransformdirections.rst b/docs/api/python/frozen/pyopencolorio_combinetransformdirections.rst deleted file mode 100644 index 9524270149..0000000000 --- a/docs/api/python/frozen/pyopencolorio_combinetransformdirections.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: CombineTransformDirections(direction1: PyOpenColorIO.TransformDirection, direction2: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.TransformDirection - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_config.rst b/docs/api/python/frozen/pyopencolorio_config.rst deleted file mode 100644 index 9329939862..0000000000 --- a/docs/api/python/frozen/pyopencolorio_config.rst +++ /dev/null @@ -1,1387 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: Config - :module: PyOpenColorIO - - A config defines all the color spaces to be available at runtime. - - The color configuration (:ref:`Config`) is the main object for interacting with this library. It encapsulates all of the information necessary to use customized :ref:`ColorSpaceTransform` and :ref:`DisplayViewTransform` operations. - - See the user-guide for more information on selecting, creating, and working with custom color configurations. - - For applications interested in using only one color config at a time (this is the vast majority of apps), their API would traditionally get the global configuration and use that, as opposed to creating a new one. This simplifies the use case for plugins and bindings, as it alleviates the need to pass around configuration handles. - - An example of an application where this would not be sufficient would be a multi-threaded image proxy server (daemon), which wished to handle multiple show configurations in a single process concurrently. This app would need to keep multiple configurations alive, and to manage them appropriately. - - Roughly speaking, a novice user should select a default configuration that most closely approximates the use case (animation, visual effects, etc.), and set the :envvar:`OCIO` environment variable to point at the root of that configuration. - - .. note:: - Initialization using environment variables is typically preferable in a multi-app ecosystem, as it allows all applications to be consistently configured. - - See developers-usageexamples - - - .. py:method:: Config.CreateFromBuiltinConfig(arg0: str) -> PyOpenColorIO.Config - :module: PyOpenColorIO - :staticmethod: - - Create a configuration using an OCIO built-in config. - - :param configName: Built-in config name. - - The available configNames are: "cg-config-v0.1.0_aces-v1.3_ocio-v2.1.1"-- ACES CG config, basic color spaces for computer graphics apps. More information about these configs is available at: https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES - - Information about the available configs is available from the :ref:`BuiltinConfigRegistry`. - - :exception :ref:`Exception`: If the configName is not recognized. - - :return: One of the configs built into the OCIO library. - - - .. py:method:: Config.CreateFromConfigIOProxy(arg0: OpenColorIO_v2_2dev::ConfigIOProxy) -> PyOpenColorIO.Config - :module: PyOpenColorIO - :staticmethod: - - Create a config from the supplied :ref:`ConfigIOProxy` object. This allows the calling program to directly provide the config and associated LUTs rather than reading them from the standard file system. - - See the :ref:`ConfigIOProxy` class documentation for more info. - - :param ciop: :ref:`ConfigIOProxy` object providing access to the config's files. - - :exception :ref:`Exception`: If the config may not be read from the proxy, or does not parse. - - :return: The :ref:`Config` object. - - - .. py:method:: Config.CreateFromEnv() -> PyOpenColorIO.Config - :module: PyOpenColorIO - :staticmethod: - - Create a configuration using the OCIO environment variable. - - Also supports the OCIO URI format for Built-in configs and supports archived configs. See :ref:`Config::CreateFromFile`. - - If the variable is missing or empty, returns the same result as :ref:`Config::CreateRaw`. :return: The :ref:`Config` object. - - - .. py:method:: Config.CreateFromFile(fileName: str) -> PyOpenColorIO.Config - :module: PyOpenColorIO - :staticmethod: - - Create a configuration using a specific config file. - - Also supports the following OCIO URI format for Built-in configs: "ocio://default" - Default Built-in config. "ocio://" - A specific Built-in config. For the list of available strings, see :ref:`Config::CreateFromBuiltinConfig`. - - Also supports archived configs (.ocioz files). - - :exception :ref:`Exception`: If the file may not be read or does not parse. - - :return: The :ref:`Config` object. - - - .. py:method:: Config.CreateFromStream(str: str) -> PyOpenColorIO.Config - :module: PyOpenColorIO - :staticmethod: - - Create a configuration using a stream. - - Note that CreateFromStream does not set the working directory so the caller would need to set that separately in order to resolve FileTransforms. This function is typically only used for self-contained configs (no LUTs). - - Configs created from CreateFromStream can not be archived unless the working directory is set and contains any necessary LUT files. - - :param istream: Stream to the config. - - :exception :ref:`Exception`: If the stream does not parse. - - :return: The :ref:`Config` object. - - - .. py:method:: Config.CreateRaw() -> PyOpenColorIO.Config - :module: PyOpenColorIO - :staticmethod: - - Create a fall-back config. - - This may be useful to allow client apps to launch in cases when the supplied config path is not loadable. :return: The :ref:`Config` object. - - - .. py:class:: Config.DisplayAllIterator - :module: PyOpenColorIO - - - .. py:method:: Config.DisplayAllIterator.__init__(*args, **kwargs) - :module: PyOpenColorIO - - - .. py:method:: Config.GetProcessorFromConfigs(*args, **kwargs) - :module: PyOpenColorIO - :staticmethod: - - Overloaded function. - - 1. GetProcessorFromConfigs(srcConfig: PyOpenColorIO.Config, srcColorSpaceName: str, dstConfig: PyOpenColorIO.Config, dstColorSpaceName: str) -> PyOpenColorIO.Processor - - Get a processor to convert between color spaces in two separate configs. - - This relies on both configs having the aces_interchange role (when srcName is scene-referred) or the role cie_xyz_d65_interchange (when srcName is display-referred) defined. An exception is thrown if that is not the case. - - 2. GetProcessorFromConfigs(srcContext: PyOpenColorIO.Context, srcConfig: PyOpenColorIO.Config, srcColorSpaceName: str, dstContext: PyOpenColorIO.Context, dstConfig: PyOpenColorIO.Config, dstColorSpaceName: str) -> PyOpenColorIO.Processor - - 3. GetProcessorFromConfigs(srcConfig: PyOpenColorIO.Config, srcColorSpaceName: str, srcInterchangeName: str, dstConfig: PyOpenColorIO.Config, dstColorSpaceName: str, dstInterchangeName: str) -> PyOpenColorIO.Processor - - The srcInterchangeName and dstInterchangeName must refer to a pair of color spaces in the two configs that are the same. A role name may also be used. - - 4. GetProcessorFromConfigs(srcContext: PyOpenColorIO.Context, srcConfig: PyOpenColorIO.Config, srcColorSpaceName: str, srcInterchangeName: str, dstContext: PyOpenColorIO.Context, dstConfig: PyOpenColorIO.Config, dstColorSpaceName: str, dstInterchangeName: str) -> PyOpenColorIO.Processor - - - .. py:class:: Config.ViewForViewTypeIterator - :module: PyOpenColorIO - - - .. py:method:: Config.ViewForViewTypeIterator.__init__(*args, **kwargs) - :module: PyOpenColorIO - - - .. py:class:: Config.VirtualViewIterator - :module: PyOpenColorIO - - - .. py:method:: Config.VirtualViewIterator.__init__(*args, **kwargs) - :module: PyOpenColorIO - - - .. py:method:: Config.__init__(self: PyOpenColorIO.Config) -> None - :module: PyOpenColorIO - - Create an empty config of the current version. - - Note that an empty config will not pass validation since required elements will be missing. :return: The :ref:`Config` object. - - - .. py:method:: Config.__str__(self: PyOpenColorIO.Config) -> str - :module: PyOpenColorIO - - - .. py:method:: Config.addColorSpace(self: PyOpenColorIO.Config, colorSpace: PyOpenColorIO.ColorSpace) -> None - :module: PyOpenColorIO - - Add a color space to the configuration. - - .. note:: - If another color space is already present with the same name, this will overwrite it. This stores a copy of the specified color space. - - .. note:: - Adding a color space to a :ref:`Config` does not affect any :ref:`ColorSpaceSet` sets that have already been created. - - - .. py:method:: Config.addDisplaySharedView(self: PyOpenColorIO.Config, display: str, view: str) -> None - :module: PyOpenColorIO - - Add a (reference to a) shared view to a display. - - The shared view must be part of the config. See :ref:`Config::addSharedView` - - This will throw if: - - Display or view are null or empty. - - Display already has a view (shared or not) with the same name. - - - .. py:method:: Config.addDisplayView(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. addDisplayView(self: PyOpenColorIO.Config, display: str, view: str, colorSpaceName: str, looks: str = '') -> None - - For the (display, view) pair, specify which color space and look to use. If a look is not desired, then just pass a null or empty string. - - 2. addDisplayView(self: PyOpenColorIO.Config, display: str, view: str, viewTransform: str, displayColorSpaceName: str, looks: str = '', ruleName: str = '', description: str = '') -> None - - For the (display, view) pair, specify which color space and look to use. If a look is not desired, then just pass a null or empty string. - - - .. py:method:: Config.addEnvironmentVar(self: PyOpenColorIO.Config, name: str, defaultValue: str) -> None - :module: PyOpenColorIO - - Add (or update) an environment variable with a default value. But it removes it if the default value is null. - - - .. py:method:: Config.addLook(self: PyOpenColorIO.Config, look: PyOpenColorIO.Look) -> None - :module: PyOpenColorIO - - - .. py:method:: Config.addNamedTransform(self: PyOpenColorIO.Config, namedTransform: PyOpenColorIO.NamedTransform) -> None - :module: PyOpenColorIO - - - .. py:method:: Config.addSearchPath(self: PyOpenColorIO.Config, path: str) -> None - :module: PyOpenColorIO - - Add a single search path to the end of the list. - - Paths may be either absolute or relative. Relative paths are relative to the working directory. Forward slashes will be normalized to reverse for Windows. Environment (context) variables may be used in paths. - - - .. py:method:: Config.addSharedView(self: PyOpenColorIO.Config, view: str, viewTransformName: str, colorSpaceName: str, looks: str = '', ruleName: str = '', description: str = '') -> None - :module: PyOpenColorIO - - Will throw if view or colorSpaceName are null or empty. - - The following methods only manipulate active displays and views. Active displays and views are defined from an env. variable or from the config file. - - Looks is a potentially comma (or colon) delimited list of lookNames, Where +/- prefixes are optionally allowed to denote forward/inverse look specification. (And forward is assumed in the absence of either) - - Add shared view (or replace existing one with same name). Shared views are defined at config level and can be referenced by several displays. Either provide a view transform and a display color space or just a color space (and a null view transform). Looks, rule and description are optional, they can be null or empty. - - Shared views using a view transform may use the token for the color space (see :c:var:`OCIO_VIEW_USE_DISPLAY_NAME`). In that case, when the view is referenced in a display, the display color space that is used will be the one matching the display name. In other words, the view will be customized based on the display it is used in. :ref:`Config::validate` will throw if the config does not contain the matching display color space. - - - .. py:method:: Config.addViewTransform(self: PyOpenColorIO.Config, viewTransform: PyOpenColorIO.ViewTransform) -> None - :module: PyOpenColorIO - - - .. py:method:: Config.addVirtualDisplaySharedView(self: PyOpenColorIO.Config, sharedView: str) -> None - :module: PyOpenColorIO - - - .. py:method:: Config.addVirtualDisplayView(self: PyOpenColorIO.Config, view: str, viewTransformName: str, colorSpaceName: str, looks: str = '', ruleName: str = '', description: str = '') -> None - :module: PyOpenColorIO - - - .. py:method:: Config.archive(self: PyOpenColorIO.Config, arg0: str) -> None - :module: PyOpenColorIO - - Archive the config and its LUTs into the specified output stream. - - The config is archived by serializing the :ref:`Config` object into a file named "config.ocio" and then walking through the current working directory and any sub-directories. Any files that have an extension matching a supported LUT file format are added to the archive. Any files that do not have an extension (or have some unsupported LUT extension, including .ocio), will not be added to the archive. To reiterate, it is the in-memory :ref:`Config` object that is archived, and not any .ocio file in the current working directory. The directory structure relative to the working directory is preserved. No files outside the working directory are archived so that if it is later expanded, no files will be created outside the working dir. - - The reason the archive is created using all supported LUT file extensions rather than by trying to resolve all the FileTransforms in the :ref:`Config` to specific files is because of the goal to allow context variables to continue to work. - - If a :ref:`Config` is created with CreateFromStream, CreateFromFile with an OCIOZ archive, or CreateFromConfigIOProxy, it cannot be archived unless the working directory is manually set to a directory that contains any necessary LUT files. - - The provided output stream must be closed by the caller, if necessary (e.g., an ofstream). - - :param ostream: The output stream to write to. - - - .. py:method:: Config.clearColorSpaces(self: PyOpenColorIO.Config) -> None - :module: PyOpenColorIO - - Remove all the color spaces from the configuration. - - .. note:: - Removing color spaces from a :ref:`Config` does not affect any :ref:`ColorSpaceSet` sets that have already been created. - - - .. py:method:: Config.clearDisplays(self: PyOpenColorIO.Config) -> None - :module: PyOpenColorIO - - Clear all the displays. - - - .. py:method:: Config.clearEnvironmentVars(self: PyOpenColorIO.Config) -> None - :module: PyOpenColorIO - - - .. py:method:: Config.clearLooks(self: PyOpenColorIO.Config) -> None - :module: PyOpenColorIO - - - .. py:method:: Config.clearNamedTransforms(self: PyOpenColorIO.Config) -> None - :module: PyOpenColorIO - - - .. py:method:: Config.clearSearchPaths(self: PyOpenColorIO.Config) -> None - :module: PyOpenColorIO - - - .. py:method:: Config.clearViewTransforms(self: PyOpenColorIO.Config) -> None - :module: PyOpenColorIO - - - .. py:method:: Config.clearVirtualDisplay(self: PyOpenColorIO.Config) -> None - :module: PyOpenColorIO - - Clear the virtual display. - - - .. py:method:: Config.filepathOnlyMatchesDefaultRule(self: PyOpenColorIO.Config, filePath: str) -> bool - :module: PyOpenColorIO - - Returns true if the only rule matched by filePath is the default rule. This is a convenience method for applications that want to require the user to manually choose a color space when strictParsing is true and no other rules match. - - - .. py:method:: Config.getActiveDisplays(self: PyOpenColorIO.Config) -> str - :module: PyOpenColorIO - - - .. py:method:: Config.getActiveViews(self: PyOpenColorIO.Config) -> str - :module: PyOpenColorIO - - - .. py:method:: Config.getCacheID(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. getCacheID(self: PyOpenColorIO.Config) -> str - - This will produce a hash of the all colorspace definitions, etc. All external references, such as files used in FileTransforms, etc., will be incorporated into the cacheID. While the contents of the files are not read, the file system is queried for relevant information (mtime, inode) so that the config's cacheID will change when the underlying luts are updated. - - If a context is not provided, the current :ref:`Context` will be used. - - If a null context is provided, file references will not be taken into account (this is essentially a hash of :ref:`Config::serialize`). - - 2. getCacheID(self: PyOpenColorIO.Config, context: PyOpenColorIO.Context) -> str - - This will produce a hash of the all colorspace definitions, etc. All external references, such as files used in FileTransforms, etc., will be incorporated into the cacheID. While the contents of the files are not read, the file system is queried for relevant information (mtime, inode) so that the config's cacheID will change when the underlying luts are updated. - - If a context is not provided, the current :ref:`Context` will be used. - - If a null context is provided, file references will not be taken into account (this is essentially a hash of :ref:`Config::serialize`). - - - .. py:method:: Config.getCanonicalName(self: PyOpenColorIO.Config, name: str) -> str - :module: PyOpenColorIO - - Accepts an alias, role name, named transform name, or color space name and returns the color space name or the named transform name. - - - .. py:method:: Config.getColorSpace(self: PyOpenColorIO.Config, name: str) -> PyOpenColorIO.ColorSpace - :module: PyOpenColorIO - - Get the color space from all the color spaces (i.e. active and inactive) and return null if the name is not found. - - .. note:: - The fcn accepts either a color space name, role name, or alias. (Color space names take precedence over roles.) - - - .. py:method:: Config.getColorSpaceFromFilepath(self: PyOpenColorIO.Config, filePath: str) -> tuple - :module: PyOpenColorIO - - Get the color space of the first rule that matched filePath. (For v1 configs, this is equivalent to calling parseColorSpaceFromString with strictparsing set to false.) - - - .. py:method:: Config.getColorSpaceNames(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. getColorSpaceNames(self: PyOpenColorIO.Config, searchReferenceType: PyOpenColorIO.SearchReferenceSpaceType, visibility: PyOpenColorIO.ColorSpaceVisibility) -> PyOpenColorIO.Config.ColorSpaceNameIterator - - 2. getColorSpaceNames(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.ActiveColorSpaceNameIterator - - - .. py:method:: Config.getColorSpaces(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. getColorSpaces(self: PyOpenColorIO.Config, category: str) -> PyOpenColorIO.ColorSpaceSet - - Get all active color spaces having a specific category in the order they appear in the config file. - - .. note:: - If the category is null or empty, the method returns all the active color spaces like :ref:`Config::getNumColorSpaces` and :ref:`Config::getColorSpaceNameByIndex` do. - - .. note:: - It's worth noticing that the method returns a copy of the selected color spaces decoupling the result from the config. Hence, any changes on the config do not affect the existing color space sets, and vice-versa. - - 2. getColorSpaces(self: PyOpenColorIO.Config, searchReferenceType: PyOpenColorIO.SearchReferenceSpaceType, visibility: PyOpenColorIO.ColorSpaceVisibility) -> PyOpenColorIO.Config.ColorSpaceIterator - - 3. getColorSpaces(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.ActiveColorSpaceIterator - - - .. py:method:: Config.getCurrentContext(self: PyOpenColorIO.Config) -> PyOpenColorIO.Context - :module: PyOpenColorIO - - - .. py:method:: Config.getDefaultDisplay(self: PyOpenColorIO.Config) -> str - :module: PyOpenColorIO - - - .. py:method:: Config.getDefaultLumaCoefs(self: PyOpenColorIO.Config) -> List[float[3]] - :module: PyOpenColorIO - - Get the default coefficients for computing luma. - - .. note:: - There is no "1 size fits all" set of luma coefficients. (The values are typically different for each colorspace, and the application of them may be nonsensical depending on the intensity coding anyways). Thus, the 'right' answer is to make these functions on the :ref:`ColorSpace` class. However, it's often useful to have a config-wide default so here it is. We will add the colorspace specific luma call if/when another client is interesting in using it. - - - .. py:method:: Config.getDefaultSceneToDisplayViewTransform(self: PyOpenColorIO.Config) -> PyOpenColorIO.ViewTransform - :module: PyOpenColorIO - - This view transform is the one that will be used by default if a :ref:`ColorSpaceTransform` is needed between a scene-referred and display-referred color space. The config author may specify a transform to use via the default_view_transform entry in the config. If that is not present, or does not return a valid view transform from the scene-referred connection space, the fall-back is to use the first valid view transform in the config. Returns a null ConstTransformRcPtr if there isn't one. - - - .. py:method:: Config.getDefaultView(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. getDefaultView(self: PyOpenColorIO.Config, display: str) -> str - - 2. getDefaultView(self: PyOpenColorIO.Config, display: str, colorSpacename: str) -> str - - - .. py:method:: Config.getDefaultViewTransformName(self: PyOpenColorIO.Config) -> str - :module: PyOpenColorIO - - Get or set the default_view_transform string from the config. - - Note that if this is not the name of a valid view transform from the scene-referred connection space, it will be ignored. - - - .. py:method:: Config.getDescription(self: PyOpenColorIO.Config) -> str - :module: PyOpenColorIO - - - .. py:method:: Config.getDisplayViewColorSpaceName(self: PyOpenColorIO.Config, display: str, view: str) -> str - :module: PyOpenColorIO - - Returns the colorspace attribute of the (display, view) pair. (Note that this may be either a color space or a display color space.) - - - .. py:method:: Config.getDisplayViewDescription(self: PyOpenColorIO.Config, display: str, view: str) -> str - :module: PyOpenColorIO - - Returns the description attribute of a (display, view) pair. - - - .. py:method:: Config.getDisplayViewLooks(self: PyOpenColorIO.Config, display: str, view: str) -> str - :module: PyOpenColorIO - - Returns the looks attribute of a (display, view) pair. - - - .. py:method:: Config.getDisplayViewRule(self: PyOpenColorIO.Config, display: str, view: str) -> str - :module: PyOpenColorIO - - Returns the rule attribute of a (display, view) pair. - - - .. py:method:: Config.getDisplayViewTransformName(self: PyOpenColorIO.Config, display: str, view: str) -> str - :module: PyOpenColorIO - - Returns the view_transform attribute of the (display, view) pair. View can be a shared view of the display. If display is null or empty, config shared views are used. - - - .. py:method:: Config.getDisplays(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.DisplayIterator - :module: PyOpenColorIO - - - .. py:method:: Config.getDisplaysAll(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.DisplayAllIterator - :module: PyOpenColorIO - - - .. py:method:: Config.getEnvironmentMode(self: PyOpenColorIO.Config) -> PyOpenColorIO.EnvironmentMode - :module: PyOpenColorIO - - - .. py:method:: Config.getEnvironmentVarDefault(self: PyOpenColorIO.Config, name: str) -> str - :module: PyOpenColorIO - - - .. py:method:: Config.getEnvironmentVarNames(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.EnvironmentVarNameIterator - :module: PyOpenColorIO - - - .. py:method:: Config.getFamilySeparator(self: PyOpenColorIO.Config) -> str - :module: PyOpenColorIO - - Get the family separator. - - A single character used to separate the family string into tokens for use in hierarchical menus. Defaults to '/'. - - - .. py:method:: Config.getFileRules(self: PyOpenColorIO.Config) -> PyOpenColorIO.FileRules - :module: PyOpenColorIO - - Get read-only version of the file rules. - - - .. py:method:: Config.getInactiveColorSpaces(self: PyOpenColorIO.Config) -> str - :module: PyOpenColorIO - - - .. py:method:: Config.getLook(self: PyOpenColorIO.Config, name: str) -> PyOpenColorIO.Look - :module: PyOpenColorIO - - - .. py:method:: Config.getLookNames(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.LookNameIterator - :module: PyOpenColorIO - - - .. py:method:: Config.getLooks(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.LookIterator - :module: PyOpenColorIO - - - .. py:method:: Config.getMajorVersion(self: PyOpenColorIO.Config) -> int - :module: PyOpenColorIO - - Get the configuration major version. - - - .. py:method:: Config.getMinorVersion(self: PyOpenColorIO.Config) -> int - :module: PyOpenColorIO - - Get the configuration minor version. - - - .. py:method:: Config.getName(self: PyOpenColorIO.Config) -> str - :module: PyOpenColorIO - - Get/set a name string for the config. - - The name string may be used to communicate config update details or similar information to workflows external to OCIO in cases where the config path/filename itself does not provide adequate information. - - - .. py:method:: Config.getNamedTransform(self: PyOpenColorIO.Config, name: str) -> PyOpenColorIO.NamedTransform - :module: PyOpenColorIO - - - .. py:method:: Config.getNamedTransformNames(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. getNamedTransformNames(self: PyOpenColorIO.Config, visibility: PyOpenColorIO.NamedTransformVisibility) -> PyOpenColorIO.Config.NamedTransformNameIterator - - 2. getNamedTransformNames(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.ActiveNamedTransformNameIterator - - - .. py:method:: Config.getNamedTransforms(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. getNamedTransforms(self: PyOpenColorIO.Config, visibility: PyOpenColorIO.NamedTransformVisibility) -> PyOpenColorIO.Config.NamedTransformIterator - - 2. getNamedTransforms(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.ActiveNamedTransformIterator - - - .. py:method:: Config.getProcessor(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. getProcessor(self: PyOpenColorIO.Config, srcColorSpace: PyOpenColorIO.ColorSpace, dstColorSpace: PyOpenColorIO.ColorSpace) -> PyOpenColorIO.Processor - - Get the processor to apply a :ref:`ColorSpaceTransform` from a source to a destination color space. - - 2. getProcessor(self: PyOpenColorIO.Config, context: PyOpenColorIO.Context, srcColorSpace: PyOpenColorIO.ColorSpace, dstColorSpace: PyOpenColorIO.ColorSpace) -> PyOpenColorIO.Processor - - 3. getProcessor(self: PyOpenColorIO.Config, srcColorSpaceName: str, dstColorSpaceName: str) -> PyOpenColorIO.Processor - - .. note:: - Names can be colorspace name, role name, or a combination of both. - - 4. getProcessor(self: PyOpenColorIO.Config, context: PyOpenColorIO.Context, srcColorSpaceName: str, dstColorSpaceName: str) -> PyOpenColorIO.Processor - - 5. getProcessor(self: PyOpenColorIO.Config, srcColorSpaceName: str, display: str, view: str, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Processor - - Get the processor to apply a :ref:`DisplayViewTransform` for a display and view. Refer to the Display/View Registration section above for more info on the display and view arguments. - - 6. getProcessor(self: PyOpenColorIO.Config, context: PyOpenColorIO.Context, srcColorSpaceName: str, display: str, view: str, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Processor - - 7. getProcessor(self: PyOpenColorIO.Config, namedTransform: PyOpenColorIO.NamedTransform, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Processor - - Get the processor to apply a :ref:`NamedTransform` in the specified direction. - - 8. getProcessor(self: PyOpenColorIO.Config, context: PyOpenColorIO.Context, namedTransform: PyOpenColorIO.NamedTransform, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Processor - - 9. getProcessor(self: PyOpenColorIO.Config, namedTransformName: str, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Processor - - 10. getProcessor(self: PyOpenColorIO.Config, context: PyOpenColorIO.Context, namedTransformName: str, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Processor - - 11. getProcessor(self: PyOpenColorIO.Config, transform: PyOpenColorIO.Transform) -> PyOpenColorIO.Processor - - Get the processor for the specified transform. - - Not often needed, but will allow for the re-use of atomic OCIO functionality (such as to apply an individual LUT file). - - 12. getProcessor(self: PyOpenColorIO.Config, transform: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Processor - - 13. getProcessor(self: PyOpenColorIO.Config, context: PyOpenColorIO.Context, transform: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Processor - - - .. py:method:: Config.getRoleNames(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.RoleNameIterator - :module: PyOpenColorIO - - - .. py:method:: Config.getRoles(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.RoleColorSpaceIterator - :module: PyOpenColorIO - - - .. py:method:: Config.getSearchPath(self: PyOpenColorIO.Config) -> str - :module: PyOpenColorIO - - - .. py:method:: Config.getSearchPaths(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.SearchPathIterator - :module: PyOpenColorIO - - - .. py:method:: Config.getSharedViews(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.SharedViewIterator - :module: PyOpenColorIO - - - .. py:method:: Config.getViewTransform(self: PyOpenColorIO.Config, name: str) -> PyOpenColorIO.ViewTransform - :module: PyOpenColorIO - - - .. py:method:: Config.getViewTransformNames(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.ViewTransformNameIterator - :module: PyOpenColorIO - - - .. py:method:: Config.getViewTransforms(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.ViewTransformIterator - :module: PyOpenColorIO - - - .. py:method:: Config.getViewingRules(self: PyOpenColorIO.Config) -> PyOpenColorIO.ViewingRules - :module: PyOpenColorIO - - Get read-only version of the viewing rules. - - - .. py:method:: Config.getViews(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. getViews(self: PyOpenColorIO.Config, display: str) -> PyOpenColorIO.Config.ViewIterator - - 2. getViews(self: PyOpenColorIO.Config, type: PyOpenColorIO.ViewType, display: str) -> PyOpenColorIO.Config.ViewForViewTypeIterator - - 3. getViews(self: PyOpenColorIO.Config, display: str, colorSpaceName: str) -> PyOpenColorIO.Config.ViewForColorSpaceIterator - - - .. py:method:: Config.getVirtualDisplayViewColorSpaceName(self: PyOpenColorIO.Config, view: str) -> str - :module: PyOpenColorIO - - - .. py:method:: Config.getVirtualDisplayViewDescription(self: PyOpenColorIO.Config, view: str) -> str - :module: PyOpenColorIO - - - .. py:method:: Config.getVirtualDisplayViewLooks(self: PyOpenColorIO.Config, view: str) -> str - :module: PyOpenColorIO - - - .. py:method:: Config.getVirtualDisplayViewRule(self: PyOpenColorIO.Config, view: str) -> str - :module: PyOpenColorIO - - - .. py:method:: Config.getVirtualDisplayViewTransformName(self: PyOpenColorIO.Config, view: str) -> str - :module: PyOpenColorIO - - - .. py:method:: Config.getVirtualDisplayViews(self: PyOpenColorIO.Config, display: PyOpenColorIO.ViewType) -> PyOpenColorIO.Config.VirtualViewIterator - :module: PyOpenColorIO - - - .. py:method:: Config.getWorkingDir(self: PyOpenColorIO.Config) -> str - :module: PyOpenColorIO - - - .. py:method:: Config.hasRole(self: PyOpenColorIO.Config, role: str) -> bool - :module: PyOpenColorIO - - Return true if the role has been defined. - - - .. py:method:: Config.instantiateDisplayFromICCProfile(self: PyOpenColorIO.Config, ICCProfileFilepath: str) -> int - :module: PyOpenColorIO - - Instantiate a new display from a virtual display, using an ICC profile. - - On platforms such as Linux, where the :ref:`SystemMonitors` class is not able to obtain a list of ICC profiles from the OS, this method may be used to manually specify a path to an ICC profile. - - Will throw if the virtual display definition is missing from the config. - - Returns the index of the display. - - - .. py:method:: Config.instantiateDisplayFromMonitorName(self: PyOpenColorIO.Config, monitorName: str) -> int - :module: PyOpenColorIO - - Instantiate a new display from a virtual display, using the monitor name. - - This method uses the virtual display to create an actual display for the given monitorName. The new display will receive the views from the virtual display. - - After the ICC profile is read, a display name will be created by combining the description text from the profile with the monitorName obtained from the OS. Use the :ref:`SystemMonitors` class to obtain the list of monitorName strings for the displays connected to the computer. - - A new display color space will also be created using the display name. It will have a from_display_reference transform that is a :ref:`FileTransform` pointing to the ICC profile. - - Any instantiated display color spaces for a virtual display are intended to be temporary (i.e. last as long as the current session). By default, they are not saved when writing a config file. If there is a need to make it a permanent color space, it may be desirable to copy the ICC profile somewhere under the config search_path. - - Will throw if the config does not have a virtual display or if the monitorName does not exist. - - If there is already a display or a display color space with the name monitorName, it will be replaced/updated. - - Returns the index of the display. - - - .. py:method:: Config.isArchivable(self: PyOpenColorIO.Config) -> bool - :module: PyOpenColorIO - - Verify if the config is archivable. - - A config is not archivable if any of the following are true: -- The working directory is not set -- It contains FileTransforms with a src outside the working directory -- The search path contains paths outside the working directory -- The search path contains paths that start with a context variable - - :ref:`Context` variables are allowed but the intent is that they may only resolve to paths that are within or below the working directory. This is because the archiving function will only archive files that are within the working directory in order to ensure that if it is later expanded, that it will not create any files outside this directory. - - For example, a context variable on the search path intended to contain the name of a sub-directory under the working directory must have the form "./$DIR_NAME" rather than just "$DIR_NAME" to be considered archivable. This is imperfect since there is no way to prevent the context variable from creating a path outside the working dir, but it should at least draw attention to the fact that the archive would fail if used with context vars that try to abuse the intended functionality. - - :return: bool Archivable if true. - - - .. py:method:: Config.isColorSpaceLinear(self: PyOpenColorIO.Config, colorSpace: str, referenceSpaceType: PyOpenColorIO.ReferenceSpaceType) -> bool - :module: PyOpenColorIO - - Return true if the specified color space is linear. - - The determination of linearity is made with respect to one of the two reference spaces (i.e., either the scene-referred one or the display-referred one). If the reference space type of the color space is the opposite of the requested reference space type, false is returned immediately rather than trying to invoke the default view transform to convert between the reference spaces. - - Note: This function relies on heuristics that may sometimes give an incorrect result. For example, if the encoding attribute is not set appropriately or the sampled values fail to detect non-linearity. - - The algorithm proceeds as follows: -- If the color space isdata attribute is true, return false. -- If the reference space type of the color space differs from the requested reference space type, return false. -- If the color space's encoding attribute is present, return true if it matches the expected reference space type (i.e., "scene-linear" for REFERENCE_SPACE_SCENE or "display-linear" for REFERENCE_SPACE_DISPLAY) and false otherwise. -- If the color space has no to_reference or from_reference transform, return true. -- Evaluate several points through the color space's transform and check if the output only differs by a scale factor (which may be different per channel, e.g. allowing an arbitrary matrix transform, with no offset). - - Note that the encoding test happens before the sampled value test to give config authors ultimate control over the linearity determination. For example, they could set the encoding attribute to indicate linearity if they want to ignore some areas of non-linearity (e.g., at extreme values). Or they could set it to indicate that a color space should not be considered linear, even if it is, in a mathematical sense. - - :param colorSpace: Color space to evaluate. - :param referenceSpaceType: Evaluate linearity with respect to the specified reference space (either scene-referred or display-referred). - - - .. py:method:: Config.isColorSpaceUsed(self: PyOpenColorIO.Config, name: str) -> bool - :module: PyOpenColorIO - - Return true if the color space is used by a transform, a role, or a look. - - .. note:: - Name must be the canonical name. - - - .. py:method:: Config.isDisplayTemporary(self: PyOpenColorIO.Config, display: str) -> bool - :module: PyOpenColorIO - - - .. py:method:: Config.isStrictParsingEnabled(self: PyOpenColorIO.Config) -> bool - :module: PyOpenColorIO - - - .. py:method:: Config.loadEnvironment(self: PyOpenColorIO.Config) -> None - :module: PyOpenColorIO - - - .. py:method:: Config.parseColorSpaceFromString(self: PyOpenColorIO.Config, str: str) -> str - :module: PyOpenColorIO - - Given the specified string, get the longest, right-most, colorspace substring that appears. - - - If strict parsing is enabled, and no color space is found, return an empty string. - - If strict parsing is disabled, return ROLE_DEFAULT (if defined). - - If the default role is not defined, return an empty string. - - - .. py:method:: Config.removeColorSpace(self: PyOpenColorIO.Config, name: str) -> None - :module: PyOpenColorIO - - Remove a color space from the configuration. - - .. note:: - It does not throw an exception. Name must be the canonical name. If a role name or alias is provided or if the name is not in the config, nothing is done. - - .. note:: - Removing a color space from a :ref:`Config` does not affect any :ref:`ColorSpaceSet` sets that have already been created. - - - .. py:method:: Config.removeDisplayView(self: PyOpenColorIO.Config, display: str, view: str) -> None - :module: PyOpenColorIO - - Remove the view and the display if no more views. - - It does not remove the associated color space. If the view name is a shared view, it only removes the reference to the view from the display but the shared view, remains in the config. - - Will throw if the view does not exist. - - - .. py:method:: Config.removeSharedView(self: PyOpenColorIO.Config, view: str) -> None - :module: PyOpenColorIO - - Remove a shared view. Will throw if the view does not exist. - - - .. py:method:: Config.removeVirtualDisplayView(self: PyOpenColorIO.Config, view: str) -> None - :module: PyOpenColorIO - - Remove the view from the virtual display. - - - .. py:method:: Config.serialize(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. serialize(self: PyOpenColorIO.Config, fileName: str) -> None - - 2. serialize(self: PyOpenColorIO.Config) -> str - - Returns the string representation of the :ref:`Config` in YAML text form. - - This is typically stored on disk in a file with the extension .ocio. NB: This does not validate the config. Applications should validate before serializing. - - - .. py:method:: Config.setActiveDisplays(self: PyOpenColorIO.Config, displays: str) -> None - :module: PyOpenColorIO - - $OCIO_ACTIVE_DISPLAYS envvar can, at runtime, optionally override the allowed displays. It is a comma or colon delimited list. Active displays that are not in the specified profile will be ignored, and the left-most defined display will be the default. - - Comma-delimited list of names to filter and order the active displays. - - .. note:: - The setter does not override the envvar. The getter does not take into account the envvar value and thus may not represent what the user is seeing. - - - .. py:method:: Config.setActiveViews(self: PyOpenColorIO.Config, views: str) -> None - :module: PyOpenColorIO - - $OCIO_ACTIVE_VIEWS envvar can, at runtime, optionally override the allowed views. It is a comma or colon delimited list. Active views that are not in the specified profile will be ignored, and the left-most defined view will be the default. - - Comma-delimited list of names to filter and order the active views. - - .. note:: - The setter does not override the envvar. The getter does not take into account the envvar value and thus may not represent what the user is seeing. - - - .. py:method:: Config.setDefaultLumaCoefs(self: PyOpenColorIO.Config, rgb: List[float[3]]) -> None - :module: PyOpenColorIO - - These should be normalized (sum to 1.0 exactly). - - - .. py:method:: Config.setDefaultViewTransformName(self: PyOpenColorIO.Config, name: str) -> None - :module: PyOpenColorIO - - - .. py:method:: Config.setDescription(self: PyOpenColorIO.Config, description: str) -> None - :module: PyOpenColorIO - - - .. py:method:: Config.setEnvironmentMode(self: PyOpenColorIO.Config, mode: PyOpenColorIO.EnvironmentMode) -> None - :module: PyOpenColorIO - - - .. py:method:: Config.setFamilySeparator(self: PyOpenColorIO.Config, separator: str) -> None - :module: PyOpenColorIO - - Set the family separator. - - Succeeds if the characters is null or a valid character from the ASCII table i.e. from value 32 (i.e. space) to 126 (i.e. '~'); otherwise, it throws an exception. - - - .. py:method:: Config.setFileRules(self: PyOpenColorIO.Config, fileRules: PyOpenColorIO.FileRules) -> None - :module: PyOpenColorIO - - Set file rules. - - .. note:: - The argument is cloned. - - - .. py:method:: Config.setInactiveColorSpaces(self: PyOpenColorIO.Config, inactiveColorSpaces: str) -> None - :module: PyOpenColorIO - - Set/get a list of inactive color space or named transform names. - - Notes: - - List can contain color space and/or named transform names. - - The inactive spaces are color spaces that should not appear in application menus. - - These color spaces will still work in :ref:`Config::getProcessor` calls. - - The argument is a comma-delimited string. A null or empty string empties the list. - - The environment variable OCIO_INACTIVE_COLORSPACES may also be used to set the inactive color space list. - - The env. var. takes precedence over the inactive_colorspaces list in the config file. - - Setting the list via the API takes precedence over either the env. var. or the config file list. - - - .. py:method:: Config.setMajorVersion(self: PyOpenColorIO.Config, major: int) -> None - :module: PyOpenColorIO - - Set the configuration major version. - - Throws if it is not supported. Resets minor to the most recent minor for the given major. - - - .. py:method:: Config.setMinorVersion(self: PyOpenColorIO.Config, minor: int) -> None - :module: PyOpenColorIO - - Set the configuration minor version. Throws if it is not supported for the current major. - - - .. py:method:: Config.setName(self: PyOpenColorIO.Config, name: str) -> None - :module: PyOpenColorIO - - - .. py:method:: Config.setProcessorCacheFlags(self: PyOpenColorIO.Config, flags: PyOpenColorIO.ProcessorCacheFlags) -> None - :module: PyOpenColorIO - - Control the caching of processors in the config instance. By default, caching is on. - The flags allow turning caching off entirely or only turning it off if dynamic properties are being used by the processor. - - - .. py:method:: Config.setRole(self: PyOpenColorIO.Config, role: str, colorSpaceName: str) -> None - :module: PyOpenColorIO - - .. note:: - Setting the `colorSpaceName` name to a null string unsets it. - - - .. py:method:: Config.setSearchPath(self: PyOpenColorIO.Config, path: str) -> None - :module: PyOpenColorIO - - Set all search paths as a concatenated string, ':' to separate the paths. - - See :ref:`addSearchPath` for a more robust and platform-agnostic method of setting the search paths. - - - .. py:method:: Config.setStrictParsingEnabled(self: PyOpenColorIO.Config, enabled: bool) -> None - :module: PyOpenColorIO - - - .. py:method:: Config.setVersion(self: PyOpenColorIO.Config, major: int, minor: int) -> None - :module: PyOpenColorIO - - Set the configuration major and minor versions. Throws if version is not supported. - - - .. py:method:: Config.setViewingRules(self: PyOpenColorIO.Config, ViewingRules: PyOpenColorIO.ViewingRules) -> None - :module: PyOpenColorIO - - Set viewing rules. - - .. note:: - The argument is cloned. - - - .. py:method:: Config.setWorkingDir(self: PyOpenColorIO.Config, dirName: str) -> None - :module: PyOpenColorIO - - The working directory defaults to the location of the config file. It is used to convert any relative paths to absolute. If no search paths have been set, the working directory will be used as the fallback search path. No environment (context) variables may be used in the working directory. - - - .. py:method:: Config.upgradeToLatestVersion(self: PyOpenColorIO.Config) -> None - :module: PyOpenColorIO - - Allows an older config to be serialized as the current version. - - - .. py:method:: Config.validate(self: PyOpenColorIO.Config) -> None - :module: PyOpenColorIO - - Performs a thorough validation for the most common user errors. - - This will throw an exception if the config is malformed. The most common error occurs when references are made to colorspaces that do not exist. - - -.. py:class:: EnvironmentVarNameIterator - :module: PyOpenColorIO.Config - - - .. py:method:: EnvironmentVarNameIterator.__getitem__(self: PyOpenColorIO.Config.EnvironmentVarNameIterator, arg0: int) -> str - :module: PyOpenColorIO.Config - - - .. py:method:: EnvironmentVarNameIterator.__iter__(self: PyOpenColorIO.Config.EnvironmentVarNameIterator) -> PyOpenColorIO.Config.EnvironmentVarNameIterator - :module: PyOpenColorIO.Config - - - .. py:method:: EnvironmentVarNameIterator.__len__(self: PyOpenColorIO.Config.EnvironmentVarNameIterator) -> int - :module: PyOpenColorIO.Config - - - .. py:method:: EnvironmentVarNameIterator.__next__(self: PyOpenColorIO.Config.EnvironmentVarNameIterator) -> str - :module: PyOpenColorIO.Config - - -.. py:class:: SearchPathIterator - :module: PyOpenColorIO.Config - - - .. py:method:: SearchPathIterator.__getitem__(self: PyOpenColorIO.Config.SearchPathIterator, arg0: int) -> str - :module: PyOpenColorIO.Config - - - .. py:method:: SearchPathIterator.__iter__(self: PyOpenColorIO.Config.SearchPathIterator) -> PyOpenColorIO.Config.SearchPathIterator - :module: PyOpenColorIO.Config - - - .. py:method:: SearchPathIterator.__len__(self: PyOpenColorIO.Config.SearchPathIterator) -> int - :module: PyOpenColorIO.Config - - - .. py:method:: SearchPathIterator.__next__(self: PyOpenColorIO.Config.SearchPathIterator) -> str - :module: PyOpenColorIO.Config - - -.. py:class:: ColorSpaceNameIterator - :module: PyOpenColorIO.Config - - - .. py:method:: ColorSpaceNameIterator.__getitem__(self: PyOpenColorIO.Config.ColorSpaceNameIterator, arg0: int) -> str - :module: PyOpenColorIO.Config - - - .. py:method:: ColorSpaceNameIterator.__iter__(self: PyOpenColorIO.Config.ColorSpaceNameIterator) -> PyOpenColorIO.Config.ColorSpaceNameIterator - :module: PyOpenColorIO.Config - - - .. py:method:: ColorSpaceNameIterator.__len__(self: PyOpenColorIO.Config.ColorSpaceNameIterator) -> int - :module: PyOpenColorIO.Config - - - .. py:method:: ColorSpaceNameIterator.__next__(self: PyOpenColorIO.Config.ColorSpaceNameIterator) -> str - :module: PyOpenColorIO.Config - - -.. py:class:: ColorSpaceIterator - :module: PyOpenColorIO.Config - - - .. py:method:: ColorSpaceIterator.__getitem__(self: PyOpenColorIO.Config.ColorSpaceIterator, arg0: int) -> PyOpenColorIO.ColorSpace - :module: PyOpenColorIO.Config - - - .. py:method:: ColorSpaceIterator.__iter__(self: PyOpenColorIO.Config.ColorSpaceIterator) -> PyOpenColorIO.Config.ColorSpaceIterator - :module: PyOpenColorIO.Config - - - .. py:method:: ColorSpaceIterator.__len__(self: PyOpenColorIO.Config.ColorSpaceIterator) -> int - :module: PyOpenColorIO.Config - - - .. py:method:: ColorSpaceIterator.__next__(self: PyOpenColorIO.Config.ColorSpaceIterator) -> PyOpenColorIO.ColorSpace - :module: PyOpenColorIO.Config - - -.. py:class:: ActiveColorSpaceNameIterator - :module: PyOpenColorIO.Config - - - .. py:method:: ActiveColorSpaceNameIterator.__getitem__(self: PyOpenColorIO.Config.ActiveColorSpaceNameIterator, arg0: int) -> str - :module: PyOpenColorIO.Config - - - .. py:method:: ActiveColorSpaceNameIterator.__iter__(self: PyOpenColorIO.Config.ActiveColorSpaceNameIterator) -> PyOpenColorIO.Config.ActiveColorSpaceNameIterator - :module: PyOpenColorIO.Config - - - .. py:method:: ActiveColorSpaceNameIterator.__len__(self: PyOpenColorIO.Config.ActiveColorSpaceNameIterator) -> int - :module: PyOpenColorIO.Config - - - .. py:method:: ActiveColorSpaceNameIterator.__next__(self: PyOpenColorIO.Config.ActiveColorSpaceNameIterator) -> str - :module: PyOpenColorIO.Config - - -.. py:class:: ActiveColorSpaceIterator - :module: PyOpenColorIO.Config - - - .. py:method:: ActiveColorSpaceIterator.__getitem__(self: PyOpenColorIO.Config.ActiveColorSpaceIterator, arg0: int) -> PyOpenColorIO.ColorSpace - :module: PyOpenColorIO.Config - - - .. py:method:: ActiveColorSpaceIterator.__iter__(self: PyOpenColorIO.Config.ActiveColorSpaceIterator) -> PyOpenColorIO.Config.ActiveColorSpaceIterator - :module: PyOpenColorIO.Config - - - .. py:method:: ActiveColorSpaceIterator.__len__(self: PyOpenColorIO.Config.ActiveColorSpaceIterator) -> int - :module: PyOpenColorIO.Config - - - .. py:method:: ActiveColorSpaceIterator.__next__(self: PyOpenColorIO.Config.ActiveColorSpaceIterator) -> PyOpenColorIO.ColorSpace - :module: PyOpenColorIO.Config - - -.. py:class:: RoleNameIterator - :module: PyOpenColorIO.Config - - - .. py:method:: RoleNameIterator.__getitem__(self: PyOpenColorIO.Config.RoleNameIterator, arg0: int) -> str - :module: PyOpenColorIO.Config - - - .. py:method:: RoleNameIterator.__iter__(self: PyOpenColorIO.Config.RoleNameIterator) -> PyOpenColorIO.Config.RoleNameIterator - :module: PyOpenColorIO.Config - - - .. py:method:: RoleNameIterator.__len__(self: PyOpenColorIO.Config.RoleNameIterator) -> int - :module: PyOpenColorIO.Config - - - .. py:method:: RoleNameIterator.__next__(self: PyOpenColorIO.Config.RoleNameIterator) -> str - :module: PyOpenColorIO.Config - - -.. py:class:: RoleColorSpaceIterator - :module: PyOpenColorIO.Config - - - .. py:method:: RoleColorSpaceIterator.__getitem__(self: PyOpenColorIO.Config.RoleColorSpaceIterator, arg0: int) -> tuple - :module: PyOpenColorIO.Config - - - .. py:method:: RoleColorSpaceIterator.__iter__(self: PyOpenColorIO.Config.RoleColorSpaceIterator) -> PyOpenColorIO.Config.RoleColorSpaceIterator - :module: PyOpenColorIO.Config - - - .. py:method:: RoleColorSpaceIterator.__len__(self: PyOpenColorIO.Config.RoleColorSpaceIterator) -> int - :module: PyOpenColorIO.Config - - - .. py:method:: RoleColorSpaceIterator.__next__(self: PyOpenColorIO.Config.RoleColorSpaceIterator) -> tuple - :module: PyOpenColorIO.Config - - -.. py:class:: DisplayIterator - :module: PyOpenColorIO.Config - - - .. py:method:: DisplayIterator.__getitem__(self: PyOpenColorIO.Config.DisplayIterator, arg0: int) -> str - :module: PyOpenColorIO.Config - - - .. py:method:: DisplayIterator.__iter__(self: PyOpenColorIO.Config.DisplayIterator) -> PyOpenColorIO.Config.DisplayIterator - :module: PyOpenColorIO.Config - - - .. py:method:: DisplayIterator.__len__(self: PyOpenColorIO.Config.DisplayIterator) -> int - :module: PyOpenColorIO.Config - - - .. py:method:: DisplayIterator.__next__(self: PyOpenColorIO.Config.DisplayIterator) -> str - :module: PyOpenColorIO.Config - - -.. py:class:: SharedViewIterator - :module: PyOpenColorIO.Config - - - .. py:method:: SharedViewIterator.__getitem__(self: PyOpenColorIO.Config.SharedViewIterator, arg0: int) -> str - :module: PyOpenColorIO.Config - - - .. py:method:: SharedViewIterator.__iter__(self: PyOpenColorIO.Config.SharedViewIterator) -> PyOpenColorIO.Config.SharedViewIterator - :module: PyOpenColorIO.Config - - - .. py:method:: SharedViewIterator.__len__(self: PyOpenColorIO.Config.SharedViewIterator) -> int - :module: PyOpenColorIO.Config - - - .. py:method:: SharedViewIterator.__next__(self: PyOpenColorIO.Config.SharedViewIterator) -> str - :module: PyOpenColorIO.Config - - -.. py:class:: ViewIterator - :module: PyOpenColorIO.Config - - - .. py:method:: ViewIterator.__getitem__(self: PyOpenColorIO.Config.ViewIterator, arg0: int) -> str - :module: PyOpenColorIO.Config - - - .. py:method:: ViewIterator.__iter__(self: PyOpenColorIO.Config.ViewIterator) -> PyOpenColorIO.Config.ViewIterator - :module: PyOpenColorIO.Config - - - .. py:method:: ViewIterator.__len__(self: PyOpenColorIO.Config.ViewIterator) -> int - :module: PyOpenColorIO.Config - - - .. py:method:: ViewIterator.__next__(self: PyOpenColorIO.Config.ViewIterator) -> str - :module: PyOpenColorIO.Config - - -.. py:class:: ViewForColorSpaceIterator - :module: PyOpenColorIO.Config - - - .. py:method:: ViewForColorSpaceIterator.__getitem__(self: PyOpenColorIO.Config.ViewForColorSpaceIterator, arg0: int) -> str - :module: PyOpenColorIO.Config - - - .. py:method:: ViewForColorSpaceIterator.__iter__(self: PyOpenColorIO.Config.ViewForColorSpaceIterator) -> PyOpenColorIO.Config.ViewForColorSpaceIterator - :module: PyOpenColorIO.Config - - - .. py:method:: ViewForColorSpaceIterator.__len__(self: PyOpenColorIO.Config.ViewForColorSpaceIterator) -> int - :module: PyOpenColorIO.Config - - - .. py:method:: ViewForColorSpaceIterator.__next__(self: PyOpenColorIO.Config.ViewForColorSpaceIterator) -> str - :module: PyOpenColorIO.Config - - -.. py:class:: LookNameIterator - :module: PyOpenColorIO.Config - - - .. py:method:: LookNameIterator.__getitem__(self: PyOpenColorIO.Config.LookNameIterator, arg0: int) -> str - :module: PyOpenColorIO.Config - - - .. py:method:: LookNameIterator.__iter__(self: PyOpenColorIO.Config.LookNameIterator) -> PyOpenColorIO.Config.LookNameIterator - :module: PyOpenColorIO.Config - - - .. py:method:: LookNameIterator.__len__(self: PyOpenColorIO.Config.LookNameIterator) -> int - :module: PyOpenColorIO.Config - - - .. py:method:: LookNameIterator.__next__(self: PyOpenColorIO.Config.LookNameIterator) -> str - :module: PyOpenColorIO.Config - - -.. py:class:: LookIterator - :module: PyOpenColorIO.Config - - - .. py:method:: LookIterator.__getitem__(self: PyOpenColorIO.Config.LookIterator, arg0: int) -> PyOpenColorIO.Look - :module: PyOpenColorIO.Config - - - .. py:method:: LookIterator.__iter__(self: PyOpenColorIO.Config.LookIterator) -> PyOpenColorIO.Config.LookIterator - :module: PyOpenColorIO.Config - - - .. py:method:: LookIterator.__len__(self: PyOpenColorIO.Config.LookIterator) -> int - :module: PyOpenColorIO.Config - - - .. py:method:: LookIterator.__next__(self: PyOpenColorIO.Config.LookIterator) -> PyOpenColorIO.Look - :module: PyOpenColorIO.Config - - -.. py:class:: ViewTransformNameIterator - :module: PyOpenColorIO.Config - - - .. py:method:: ViewTransformNameIterator.__getitem__(self: PyOpenColorIO.Config.ViewTransformNameIterator, arg0: int) -> str - :module: PyOpenColorIO.Config - - - .. py:method:: ViewTransformNameIterator.__iter__(self: PyOpenColorIO.Config.ViewTransformNameIterator) -> PyOpenColorIO.Config.ViewTransformNameIterator - :module: PyOpenColorIO.Config - - - .. py:method:: ViewTransformNameIterator.__len__(self: PyOpenColorIO.Config.ViewTransformNameIterator) -> int - :module: PyOpenColorIO.Config - - - .. py:method:: ViewTransformNameIterator.__next__(self: PyOpenColorIO.Config.ViewTransformNameIterator) -> str - :module: PyOpenColorIO.Config - - -.. py:class:: ViewTransformIterator - :module: PyOpenColorIO.Config - - - .. py:method:: ViewTransformIterator.__getitem__(self: PyOpenColorIO.Config.ViewTransformIterator, arg0: int) -> PyOpenColorIO.ViewTransform - :module: PyOpenColorIO.Config - - - .. py:method:: ViewTransformIterator.__iter__(self: PyOpenColorIO.Config.ViewTransformIterator) -> PyOpenColorIO.Config.ViewTransformIterator - :module: PyOpenColorIO.Config - - - .. py:method:: ViewTransformIterator.__len__(self: PyOpenColorIO.Config.ViewTransformIterator) -> int - :module: PyOpenColorIO.Config - - - .. py:method:: ViewTransformIterator.__next__(self: PyOpenColorIO.Config.ViewTransformIterator) -> PyOpenColorIO.ViewTransform - :module: PyOpenColorIO.Config - - -.. py:class:: NamedTransformNameIterator - :module: PyOpenColorIO.Config - - - .. py:method:: NamedTransformNameIterator.__getitem__(self: PyOpenColorIO.Config.NamedTransformNameIterator, arg0: int) -> str - :module: PyOpenColorIO.Config - - - .. py:method:: NamedTransformNameIterator.__iter__(self: PyOpenColorIO.Config.NamedTransformNameIterator) -> PyOpenColorIO.Config.NamedTransformNameIterator - :module: PyOpenColorIO.Config - - - .. py:method:: NamedTransformNameIterator.__len__(self: PyOpenColorIO.Config.NamedTransformNameIterator) -> int - :module: PyOpenColorIO.Config - - - .. py:method:: NamedTransformNameIterator.__next__(self: PyOpenColorIO.Config.NamedTransformNameIterator) -> str - :module: PyOpenColorIO.Config - - -.. py:class:: NamedTransformIterator - :module: PyOpenColorIO.Config - - - .. py:method:: NamedTransformIterator.__getitem__(self: PyOpenColorIO.Config.NamedTransformIterator, arg0: int) -> PyOpenColorIO.NamedTransform - :module: PyOpenColorIO.Config - - - .. py:method:: NamedTransformIterator.__iter__(self: PyOpenColorIO.Config.NamedTransformIterator) -> PyOpenColorIO.Config.NamedTransformIterator - :module: PyOpenColorIO.Config - - - .. py:method:: NamedTransformIterator.__len__(self: PyOpenColorIO.Config.NamedTransformIterator) -> int - :module: PyOpenColorIO.Config - - - .. py:method:: NamedTransformIterator.__next__(self: PyOpenColorIO.Config.NamedTransformIterator) -> PyOpenColorIO.NamedTransform - :module: PyOpenColorIO.Config - - -.. py:class:: ActiveNamedTransformNameIterator - :module: PyOpenColorIO.Config - - - .. py:method:: ActiveNamedTransformNameIterator.__getitem__(self: PyOpenColorIO.Config.ActiveNamedTransformNameIterator, arg0: int) -> str - :module: PyOpenColorIO.Config - - - .. py:method:: ActiveNamedTransformNameIterator.__iter__(self: PyOpenColorIO.Config.ActiveNamedTransformNameIterator) -> PyOpenColorIO.Config.ActiveNamedTransformNameIterator - :module: PyOpenColorIO.Config - - - .. py:method:: ActiveNamedTransformNameIterator.__len__(self: PyOpenColorIO.Config.ActiveNamedTransformNameIterator) -> int - :module: PyOpenColorIO.Config - - - .. py:method:: ActiveNamedTransformNameIterator.__next__(self: PyOpenColorIO.Config.ActiveNamedTransformNameIterator) -> str - :module: PyOpenColorIO.Config - - -.. py:class:: ActiveNamedTransformIterator - :module: PyOpenColorIO.Config - - - .. py:method:: ActiveNamedTransformIterator.__getitem__(self: PyOpenColorIO.Config.ActiveNamedTransformIterator, arg0: int) -> PyOpenColorIO.NamedTransform - :module: PyOpenColorIO.Config - - - .. py:method:: ActiveNamedTransformIterator.__iter__(self: PyOpenColorIO.Config.ActiveNamedTransformIterator) -> PyOpenColorIO.Config.ActiveNamedTransformIterator - :module: PyOpenColorIO.Config - - - .. py:method:: ActiveNamedTransformIterator.__len__(self: PyOpenColorIO.Config.ActiveNamedTransformIterator) -> int - :module: PyOpenColorIO.Config - - - .. py:method:: ActiveNamedTransformIterator.__next__(self: PyOpenColorIO.Config.ActiveNamedTransformIterator) -> PyOpenColorIO.NamedTransform - :module: PyOpenColorIO.Config - diff --git a/docs/api/python/frozen/pyopencolorio_context.rst b/docs/api/python/frozen/pyopencolorio_context.rst deleted file mode 100644 index 9766d703d2..0000000000 --- a/docs/api/python/frozen/pyopencolorio_context.rst +++ /dev/null @@ -1,191 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: Context - :module: PyOpenColorIO - - :ref:`Context` - - A context defines some overrides to a :ref:`Config`. For example, it can override the search path or change the value of a context variable. - - .. note:: - Only some :ref:`Config::getProcessor` methods accept a custom context; otherwise, the default context instance is used (see Config::getCurrentContext). - - :ref:`Context` Variables - - The context variables allow changes at runtime using environment variables. For example, a color space name (such as src & dst for the :ref:`ColorSpaceTransform`) or a file name (such as LUT file name for the :ref:`FileTransform`) could be defined by context variables. The color transformation is then customized based on some environment variables. - - In a config the context variables support three syntaxes (i.e. ${VAR}, $VAR and VAR%) and the parsing starts from longest to shortest. So, the resolve works like '$TEST_$TESTING_$TE' expands in this order '2 1 3'. - - :ref:`Config` authors are recommended to include the "environment" section in their configs. This improves performance as well as making the config more readable. When present, this section must declare all context variables used in the config. It may also provide a default value, in case the variable is not present in the user's environment. - - A context variable may only be used in the following places: - - the `:ref:`ColorSpaceTransform`` to define the source and the destination color space names, - - the `:ref:`FileTransform`` to define the source file name (e.g. a LUT file name), - - the search_path, - - the cccid of the `:ref:`FileTransform`` to only extract one specific transform from the CDL & CCC files. - - Some specific restrictions are worth calling out: - - they cannot be used as either the name or value of a role, - - the context variable characters $ and % are prohibited in a color space name. - - - .. py:method:: Context.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.Context) -> None - - 2. __init__(self: PyOpenColorIO.Context, workingDir: str = '', searchPaths: List[str] = [], stringVars: Dict[str, str] = {}, environmentMode: PyOpenColorIO.EnvironmentMode = ) -> None - - - .. py:method:: Context.addSearchPath(self: PyOpenColorIO.Context, path: str) -> None - :module: PyOpenColorIO - - - .. py:method:: Context.clearSearchPaths(self: PyOpenColorIO.Context) -> None - :module: PyOpenColorIO - - - .. py:method:: Context.clearStringVars(self: PyOpenColorIO.Context) -> None - :module: PyOpenColorIO - - - .. py:method:: Context.getCacheID(self: PyOpenColorIO.Context) -> str - :module: PyOpenColorIO - - - .. py:method:: Context.getEnvironmentMode(self: PyOpenColorIO.Context) -> PyOpenColorIO.EnvironmentMode - :module: PyOpenColorIO - - - .. py:method:: Context.getSearchPath(self: PyOpenColorIO.Context) -> str - :module: PyOpenColorIO - - - .. py:method:: Context.getSearchPaths(self: PyOpenColorIO.Context) -> PyOpenColorIO.Context.SearchPathIterator - :module: PyOpenColorIO - - - .. py:method:: Context.getStringVars(self: PyOpenColorIO.Context) -> PyOpenColorIO.Context.StringVarIterator - :module: PyOpenColorIO - - - .. py:method:: Context.getWorkingDir(self: PyOpenColorIO.Context) -> str - :module: PyOpenColorIO - - - .. py:method:: Context.loadEnvironment(self: PyOpenColorIO.Context) -> None - :module: PyOpenColorIO - - Seed all string vars with the current environment. - - - .. py:method:: Context.resolveFileLocation(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. resolveFileLocation(self: PyOpenColorIO.Context, filename: str) -> str - - Build the resolved and expanded filepath using the search_path when needed, and check if the filepath exists. If it cannot be resolved or found, an exception will be thrown. The method argument is directly from the config file so it can be an absolute or relative file path or a file name. - - .. note:: - The filepath existence check could add a performance hit. - - .. note:: - The context variable resolution is performed using :cpp:func:`resolveStringVar`. - - 2. resolveFileLocation(self: PyOpenColorIO.Context, filename: str, usedContextVars: PyOpenColorIO.Context) -> str - - Build the resolved and expanded filepath and return all the context variables used to resolve the filename (empty if no context variables were used). - - - .. py:method:: Context.resolveStringVar(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. resolveStringVar(self: PyOpenColorIO.Context, string: str) -> str - - Resolve all the context variables from the string. It could be color space names or file names. Note that it recursively applies the context variable resolution. Returns the string unchanged if it does not contain any context variable. - - 2. resolveStringVar(self: PyOpenColorIO.Context, string: str, usedContextVars: PyOpenColorIO.Context) -> str - - Resolve all the context variables from the string and return all the context variables used to resolve the string (empty if no context variables were used). - - - .. py:method:: Context.setEnvironmentMode(self: PyOpenColorIO.Context, mode: PyOpenColorIO.EnvironmentMode) -> None - :module: PyOpenColorIO - - - .. py:method:: Context.setSearchPath(self: PyOpenColorIO.Context, path: str) -> None - :module: PyOpenColorIO - - - .. py:method:: Context.setWorkingDir(self: PyOpenColorIO.Context, dirName: str) -> None - :module: PyOpenColorIO - - -.. py:class:: StringVarNameIterator - :module: PyOpenColorIO.Context - - - .. py:method:: StringVarNameIterator.__getitem__(self: PyOpenColorIO.Context.StringVarNameIterator, arg0: int) -> str - :module: PyOpenColorIO.Context - - - .. py:method:: StringVarNameIterator.__iter__(self: PyOpenColorIO.Context.StringVarNameIterator) -> PyOpenColorIO.Context.StringVarNameIterator - :module: PyOpenColorIO.Context - - - .. py:method:: StringVarNameIterator.__len__(self: PyOpenColorIO.Context.StringVarNameIterator) -> int - :module: PyOpenColorIO.Context - - - .. py:method:: StringVarNameIterator.__next__(self: PyOpenColorIO.Context.StringVarNameIterator) -> str - :module: PyOpenColorIO.Context - - -.. py:class:: StringVarIterator - :module: PyOpenColorIO.Context - - - .. py:method:: StringVarIterator.__getitem__(self: PyOpenColorIO.Context.StringVarIterator, arg0: int) -> tuple - :module: PyOpenColorIO.Context - - - .. py:method:: StringVarIterator.__iter__(self: PyOpenColorIO.Context.StringVarIterator) -> PyOpenColorIO.Context.StringVarIterator - :module: PyOpenColorIO.Context - - - .. py:method:: StringVarIterator.__len__(self: PyOpenColorIO.Context.StringVarIterator) -> int - :module: PyOpenColorIO.Context - - - .. py:method:: StringVarIterator.__next__(self: PyOpenColorIO.Context.StringVarIterator) -> tuple - :module: PyOpenColorIO.Context - - -.. py:class:: SearchPathIterator - :module: PyOpenColorIO.Context - - - .. py:method:: SearchPathIterator.__getitem__(self: PyOpenColorIO.Context.SearchPathIterator, arg0: int) -> str - :module: PyOpenColorIO.Context - - - .. py:method:: SearchPathIterator.__iter__(self: PyOpenColorIO.Context.SearchPathIterator) -> PyOpenColorIO.Context.SearchPathIterator - :module: PyOpenColorIO.Context - - - .. py:method:: SearchPathIterator.__len__(self: PyOpenColorIO.Context.SearchPathIterator) -> int - :module: PyOpenColorIO.Context - - - .. py:method:: SearchPathIterator.__next__(self: PyOpenColorIO.Context.SearchPathIterator) -> str - :module: PyOpenColorIO.Context - diff --git a/docs/api/python/frozen/pyopencolorio_cpuprocessor.rst b/docs/api/python/frozen/pyopencolorio_cpuprocessor.rst index 748413280f..088b4bde8b 100644 --- a/docs/api/python/frozen/pyopencolorio_cpuprocessor.rst +++ b/docs/api/python/frozen/pyopencolorio_cpuprocessor.rst @@ -5,6 +5,7 @@ .. py:class:: CPUProcessor :module: PyOpenColorIO + :canonical: PyOpenColorIO.PyOpenColorIO.CPUProcessor .. py:method:: CPUProcessor.__init__(*args, **kwargs) @@ -16,7 +17,7 @@ Overloaded function. - 1. apply(self: PyOpenColorIO.CPUProcessor, imgDesc: PyOpenColorIO.ImageDesc) -> None + 1. apply(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor, imgDesc: PyOpenColorIO.PyOpenColorIO.ImageDesc) -> None Apply to an image with any kind of channel ordering while respecting @@ -35,7 +36,7 @@ - 2. apply(self: PyOpenColorIO.CPUProcessor, srcImgDesc: PyOpenColorIO.ImageDesc, dstImgDesc: PyOpenColorIO.ImageDesc) -> None + 2. apply(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor, srcImgDesc: PyOpenColorIO.PyOpenColorIO.ImageDesc, dstImgDesc: PyOpenColorIO.PyOpenColorIO.ImageDesc) -> None Apply to an image with any kind of channel ordering while respecting @@ -59,7 +60,7 @@ Overloaded function. - 1. applyRGB(self: PyOpenColorIO.CPUProcessor, data: buffer) -> None + 1. applyRGB(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor, data: buffer) -> None Apply to a packed RGB array adhering to the Python buffer protocol. @@ -77,7 +78,7 @@ - 2. applyRGB(self: PyOpenColorIO.CPUProcessor, data: List[float]) -> List[float] + 2. applyRGB(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor, data: List[float]) -> List[float] Apply to a packed RGB list of float values. Any size is supported as @@ -102,7 +103,7 @@ Overloaded function. - 1. applyRGBA(self: PyOpenColorIO.CPUProcessor, data: buffer) -> None + 1. applyRGBA(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor, data: buffer) -> None Apply to a packed RGBA array adhering to the Python buffer protocol. @@ -120,7 +121,7 @@ - 2. applyRGBA(self: PyOpenColorIO.CPUProcessor, data: List[float]) -> List[float] + 2. applyRGBA(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor, data: List[float]) -> List[float] Apply to a packed RGBA list of float values. Any size is supported as @@ -140,11 +141,11 @@ modified in place. - .. py:method:: CPUProcessor.getCacheID(self: PyOpenColorIO.CPUProcessor) -> str + .. py:method:: CPUProcessor.getCacheID(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor) -> str :module: PyOpenColorIO - .. py:method:: CPUProcessor.getDynamicProperty(self: PyOpenColorIO.CPUProcessor, type: PyOpenColorIO.DynamicPropertyType) -> PyOpenColorIO.DynamicProperty + .. py:method:: CPUProcessor.getDynamicProperty(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor, type: PyOpenColorIO.PyOpenColorIO.DynamicPropertyType) -> PyOpenColorIO.PyOpenColorIO.DynamicProperty :module: PyOpenColorIO The returned pointer may be used to set the value of any dynamic properties of the requested type. Throws if the requested property is not found. Note that if the processor contains several ops that support the requested property, only one can be dynamic. @@ -153,29 +154,41 @@ The dynamic properties in this object are decoupled from the ones in the :ref:`Processor` it was generated from. For each dynamic property in the :ref:`Processor`, there is one in the CPU processor. - .. py:method:: CPUProcessor.getInputBitDepth(self: PyOpenColorIO.CPUProcessor) -> PyOpenColorIO.BitDepth + .. py:method:: CPUProcessor.getInputBitDepth(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor) -> PyOpenColorIO.PyOpenColorIO.BitDepth :module: PyOpenColorIO Bit-depth of the input pixel buffer. - .. py:method:: CPUProcessor.getOutputBitDepth(self: PyOpenColorIO.CPUProcessor) -> PyOpenColorIO.BitDepth + .. py:method:: CPUProcessor.getOutputBitDepth(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor) -> PyOpenColorIO.PyOpenColorIO.BitDepth :module: PyOpenColorIO Bit-depth of the output pixel buffer. - .. py:method:: CPUProcessor.hasChannelCrosstalk(self: PyOpenColorIO.CPUProcessor) -> bool + .. py:method:: CPUProcessor.hasChannelCrosstalk(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor) -> bool :module: PyOpenColorIO - .. py:method:: CPUProcessor.isIdentity(self: PyOpenColorIO.CPUProcessor) -> bool + .. py:method:: CPUProcessor.hasDynamicProperty(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor, type: PyOpenColorIO.PyOpenColorIO.DynamicPropertyType) -> bool + :module: PyOpenColorIO + + True if at least one dynamic property of that type exists. + + + .. py:method:: CPUProcessor.isDynamic(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor) -> bool + :module: PyOpenColorIO + + True if at least one dynamic property of any type exists and is dynamic. + + + .. py:method:: CPUProcessor.isIdentity(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor) -> bool :module: PyOpenColorIO Equivalent to isNoOp from the underlying :ref:`Processor`, i.e., it ignores in/out bit-depth differences. - .. py:method:: CPUProcessor.isNoOp(self: PyOpenColorIO.CPUProcessor) -> bool + .. py:method:: CPUProcessor.isNoOp(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor) -> bool :module: PyOpenColorIO The in and out bit-depths must be equal for isNoOp to be true. diff --git a/docs/api/python/frozen/pyopencolorio_displayviewhelpers.rst b/docs/api/python/frozen/pyopencolorio_displayviewhelpers.rst index c99237493c..f186a7f009 100644 --- a/docs/api/python/frozen/pyopencolorio_displayviewhelpers.rst +++ b/docs/api/python/frozen/pyopencolorio_displayviewhelpers.rst @@ -3,25 +3,25 @@ Copyright Contributors to the OpenColorIO Project. Do not edit! This file was automatically generated by share/docs/frozendoc.py. -.. py:function:: GetProcessor(config: PyOpenColorIO.Config, context: PyOpenColorIO.Context = None, workingSpaceName: str, displayName: str, viewName: str, channelView: PyOpenColorIO.MatrixTransform = None, direction: PyOpenColorIO.TransformDirection = ) -> PyOpenColorIO.Processor +.. py:function:: GetProcessor(config: PyOpenColorIO.PyOpenColorIO.Config, context: PyOpenColorIO.PyOpenColorIO.Context = None, workingSpaceName: str, displayName: str, viewName: str, channelView: PyOpenColorIO.PyOpenColorIO.MatrixTransform = None, direction: PyOpenColorIO.PyOpenColorIO.TransformDirection = ) -> PyOpenColorIO.PyOpenColorIO.Processor :module: PyOpenColorIO.DisplayViewHelpers Get the processor from the working color space to (display, view) pair (forward) or (display, view) pair to working (inverse). The working color space name could be a role name or a color space name. ChannelView can be empty. If not already present, each of these functions adds ExposureContrastTransforms to enable changing exposure, contrast, and gamma after the processor has been created using dynamic properties. -.. py:function:: GetIdentityProcessor(config: PyOpenColorIO.Config) -> PyOpenColorIO.Processor +.. py:function:: GetIdentityProcessor(config: PyOpenColorIO.PyOpenColorIO.Config) -> PyOpenColorIO.PyOpenColorIO.Processor :module: PyOpenColorIO.DisplayViewHelpers Get an identity processor containing only the ExposureContrastTransforms. -.. py:function:: AddDisplayView(config: PyOpenColorIO.Config, displayName: str, viewName: str, lookName: str = '', colorSpaceName: str = '', colorSpaceFamily: str = '', colorSpaceDescription: str = '', colorSpaceCategories: str = '', transformFilePath: str, connectionColorSpaceName: str) -> None +.. py:function:: AddDisplayView(config: PyOpenColorIO.PyOpenColorIO.Config, displayName: str, viewName: str, lookName: str = '', colorSpaceName: str = '', colorSpaceFamily: str = '', colorSpaceDescription: str = '', colorSpaceCategories: str = '', transformFilePath: str, connectionColorSpaceName: str) -> None :module: PyOpenColorIO.DisplayViewHelpers Add a new (display, view) pair and the new color space to a configuration instance. The input to the userTransform must be in the specified connectionColorSpace. -.. py:function:: RemoveDisplayView(config: PyOpenColorIO.Config, displayName: str, viewName: str) -> None +.. py:function:: RemoveDisplayView(config: PyOpenColorIO.PyOpenColorIO.Config, displayName: str, viewName: str) -> None :module: PyOpenColorIO.DisplayViewHelpers Remove a (display, view) pair including the associated color space (only if not used). Note that the view is always removed but the display is only removed if empty. diff --git a/docs/api/python/frozen/pyopencolorio_displayviewtransform.rst b/docs/api/python/frozen/pyopencolorio_displayviewtransform.rst deleted file mode 100644 index 3d780e17f5..0000000000 --- a/docs/api/python/frozen/pyopencolorio_displayviewtransform.rst +++ /dev/null @@ -1,88 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: DisplayViewTransform - :module: PyOpenColorIO - - - .. py:method:: DisplayViewTransform.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.DisplayViewTransform) -> None - - 2. __init__(self: PyOpenColorIO.DisplayViewTransform, src: str = '', display: str = '', view: str = '', looksBypass: bool = False, dataBypass: bool = True, direction: PyOpenColorIO.TransformDirection = ) -> None - - - .. py:method:: DisplayViewTransform.getDataBypass(self: PyOpenColorIO.DisplayViewTransform) -> bool - :module: PyOpenColorIO - - - .. py:method:: DisplayViewTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection - :module: PyOpenColorIO - - - .. py:method:: DisplayViewTransform.getDisplay(self: PyOpenColorIO.DisplayViewTransform) -> str - :module: PyOpenColorIO - - - .. py:method:: DisplayViewTransform.getLooksBypass(self: PyOpenColorIO.DisplayViewTransform) -> bool - :module: PyOpenColorIO - - - .. py:method:: DisplayViewTransform.getSrc(self: PyOpenColorIO.DisplayViewTransform) -> str - :module: PyOpenColorIO - - - .. py:method:: DisplayViewTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType - :module: PyOpenColorIO - - - .. py:method:: DisplayViewTransform.getView(self: PyOpenColorIO.DisplayViewTransform) -> str - :module: PyOpenColorIO - - - .. py:method:: DisplayViewTransform.setDataBypass(self: PyOpenColorIO.DisplayViewTransform, dataBypass: bool) -> None - :module: PyOpenColorIO - - Data color spaces do not get processed when true (which is the default). - - - .. py:method:: DisplayViewTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None - :module: PyOpenColorIO - - Note that this only affects the evaluation and not the values stored in the object. - - - .. py:method:: DisplayViewTransform.setDisplay(self: PyOpenColorIO.DisplayViewTransform, display: str) -> None - :module: PyOpenColorIO - - Specify which display to use. - - - .. py:method:: DisplayViewTransform.setLooksBypass(self: PyOpenColorIO.DisplayViewTransform, looksBypass: bool) -> None - :module: PyOpenColorIO - - Looks will be bypassed when true (the default is false). - - - .. py:method:: DisplayViewTransform.setSrc(self: PyOpenColorIO.DisplayViewTransform, src: str) -> None - :module: PyOpenColorIO - - Specify the incoming color space. - - - .. py:method:: DisplayViewTransform.setView(self: PyOpenColorIO.DisplayViewTransform, view: str) -> None - :module: PyOpenColorIO - - Specify which view transform to use. - - - .. py:method:: DisplayViewTransform.validate(self: PyOpenColorIO.Transform) -> None - :module: PyOpenColorIO - - Will throw if data is not valid. - diff --git a/docs/api/python/frozen/pyopencolorio_dynamicproperty.rst b/docs/api/python/frozen/pyopencolorio_dynamicproperty.rst deleted file mode 100644 index 6c031451a1..0000000000 --- a/docs/api/python/frozen/pyopencolorio_dynamicproperty.rst +++ /dev/null @@ -1,105 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: DynamicProperty - :module: PyOpenColorIO - - Allows transform parameter values to be set on-the-fly (after finalization). For example, to modify the exposure in a viewport. Dynamic properties can be accessed from the `:ref:`CPUProcessor`` or `:ref:`GpuShaderCreator`` to change values between processing. - - .. code-block:: cpp - - OCIO::ConstConfigRcPtr config = OCIO::GetCurrentConfig(); - OCIO::ConstProcessorRcPtr processor = config->getProcessor(colorSpace1, colorSpace2); - OCIO::ConstCPUProcessorRcPtr cpuProcessor = processor->getDefaultCPUProcessor(); - - if (cpuProcessor->hasDynamicProperty(OCIO::DYNAMIC_PROPERTY_EXPOSURE)) - { - // Get the in-memory implementation of the dynamic property. - OCIO::DynamicPropertyRcPtr dynProp = - cpuProcessor->getDynamicProperty(OCIO::DYNAMIC_PROPERTY_EXPOSURE); - // Get the interface used to change the double value. - OCIO::DynamicPropertyDoubleRcPtr exposure = - OCIO::DynamicPropertyValue::AsDouble(dynProp); - // Update of the dynamic property instance with the new value. - exposure->setValue(1.1f); - } - if (cpuProcessor->hasDynamicProperty(OCIO::DYNAMIC_PROPERTY_GRADING_PRIMARY)) - { - OCIO::DynamicPropertyRcPtr dynProp = - cpuProcessor->getDynamicProperty(OCIO::DYNAMIC_PROPERTY_GRADING_PRIMARY); - OCIO::DynamicPropertyGradingPrimaryRcPtr primaryProp = - OCIO::DynamicPropertyValue::AsGradingPrimary(dynProp); - OCIO::GradingPrimary primary = primaryProp->getValue(); - primary.m_saturation += 0.1f; - rgbCurveProp->setValue(primary); - } - if (cpuProcessor->hasDynamicProperty(OCIO::DYNAMIC_PROPERTY_GRADING_RGBCURVE)) - { - OCIO::DynamicPropertyRcPtr dynProp = - cpuProcessor->getDynamicProperty(OCIO::DYNAMIC_PROPERTY_GRADING_RGBCURVE); - OCIO::DynamicPropertyGradingRGBCurveRcPtr rgbCurveProp = - OCIO::DynamicPropertyValue::AsGradingRGBCurve(dynProp); - OCIO::ConstGradingRGBCurveRcPtr rgbCurve = rgbCurveProp->getValue()->createEditableCopy(); - OCIO::GradingBSplineCurveRcPtr rCurve = rgbCurve->getCurve(OCIO::RGB_RED); - rCurve->getControlPoint(1).m_y += 0.1f; - rgbCurveProp->setValue(rgbCurve); - } - - - .. py:method:: DynamicProperty.__init__(*args, **kwargs) - :module: PyOpenColorIO - - - .. py:method:: DynamicProperty.getDouble(self: PyOpenColorIO.DynamicProperty) -> float - :module: PyOpenColorIO - - Get the property as DynamicPropertyDoubleRcPtr to access the double value. Will throw if property type is not a type that holds a double such as DYNAMIC_PROPERTY_EXPOSURE. - - - .. py:method:: DynamicProperty.getGradingPrimary(self: PyOpenColorIO.DynamicProperty) -> PyOpenColorIO.GradingPrimary - :module: PyOpenColorIO - - Get the property as DynamicPropertyGradingPrimaryRcPtr to access the :ref:`GradingPrimary` value. Will throw if property type is not DYNAMIC_PROPERTY_GRADING_PRIMARY. - - - .. py:method:: DynamicProperty.getGradingRGBCurve(self: PyOpenColorIO.DynamicProperty) -> PyOpenColorIO.GradingRGBCurve - :module: PyOpenColorIO - - Get the property as DynamicPropertyGradingRGBCurveRcPtr to access the GradingRGBCurveRcPtr value. Will throw if property type is not DYNAMIC_PROPERTY_GRADING_RGBCURVE. - - - .. py:method:: DynamicProperty.getGradingTone(self: PyOpenColorIO.DynamicProperty) -> PyOpenColorIO.GradingTone - :module: PyOpenColorIO - - Get the property as DynamicPropertyGradingToneRcPtr to access the :ref:`GradingTone` value. Will throw if property type is not DYNAMIC_PROPERTY_GRADING_TONE. - - - .. py:method:: DynamicProperty.getType(self: PyOpenColorIO.DynamicProperty) -> PyOpenColorIO.DynamicPropertyType - :module: PyOpenColorIO - - - .. py:method:: DynamicProperty.setDouble(self: PyOpenColorIO.DynamicProperty, val: float) -> None - :module: PyOpenColorIO - - Get the property as DynamicPropertyDoubleRcPtr to access the double value. Will throw if property type is not a type that holds a double such as DYNAMIC_PROPERTY_EXPOSURE. - - - .. py:method:: DynamicProperty.setGradingPrimary(self: PyOpenColorIO.DynamicProperty, val: PyOpenColorIO.GradingPrimary) -> None - :module: PyOpenColorIO - - Get the property as DynamicPropertyGradingPrimaryRcPtr to access the :ref:`GradingPrimary` value. Will throw if property type is not DYNAMIC_PROPERTY_GRADING_PRIMARY. - - - .. py:method:: DynamicProperty.setGradingRGBCurve(self: PyOpenColorIO.DynamicProperty, val: PyOpenColorIO.GradingRGBCurve) -> None - :module: PyOpenColorIO - - Get the property as DynamicPropertyGradingRGBCurveRcPtr to access the GradingRGBCurveRcPtr value. Will throw if property type is not DYNAMIC_PROPERTY_GRADING_RGBCURVE. - - - .. py:method:: DynamicProperty.setGradingTone(self: PyOpenColorIO.DynamicProperty, val: PyOpenColorIO.GradingTone) -> None - :module: PyOpenColorIO - - Get the property as DynamicPropertyGradingToneRcPtr to access the :ref:`GradingTone` value. Will throw if property type is not DYNAMIC_PROPERTY_GRADING_TONE. - diff --git a/docs/api/python/frozen/pyopencolorio_dynamicpropertytype.rst b/docs/api/python/frozen/pyopencolorio_dynamicpropertytype.rst deleted file mode 100644 index 479ddc2df1..0000000000 --- a/docs/api/python/frozen/pyopencolorio_dynamicpropertytype.rst +++ /dev/null @@ -1,60 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: DynamicPropertyType - :module: PyOpenColorIO - - Types for dynamic properties. - - Members: - - DYNAMIC_PROPERTY_EXPOSURE : Image exposure value (double floating point value) - - DYNAMIC_PROPERTY_CONTRAST : Image contrast value (double floating point value) - - DYNAMIC_PROPERTY_GAMMA : Image gamma value (double floating point value) - - DYNAMIC_PROPERTY_GRADING_PRIMARY : Used by :ref:`GradingPrimaryTransform`. - - DYNAMIC_PROPERTY_GRADING_RGBCURVE : Used by :ref:`GradingRGBCurveTransform`. - - DYNAMIC_PROPERTY_GRADING_TONE : Used by :ref:`GradingToneTransform`. - - .. py:method:: name() -> str - :property: - - .. py:attribute:: DynamicPropertyType.DYNAMIC_PROPERTY_CONTRAST - :module: PyOpenColorIO - :value: - - - .. py:attribute:: DynamicPropertyType.DYNAMIC_PROPERTY_EXPOSURE - :module: PyOpenColorIO - :value: - - - .. py:attribute:: DynamicPropertyType.DYNAMIC_PROPERTY_GAMMA - :module: PyOpenColorIO - :value: - - - .. py:attribute:: DynamicPropertyType.DYNAMIC_PROPERTY_GRADING_PRIMARY - :module: PyOpenColorIO - :value: - - - .. py:attribute:: DynamicPropertyType.DYNAMIC_PROPERTY_GRADING_RGBCURVE - :module: PyOpenColorIO - :value: - - - .. py:attribute:: DynamicPropertyType.DYNAMIC_PROPERTY_GRADING_TONE - :module: PyOpenColorIO - :value: - - - .. py:property:: DynamicPropertyType.value - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_environmentmode.rst b/docs/api/python/frozen/pyopencolorio_environmentmode.rst deleted file mode 100644 index f86bcc35a1..0000000000 --- a/docs/api/python/frozen/pyopencolorio_environmentmode.rst +++ /dev/null @@ -1,37 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: EnvironmentMode - :module: PyOpenColorIO - - Members: - - ENV_ENVIRONMENT_UNKNOWN : - - ENV_ENVIRONMENT_LOAD_PREDEFINED : - - ENV_ENVIRONMENT_LOAD_ALL : - - .. py:method:: name() -> str - :property: - - .. py:attribute:: EnvironmentMode.ENV_ENVIRONMENT_LOAD_ALL - :module: PyOpenColorIO - :value: - - - .. py:attribute:: EnvironmentMode.ENV_ENVIRONMENT_LOAD_PREDEFINED - :module: PyOpenColorIO - :value: - - - .. py:attribute:: EnvironmentMode.ENV_ENVIRONMENT_UNKNOWN - :module: PyOpenColorIO - :value: - - - .. py:property:: EnvironmentMode.value - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_environmentmodefromstring.rst b/docs/api/python/frozen/pyopencolorio_environmentmodefromstring.rst deleted file mode 100644 index 5d7baedb4d..0000000000 --- a/docs/api/python/frozen/pyopencolorio_environmentmodefromstring.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: EnvironmentModeFromString(str: str) -> PyOpenColorIO.EnvironmentMode - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_environmentmodetostring.rst b/docs/api/python/frozen/pyopencolorio_environmentmodetostring.rst deleted file mode 100644 index 3f3eccaf53..0000000000 --- a/docs/api/python/frozen/pyopencolorio_environmentmodetostring.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: EnvironmentModeToString(mode: PyOpenColorIO.EnvironmentMode) -> str - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_exception.rst b/docs/api/python/frozen/pyopencolorio_exception.rst deleted file mode 100644 index f22ab45b97..0000000000 --- a/docs/api/python/frozen/pyopencolorio_exception.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:exception:: Exception - :module: PyOpenColorIO - - An exception class to throw for errors detected at runtime. - - .. warning:: - All functions in the :ref:`Config` class can potentially throw this exception. - diff --git a/docs/api/python/frozen/pyopencolorio_exceptionmissingfile.rst b/docs/api/python/frozen/pyopencolorio_exceptionmissingfile.rst deleted file mode 100644 index 6bbf70207f..0000000000 --- a/docs/api/python/frozen/pyopencolorio_exceptionmissingfile.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:exception:: ExceptionMissingFile - :module: PyOpenColorIO - - An exception class for errors detected at runtime. - - Thrown when OCIO cannot find a file that is expected to exist. This is provided as a custom type to distinguish cases where one wants to continue looking for missing files, but wants to properly fail for other error conditions. - diff --git a/docs/api/python/frozen/pyopencolorio_exponenttransform.rst b/docs/api/python/frozen/pyopencolorio_exponenttransform.rst deleted file mode 100644 index d350668af9..0000000000 --- a/docs/api/python/frozen/pyopencolorio_exponenttransform.rst +++ /dev/null @@ -1,75 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: ExponentTransform - :module: PyOpenColorIO - - Represents exponent transform: pow( clamp(color), value ). - - .. note:: - For configs with version == 1: Negative style is ignored and if the exponent is 1.0, this will not clamp. Otherwise, the input color will be clamped between [0.0, inf]. For configs with version > 1: Negative value handling may be specified via setNegativeStyle. - - - .. py:method:: ExponentTransform.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.ExponentTransform) -> None - - 2. __init__(self: PyOpenColorIO.ExponentTransform, value: List[float[4]] = [1.0, 1.0, 1.0, 1.0], negativeStyle: PyOpenColorIO.NegativeStyle = , direction: PyOpenColorIO.TransformDirection = ) -> None - - - .. py:method:: ExponentTransform.equals(self: PyOpenColorIO.ExponentTransform, other: PyOpenColorIO.ExponentTransform) -> bool - :module: PyOpenColorIO - - Checks if this exactly equals other. - - - .. py:method:: ExponentTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection - :module: PyOpenColorIO - - - .. py:method:: ExponentTransform.getFormatMetadata(self: PyOpenColorIO.ExponentTransform) -> PyOpenColorIO.FormatMetadata - :module: PyOpenColorIO - - - .. py:method:: ExponentTransform.getNegativeStyle(self: PyOpenColorIO.ExponentTransform) -> PyOpenColorIO.NegativeStyle - :module: PyOpenColorIO - - Specifies how negative values are handled. Legal values: - - - NEGATIVE_CLAMP -- Clamp negative values (default). - - NEGATIVE_MIRROR -- Positive curve is rotated 180 degrees around the origin to handle negatives. - - NEGATIVE_PASS_THRU -- Negative values are passed through unchanged. - - - .. py:method:: ExponentTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType - :module: PyOpenColorIO - - - .. py:method:: ExponentTransform.getValue(self: PyOpenColorIO.ExponentTransform) -> List[float[4]] - :module: PyOpenColorIO - - - .. py:method:: ExponentTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None - :module: PyOpenColorIO - - Note that this only affects the evaluation and not the values stored in the object. - - - .. py:method:: ExponentTransform.setNegativeStyle(self: PyOpenColorIO.ExponentTransform, style: PyOpenColorIO.NegativeStyle) -> None - :module: PyOpenColorIO - - - .. py:method:: ExponentTransform.setValue(self: PyOpenColorIO.ExponentTransform, value: List[float[4]]) -> None - :module: PyOpenColorIO - - - .. py:method:: ExponentTransform.validate(self: PyOpenColorIO.Transform) -> None - :module: PyOpenColorIO - - Will throw if data is not valid. - diff --git a/docs/api/python/frozen/pyopencolorio_exponentwithlineartransform.rst b/docs/api/python/frozen/pyopencolorio_exponentwithlineartransform.rst deleted file mode 100644 index aad657a7b5..0000000000 --- a/docs/api/python/frozen/pyopencolorio_exponentwithlineartransform.rst +++ /dev/null @@ -1,95 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: ExponentWithLinearTransform - :module: PyOpenColorIO - - Represents power functions with a linear section in the shadows such as sRGB and L*. - - The basic formula is:: - - pow( (x + offset)/(1 + offset), gamma ) with the breakpoint at offset/(gamma - 1). - - Negative values are never clamped. - - - .. py:method:: ExponentWithLinearTransform.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.ExponentWithLinearTransform) -> None - - 2. __init__(self: PyOpenColorIO.ExponentWithLinearTransform, gamma: List[float[4]] = [1.0, 1.0, 1.0, 1.0], offset: List[float[4]] = [0.0, 0.0, 0.0, 0.0], negativeStyle: PyOpenColorIO.NegativeStyle = , direction: PyOpenColorIO.TransformDirection = ) -> None - - - .. py:method:: ExponentWithLinearTransform.equals(self: PyOpenColorIO.ExponentWithLinearTransform, other: PyOpenColorIO.ExponentWithLinearTransform) -> bool - :module: PyOpenColorIO - - Checks if this exactly equals other. - - - .. py:method:: ExponentWithLinearTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection - :module: PyOpenColorIO - - - .. py:method:: ExponentWithLinearTransform.getFormatMetadata(self: PyOpenColorIO.ExponentWithLinearTransform) -> PyOpenColorIO.FormatMetadata - :module: PyOpenColorIO - - - .. py:method:: ExponentWithLinearTransform.getGamma(self: PyOpenColorIO.ExponentWithLinearTransform) -> List[float[4]] - :module: PyOpenColorIO - - - .. py:method:: ExponentWithLinearTransform.getNegativeStyle(self: PyOpenColorIO.ExponentWithLinearTransform) -> PyOpenColorIO.NegativeStyle - :module: PyOpenColorIO - - Specifies how negative values are handled. Legal values: - - - NEGATIVE_LINEAR -- Linear segment continues into negatives (default). - - NEGATIVE_MIRROR -- Positive curve is rotated 180 degrees around the origin to handle negatives. - - - .. py:method:: ExponentWithLinearTransform.getOffset(self: PyOpenColorIO.ExponentWithLinearTransform) -> List[float[4]] - :module: PyOpenColorIO - - - .. py:method:: ExponentWithLinearTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType - :module: PyOpenColorIO - - - .. py:method:: ExponentWithLinearTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None - :module: PyOpenColorIO - - Note that this only affects the evaluation and not the values stored in the object. - - - .. py:method:: ExponentWithLinearTransform.setGamma(self: PyOpenColorIO.ExponentWithLinearTransform, values: List[float[4]]) -> None - :module: PyOpenColorIO - - Set the exponent value for the power function for R, G, B, A. - - .. note:: - The gamma values must be in the range of [1, 10]. Set the transform direction to inverse to obtain the effect of values less than 1. - - - .. py:method:: ExponentWithLinearTransform.setNegativeStyle(self: PyOpenColorIO.ExponentWithLinearTransform, style: PyOpenColorIO.NegativeStyle) -> None - :module: PyOpenColorIO - - - .. py:method:: ExponentWithLinearTransform.setOffset(self: PyOpenColorIO.ExponentWithLinearTransform, values: List[float[4]]) -> None - :module: PyOpenColorIO - - Set the offset value for the power function for R, G, B, A. - - .. note:: - The offset values must be in the range [0, 0.9]. - - - .. py:method:: ExponentWithLinearTransform.validate(self: PyOpenColorIO.Transform) -> None - :module: PyOpenColorIO - - Will throw if data is not valid. - diff --git a/docs/api/python/frozen/pyopencolorio_exposurecontraststyle.rst b/docs/api/python/frozen/pyopencolorio_exposurecontraststyle.rst deleted file mode 100644 index b3ef1b4ca1..0000000000 --- a/docs/api/python/frozen/pyopencolorio_exposurecontraststyle.rst +++ /dev/null @@ -1,39 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: ExposureContrastStyle - :module: PyOpenColorIO - - Enumeration of the :cpp:class:`:ref:`ExposureContrastTransform`` transform algorithms. - - Members: - - EXPOSURE_CONTRAST_LINEAR : E/C to be applied to a linear space image. - - EXPOSURE_CONTRAST_VIDEO : E/C to be applied to a video space image. - - EXPOSURE_CONTRAST_LOGARITHMIC : E/C to be applied to a log space image. - - .. py:method:: name() -> str - :property: - - .. py:attribute:: ExposureContrastStyle.EXPOSURE_CONTRAST_LINEAR - :module: PyOpenColorIO - :value: - - - .. py:attribute:: ExposureContrastStyle.EXPOSURE_CONTRAST_LOGARITHMIC - :module: PyOpenColorIO - :value: - - - .. py:attribute:: ExposureContrastStyle.EXPOSURE_CONTRAST_VIDEO - :module: PyOpenColorIO - :value: - - - .. py:property:: ExposureContrastStyle.value - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_exposurecontraststylefromstring.rst b/docs/api/python/frozen/pyopencolorio_exposurecontraststylefromstring.rst deleted file mode 100644 index 086ecd5301..0000000000 --- a/docs/api/python/frozen/pyopencolorio_exposurecontraststylefromstring.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: ExposureContrastStyleFromString(str: str) -> PyOpenColorIO.ExposureContrastStyle - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_exposurecontraststyletostring.rst b/docs/api/python/frozen/pyopencolorio_exposurecontraststyletostring.rst deleted file mode 100644 index 1f6b2bfc95..0000000000 --- a/docs/api/python/frozen/pyopencolorio_exposurecontraststyletostring.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: ExposureContrastStyleToString(style: PyOpenColorIO.ExposureContrastStyle) -> str - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_exposurecontrasttransform.rst b/docs/api/python/frozen/pyopencolorio_exposurecontrasttransform.rst deleted file mode 100644 index 5245656a42..0000000000 --- a/docs/api/python/frozen/pyopencolorio_exposurecontrasttransform.rst +++ /dev/null @@ -1,160 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: ExposureContrastTransform - :module: PyOpenColorIO - - Applies exposure, gamma, and pivoted contrast adjustments. Adjusts the math to be appropriate for linear, logarithmic, or video color spaces. - - - .. py:method:: ExposureContrastTransform.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.ExposureContrastTransform) -> None - - 2. __init__(self: PyOpenColorIO.ExposureContrastTransform, style: PyOpenColorIO.ExposureContrastStyle = , exposure: float = 0.0, contrast: float = 1.0, gamma: float = 1.0, pivot: float = 0.18, logExposureStep: float = 0.088, logMidGray: float = 0.435, dynamicExposure: bool = False, dynamicContrast: bool = False, dynamicGamma: bool = False, direction: PyOpenColorIO.TransformDirection = ) -> None - - - .. py:method:: ExposureContrastTransform.equals(self: PyOpenColorIO.ExposureContrastTransform, other: PyOpenColorIO.ExposureContrastTransform) -> bool - :module: PyOpenColorIO - - Checks if this exactly equals other. - - - .. py:method:: ExposureContrastTransform.getContrast(self: PyOpenColorIO.ExposureContrastTransform) -> float - :module: PyOpenColorIO - - - .. py:method:: ExposureContrastTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection - :module: PyOpenColorIO - - - .. py:method:: ExposureContrastTransform.getExposure(self: PyOpenColorIO.ExposureContrastTransform) -> float - :module: PyOpenColorIO - - - .. py:method:: ExposureContrastTransform.getFormatMetadata(self: PyOpenColorIO.ExposureContrastTransform) -> PyOpenColorIO.FormatMetadata - :module: PyOpenColorIO - - - .. py:method:: ExposureContrastTransform.getGamma(self: PyOpenColorIO.ExposureContrastTransform) -> float - :module: PyOpenColorIO - - - .. py:method:: ExposureContrastTransform.getLogExposureStep(self: PyOpenColorIO.ExposureContrastTransform) -> float - :module: PyOpenColorIO - - - .. py:method:: ExposureContrastTransform.getLogMidGray(self: PyOpenColorIO.ExposureContrastTransform) -> float - :module: PyOpenColorIO - - - .. py:method:: ExposureContrastTransform.getPivot(self: PyOpenColorIO.ExposureContrastTransform) -> float - :module: PyOpenColorIO - - - .. py:method:: ExposureContrastTransform.getStyle(self: PyOpenColorIO.ExposureContrastTransform) -> PyOpenColorIO.ExposureContrastStyle - :module: PyOpenColorIO - - - .. py:method:: ExposureContrastTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType - :module: PyOpenColorIO - - - .. py:method:: ExposureContrastTransform.isContrastDynamic(self: PyOpenColorIO.ExposureContrastTransform) -> bool - :module: PyOpenColorIO - - Contrast can be made dynamic so the value can be changed through the CPU or GPU processor, but if there are several :ref:`ExposureContrastTransform` only one can have a dynamic contrast. - - - .. py:method:: ExposureContrastTransform.isExposureDynamic(self: PyOpenColorIO.ExposureContrastTransform) -> bool - :module: PyOpenColorIO - - Exposure can be made dynamic so the value can be changed through the CPU or GPU processor, but if there are several :ref:`ExposureContrastTransform` only one can have a dynamic exposure. - - - .. py:method:: ExposureContrastTransform.isGammaDynamic(self: PyOpenColorIO.ExposureContrastTransform) -> bool - :module: PyOpenColorIO - - Gamma can be made dynamic so the value can be changed through the CPU or GPU processor, but if there are several :ref:`ExposureContrastTransform` only one can have a dynamic gamma. - - - .. py:method:: ExposureContrastTransform.makeContrastDynamic(self: PyOpenColorIO.ExposureContrastTransform) -> None - :module: PyOpenColorIO - - - .. py:method:: ExposureContrastTransform.makeContrastNonDynamic(self: PyOpenColorIO.ExposureContrastTransform) -> None - :module: PyOpenColorIO - - - .. py:method:: ExposureContrastTransform.makeExposureDynamic(self: PyOpenColorIO.ExposureContrastTransform) -> None - :module: PyOpenColorIO - - - .. py:method:: ExposureContrastTransform.makeExposureNonDynamic(self: PyOpenColorIO.ExposureContrastTransform) -> None - :module: PyOpenColorIO - - - .. py:method:: ExposureContrastTransform.makeGammaDynamic(self: PyOpenColorIO.ExposureContrastTransform) -> None - :module: PyOpenColorIO - - - .. py:method:: ExposureContrastTransform.makeGammaNonDynamic(self: PyOpenColorIO.ExposureContrastTransform) -> None - :module: PyOpenColorIO - - - .. py:method:: ExposureContrastTransform.setContrast(self: PyOpenColorIO.ExposureContrastTransform, contrast: float) -> None - :module: PyOpenColorIO - - Applies a contrast/gamma adjustment around a pivot point. The contrast and gamma are mathematically the same, but two controls are provided to enable the use of separate dynamic parameters. Contrast is usually a scene-referred adjustment that pivots around gray whereas gamma is usually a display-referred adjustment that pivots around white. - - - .. py:method:: ExposureContrastTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None - :module: PyOpenColorIO - - Note that this only affects the evaluation and not the values stored in the object. - - - .. py:method:: ExposureContrastTransform.setExposure(self: PyOpenColorIO.ExposureContrastTransform, exposure: float) -> None - :module: PyOpenColorIO - - Applies an exposure adjustment. The value is in units of stops (regardless of style), for example, a value of -1 would be equivalent to reducing the lighting by one half. - - - .. py:method:: ExposureContrastTransform.setGamma(self: PyOpenColorIO.ExposureContrastTransform, gamma: float) -> None - :module: PyOpenColorIO - - - .. py:method:: ExposureContrastTransform.setLogExposureStep(self: PyOpenColorIO.ExposureContrastTransform, logExposureStep: float) -> None - :module: PyOpenColorIO - - Set the increment needed to move one stop for the log-style algorithm. For example, ACEScct is 0.057, LogC is roughly 0.074, and Cineon is roughly 90/1023 = 0.088. The default value is 0.088. - - - .. py:method:: ExposureContrastTransform.setLogMidGray(self: PyOpenColorIO.ExposureContrastTransform, logMidGray: float) -> None - :module: PyOpenColorIO - - Set the position of 18% gray for use by the log-style algorithm. For example, ACEScct is about 0.41, LogC is about 0.39, and ADX10 is 445/1023 = 0.435. The default value is 0.435. - - - .. py:method:: ExposureContrastTransform.setPivot(self: PyOpenColorIO.ExposureContrastTransform, pivot: float) -> None - :module: PyOpenColorIO - - Set the pivot point around which the contrast and gamma controls will work. Regardless of whether linear/video/log-style is being used, the pivot is always expressed in linear. In other words, a pivot of 0.18 is always mid-gray. - - - .. py:method:: ExposureContrastTransform.setStyle(self: PyOpenColorIO.ExposureContrastTransform, style: PyOpenColorIO.ExposureContrastStyle) -> None - :module: PyOpenColorIO - - Select the algorithm for linear, video or log color spaces. - - - .. py:method:: ExposureContrastTransform.validate(self: PyOpenColorIO.Transform) -> None - :module: PyOpenColorIO - - Will throw if data is not valid. - diff --git a/docs/api/python/frozen/pyopencolorio_filerules.rst b/docs/api/python/frozen/pyopencolorio_filerules.rst deleted file mode 100644 index 9835c7a21b..0000000000 --- a/docs/api/python/frozen/pyopencolorio_filerules.rst +++ /dev/null @@ -1,181 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: FileRules - :module: PyOpenColorIO - - The File Rules are a set of filepath to color space mappings that are evaluated from first to last. The first rule to match is what determines which color space is returned. There are four types of rules available. Each rule type has a name key that may be used by applications to refer to that rule. Name values must be unique i.e. using a case insensitive comparison. The other keys depend on the rule type: - - - *Basic Rule*: This is the basic rule type that uses Unix glob style pattern matching and is thus very easy to use. It contains the keys: - - name: Name of the rule - - colorspace: Color space name to be returned. - - pattern: Glob pattern to be used for the main part of the name/path. - - extension: Glob pattern to be used for the file extension. Note that if glob tokens are not used, the extension will be used in a non-case-sensitive way by default. - - - *Regex Rule*: This is similar to the basic rule but allows additional capabilities for power-users. It contains the keys: - - name: Name of the rule - - colorspace: Color space name to be returned. - - regex: Regular expression to be evaluated. - - - *OCIO v1 style Rule*: This rule allows the use of the OCIO v1 style, where the string is searched for color space names from the config. This rule may occur 0 or 1 times in the list. The position in the list prioritizes it with respect to the other rules. StrictParsing is not used. If no color space is found in the path, the rule will not match and the next rule will be considered. see :ref:`insertPathSearchRule`. It has the key: - - name: Must be "ColorSpaceNamePathSearch". - - - *Default Rule*: The file_rules must always end with this rule. If no prior rules match, this rule specifies the color space applications will use. see :ref:`setDefaultRuleColorSpace`. It has the keys: - - name: must be "Default". - - colorspace : Color space name to be returned. - - Custom string keys and associated string values may be used to convey app or workflow-specific information, e.g. whether the color space should be left as is or converted into a working space. - - Getters and setters are using the rule position, they will throw if the position is not valid. If the rule at the specified position does not implement the requested property getter will return NULL and setter will throw. - - When loading a v1 config, a set of :ref:`FileRules` are created with ColorSpaceNamePathSearch followed by the Default rule pointing to the default role. This allows getColorSpaceFromFilepath to emulate OCIO v1 code that used parseColorSpaceFromString with strictparsing set to false. - - - .. py:method:: FileRules.__init__(self: PyOpenColorIO.FileRules) -> None - :module: PyOpenColorIO - - Creates :ref:`FileRules` for a :ref:`Config`. File rules will contain the default rule using the default role. The default rule cannot be removed. - - - .. py:method:: FileRules.decreaseRulePriority(self: PyOpenColorIO.FileRules, ruleIndex: int) -> None - :module: PyOpenColorIO - - Move a rule closer to the end of the list by one position. - - - .. py:method:: FileRules.getColorSpace(self: PyOpenColorIO.FileRules, ruleIndex: int) -> str - :module: PyOpenColorIO - - Set the rule's color space (may also be a role). - - - .. py:method:: FileRules.getCustomKeyName(self: PyOpenColorIO.FileRules, ruleIndex: int, key: int) -> str - :module: PyOpenColorIO - - Get name of key. - - - .. py:method:: FileRules.getCustomKeyValue(self: PyOpenColorIO.FileRules, ruleIndex: int, key: int) -> str - :module: PyOpenColorIO - - Get value for the key. - - - .. py:method:: FileRules.getExtension(self: PyOpenColorIO.FileRules, ruleIndex: int) -> str - :module: PyOpenColorIO - - Setting extension will erase regex. - - - .. py:method:: FileRules.getIndexForRule(self: PyOpenColorIO.FileRules, ruleName: str) -> int - :module: PyOpenColorIO - - Get the index from the rule name. - - - .. py:method:: FileRules.getName(self: PyOpenColorIO.FileRules, ruleIndex: int) -> str - :module: PyOpenColorIO - - Get name of the rule. - - - .. py:method:: FileRules.getNumCustomKeys(self: PyOpenColorIO.FileRules, ruleIndex: int) -> int - :module: PyOpenColorIO - - Get number of key/value pairs. - - - .. py:method:: FileRules.getNumEntries(self: PyOpenColorIO.FileRules) -> int - :module: PyOpenColorIO - - Does include default rule. Result will be at least 1. - - - .. py:method:: FileRules.getPattern(self: PyOpenColorIO.FileRules, ruleIndex: int) -> str - :module: PyOpenColorIO - - Setting pattern will erase regex. - - - .. py:method:: FileRules.getRegex(self: PyOpenColorIO.FileRules, ruleIndex: int) -> str - :module: PyOpenColorIO - - Setting a regex will erase pattern & extension. - - - .. py:method:: FileRules.increaseRulePriority(self: PyOpenColorIO.FileRules, ruleIndex: int) -> None - :module: PyOpenColorIO - - Move a rule closer to the start of the list by one position. - - - .. py:method:: FileRules.insertPathSearchRule(self: PyOpenColorIO.FileRules, ruleIndex: int) -> None - :module: PyOpenColorIO - - Helper function to insert a rule. - - Uses Config:parseColorSpaceFromString to search the path for any of the color spaces named in the config (as per OCIO v1). - - - .. py:method:: FileRules.insertRule(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. insertRule(self: PyOpenColorIO.FileRules, ruleIndex: int, name: str, colorSpace: str, pattern: str, extension: str) -> None - - Insert a rule at a given ruleIndex. - - Rule currently at ruleIndex will be pushed to index: ruleIndex + 1. Name must be unique. - - "Default" is a reserved name for the default rule. The default rule is automatically added and can't be removed. (see :ref:`FileRules::setDefaultRuleColorSpace` ). - - "ColorSpaceNamePathSearch" is also a reserved name (see :ref:`FileRules::insertPathSearchRule` ). - - Will throw if pattern, extension or regex is a null or empty string. - - Will throw if ruleIndex is not less than :ref:`FileRules::getNumEntries` . - - 2. insertRule(self: PyOpenColorIO.FileRules, ruleIndex: int, name: str, colorSpace: str, regex: str) -> None - - - .. py:method:: FileRules.isDefault(self: PyOpenColorIO.FileRules) -> bool - :module: PyOpenColorIO - - Check if there is only the default rule using default role and no custom key. This is the default :ref:`FileRules` state when creating a new config. - - - .. py:method:: FileRules.removeRule(self: PyOpenColorIO.FileRules, ruleIndex: int) -> None - :module: PyOpenColorIO - - .. note:: - Default rule can't be removed. Will throw if ruleIndex + 1 is not less than :ref:`FileRules::getNumEntries` . - - - .. py:method:: FileRules.setColorSpace(self: PyOpenColorIO.FileRules, ruleIndex: int, colorSpace: str) -> None - :module: PyOpenColorIO - - - .. py:method:: FileRules.setCustomKey(self: PyOpenColorIO.FileRules, ruleIndex: int, key: str, value: str) -> None - :module: PyOpenColorIO - - Adds a key/value or replace value if key exists. Setting a NULL or an empty value will erase the key. - - - .. py:method:: FileRules.setDefaultRuleColorSpace(self: PyOpenColorIO.FileRules, colorSpace: str) -> None - :module: PyOpenColorIO - - Helper function to set the color space for the default rule. - - - .. py:method:: FileRules.setExtension(self: PyOpenColorIO.FileRules, ruleIndex: int, extension: str) -> None - :module: PyOpenColorIO - - - .. py:method:: FileRules.setPattern(self: PyOpenColorIO.FileRules, ruleIndex: int, pattern: str) -> None - :module: PyOpenColorIO - - - .. py:method:: FileRules.setRegex(self: PyOpenColorIO.FileRules, ruleIndex: int, regex: str) -> None - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_filetransform.rst b/docs/api/python/frozen/pyopencolorio_filetransform.rst deleted file mode 100644 index 120daa0778..0000000000 --- a/docs/api/python/frozen/pyopencolorio_filetransform.rst +++ /dev/null @@ -1,101 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: FileTransform - :module: PyOpenColorIO - - - .. py:method:: FileTransform.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.FileTransform) -> None - - 2. __init__(self: PyOpenColorIO.FileTransform, src: str = '', cccId: str = '', interpolation: PyOpenColorIO.Interpolation = , direction: PyOpenColorIO.TransformDirection = ) -> None - - - .. py:method:: FileTransform.getCCCId(self: PyOpenColorIO.FileTransform) -> str - :module: PyOpenColorIO - - The cccid can be the ID of a CDL or the index of the CDL (as string). If cccid is NULL or empty the first CDL is returned. The cccid is case-sensitive. - - - .. py:method:: FileTransform.getCDLStyle(self: PyOpenColorIO.FileTransform) -> PyOpenColorIO.CDLStyle - :module: PyOpenColorIO - - - .. py:method:: FileTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection - :module: PyOpenColorIO - - - .. py:method:: FileTransform.getFormats() -> PyOpenColorIO.FileTransform.FormatIterator - :module: PyOpenColorIO - :staticmethod: - - - .. py:method:: FileTransform.getInterpolation(self: PyOpenColorIO.FileTransform) -> PyOpenColorIO.Interpolation - :module: PyOpenColorIO - - The file parsers that care about interpolation (LUTs) will try to make use of the requested interpolation method when loading the file. In these cases, if the requested method could not be used, a warning is logged. If no method is provided, or a method cannot be used, INTERP_DEFAULT is used. - - - .. py:method:: FileTransform.getSrc(self: PyOpenColorIO.FileTransform) -> str - :module: PyOpenColorIO - - - .. py:method:: FileTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType - :module: PyOpenColorIO - - - .. py:method:: FileTransform.setCCCId(self: PyOpenColorIO.FileTransform, cccId: str) -> None - :module: PyOpenColorIO - - - .. py:method:: FileTransform.setCDLStyle(self: PyOpenColorIO.FileTransform, style: PyOpenColorIO.CDLStyle) -> None - :module: PyOpenColorIO - - Can be used with CDL, CC & CCC formats to specify the clamping behavior of the :ref:`CDLTransform`. Default is CDL_NO_CLAMP. - - - .. py:method:: FileTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None - :module: PyOpenColorIO - - Note that this only affects the evaluation and not the values stored in the object. - - - .. py:method:: FileTransform.setInterpolation(self: PyOpenColorIO.FileTransform, interpolation: PyOpenColorIO.Interpolation) -> None - :module: PyOpenColorIO - - - .. py:method:: FileTransform.setSrc(self: PyOpenColorIO.FileTransform, src: str) -> None - :module: PyOpenColorIO - - - .. py:method:: FileTransform.validate(self: PyOpenColorIO.Transform) -> None - :module: PyOpenColorIO - - Will throw if data is not valid. - - -.. py:class:: FormatIterator - :module: PyOpenColorIO.FileTransform - - - .. py:method:: FormatIterator.__getitem__(self: PyOpenColorIO.FileTransform.FormatIterator, arg0: int) -> tuple - :module: PyOpenColorIO.FileTransform - - - .. py:method:: FormatIterator.__iter__(self: PyOpenColorIO.FileTransform.FormatIterator) -> PyOpenColorIO.FileTransform.FormatIterator - :module: PyOpenColorIO.FileTransform - - - .. py:method:: FormatIterator.__len__(self: PyOpenColorIO.FileTransform.FormatIterator) -> int - :module: PyOpenColorIO.FileTransform - - - .. py:method:: FormatIterator.__next__(self: PyOpenColorIO.FileTransform.FormatIterator) -> tuple - :module: PyOpenColorIO.FileTransform - diff --git a/docs/api/python/frozen/pyopencolorio_fixedfunctionstyle.rst b/docs/api/python/frozen/pyopencolorio_fixedfunctionstyle.rst deleted file mode 100644 index c4cba43d7b..0000000000 --- a/docs/api/python/frozen/pyopencolorio_fixedfunctionstyle.rst +++ /dev/null @@ -1,109 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: FixedFunctionStyle - :module: PyOpenColorIO - - Enumeration of the :cpp:class:`:ref:`FixedFunctionTransform`` transform algorithms. - - Members: - - FIXED_FUNCTION_ACES_RED_MOD_03 : Red modifier (ACES 0.3/0.7) - - FIXED_FUNCTION_ACES_RED_MOD_10 : Red modifier (ACES 1.0) - - FIXED_FUNCTION_ACES_GLOW_03 : Glow function (ACES 0.3/0.7) - - FIXED_FUNCTION_ACES_GLOW_10 : Glow function (ACES 1.0) - - FIXED_FUNCTION_ACES_DARK_TO_DIM_10 : Dark to dim surround correction (ACES 1.0) - - FIXED_FUNCTION_REC2100_SURROUND : Rec.2100 surround correction (takes one double for the gamma param) - - FIXED_FUNCTION_RGB_TO_HSV : Classic RGB to HSV function. - - FIXED_FUNCTION_XYZ_TO_xyY : CIE XYZ to 1931 xy chromaticity coordinates. - - FIXED_FUNCTION_XYZ_TO_uvY : CIE XYZ to 1976 u'v' chromaticity coordinates. - - FIXED_FUNCTION_XYZ_TO_LUV : CIE XYZ to 1976 CIELUV colour space (D65 white) - - FIXED_FUNCTION_ACES_GAMUTMAP_02 : ACES 0.2 Gamut clamping algorithm -- NOT IMPLEMENTED YET. - - FIXED_FUNCTION_ACES_GAMUTMAP_07 : ACES 0.7 Gamut clamping algorithm -- NOT IMPLEMENTED YET. - - FIXED_FUNCTION_ACES_GAMUT_COMP_13 : ACES 1.3 Parametric Gamut Compression (expects ACEScg values) - - .. py:method:: name() -> str - :property: - - .. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_ACES_DARK_TO_DIM_10 - :module: PyOpenColorIO - :value: - - - .. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_ACES_GAMUTMAP_02 - :module: PyOpenColorIO - :value: - - - .. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_ACES_GAMUTMAP_07 - :module: PyOpenColorIO - :value: - - - .. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_ACES_GAMUT_COMP_13 - :module: PyOpenColorIO - :value: - - - .. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_ACES_GLOW_03 - :module: PyOpenColorIO - :value: - - - .. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_ACES_GLOW_10 - :module: PyOpenColorIO - :value: - - - .. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_ACES_RED_MOD_03 - :module: PyOpenColorIO - :value: - - - .. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_ACES_RED_MOD_10 - :module: PyOpenColorIO - :value: - - - .. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_REC2100_SURROUND - :module: PyOpenColorIO - :value: - - - .. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_RGB_TO_HSV - :module: PyOpenColorIO - :value: - - - .. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_XYZ_TO_LUV - :module: PyOpenColorIO - :value: - - - .. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_XYZ_TO_uvY - :module: PyOpenColorIO - :value: - - - .. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_XYZ_TO_xyY - :module: PyOpenColorIO - :value: - - - .. py:property:: FixedFunctionStyle.value - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_fixedfunctionstylefromstring.rst b/docs/api/python/frozen/pyopencolorio_fixedfunctionstylefromstring.rst deleted file mode 100644 index aa3376a0bc..0000000000 --- a/docs/api/python/frozen/pyopencolorio_fixedfunctionstylefromstring.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: FixedFunctionStyleFromString(str: str) -> PyOpenColorIO.FixedFunctionStyle - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_fixedfunctionstyletostring.rst b/docs/api/python/frozen/pyopencolorio_fixedfunctionstyletostring.rst deleted file mode 100644 index 29bd85d7af..0000000000 --- a/docs/api/python/frozen/pyopencolorio_fixedfunctionstyletostring.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: FixedFunctionStyleToString(style: PyOpenColorIO.FixedFunctionStyle) -> str - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_fixedfunctiontransform.rst b/docs/api/python/frozen/pyopencolorio_fixedfunctiontransform.rst deleted file mode 100644 index 06ea28fa09..0000000000 --- a/docs/api/python/frozen/pyopencolorio_fixedfunctiontransform.rst +++ /dev/null @@ -1,64 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: FixedFunctionTransform - :module: PyOpenColorIO - - Provides a set of hard-coded algorithmic building blocks that are needed to accurately implement various common color transformations. - - - .. py:method:: FixedFunctionTransform.__init__(self: PyOpenColorIO.FixedFunctionTransform, style: PyOpenColorIO.FixedFunctionStyle, params: List[float] = [], direction: PyOpenColorIO.TransformDirection = ) -> None - :module: PyOpenColorIO - - - .. py:method:: FixedFunctionTransform.equals(self: PyOpenColorIO.FixedFunctionTransform, other: PyOpenColorIO.FixedFunctionTransform) -> bool - :module: PyOpenColorIO - - Checks if this exactly equals other. - - - .. py:method:: FixedFunctionTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection - :module: PyOpenColorIO - - - .. py:method:: FixedFunctionTransform.getFormatMetadata(self: PyOpenColorIO.FixedFunctionTransform) -> PyOpenColorIO.FormatMetadata - :module: PyOpenColorIO - - - .. py:method:: FixedFunctionTransform.getParams(self: PyOpenColorIO.FixedFunctionTransform) -> List[float] - :module: PyOpenColorIO - - - .. py:method:: FixedFunctionTransform.getStyle(self: PyOpenColorIO.FixedFunctionTransform) -> PyOpenColorIO.FixedFunctionStyle - :module: PyOpenColorIO - - - .. py:method:: FixedFunctionTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType - :module: PyOpenColorIO - - - .. py:method:: FixedFunctionTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None - :module: PyOpenColorIO - - Note that this only affects the evaluation and not the values stored in the object. - - - .. py:method:: FixedFunctionTransform.setParams(self: PyOpenColorIO.FixedFunctionTransform, params: List[float]) -> None - :module: PyOpenColorIO - - Set the parameters (for functions that require them). - - - .. py:method:: FixedFunctionTransform.setStyle(self: PyOpenColorIO.FixedFunctionTransform, style: PyOpenColorIO.FixedFunctionStyle) -> None - :module: PyOpenColorIO - - Select which algorithm to use. - - - .. py:method:: FixedFunctionTransform.validate(self: PyOpenColorIO.Transform) -> None - :module: PyOpenColorIO - - Will throw if data is not valid. - diff --git a/docs/api/python/frozen/pyopencolorio_formatmetadata.rst b/docs/api/python/frozen/pyopencolorio_formatmetadata.rst deleted file mode 100644 index 747f773c1d..0000000000 --- a/docs/api/python/frozen/pyopencolorio_formatmetadata.rst +++ /dev/null @@ -1,184 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: FormatMetadata - :module: PyOpenColorIO - - The :ref:`FormatMetadata` class is intended to be a generic container to hold metadata from various file formats. - - This class provides a hierarchical metadata container. A metadata object is similar to an element in XML. The top level element is named "ROOT" and can't be renamed. Several transforms have a :ref:`FormatMetadata`. The root element and all of the sub-elements may contain: - - A name string (e.g. "ROOT", "Description"...). Name can't be empty. - - A value string (e.g. "updated viewing LUT"). Value can be empty. - - A list of attributes (name, value) string pairs (e.g. "version", "1.5"). There are helper functions to get and set "id" and "name" attributes. Attribute names are unique. - - And a list of child sub-elements, which are also objects implementing :ref:`FormatMetadata`. There can be several sub-elements with the same name. - - - .. py:method:: FormatMetadata.__contains__(self: PyOpenColorIO.FormatMetadata, name: str) -> bool - :module: PyOpenColorIO - - - .. py:method:: FormatMetadata.__getitem__(self: PyOpenColorIO.FormatMetadata, name: str) -> str - :module: PyOpenColorIO - - Get the value of a attribute ("" if attribute does not exist). - - - .. py:method:: FormatMetadata.__init__(*args, **kwargs) - :module: PyOpenColorIO - - - .. py:method:: FormatMetadata.__iter__(self: PyOpenColorIO.FormatMetadata) -> PyOpenColorIO.FormatMetadata.AttributeNameIterator - :module: PyOpenColorIO - - - .. py:method:: FormatMetadata.__len__(self: PyOpenColorIO.FormatMetadata) -> int - :module: PyOpenColorIO - - - .. py:method:: FormatMetadata.__setitem__(self: PyOpenColorIO.FormatMetadata, name: str, value: str) -> None - :module: PyOpenColorIO - - Add an attribute with a given name and value. If an attribute with the same name already exists, its value is replaced. Throw if name is NULL or empty. - - - .. py:method:: FormatMetadata.addChildElement(self: PyOpenColorIO.FormatMetadata, name: str, value: str) -> None - :module: PyOpenColorIO - - Add a child element with a given name and value. - - Name has to be non-empty. Value may be empty, particularly if this element will have children. Element is added after all existing children. Use getChildElement(getNumChildrenElements()-1) to access the added element. - - - .. py:method:: FormatMetadata.clear(self: PyOpenColorIO.FormatMetadata) -> None - :module: PyOpenColorIO - - Remove all children, all attributes and the value. - - - .. py:method:: FormatMetadata.getAttributes(self: PyOpenColorIO.FormatMetadata) -> PyOpenColorIO.FormatMetadata.AttributeIterator - :module: PyOpenColorIO - - - .. py:method:: FormatMetadata.getChildElements(self: PyOpenColorIO.FormatMetadata) -> PyOpenColorIO.FormatMetadata.ChildElementIterator - :module: PyOpenColorIO - - - .. py:method:: FormatMetadata.getElementName(self: PyOpenColorIO.FormatMetadata) -> str - :module: PyOpenColorIO - - - .. py:method:: FormatMetadata.getElementValue(self: PyOpenColorIO.FormatMetadata) -> str - :module: PyOpenColorIO - - - .. py:method:: FormatMetadata.getID(self: PyOpenColorIO.FormatMetadata) -> str - :module: PyOpenColorIO - - Convenience method to easily get/set the 'id' attribute. This corresponds to the ProcessNode id attribute from a CLF/CTF file or the ColorCorrection id attribute from a CC/CCC/CDL file. - - - .. py:method:: FormatMetadata.getName(self: PyOpenColorIO.FormatMetadata) -> str - :module: PyOpenColorIO - - Convenience method to easily get/set the 'name' attribute. This corresponds to the ProcessNode name attribute from a CLF / CTF file or the name key of a transform in the config YAML. - - - .. py:method:: FormatMetadata.setElementName(self: PyOpenColorIO.FormatMetadata, name: str) -> None - :module: PyOpenColorIO - - Name has to be a non-empty string. Top-level element can't be renamed. 'ROOT' is reserved. - - - .. py:method:: FormatMetadata.setElementValue(self: PyOpenColorIO.FormatMetadata, value: str) -> None - :module: PyOpenColorIO - - - .. py:method:: FormatMetadata.setID(self: PyOpenColorIO.FormatMetadata, id: str) -> None - :module: PyOpenColorIO - - - .. py:method:: FormatMetadata.setName(self: PyOpenColorIO.FormatMetadata, name: str) -> None - :module: PyOpenColorIO - - -.. py:class:: AttributeNameIterator - :module: PyOpenColorIO.FormatMetadata - - - .. py:method:: AttributeNameIterator.__getitem__(self: PyOpenColorIO.FormatMetadata.AttributeNameIterator, arg0: int) -> str - :module: PyOpenColorIO.FormatMetadata - - - .. py:method:: AttributeNameIterator.__iter__(self: PyOpenColorIO.FormatMetadata.AttributeNameIterator) -> PyOpenColorIO.FormatMetadata.AttributeNameIterator - :module: PyOpenColorIO.FormatMetadata - - - .. py:method:: AttributeNameIterator.__len__(self: PyOpenColorIO.FormatMetadata.AttributeNameIterator) -> int - :module: PyOpenColorIO.FormatMetadata - - - .. py:method:: AttributeNameIterator.__next__(self: PyOpenColorIO.FormatMetadata.AttributeNameIterator) -> str - :module: PyOpenColorIO.FormatMetadata - - -.. py:class:: AttributeIterator - :module: PyOpenColorIO.FormatMetadata - - - .. py:method:: AttributeIterator.__getitem__(self: PyOpenColorIO.FormatMetadata.AttributeIterator, arg0: int) -> tuple - :module: PyOpenColorIO.FormatMetadata - - - .. py:method:: AttributeIterator.__iter__(self: PyOpenColorIO.FormatMetadata.AttributeIterator) -> PyOpenColorIO.FormatMetadata.AttributeIterator - :module: PyOpenColorIO.FormatMetadata - - - .. py:method:: AttributeIterator.__len__(self: PyOpenColorIO.FormatMetadata.AttributeIterator) -> int - :module: PyOpenColorIO.FormatMetadata - - - .. py:method:: AttributeIterator.__next__(self: PyOpenColorIO.FormatMetadata.AttributeIterator) -> tuple - :module: PyOpenColorIO.FormatMetadata - - -.. py:class:: ConstChildElementIterator - :module: PyOpenColorIO.FormatMetadata - - - .. py:method:: ConstChildElementIterator.__getitem__(self: PyOpenColorIO.FormatMetadata.ConstChildElementIterator, arg0: int) -> PyOpenColorIO.FormatMetadata - :module: PyOpenColorIO.FormatMetadata - - - .. py:method:: ConstChildElementIterator.__iter__(self: PyOpenColorIO.FormatMetadata.ConstChildElementIterator) -> PyOpenColorIO.FormatMetadata.ConstChildElementIterator - :module: PyOpenColorIO.FormatMetadata - - - .. py:method:: ConstChildElementIterator.__len__(self: PyOpenColorIO.FormatMetadata.ConstChildElementIterator) -> int - :module: PyOpenColorIO.FormatMetadata - - - .. py:method:: ConstChildElementIterator.__next__(self: PyOpenColorIO.FormatMetadata.ConstChildElementIterator) -> PyOpenColorIO.FormatMetadata - :module: PyOpenColorIO.FormatMetadata - - -.. py:class:: ChildElementIterator - :module: PyOpenColorIO.FormatMetadata - - - .. py:method:: ChildElementIterator.__getitem__(self: PyOpenColorIO.FormatMetadata.ChildElementIterator, arg0: int) -> PyOpenColorIO.FormatMetadata - :module: PyOpenColorIO.FormatMetadata - - - .. py:method:: ChildElementIterator.__iter__(self: PyOpenColorIO.FormatMetadata.ChildElementIterator) -> PyOpenColorIO.FormatMetadata.ChildElementIterator - :module: PyOpenColorIO.FormatMetadata - - - .. py:method:: ChildElementIterator.__len__(self: PyOpenColorIO.FormatMetadata.ChildElementIterator) -> int - :module: PyOpenColorIO.FormatMetadata - - - .. py:method:: ChildElementIterator.__next__(self: PyOpenColorIO.FormatMetadata.ChildElementIterator) -> PyOpenColorIO.FormatMetadata - :module: PyOpenColorIO.FormatMetadata - diff --git a/docs/api/python/frozen/pyopencolorio_getenvvariable.rst b/docs/api/python/frozen/pyopencolorio_getenvvariable.rst deleted file mode 100644 index ee5450f57b..0000000000 --- a/docs/api/python/frozen/pyopencolorio_getenvvariable.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: GetEnvVariable(name: str) -> str - :module: PyOpenColorIO - - Another call modifies the string obtained from a previous call as the method always uses the same memory buffer. - diff --git a/docs/api/python/frozen/pyopencolorio_getinversetransformdirection.rst b/docs/api/python/frozen/pyopencolorio_getinversetransformdirection.rst deleted file mode 100644 index 2729420ea6..0000000000 --- a/docs/api/python/frozen/pyopencolorio_getinversetransformdirection.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: GetInverseTransformDirection(direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.TransformDirection - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_getlogginglevel.rst b/docs/api/python/frozen/pyopencolorio_getlogginglevel.rst deleted file mode 100644 index 1c60f9b80f..0000000000 --- a/docs/api/python/frozen/pyopencolorio_getlogginglevel.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: GetLoggingLevel() -> PyOpenColorIO.LoggingLevel - :module: PyOpenColorIO - - Get the global logging level. - - You can override this at runtime using the OCIO_LOGGING_LEVEL environment variable. The client application that sets this should use :ref:`SetLoggingLevel`, and not the environment variable. The default value is INFO. - diff --git a/docs/api/python/frozen/pyopencolorio_getversion.rst b/docs/api/python/frozen/pyopencolorio_getversion.rst deleted file mode 100644 index a66022a087..0000000000 --- a/docs/api/python/frozen/pyopencolorio_getversion.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: GetVersion() -> str - :module: PyOpenColorIO - - Get the version number for the library, as a dot-delimited string (e.g., "1.0.0"). - - This is also available at compile time as OCIO_VERSION_FULL_STR. - diff --git a/docs/api/python/frozen/pyopencolorio_getversionhex.rst b/docs/api/python/frozen/pyopencolorio_getversionhex.rst deleted file mode 100644 index 471332fe04..0000000000 --- a/docs/api/python/frozen/pyopencolorio_getversionhex.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: GetVersionHex() -> int - :module: PyOpenColorIO - - Get the version number for the library, as a single 4-byte hex number (e.g., 0x01050200 for "1.5.2"), to be used for numeric comparisons. - - This is also at compile time as OCIO_VERSION_HEX. - diff --git a/docs/api/python/frozen/pyopencolorio_gpulanguage.rst b/docs/api/python/frozen/pyopencolorio_gpulanguage.rst deleted file mode 100644 index aa679428c7..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gpulanguage.rst +++ /dev/null @@ -1,74 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: GpuLanguage - :module: PyOpenColorIO - - Used when there is a choice of hardware shader language. - - Members: - - GPU_LANGUAGE_CG : Nvidia Cg shader. - - GPU_LANGUAGE_GLSL_1_2 : OpenGL Shading Language. - - GPU_LANGUAGE_GLSL_1_3 : OpenGL Shading Language. - - GPU_LANGUAGE_GLSL_4_0 : OpenGL Shading Language. - - GPU_LANGUAGE_GLSL_ES_1_0 : OpenGL ES Shading Language. - - GPU_LANGUAGE_GLSL_ES_3_0 : OpenGL ES Shading Language. - - GPU_LANGUAGE_HLSL_DX11 : DirectX Shading Language. - - GPU_LANGUAGE_MSL_2_0 : Metal Shading Language. - - .. py:method:: name() -> str - :property: - - .. py:attribute:: GpuLanguage.GPU_LANGUAGE_CG - :module: PyOpenColorIO - :value: - - - .. py:attribute:: GpuLanguage.GPU_LANGUAGE_GLSL_1_2 - :module: PyOpenColorIO - :value: - - - .. py:attribute:: GpuLanguage.GPU_LANGUAGE_GLSL_1_3 - :module: PyOpenColorIO - :value: - - - .. py:attribute:: GpuLanguage.GPU_LANGUAGE_GLSL_4_0 - :module: PyOpenColorIO - :value: - - - .. py:attribute:: GpuLanguage.GPU_LANGUAGE_GLSL_ES_1_0 - :module: PyOpenColorIO - :value: - - - .. py:attribute:: GpuLanguage.GPU_LANGUAGE_GLSL_ES_3_0 - :module: PyOpenColorIO - :value: - - - .. py:attribute:: GpuLanguage.GPU_LANGUAGE_HLSL_DX11 - :module: PyOpenColorIO - :value: - - - .. py:attribute:: GpuLanguage.GPU_LANGUAGE_MSL_2_0 - :module: PyOpenColorIO - :value: - - - .. py:property:: GpuLanguage.value - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_gpulanguagefromstring.rst b/docs/api/python/frozen/pyopencolorio_gpulanguagefromstring.rst deleted file mode 100644 index 738f51c50e..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gpulanguagefromstring.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: GpuLanguageFromString(str: str) -> PyOpenColorIO.GpuLanguage - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_gpulanguagetostring.rst b/docs/api/python/frozen/pyopencolorio_gpulanguagetostring.rst deleted file mode 100644 index e79d729eda..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gpulanguagetostring.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: GpuLanguageToString(language: PyOpenColorIO.GpuLanguage) -> str - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_gpuprocessor.rst b/docs/api/python/frozen/pyopencolorio_gpuprocessor.rst index 4afdec714e..1bb440937a 100644 --- a/docs/api/python/frozen/pyopencolorio_gpuprocessor.rst +++ b/docs/api/python/frozen/pyopencolorio_gpuprocessor.rst @@ -5,26 +5,27 @@ .. py:class:: GPUProcessor :module: PyOpenColorIO + :canonical: PyOpenColorIO.PyOpenColorIO.GPUProcessor .. py:method:: GPUProcessor.__init__(*args, **kwargs) :module: PyOpenColorIO - .. py:method:: GPUProcessor.extractGpuShaderInfo(self: PyOpenColorIO.GPUProcessor, shaderDesc: PyOpenColorIO.GpuShaderDesc) -> None + .. py:method:: GPUProcessor.extractGpuShaderInfo(self: PyOpenColorIO.PyOpenColorIO.GPUProcessor, shaderDesc: PyOpenColorIO.PyOpenColorIO.GpuShaderDesc) -> None :module: PyOpenColorIO Extract & Store the shader information to implement the color processing. - .. py:method:: GPUProcessor.getCacheID(self: PyOpenColorIO.GPUProcessor) -> str + .. py:method:: GPUProcessor.getCacheID(self: PyOpenColorIO.PyOpenColorIO.GPUProcessor) -> str :module: PyOpenColorIO - .. py:method:: GPUProcessor.hasChannelCrosstalk(self: PyOpenColorIO.GPUProcessor) -> bool + .. py:method:: GPUProcessor.hasChannelCrosstalk(self: PyOpenColorIO.PyOpenColorIO.GPUProcessor) -> bool :module: PyOpenColorIO - .. py:method:: GPUProcessor.isNoOp(self: PyOpenColorIO.GPUProcessor) -> bool + .. py:method:: GPUProcessor.isNoOp(self: PyOpenColorIO.PyOpenColorIO.GPUProcessor) -> bool :module: PyOpenColorIO diff --git a/docs/api/python/frozen/pyopencolorio_gpushadercreator.rst b/docs/api/python/frozen/pyopencolorio_gpushadercreator.rst deleted file mode 100644 index d55fe2a7b2..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gpushadercreator.rst +++ /dev/null @@ -1,278 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: GpuShaderCreator - :module: PyOpenColorIO - - Inherit from the class to fully customize the implementation of a GPU shader program from a color transformation. - - When no customizations are needed and the intermediate in-memory step is acceptable then the :ref:`GpuShaderDesc` is a better choice. - - .. note:: - To better decouple the DynamicProperties from their GPU implementation, the code provides several addUniform() methods i.e. one per access function types. For example, an :ref:`ExposureContrastTransform` instance owns three DynamicProperties and they are all implemented by a double. When creating the GPU fragment shader program, the addUniform() with :ref:`GpuShaderCreator::DoubleGetter` is called when property is dynamic, up to three times. - - **An OCIO shader program could contain:** - - - A declaration part e.g., uniform sampled3D tex3; - - Some helper methods - - The OCIO shader function may be broken down as: - - The function header e.g., void OCIODisplay(in vec4 inColor) { - - The function body e.g., vec4 outColor.rgb = texture3D(tex3, inColor.rgb).rgb; - - The function footer e.g., return outColor; } - - **Usage Example:** - - Below is a code snippet to highlight the different parts of the OCIO shader program. - - .. code-block:: cpp - - // All global declarations - uniform sampled3D tex3; - - // All helper methods - vec3 computePosition(vec3 color) - { - vec3 coords = color; - // Some processing... - return coords; - } - - // The shader function - vec4 OCIODisplay(in vec4 inColor) // - { // Function Header - vec4 outColor = inColor; // - - outColor.rgb = texture3D(tex3, computePosition(inColor.rgb)).rgb; - - return outColor; // Function Footer - } // - - - .. py:attribute:: GpuShaderCreator.TEXTURE_1D - :module: PyOpenColorIO - :value: - - - .. py:attribute:: GpuShaderCreator.TEXTURE_2D - :module: PyOpenColorIO - :value: - - - .. py:class:: GpuShaderCreator.TextureDimensions - :module: PyOpenColorIO - :canonical: PyOpenColorIO.GpuShaderCreator.TextureDimensions - - Dimension enum used to differentiate between 1D and 2D object/resource types. - - Members: - - TEXTURE_1D - - TEXTURE_2D - - - .. py:attribute:: GpuShaderCreator.TextureDimensions.TEXTURE_1D - :module: PyOpenColorIO - :value: - - - .. py:attribute:: GpuShaderCreator.TextureDimensions.TEXTURE_2D - :module: PyOpenColorIO - :value: - - - .. py:property:: GpuShaderCreator.TextureDimensions.name - :module: PyOpenColorIO - - - .. py:property:: GpuShaderCreator.TextureDimensions.value - :module: PyOpenColorIO - - - .. py:method:: GpuShaderCreator.addToDeclareShaderCode(self: PyOpenColorIO.GpuShaderCreator, shaderCode: str) -> None - :module: PyOpenColorIO - - - .. py:method:: GpuShaderCreator.addToFunctionFooterShaderCode(self: PyOpenColorIO.GpuShaderCreator, shaderCode: str) -> None - :module: PyOpenColorIO - - - .. py:method:: GpuShaderCreator.addToFunctionHeaderShaderCode(self: PyOpenColorIO.GpuShaderCreator, shaderCode: str) -> None - :module: PyOpenColorIO - - - .. py:method:: GpuShaderCreator.addToFunctionShaderCode(self: PyOpenColorIO.GpuShaderCreator, shaderCode: str) -> None - :module: PyOpenColorIO - - - .. py:method:: GpuShaderCreator.addToHelperShaderCode(self: PyOpenColorIO.GpuShaderCreator, shaderCode: str) -> None - :module: PyOpenColorIO - - - .. py:method:: GpuShaderCreator.begin(self: PyOpenColorIO.GpuShaderCreator, uid: str) -> None - :module: PyOpenColorIO - - Start to collect the shader data. - - - .. py:method:: GpuShaderCreator.clone(self: PyOpenColorIO.GpuShaderCreator) -> PyOpenColorIO.GpuShaderCreator - :module: PyOpenColorIO - - - .. py:method:: GpuShaderCreator.createShaderText(self: PyOpenColorIO.GpuShaderCreator, shaderDeclarations: str, shaderHelperMethods: str, shaderFunctionHeader: str, shaderFunctionBody: str, shaderFunctionFooter: str) -> None - :module: PyOpenColorIO - - Create the OCIO shader program. - - .. note:: - The OCIO shader program is decomposed to allow a specific implementation to change some parts. Some product integrations add the color processing within a client shader program, imposing constraints requiring this flexibility. - - - .. py:method:: GpuShaderCreator.end(self: PyOpenColorIO.GpuShaderCreator) -> None - :module: PyOpenColorIO - - End to collect the shader data. - - - .. py:method:: GpuShaderCreator.finalize(self: PyOpenColorIO.GpuShaderCreator) -> None - :module: PyOpenColorIO - - - .. py:method:: GpuShaderCreator.getAllowTexture1D(self: PyOpenColorIO.GpuShaderCreator) -> bool - :module: PyOpenColorIO - - - .. py:method:: GpuShaderCreator.getCacheID(self: PyOpenColorIO.GpuShaderCreator) -> str - :module: PyOpenColorIO - - - .. py:method:: GpuShaderCreator.getDynamicProperties(self: PyOpenColorIO.GpuShaderCreator) -> PyOpenColorIO.GpuShaderCreator.DynamicPropertyIterator - :module: PyOpenColorIO - - - .. py:method:: GpuShaderCreator.getDynamicProperty(self: PyOpenColorIO.GpuShaderCreator, type: PyOpenColorIO.DynamicPropertyType) -> PyOpenColorIO.DynamicProperty - :module: PyOpenColorIO - - - .. py:method:: GpuShaderCreator.getFunctionName(self: PyOpenColorIO.GpuShaderCreator) -> str - :module: PyOpenColorIO - - - .. py:method:: GpuShaderCreator.getLanguage(self: PyOpenColorIO.GpuShaderCreator) -> PyOpenColorIO.GpuLanguage - :module: PyOpenColorIO - - - .. py:method:: GpuShaderCreator.getNextResourceIndex(self: PyOpenColorIO.GpuShaderCreator) -> int - :module: PyOpenColorIO - - To avoid global texture sampler and uniform name clashes always append an increasing index to the resource name. - - - .. py:method:: GpuShaderCreator.getPixelName(self: PyOpenColorIO.GpuShaderCreator) -> str - :module: PyOpenColorIO - - - .. py:method:: GpuShaderCreator.getResourcePrefix(self: PyOpenColorIO.GpuShaderCreator) -> str - :module: PyOpenColorIO - - .. note:: - Some applications require that textures, uniforms, and helper methods be uniquely named because several processor instances could coexist. - - - .. py:method:: GpuShaderCreator.getTextureMaxWidth(self: PyOpenColorIO.GpuShaderCreator) -> int - :module: PyOpenColorIO - - - .. py:method:: GpuShaderCreator.getUniqueID(self: PyOpenColorIO.GpuShaderCreator) -> str - :module: PyOpenColorIO - - - .. py:method:: GpuShaderCreator.hasDynamicProperty(self: PyOpenColorIO.GpuShaderCreator, type: PyOpenColorIO.DynamicPropertyType) -> bool - :module: PyOpenColorIO - - - .. py:method:: GpuShaderCreator.setAllowTexture1D(self: PyOpenColorIO.GpuShaderCreator, allowed: bool) -> None - :module: PyOpenColorIO - - Allow 1D GPU resource type, otherwise always using 2D resources for 1D LUTs. - - - .. py:method:: GpuShaderCreator.setFunctionName(self: PyOpenColorIO.GpuShaderCreator, name: str) -> None - :module: PyOpenColorIO - - - .. py:method:: GpuShaderCreator.setLanguage(self: PyOpenColorIO.GpuShaderCreator, language: PyOpenColorIO.GpuLanguage) -> None - :module: PyOpenColorIO - - Set the shader program language. - - - .. py:method:: GpuShaderCreator.setPixelName(self: PyOpenColorIO.GpuShaderCreator, name: str) -> None - :module: PyOpenColorIO - - Set the pixel name variable holding the color values. - - - .. py:method:: GpuShaderCreator.setResourcePrefix(self: PyOpenColorIO.GpuShaderCreator, prefix: str) -> None - :module: PyOpenColorIO - - Set a prefix to the resource name. - - - .. py:method:: GpuShaderCreator.setTextureMaxWidth(self: PyOpenColorIO.GpuShaderCreator, maxWidth: int) -> None - :module: PyOpenColorIO - - Some graphic cards could have 1D & 2D textures with size limitations. - - - .. py:method:: GpuShaderCreator.setUniqueID(self: PyOpenColorIO.GpuShaderCreator, uid: str) -> None - :module: PyOpenColorIO - - -.. py:class:: TextureType - :module: PyOpenColorIO.GpuShaderCreator - - Members: - - TEXTURE_RED_CHANNEL - - TEXTURE_RGB_CHANNEL - - .. py:method:: name() -> str - :property: - - .. py:attribute:: TextureType.TEXTURE_RED_CHANNEL - :module: PyOpenColorIO.GpuShaderCreator - :value: - - - .. py:attribute:: TextureType.TEXTURE_RGB_CHANNEL - :module: PyOpenColorIO.GpuShaderCreator - :value: - - - .. py:property:: TextureType.value - :module: PyOpenColorIO.GpuShaderCreator - - -.. py:class:: DynamicPropertyIterator - :module: PyOpenColorIO.GpuShaderCreator - - - .. py:method:: DynamicPropertyIterator.__getitem__(self: PyOpenColorIO.GpuShaderCreator.DynamicPropertyIterator, arg0: int) -> PyOpenColorIO.DynamicProperty - :module: PyOpenColorIO.GpuShaderCreator - - - .. py:method:: DynamicPropertyIterator.__iter__(self: PyOpenColorIO.GpuShaderCreator.DynamicPropertyIterator) -> PyOpenColorIO.GpuShaderCreator.DynamicPropertyIterator - :module: PyOpenColorIO.GpuShaderCreator - - - .. py:method:: DynamicPropertyIterator.__len__(self: PyOpenColorIO.GpuShaderCreator.DynamicPropertyIterator) -> int - :module: PyOpenColorIO.GpuShaderCreator - - - .. py:method:: DynamicPropertyIterator.__next__(self: PyOpenColorIO.GpuShaderCreator.DynamicPropertyIterator) -> PyOpenColorIO.DynamicProperty - :module: PyOpenColorIO.GpuShaderCreator - diff --git a/docs/api/python/frozen/pyopencolorio_gpushaderdesc.rst b/docs/api/python/frozen/pyopencolorio_gpushaderdesc.rst deleted file mode 100644 index 6fb50e827b..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gpushaderdesc.rst +++ /dev/null @@ -1,568 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: GpuShaderDesc - :module: PyOpenColorIO - - This class holds the GPU-related information needed to build a shader program from a specific processor. - - This class defines the interface and there are two implementations provided. The "legacy" mode implements the OCIO v1 approach of baking certain ops in order to have at most one 3D-LUT. The "generic" mode is the v2 default and allows all the ops to be processed as-is, without baking, like the CPU renderer. Custom implementations could be written to accommodate the GPU needs of a specific client app. - - The complete fragment shader program is decomposed in two main parts: the OCIO shader program for the color processing and the client shader program which consumes the pixel color processing. - - The OCIO shader program is fully described by the :ref:`GpuShaderDesc` independently from the client shader program. The only critical point is the agreement on the OCIO function shader name. - - To summarize, the complete shader program is: - - .. code-block:: cpp - - // // - // The complete fragment shader program // - // // - // // - // ////////////////////////////////////////////////////////////// // - // // // // - // // The OCIO shader program // // - // // // // - // ////////////////////////////////////////////////////////////// // - // // // // - // // // All global declarations // // - // // uniform sampled3D tex3; // // - // // // // - // // // All helper methods // // - // // vec3 computePos(vec3 color) // // - // // { // // - // // vec3 coords = color; // // - // // ... // // - // // return coords; // // - // // } // // - // // // // - // // // The OCIO shader function // // - // // vec4 OCIODisplay(in vec4 inColor) // // - // // { // // - // // vec4 outColor = inColor; // // - // // ... // // - // // outColor.rbg // // - // // = texture3D(tex3, computePos(inColor.rgb)).rgb; // // - // // ... // // - // // return outColor; // // - // // } // // - // // // // - // ////////////////////////////////////////////////////////////// // - // // - // ////////////////////////////////////////////////////////////// // - // // // // - // // The client shader program // // - // // // // - // ////////////////////////////////////////////////////////////// // - // // // // - // // uniform sampler2D image; // // - // // // // - // // void main() // // - // // { // // - // // vec4 inColor = texture2D(image, gl_TexCoord[0].st); // // - // // ... // // - // // vec4 outColor = OCIODisplay(inColor); // // - // // ... // // - // // gl_FragColor = outColor; // // - // // } // // - // // // // - // ////////////////////////////////////////////////////////////// // - // // - //////////////////////////////////////////////////////////////////////// - - **Usage Example:** *Building a GPU shader* - - This example is based on the code in: src/apps/ociodisplay/main.cpp - - .. code-block:: cpp - - // Get the processor - // - OCIO::ConstConfigRcPtr config = OCIO::Config::CreateFromEnv(); - OCIO::ConstProcessorRcPtr processor - = config->getProcessor("ACES - ACEScg", "Output - sRGB"); - - // Step 1: Create a GPU shader description - // - // The two potential scenarios are: - // - // 1. Instantiate the generic shader description. The color processor - // is used as-is (i.e. without any baking step) and could contain - // any number of 1D & 3D luts. - // - // This is the default OCIO v2 behavior and allows a much better - // match between the CPU and GPU renderers. - // - OCIO::GpuShaderDescRcPtr shaderDesc = OCIO::GpuShaderDesc::Create(); - // - // 2. Instantiate a custom shader description. - // - // Writing a custom shader description is a way to tailor the shaders - // to the needs of a given client program. This involves writing a - // new class inheriting from the pure virtual class GpuShaderDesc. - // - // Please refer to the GenericGpuShaderDesc class for an example. - // - OCIO::GpuShaderDescRcPtr shaderDesc = MyCustomGpuShader::Create(); - - shaderDesc->setLanguage(OCIO::GPU_LANGUAGE_GLSL_1_2); - shaderDesc->setFunctionName("OCIODisplay"); - - // Step 2: Collect the shader program information for a specific processor - // - processor->extractGpuShaderInfo(shaderDesc); - - // Step 3: Create a helper to build the shader. Here we use a helper for - // OpenGL but there will also be helpers for other languages. - // - OpenGLBuilderRcPtr oglBuilder = OpenGLBuilder::Create(shaderDesc); - - // Step 4: Allocate & upload all the LUTs - // - oglBuilder->allocateAllTextures(); - - // Step 5: Build the complete fragment shader program using - // g_fragShaderText which is the client shader program. - // - g_programId = oglBuilder->buildProgram(g_fragShaderText); - - // Step 6: Enable the fragment shader program, and all needed textures - // - glUseProgram(g_programId); - glUniform1i(glGetUniformLocation(g_programId, "tex1"), 1); // image texture - oglBuilder->useAllTextures(g_programId); // LUT textures - - // Step 7: Update uniforms from dynamic property instances. - m_oglBuilder->useAllUniforms(); - - - .. py:method:: GpuShaderDesc.CreateShaderDesc(language: PyOpenColorIO.GpuLanguage = , functionName: str = 'OCIOMain', pixelName: str = 'outColor', resourcePrefix: str = 'ocio', uid: str = '') -> PyOpenColorIO.GpuShaderDesc - :module: PyOpenColorIO - :staticmethod: - - Create the default shader description. - - - .. py:attribute:: GpuShaderDesc.TEXTURE_1D - :module: PyOpenColorIO - :value: - - - .. py:attribute:: GpuShaderDesc.TEXTURE_2D - :module: PyOpenColorIO - :value: - - - .. py:class:: GpuShaderDesc.TextureDimensions - :module: PyOpenColorIO - :canonical: PyOpenColorIO.GpuShaderCreator.TextureDimensions - - Dimension enum used to differentiate between 1D and 2D object/resource types. - - Members: - - TEXTURE_1D - - TEXTURE_2D - - - .. py:attribute:: GpuShaderDesc.TextureDimensions.TEXTURE_1D - :module: PyOpenColorIO - :value: - - - .. py:attribute:: GpuShaderDesc.TextureDimensions.TEXTURE_2D - :module: PyOpenColorIO - :value: - - - .. py:method:: GpuShaderDesc.TextureDimensions.__init__(self: PyOpenColorIO.GpuShaderCreator.TextureDimensions, value: int) -> None - :module: PyOpenColorIO - - - .. py:property:: GpuShaderDesc.TextureDimensions.name - :module: PyOpenColorIO - - - .. py:property:: GpuShaderDesc.TextureDimensions.value - :module: PyOpenColorIO - - - .. py:method:: GpuShaderDesc.__init__(*args, **kwargs) - :module: PyOpenColorIO - - - .. py:method:: GpuShaderDesc.add3DTexture(self: PyOpenColorIO.GpuShaderDesc, textureName: str, samplerName: str, edgeLen: int, interpolation: PyOpenColorIO.Interpolation, values: buffer) -> None - :module: PyOpenColorIO - - Add a 3D texture with RGB channel type. - - .. note:: - The 'values' parameter contains the 3D LUT data which must be used as-is as the dimension and origin are hard-coded in the fragment shader program. So, it means one GPU 3D texture per entry. - - - .. py:method:: GpuShaderDesc.addTexture(self: PyOpenColorIO.GpuShaderDesc, textureName: str, samplerName: str, width: int, height: int, channel: PyOpenColorIO.GpuShaderCreator.TextureType, dimensions: PyOpenColorIO.GpuShaderCreator.TextureDimensions, interpolation: PyOpenColorIO.Interpolation, values: buffer) -> None - :module: PyOpenColorIO - - Add a 1D or 2D texture - - .. note:: - The 'values' parameter contains the LUT data which must be used as-is as the dimensions and origin are hard-coded in the fragment shader program. So, it means one GPU texture per entry. - - - .. py:method:: GpuShaderDesc.addToDeclareShaderCode(self: PyOpenColorIO.GpuShaderCreator, shaderCode: str) -> None - :module: PyOpenColorIO - - - .. py:method:: GpuShaderDesc.addToFunctionFooterShaderCode(self: PyOpenColorIO.GpuShaderCreator, shaderCode: str) -> None - :module: PyOpenColorIO - - - .. py:method:: GpuShaderDesc.addToFunctionHeaderShaderCode(self: PyOpenColorIO.GpuShaderCreator, shaderCode: str) -> None - :module: PyOpenColorIO - - - .. py:method:: GpuShaderDesc.addToFunctionShaderCode(self: PyOpenColorIO.GpuShaderCreator, shaderCode: str) -> None - :module: PyOpenColorIO - - - .. py:method:: GpuShaderDesc.addToHelperShaderCode(self: PyOpenColorIO.GpuShaderCreator, shaderCode: str) -> None - :module: PyOpenColorIO - - - .. py:method:: GpuShaderDesc.begin(self: PyOpenColorIO.GpuShaderCreator, uid: str) -> None - :module: PyOpenColorIO - - Start to collect the shader data. - - - .. py:method:: GpuShaderDesc.clone(self: PyOpenColorIO.GpuShaderDesc) -> PyOpenColorIO.GpuShaderCreator - :module: PyOpenColorIO - - - .. py:method:: GpuShaderDesc.createShaderText(self: PyOpenColorIO.GpuShaderCreator, shaderDeclarations: str, shaderHelperMethods: str, shaderFunctionHeader: str, shaderFunctionBody: str, shaderFunctionFooter: str) -> None - :module: PyOpenColorIO - - Create the OCIO shader program. - - .. note:: - The OCIO shader program is decomposed to allow a specific implementation to change some parts. Some product integrations add the color processing within a client shader program, imposing constraints requiring this flexibility. - - - .. py:method:: GpuShaderDesc.end(self: PyOpenColorIO.GpuShaderCreator) -> None - :module: PyOpenColorIO - - End to collect the shader data. - - - .. py:method:: GpuShaderDesc.finalize(self: PyOpenColorIO.GpuShaderCreator) -> None - :module: PyOpenColorIO - - - .. py:method:: GpuShaderDesc.get3DTextures(self: PyOpenColorIO.GpuShaderDesc) -> PyOpenColorIO.GpuShaderDesc.Texture3DIterator - :module: PyOpenColorIO - - - .. py:method:: GpuShaderDesc.getAllowTexture1D(self: PyOpenColorIO.GpuShaderCreator) -> bool - :module: PyOpenColorIO - - - .. py:method:: GpuShaderDesc.getCacheID(self: PyOpenColorIO.GpuShaderCreator) -> str - :module: PyOpenColorIO - - - .. py:method:: GpuShaderDesc.getDynamicProperties(self: PyOpenColorIO.GpuShaderCreator) -> PyOpenColorIO.GpuShaderCreator.DynamicPropertyIterator - :module: PyOpenColorIO - - - .. py:method:: GpuShaderDesc.getDynamicProperty(self: PyOpenColorIO.GpuShaderCreator, type: PyOpenColorIO.DynamicPropertyType) -> PyOpenColorIO.DynamicProperty - :module: PyOpenColorIO - - - .. py:method:: GpuShaderDesc.getFunctionName(self: PyOpenColorIO.GpuShaderCreator) -> str - :module: PyOpenColorIO - - - .. py:method:: GpuShaderDesc.getLanguage(self: PyOpenColorIO.GpuShaderCreator) -> PyOpenColorIO.GpuLanguage - :module: PyOpenColorIO - - - .. py:method:: GpuShaderDesc.getNextResourceIndex(self: PyOpenColorIO.GpuShaderCreator) -> int - :module: PyOpenColorIO - - To avoid global texture sampler and uniform name clashes always append an increasing index to the resource name. - - - .. py:method:: GpuShaderDesc.getPixelName(self: PyOpenColorIO.GpuShaderCreator) -> str - :module: PyOpenColorIO - - - .. py:method:: GpuShaderDesc.getResourcePrefix(self: PyOpenColorIO.GpuShaderCreator) -> str - :module: PyOpenColorIO - - .. note:: - Some applications require that textures, uniforms, and helper methods be uniquely named because several processor instances could coexist. - - - .. py:method:: GpuShaderDesc.getShaderText(self: PyOpenColorIO.GpuShaderDesc) -> str - :module: PyOpenColorIO - - Get the complete OCIO shader program. - - - .. py:method:: GpuShaderDesc.getTextureMaxWidth(self: PyOpenColorIO.GpuShaderCreator) -> int - :module: PyOpenColorIO - - - .. py:method:: GpuShaderDesc.getTextures(self: PyOpenColorIO.GpuShaderDesc) -> PyOpenColorIO.GpuShaderDesc.TextureIterator - :module: PyOpenColorIO - - - .. py:method:: GpuShaderDesc.getUniforms(self: PyOpenColorIO.GpuShaderDesc) -> PyOpenColorIO.GpuShaderDesc.UniformIterator - :module: PyOpenColorIO - - - .. py:method:: GpuShaderDesc.getUniqueID(self: PyOpenColorIO.GpuShaderCreator) -> str - :module: PyOpenColorIO - - - .. py:method:: GpuShaderDesc.hasDynamicProperty(self: PyOpenColorIO.GpuShaderCreator, type: PyOpenColorIO.DynamicPropertyType) -> bool - :module: PyOpenColorIO - - - .. py:method:: GpuShaderDesc.setAllowTexture1D(self: PyOpenColorIO.GpuShaderCreator, allowed: bool) -> None - :module: PyOpenColorIO - - Allow 1D GPU resource type, otherwise always using 2D resources for 1D LUTs. - - - .. py:method:: GpuShaderDesc.setFunctionName(self: PyOpenColorIO.GpuShaderCreator, name: str) -> None - :module: PyOpenColorIO - - - .. py:method:: GpuShaderDesc.setLanguage(self: PyOpenColorIO.GpuShaderCreator, language: PyOpenColorIO.GpuLanguage) -> None - :module: PyOpenColorIO - - Set the shader program language. - - - .. py:method:: GpuShaderDesc.setPixelName(self: PyOpenColorIO.GpuShaderCreator, name: str) -> None - :module: PyOpenColorIO - - Set the pixel name variable holding the color values. - - - .. py:method:: GpuShaderDesc.setResourcePrefix(self: PyOpenColorIO.GpuShaderCreator, prefix: str) -> None - :module: PyOpenColorIO - - Set a prefix to the resource name. - - - .. py:method:: GpuShaderDesc.setTextureMaxWidth(self: PyOpenColorIO.GpuShaderCreator, maxWidth: int) -> None - :module: PyOpenColorIO - - Some graphic cards could have 1D & 2D textures with size limitations. - - - .. py:method:: GpuShaderDesc.setUniqueID(self: PyOpenColorIO.GpuShaderCreator, uid: str) -> None - :module: PyOpenColorIO - - -.. py:class:: TextureType - :module: PyOpenColorIO.GpuShaderDesc - :canonical: PyOpenColorIO.GpuShaderCreator.TextureType - - Members: - - TEXTURE_RED_CHANNEL - - TEXTURE_RGB_CHANNEL - - .. py:method:: name() -> str - :property: - - .. py:attribute:: TextureType.TEXTURE_RED_CHANNEL - :module: PyOpenColorIO.GpuShaderDesc - :value: - - - .. py:attribute:: TextureType.TEXTURE_RGB_CHANNEL - :module: PyOpenColorIO.GpuShaderDesc - :value: - - - .. py:property:: TextureType.value - :module: PyOpenColorIO.GpuShaderDesc - - -.. py:class:: UniformData - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:method:: UniformData.getBool(self: PyOpenColorIO.GpuShaderDesc.UniformData) -> bool - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:method:: UniformData.getDouble(self: PyOpenColorIO.GpuShaderDesc.UniformData) -> float - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:method:: UniformData.getFloat3(self: PyOpenColorIO.GpuShaderDesc.UniformData) -> List[float[3]] - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:method:: UniformData.getVectorFloat(self: PyOpenColorIO.GpuShaderDesc.UniformData) -> numpy.ndarray - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:method:: UniformData.getVectorInt(self: PyOpenColorIO.GpuShaderDesc.UniformData) -> numpy.ndarray - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:property:: UniformData.type - :module: PyOpenColorIO.GpuShaderDesc - - -.. py:class:: Texture - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:property:: Texture.channel - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:property:: Texture.dimensions - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:method:: Texture.getValues(self: PyOpenColorIO.GpuShaderDesc.Texture) -> numpy.ndarray - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:property:: Texture.height - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:property:: Texture.interpolation - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:property:: Texture.samplerName - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:property:: Texture.textureName - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:property:: Texture.width - :module: PyOpenColorIO.GpuShaderDesc - - -.. py:class:: Texture3D - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:property:: Texture3D.edgeLen - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:method:: Texture3D.getValues(self: PyOpenColorIO.GpuShaderDesc.Texture3D) -> numpy.ndarray - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:property:: Texture3D.interpolation - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:property:: Texture3D.samplerName - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:property:: Texture3D.textureName - :module: PyOpenColorIO.GpuShaderDesc - - -.. py:class:: UniformIterator - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:method:: UniformIterator.__getitem__(self: PyOpenColorIO.GpuShaderDesc.UniformIterator, arg0: int) -> tuple - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:method:: UniformIterator.__iter__(self: PyOpenColorIO.GpuShaderDesc.UniformIterator) -> PyOpenColorIO.GpuShaderDesc.UniformIterator - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:method:: UniformIterator.__len__(self: PyOpenColorIO.GpuShaderDesc.UniformIterator) -> int - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:method:: UniformIterator.__next__(self: PyOpenColorIO.GpuShaderDesc.UniformIterator) -> tuple - :module: PyOpenColorIO.GpuShaderDesc - - -.. py:class:: TextureIterator - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:method:: TextureIterator.__getitem__(self: PyOpenColorIO.GpuShaderDesc.TextureIterator, arg0: int) -> PyOpenColorIO.GpuShaderDesc.Texture - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:method:: TextureIterator.__iter__(self: PyOpenColorIO.GpuShaderDesc.TextureIterator) -> PyOpenColorIO.GpuShaderDesc.TextureIterator - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:method:: TextureIterator.__len__(self: PyOpenColorIO.GpuShaderDesc.TextureIterator) -> int - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:method:: TextureIterator.__next__(self: PyOpenColorIO.GpuShaderDesc.TextureIterator) -> PyOpenColorIO.GpuShaderDesc.Texture - :module: PyOpenColorIO.GpuShaderDesc - - -.. py:class:: Texture3DIterator - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:method:: Texture3DIterator.__getitem__(self: PyOpenColorIO.GpuShaderDesc.Texture3DIterator, arg0: int) -> PyOpenColorIO.GpuShaderDesc.Texture3D - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:method:: Texture3DIterator.__iter__(self: PyOpenColorIO.GpuShaderDesc.Texture3DIterator) -> PyOpenColorIO.GpuShaderDesc.Texture3DIterator - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:method:: Texture3DIterator.__len__(self: PyOpenColorIO.GpuShaderDesc.Texture3DIterator) -> int - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:method:: Texture3DIterator.__next__(self: PyOpenColorIO.GpuShaderDesc.Texture3DIterator) -> PyOpenColorIO.GpuShaderDesc.Texture3D - :module: PyOpenColorIO.GpuShaderDesc - - -.. py:class:: DynamicPropertyIterator - :module: PyOpenColorIO.GpuShaderDesc - :canonical: PyOpenColorIO.GpuShaderCreator.DynamicPropertyIterator - - - .. py:method:: DynamicPropertyIterator.__getitem__(self: PyOpenColorIO.GpuShaderCreator.DynamicPropertyIterator, arg0: int) -> PyOpenColorIO.DynamicProperty - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:method:: DynamicPropertyIterator.__iter__(self: PyOpenColorIO.GpuShaderCreator.DynamicPropertyIterator) -> PyOpenColorIO.GpuShaderCreator.DynamicPropertyIterator - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:method:: DynamicPropertyIterator.__len__(self: PyOpenColorIO.GpuShaderCreator.DynamicPropertyIterator) -> int - :module: PyOpenColorIO.GpuShaderDesc - - - .. py:method:: DynamicPropertyIterator.__next__(self: PyOpenColorIO.GpuShaderCreator.DynamicPropertyIterator) -> PyOpenColorIO.DynamicProperty - :module: PyOpenColorIO.GpuShaderDesc - diff --git a/docs/api/python/frozen/pyopencolorio_gradingbsplinecurve.rst b/docs/api/python/frozen/pyopencolorio_gradingbsplinecurve.rst deleted file mode 100644 index 56f0fc0dc8..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gradingbsplinecurve.rst +++ /dev/null @@ -1,60 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: GradingBSplineCurve - :module: PyOpenColorIO - - A BSpline curve defined with :ref:`GradingControlPoint`. - - - .. py:method:: GradingBSplineCurve.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.GradingBSplineCurve, size: int) -> None - - Create a BSpline curve with a specified number of control points. - - 2. __init__(self: PyOpenColorIO.GradingBSplineCurve, arg0: List[float]) -> None - - Create a BSpline curve with a list of control points. - - - .. py:method:: GradingBSplineCurve.getControlPoints(self: PyOpenColorIO.GradingBSplineCurve) -> PyOpenColorIO.GradingBSplineCurve.GradingControlPointIterator - :module: PyOpenColorIO - - - .. py:method:: GradingBSplineCurve.setNumControlPoints(self: PyOpenColorIO.GradingBSplineCurve, size: int) -> None - :module: PyOpenColorIO - - - .. py:method:: GradingBSplineCurve.validate(self: PyOpenColorIO.GradingBSplineCurve) -> None - :module: PyOpenColorIO - - -.. py:class:: GradingControlPointIterator - :module: PyOpenColorIO.GradingBSplineCurve - - - .. py:method:: GradingControlPointIterator.__getitem__(self: PyOpenColorIO.GradingBSplineCurve.GradingControlPointIterator, arg0: int) -> PyOpenColorIO.GradingControlPoint - :module: PyOpenColorIO.GradingBSplineCurve - - - .. py:method:: GradingControlPointIterator.__iter__(self: PyOpenColorIO.GradingBSplineCurve.GradingControlPointIterator) -> PyOpenColorIO.GradingBSplineCurve.GradingControlPointIterator - :module: PyOpenColorIO.GradingBSplineCurve - - - .. py:method:: GradingControlPointIterator.__len__(self: PyOpenColorIO.GradingBSplineCurve.GradingControlPointIterator) -> int - :module: PyOpenColorIO.GradingBSplineCurve - - - .. py:method:: GradingControlPointIterator.__next__(self: PyOpenColorIO.GradingBSplineCurve.GradingControlPointIterator) -> PyOpenColorIO.GradingControlPoint - :module: PyOpenColorIO.GradingBSplineCurve - - - .. py:method:: GradingControlPointIterator.__setitem__(self: PyOpenColorIO.GradingBSplineCurve.GradingControlPointIterator, arg0: int, arg1: PyOpenColorIO.GradingControlPoint) -> None - :module: PyOpenColorIO.GradingBSplineCurve - diff --git a/docs/api/python/frozen/pyopencolorio_gradingcontrolpoint.rst b/docs/api/python/frozen/pyopencolorio_gradingcontrolpoint.rst deleted file mode 100644 index 5ecb2be29c..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gradingcontrolpoint.rst +++ /dev/null @@ -1,28 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: GradingControlPoint - :module: PyOpenColorIO - - 2D control point used by :ref:`GradingBSplineCurve`. - - - .. py:method:: GradingControlPoint.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.GradingControlPoint) -> None - - 2. __init__(self: PyOpenColorIO.GradingControlPoint, x: float = 0.0, y: float = 0.0) -> None - - - .. py:property:: GradingControlPoint.x - :module: PyOpenColorIO - - - .. py:property:: GradingControlPoint.y - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_gradingprimary.rst b/docs/api/python/frozen/pyopencolorio_gradingprimary.rst deleted file mode 100644 index 0c2dc72c7a..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gradingprimary.rst +++ /dev/null @@ -1,82 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: GradingPrimary - :module: PyOpenColorIO - - Grading primary values. - - - .. py:attribute:: GradingPrimary.NoClampBlack - :module: PyOpenColorIO - :value: -1.7976931348623157e+308 - - - .. py:attribute:: GradingPrimary.NoClampWhite - :module: PyOpenColorIO - :value: 1.7976931348623157e+308 - - - .. py:method:: GradingPrimary.__init__(self: PyOpenColorIO.GradingPrimary, arg0: PyOpenColorIO.GradingStyle) -> None - :module: PyOpenColorIO - - - .. py:property:: GradingPrimary.brightness - :module: PyOpenColorIO - - - .. py:property:: GradingPrimary.clampBlack - :module: PyOpenColorIO - - - .. py:property:: GradingPrimary.clampWhite - :module: PyOpenColorIO - - - .. py:property:: GradingPrimary.contrast - :module: PyOpenColorIO - - - .. py:property:: GradingPrimary.exposure - :module: PyOpenColorIO - - - .. py:property:: GradingPrimary.gain - :module: PyOpenColorIO - - - .. py:property:: GradingPrimary.gamma - :module: PyOpenColorIO - - - .. py:property:: GradingPrimary.lift - :module: PyOpenColorIO - - - .. py:property:: GradingPrimary.offset - :module: PyOpenColorIO - - - .. py:property:: GradingPrimary.pivot - :module: PyOpenColorIO - - - .. py:property:: GradingPrimary.pivotBlack - :module: PyOpenColorIO - - - .. py:property:: GradingPrimary.pivotWhite - :module: PyOpenColorIO - - - .. py:property:: GradingPrimary.saturation - :module: PyOpenColorIO - - - .. py:method:: GradingPrimary.validate(self: PyOpenColorIO.GradingPrimary, arg0: PyOpenColorIO.GradingStyle) -> None - :module: PyOpenColorIO - - The valid range for each parameter varies. - diff --git a/docs/api/python/frozen/pyopencolorio_gradingprimarytransform.rst b/docs/api/python/frozen/pyopencolorio_gradingprimarytransform.rst deleted file mode 100644 index 49a0aa58c6..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gradingprimarytransform.rst +++ /dev/null @@ -1,93 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: GradingPrimaryTransform - :module: PyOpenColorIO - - Primary color correction controls. - - This transform is for making basic color correction adjustments to an image such as brightness, contrast, or saturation. - - The controls are customized for linear, logarithmic, and video color encodings. - - Linear controls: Exposure, Contrast, Pivot, Offset, Saturation, Black Clip, White Clip. - - Log controls: Brightness, Contrast, Pivot, Log Gamma, Saturation, Black Clip, White Clip, Black Pivot White Pivot. - - Video controls : Lift, Gamma, Gain, Offset, Saturation, Black Clip, White Clip, Black Pivot White Pivot. - - The controls are dynamic, so they may be adjusted even after the :ref:`Transform` has been included in a :ref:`Processor`. - - - .. py:method:: GradingPrimaryTransform.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.GradingPrimaryTransform, values: PyOpenColorIO.GradingPrimary, style: PyOpenColorIO.GradingStyle = , dynamic: bool = False, dir: PyOpenColorIO.TransformDirection = ) -> None - - Creates an instance of :ref:`GradingPrimaryTransform`. - - 2. __init__(self: PyOpenColorIO.GradingPrimaryTransform, style: PyOpenColorIO.GradingStyle = , dynamic: bool = False, dir: PyOpenColorIO.TransformDirection = ) -> None - - Creates an instance of :ref:`GradingPrimaryTransform`. - - - .. py:method:: GradingPrimaryTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection - :module: PyOpenColorIO - - - .. py:method:: GradingPrimaryTransform.getFormatMetadata(self: PyOpenColorIO.GradingPrimaryTransform) -> PyOpenColorIO.FormatMetadata - :module: PyOpenColorIO - - - .. py:method:: GradingPrimaryTransform.getStyle(self: PyOpenColorIO.GradingPrimaryTransform) -> PyOpenColorIO.GradingStyle - :module: PyOpenColorIO - - Adjusts the behavior of the transform for log, linear, or video color space encodings. - - - .. py:method:: GradingPrimaryTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType - :module: PyOpenColorIO - - - .. py:method:: GradingPrimaryTransform.getValue(self: PyOpenColorIO.GradingPrimaryTransform) -> PyOpenColorIO.GradingPrimary - :module: PyOpenColorIO - - - .. py:method:: GradingPrimaryTransform.isDynamic(self: PyOpenColorIO.GradingPrimaryTransform) -> bool - :module: PyOpenColorIO - - Parameters can be made dynamic so the values can be changed through the CPU or GPU processor, but if there are several :ref:`GradingPrimaryTransform` only one can have dynamic parameters. - - - .. py:method:: GradingPrimaryTransform.makeDynamic(self: PyOpenColorIO.GradingPrimaryTransform) -> None - :module: PyOpenColorIO - - - .. py:method:: GradingPrimaryTransform.makeNonDynamic(self: PyOpenColorIO.GradingPrimaryTransform) -> None - :module: PyOpenColorIO - - - .. py:method:: GradingPrimaryTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None - :module: PyOpenColorIO - - Note that this only affects the evaluation and not the values stored in the object. - - - .. py:method:: GradingPrimaryTransform.setStyle(self: PyOpenColorIO.GradingPrimaryTransform, style: PyOpenColorIO.GradingStyle) -> None - :module: PyOpenColorIO - - Will reset value to style's defaults if style is not the current style. - - - .. py:method:: GradingPrimaryTransform.setValue(self: PyOpenColorIO.GradingPrimaryTransform, values: PyOpenColorIO.GradingPrimary) -> None - :module: PyOpenColorIO - - Throws if value is not valid. - - - .. py:method:: GradingPrimaryTransform.validate(self: PyOpenColorIO.Transform) -> None - :module: PyOpenColorIO - - Will throw if data is not valid. - diff --git a/docs/api/python/frozen/pyopencolorio_gradingrgbcurve.rst b/docs/api/python/frozen/pyopencolorio_gradingrgbcurve.rst deleted file mode 100644 index f6c4dd78d2..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gradingrgbcurve.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: GradingRGBCurve - :module: PyOpenColorIO - - A set of red, green, blue and master curves. It is used by RGBCurveTransform and can be used as a dynamic property (see :ref:`DynamicPropertyGradingRGBCurve`). - - - .. py:method:: GradingRGBCurve.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.GradingRGBCurve, style: PyOpenColorIO.GradingStyle) -> None - - Do not use (needed only for pybind11). - - 2. __init__(self: PyOpenColorIO.GradingRGBCurve, red: PyOpenColorIO.GradingBSplineCurve = ]>, green: PyOpenColorIO.GradingBSplineCurve = ]>, blue: PyOpenColorIO.GradingBSplineCurve = ]>, master: PyOpenColorIO.GradingBSplineCurve = ]>) -> None - - - .. py:property:: GradingRGBCurve.blue - :module: PyOpenColorIO - - - .. py:property:: GradingRGBCurve.green - :module: PyOpenColorIO - - - .. py:property:: GradingRGBCurve.master - :module: PyOpenColorIO - - - .. py:property:: GradingRGBCurve.red - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_gradingrgbcurvetransform.rst b/docs/api/python/frozen/pyopencolorio_gradingrgbcurvetransform.rst deleted file mode 100644 index 73b45f2ed8..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gradingrgbcurvetransform.rst +++ /dev/null @@ -1,114 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: GradingRGBCurveTransform - :module: PyOpenColorIO - - RGB curve color correction controls. - - This transform allows for modifying tone reproduction via B-spline curves. - - There is an R, G, and B curve along with a Master curve (that applies to R, G, and B). Each curve is specified via the x and y coordinates of its control points. A monotonic spline is fit to the control points. The x coordinates must be non-decreasing. When the grading style is linear, the units for the control points are photographic stops relative to 0.18. - - The control points are dynamic, so they may be adjusted even after the :ref:`Transform` is included in a :ref:`Processor`. - - - .. py:method:: GradingRGBCurveTransform.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.GradingRGBCurveTransform, values: PyOpenColorIO.GradingRGBCurve, style: PyOpenColorIO.GradingStyle = , dynamic: bool = False, dir: PyOpenColorIO.TransformDirection = ) -> None - - Creates an instance of :ref:`GradingPrimaryTransform`. - - 2. __init__(self: PyOpenColorIO.GradingRGBCurveTransform, style: PyOpenColorIO.GradingStyle = , dynamic: bool = False, dir: PyOpenColorIO.TransformDirection = ) -> None - - Creates an instance of :ref:`GradingPrimaryTransform`. - - - .. py:method:: GradingRGBCurveTransform.getBypassLinToLog(self: PyOpenColorIO.GradingRGBCurveTransform) -> bool - :module: PyOpenColorIO - - The scene-linear grading style applies a lin-to-log transform to the pixel values before going through the curve. However, in some cases (e.g. drawing curves in a UI) it may be useful to bypass the lin-to-log. Default value is false. - - - .. py:method:: GradingRGBCurveTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection - :module: PyOpenColorIO - - - .. py:method:: GradingRGBCurveTransform.getFormatMetadata(self: PyOpenColorIO.GradingRGBCurveTransform) -> PyOpenColorIO.FormatMetadata - :module: PyOpenColorIO - - - .. py:method:: GradingRGBCurveTransform.getSlope(self: PyOpenColorIO.GradingRGBCurveTransform, channel: PyOpenColorIO.RGBCurveType, index: int) -> float - :module: PyOpenColorIO - - It is possible to provide a desired slope value for each control point. The number of slopes is always the same as the number of control points and so the control points must be set before setting the slopes. The slopes are primarily intended for use by config authors looking to match a specific shape with as few control points as possible, they are not intended to be exposed to a user interface for direct manipulation. When a curve is being generated for creative purposes it is better to let OCIO calculate the slopes automatically. - - - .. py:method:: GradingRGBCurveTransform.getStyle(self: PyOpenColorIO.GradingRGBCurveTransform) -> PyOpenColorIO.GradingStyle - :module: PyOpenColorIO - - Adjusts the behavior of the transform for log, linear, or video color space encodings. - - - .. py:method:: GradingRGBCurveTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType - :module: PyOpenColorIO - - - .. py:method:: GradingRGBCurveTransform.getValue(self: PyOpenColorIO.GradingRGBCurveTransform) -> PyOpenColorIO.GradingRGBCurve - :module: PyOpenColorIO - - - .. py:method:: GradingRGBCurveTransform.isDynamic(self: PyOpenColorIO.GradingRGBCurveTransform) -> bool - :module: PyOpenColorIO - - Parameters can be made dynamic so the values can be changed through the CPU or GPU processor, but if there are several :ref:`GradingRGBCurveTransform` only one can have dynamic parameters. - - - .. py:method:: GradingRGBCurveTransform.makeDynamic(self: PyOpenColorIO.GradingRGBCurveTransform) -> None - :module: PyOpenColorIO - - - .. py:method:: GradingRGBCurveTransform.makeNonDynamic(self: PyOpenColorIO.GradingRGBCurveTransform) -> None - :module: PyOpenColorIO - - - .. py:method:: GradingRGBCurveTransform.setBypassLinToLog(self: PyOpenColorIO.GradingRGBCurveTransform, bypass: bool) -> None - :module: PyOpenColorIO - - - .. py:method:: GradingRGBCurveTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None - :module: PyOpenColorIO - - Note that this only affects the evaluation and not the values stored in the object. - - - .. py:method:: GradingRGBCurveTransform.setSlope(self: PyOpenColorIO.GradingRGBCurveTransform, channel: PyOpenColorIO.RGBCurveType, index: int, slope: float) -> None - :module: PyOpenColorIO - - - .. py:method:: GradingRGBCurveTransform.setStyle(self: PyOpenColorIO.GradingRGBCurveTransform, style: PyOpenColorIO.GradingStyle) -> None - :module: PyOpenColorIO - - Will reset value to style's defaults if style is not the current style. - - - .. py:method:: GradingRGBCurveTransform.setValue(self: PyOpenColorIO.GradingRGBCurveTransform, values: PyOpenColorIO.GradingRGBCurve) -> None - :module: PyOpenColorIO - - Throws if value is not valid. - - - .. py:method:: GradingRGBCurveTransform.slopesAreDefault(self: PyOpenColorIO.GradingRGBCurveTransform, channel: PyOpenColorIO.RGBCurveType) -> bool - :module: PyOpenColorIO - - - .. py:method:: GradingRGBCurveTransform.validate(self: PyOpenColorIO.Transform) -> None - :module: PyOpenColorIO - - Will throw if data is not valid. - diff --git a/docs/api/python/frozen/pyopencolorio_gradingrgbm.rst b/docs/api/python/frozen/pyopencolorio_gradingrgbm.rst deleted file mode 100644 index c55e1da241..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gradingrgbm.rst +++ /dev/null @@ -1,36 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: GradingRGBM - :module: PyOpenColorIO - - Used by the grading transforms to hold the red, green, blue, and master components of a single parameter. The master component affects all three channels (RGB). - - - .. py:method:: GradingRGBM.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.GradingRGBM) -> None - - 2. __init__(self: PyOpenColorIO.GradingRGBM, red: float, green: float, blue: float, master: float) -> None - - - .. py:property:: GradingRGBM.blue - :module: PyOpenColorIO - - - .. py:property:: GradingRGBM.green - :module: PyOpenColorIO - - - .. py:property:: GradingRGBM.master - :module: PyOpenColorIO - - - .. py:property:: GradingRGBM.red - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_gradingrgbmsw.rst b/docs/api/python/frozen/pyopencolorio_gradingrgbmsw.rst deleted file mode 100644 index dfc24f90f4..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gradingrgbmsw.rst +++ /dev/null @@ -1,46 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: GradingRGBMSW - :module: PyOpenColorIO - - Used by the grading tone transforms to hold the red, green, blue, master, start, and width components of a single parameter. The master component affects all three channels (RGB). The start and width components control the range of tones affected. Although this struct simply uses "start" and "width" for all the range values, the actual user-facing name changes based on the parameter. - - - .. py:method:: GradingRGBMSW.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.GradingRGBMSW) -> None - - 2. __init__(self: PyOpenColorIO.GradingRGBMSW, red: float, green: float, blue: float, master: float, start: float, width: float) -> None - - 3. __init__(self: PyOpenColorIO.GradingRGBMSW, start: float, width: float) -> None - - - .. py:property:: GradingRGBMSW.blue - :module: PyOpenColorIO - - - .. py:property:: GradingRGBMSW.green - :module: PyOpenColorIO - - - .. py:property:: GradingRGBMSW.master - :module: PyOpenColorIO - - - .. py:property:: GradingRGBMSW.red - :module: PyOpenColorIO - - - .. py:property:: GradingRGBMSW.start - :module: PyOpenColorIO - - - .. py:property:: GradingRGBMSW.width - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_gradingstyle.rst b/docs/api/python/frozen/pyopencolorio_gradingstyle.rst deleted file mode 100644 index 75f1ae2035..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gradingstyle.rst +++ /dev/null @@ -1,39 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: GradingStyle - :module: PyOpenColorIO - - Styles for grading transforms. - - Members: - - GRADING_LOG : Algorithms for Logarithmic color spaces. - - GRADING_LIN : Algorithms for Scene Linear color spaces. - - GRADING_VIDEO : Algorithms for Video color spaces. - - .. py:method:: name() -> str - :property: - - .. py:attribute:: GradingStyle.GRADING_LIN - :module: PyOpenColorIO - :value: - - - .. py:attribute:: GradingStyle.GRADING_LOG - :module: PyOpenColorIO - :value: - - - .. py:attribute:: GradingStyle.GRADING_VIDEO - :module: PyOpenColorIO - :value: - - - .. py:property:: GradingStyle.value - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_gradingstylefromstring.rst b/docs/api/python/frozen/pyopencolorio_gradingstylefromstring.rst deleted file mode 100644 index 6792efad76..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gradingstylefromstring.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: GradingStyleFromString(str: str) -> PyOpenColorIO.GradingStyle - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_gradingstyletostring.rst b/docs/api/python/frozen/pyopencolorio_gradingstyletostring.rst deleted file mode 100644 index e1ea0011d2..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gradingstyletostring.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: GradingStyleToString(style: PyOpenColorIO.GradingStyle) -> str - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_gradingtone.rst b/docs/api/python/frozen/pyopencolorio_gradingtone.rst deleted file mode 100644 index 352e1b0a5d..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gradingtone.rst +++ /dev/null @@ -1,44 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: GradingTone - :module: PyOpenColorIO - - Grading tone values. - - - .. py:method:: GradingTone.__init__(self: PyOpenColorIO.GradingTone, arg0: PyOpenColorIO.GradingStyle) -> None - :module: PyOpenColorIO - - - .. py:property:: GradingTone.blacks - :module: PyOpenColorIO - - - .. py:property:: GradingTone.highlights - :module: PyOpenColorIO - - - .. py:property:: GradingTone.midtones - :module: PyOpenColorIO - - - .. py:property:: GradingTone.scontrast - :module: PyOpenColorIO - - - .. py:property:: GradingTone.shadows - :module: PyOpenColorIO - - - .. py:method:: GradingTone.validate(self: PyOpenColorIO.GradingTone) -> None - :module: PyOpenColorIO - - The valid range for each parameter varies. The client is expected to enforce these bounds in the UI. - - - .. py:property:: GradingTone.whites - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_gradingtonetransform.rst b/docs/api/python/frozen/pyopencolorio_gradingtonetransform.rst deleted file mode 100644 index ae62e1cdbe..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gradingtonetransform.rst +++ /dev/null @@ -1,99 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: GradingToneTransform - :module: PyOpenColorIO - - Tonal color correction controls. - - This transform is for making fine adjustments to tone reproduction in specific tonal ranges. - - There are five tonal controls and each one has two parameters to control its range: - - Blacks (start, width) - - Shadows(start, pivot) - - Midtones(center, width) - - Highlights(start, pivot) - - Whites(start, width) - - The transform has three styles that adjust the response and default ranges for linear, logarithimic, and video color encodings. The defaults vary based on the style. When the style is linear, the units for start/width/etc. are photographic stops relative to 0.18. - - Each control allows R, G, B adjustments and a Master adjustment. - - There is also an S-contrast control for imparting an S-shape curve. - - The controls are dynamic, so they may be adjusted even after the :ref:`Transform` has been included in a :ref:`Processor`. - - - .. py:method:: GradingToneTransform.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.GradingToneTransform, values: PyOpenColorIO.GradingTone, style: PyOpenColorIO.GradingStyle = , dynamic: bool = False, dir: PyOpenColorIO.TransformDirection = ) -> None - - Creates an instance of :ref:`GradingToneTransform`. - - 2. __init__(self: PyOpenColorIO.GradingToneTransform, style: PyOpenColorIO.GradingStyle = , dynamic: bool = False, dir: PyOpenColorIO.TransformDirection = ) -> None - - Creates an instance of :ref:`GradingToneTransform`. - - - .. py:method:: GradingToneTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection - :module: PyOpenColorIO - - - .. py:method:: GradingToneTransform.getFormatMetadata(self: PyOpenColorIO.GradingToneTransform) -> PyOpenColorIO.FormatMetadata - :module: PyOpenColorIO - - - .. py:method:: GradingToneTransform.getStyle(self: PyOpenColorIO.GradingToneTransform) -> PyOpenColorIO.GradingStyle - :module: PyOpenColorIO - - Adjusts the behavior of the transform for log, linear, or video color space encodings. - - - .. py:method:: GradingToneTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType - :module: PyOpenColorIO - - - .. py:method:: GradingToneTransform.getValue(self: PyOpenColorIO.GradingToneTransform) -> PyOpenColorIO.GradingTone - :module: PyOpenColorIO - - - .. py:method:: GradingToneTransform.isDynamic(self: PyOpenColorIO.GradingToneTransform) -> bool - :module: PyOpenColorIO - - Parameters can be made dynamic so the values can be changed through the CPU or GPU processor, but if there are several :ref:`GradingToneTransform` only one can have dynamic parameters. - - - .. py:method:: GradingToneTransform.makeDynamic(self: PyOpenColorIO.GradingToneTransform) -> None - :module: PyOpenColorIO - - - .. py:method:: GradingToneTransform.makeNonDynamic(self: PyOpenColorIO.GradingToneTransform) -> None - :module: PyOpenColorIO - - - .. py:method:: GradingToneTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None - :module: PyOpenColorIO - - Note that this only affects the evaluation and not the values stored in the object. - - - .. py:method:: GradingToneTransform.setStyle(self: PyOpenColorIO.GradingToneTransform, style: PyOpenColorIO.GradingStyle) -> None - :module: PyOpenColorIO - - Will reset value to style's defaults if style is not the current style. - - - .. py:method:: GradingToneTransform.setValue(self: PyOpenColorIO.GradingToneTransform, values: PyOpenColorIO.GradingTone) -> None - :module: PyOpenColorIO - - - .. py:method:: GradingToneTransform.validate(self: PyOpenColorIO.Transform) -> None - :module: PyOpenColorIO - - Will throw if data is not valid. - diff --git a/docs/api/python/frozen/pyopencolorio_grouptransform.rst b/docs/api/python/frozen/pyopencolorio_grouptransform.rst deleted file mode 100644 index 630ac4a122..0000000000 --- a/docs/api/python/frozen/pyopencolorio_grouptransform.rst +++ /dev/null @@ -1,137 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: GroupTransform - :module: PyOpenColorIO - - - .. py:method:: GroupTransform.GetWriteFormats() -> PyOpenColorIO.GroupTransform.WriteFormatIterator - :module: PyOpenColorIO - :staticmethod: - - - .. py:method:: GroupTransform.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.GroupTransform) -> None - - 2. __init__(self: PyOpenColorIO.GroupTransform, transforms: List[PyOpenColorIO.Transform] = [], direction: PyOpenColorIO.TransformDirection = ) -> None - - - .. py:method:: GroupTransform.appendTransform(self: PyOpenColorIO.GroupTransform, transform: PyOpenColorIO.Transform) -> None - :module: PyOpenColorIO - - Adds a transform to the end of the group. - - - .. py:method:: GroupTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection - :module: PyOpenColorIO - - - .. py:method:: GroupTransform.getFormatMetadata(self: PyOpenColorIO.GroupTransform) -> PyOpenColorIO.FormatMetadata - :module: PyOpenColorIO - - - .. py:method:: GroupTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType - :module: PyOpenColorIO - - - .. py:method:: GroupTransform.prependTransform(self: PyOpenColorIO.GroupTransform, transform: PyOpenColorIO.Transform) -> None - :module: PyOpenColorIO - - Add a transform at the beginning of the group. - - - .. py:method:: GroupTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None - :module: PyOpenColorIO - - Note that this only affects the evaluation and not the values stored in the object. - - - .. py:method:: GroupTransform.validate(self: PyOpenColorIO.Transform) -> None - :module: PyOpenColorIO - - Will throw if data is not valid. - - - .. py:method:: GroupTransform.write(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. write(self: PyOpenColorIO.GroupTransform, formatName: str, fileName: str, config: PyOpenColorIO.Config = None) -> None - - Write the transforms comprising the group to the stream. - - Writing (as opposed to Baking) is a lossless process. An exception is thrown if the processor cannot be losslessly written to the specified file format. Transforms such as :ref:`FileTransform` or :ref:`ColorSpaceTransform` are resolved into write-able simple transforms using the config and context. Supported formats include CTF, CLF, and CDL. All available formats can be listed with the following: .. code-block:: cpp - - // What are the allowed writing output formats? - std::ostringstream formats; - formats << "Formats to write to: "; - for (int i = 0; i < :ref:`GroupTransform::GetNumWriteFormats`(); ++i) - { - if (i != 0) formats << ", "; - formats << :ref:`GroupTransform::GetFormatNameByIndex`(i); - formats << " (." << GroupTransform::GetFormatExtensionByIndex(i) << ")"; - } - - 2. write(self: PyOpenColorIO.GroupTransform, formatName: str, config: PyOpenColorIO.Config = None) -> str - - Write the transforms comprising the group to the stream. - - Writing (as opposed to Baking) is a lossless process. An exception is thrown if the processor cannot be losslessly written to the specified file format. Transforms such as :ref:`FileTransform` or :ref:`ColorSpaceTransform` are resolved into write-able simple transforms using the config and context. Supported formats include CTF, CLF, and CDL. All available formats can be listed with the following: .. code-block:: cpp - - // What are the allowed writing output formats? - std::ostringstream formats; - formats << "Formats to write to: "; - for (int i = 0; i < :ref:`GroupTransform::GetNumWriteFormats`(); ++i) - { - if (i != 0) formats << ", "; - formats << :ref:`GroupTransform::GetFormatNameByIndex`(i); - formats << " (." << GroupTransform::GetFormatExtensionByIndex(i) << ")"; - } - - -.. py:class:: WriteFormatIterator - :module: PyOpenColorIO.GroupTransform - - - .. py:method:: WriteFormatIterator.__getitem__(self: PyOpenColorIO.GroupTransform.WriteFormatIterator, arg0: int) -> tuple - :module: PyOpenColorIO.GroupTransform - - - .. py:method:: WriteFormatIterator.__iter__(self: PyOpenColorIO.GroupTransform.WriteFormatIterator) -> PyOpenColorIO.GroupTransform.WriteFormatIterator - :module: PyOpenColorIO.GroupTransform - - - .. py:method:: WriteFormatIterator.__len__(self: PyOpenColorIO.GroupTransform.WriteFormatIterator) -> int - :module: PyOpenColorIO.GroupTransform - - - .. py:method:: WriteFormatIterator.__next__(self: PyOpenColorIO.GroupTransform.WriteFormatIterator) -> tuple - :module: PyOpenColorIO.GroupTransform - - -.. py:class:: TransformIterator - :module: PyOpenColorIO.GroupTransform - - - .. py:method:: TransformIterator.__getitem__(self: PyOpenColorIO.GroupTransform.TransformIterator, arg0: int) -> PyOpenColorIO.Transform - :module: PyOpenColorIO.GroupTransform - - - .. py:method:: TransformIterator.__iter__(self: PyOpenColorIO.GroupTransform.TransformIterator) -> PyOpenColorIO.GroupTransform.TransformIterator - :module: PyOpenColorIO.GroupTransform - - - .. py:method:: TransformIterator.__len__(self: PyOpenColorIO.GroupTransform.TransformIterator) -> int - :module: PyOpenColorIO.GroupTransform - - - .. py:method:: TransformIterator.__next__(self: PyOpenColorIO.GroupTransform.TransformIterator) -> PyOpenColorIO.Transform - :module: PyOpenColorIO.GroupTransform - diff --git a/docs/api/python/frozen/pyopencolorio_imagedesc.rst b/docs/api/python/frozen/pyopencolorio_imagedesc.rst deleted file mode 100644 index f651298153..0000000000 --- a/docs/api/python/frozen/pyopencolorio_imagedesc.rst +++ /dev/null @@ -1,56 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: ImageDesc - :module: PyOpenColorIO - - This is a light-weight wrapper around an image, that provides a context for pixel access. This does NOT claim ownership of the pixels or copy image data. - - - .. py:method:: ImageDesc.__init__(self: PyOpenColorIO.ImageDesc) -> None - :module: PyOpenColorIO - - - .. py:method:: ImageDesc.getBitDepth(self: PyOpenColorIO.ImageDesc) -> PyOpenColorIO.BitDepth - :module: PyOpenColorIO - - Get the bit-depth. - - - .. py:method:: ImageDesc.getHeight(self: PyOpenColorIO.ImageDesc) -> int - :module: PyOpenColorIO - - Get the height to process (where y position starts at 0 and ends at height-1). - - - .. py:method:: ImageDesc.getWidth(self: PyOpenColorIO.ImageDesc) -> int - :module: PyOpenColorIO - - Get the width to process (where x position starts at 0 and ends at width-1). - - - .. py:method:: ImageDesc.getXStrideBytes(self: PyOpenColorIO.ImageDesc) -> int - :module: PyOpenColorIO - - Get the step in bytes to find the same color channel of the next pixel. - - - .. py:method:: ImageDesc.getYStrideBytes(self: PyOpenColorIO.ImageDesc) -> int - :module: PyOpenColorIO - - Get the step in bytes to find the same color channel of the pixel at the same position in the next line. - - - .. py:method:: ImageDesc.isFloat(self: PyOpenColorIO.ImageDesc) -> bool - :module: PyOpenColorIO - - Is the image buffer 32-bit float? - - - .. py:method:: ImageDesc.isRGBAPacked(self: PyOpenColorIO.ImageDesc) -> bool - :module: PyOpenColorIO - - Is the image buffer in packed mode with the 4 color channels? ("Packed" here means that XStrideBytes is 4x the bytes per channel, so it is more specific than simply any :ref:`PackedImageDesc`.) - diff --git a/docs/api/python/frozen/pyopencolorio_interpolation.rst b/docs/api/python/frozen/pyopencolorio_interpolation.rst deleted file mode 100644 index 91be18698f..0000000000 --- a/docs/api/python/frozen/pyopencolorio_interpolation.rst +++ /dev/null @@ -1,77 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: Interpolation - :module: PyOpenColorIO - - Specify the interpolation type to use If the specified interpolation type is not supported in the requested context (for example, using tetrahedral interpolationon 1D LUTs) an exception will be thrown. - - INTERP_DEFAULT will choose the default interpolation type for the requested context: - - 1D LUT INTERP_DEFAULT: LINEAR 3D LUT INTERP_DEFAULT: LINEAR - - INTERP_BEST will choose the best interpolation type for the requested context: - - 1D LUT INTERP_BEST: LINEAR 3D LUT INTERP_BEST: TETRAHEDRAL - - Note: INTERP_BEST and INTERP_DEFAULT are subject to change in minor releases, so if you care about locking off on a specific interpolation type, we'd recommend directly specifying it. - - Members: - - INTERP_UNKNOWN : - - INTERP_NEAREST : nearest neighbor - - INTERP_LINEAR : linear interpolation (trilinear for Lut3D) - - INTERP_TETRAHEDRAL : tetrahedral interpolation (Lut3D only) - - INTERP_CUBIC : cubic interpolation (not supported) - - INTERP_DEFAULT : the default interpolation type - - INTERP_BEST : the 'best' suitable interpolation type - - .. py:method:: name() -> str - :property: - - .. py:attribute:: Interpolation.INTERP_BEST - :module: PyOpenColorIO - :value: - - - .. py:attribute:: Interpolation.INTERP_CUBIC - :module: PyOpenColorIO - :value: - - - .. py:attribute:: Interpolation.INTERP_DEFAULT - :module: PyOpenColorIO - :value: - - - .. py:attribute:: Interpolation.INTERP_LINEAR - :module: PyOpenColorIO - :value: - - - .. py:attribute:: Interpolation.INTERP_NEAREST - :module: PyOpenColorIO - :value: - - - .. py:attribute:: Interpolation.INTERP_TETRAHEDRAL - :module: PyOpenColorIO - :value: - - - .. py:attribute:: Interpolation.INTERP_UNKNOWN - :module: PyOpenColorIO - :value: - - - .. py:property:: Interpolation.value - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_interpolationfromstring.rst b/docs/api/python/frozen/pyopencolorio_interpolationfromstring.rst deleted file mode 100644 index 1fb73dc038..0000000000 --- a/docs/api/python/frozen/pyopencolorio_interpolationfromstring.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: InterpolationFromString(str: str) -> PyOpenColorIO.Interpolation - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_interpolationtostring.rst b/docs/api/python/frozen/pyopencolorio_interpolationtostring.rst deleted file mode 100644 index 280e5fcb4b..0000000000 --- a/docs/api/python/frozen/pyopencolorio_interpolationtostring.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: InterpolationToString(interpolation: PyOpenColorIO.Interpolation) -> str - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_isenvvariablepresent.rst b/docs/api/python/frozen/pyopencolorio_isenvvariablepresent.rst deleted file mode 100644 index 2dbae9e715..0000000000 --- a/docs/api/python/frozen/pyopencolorio_isenvvariablepresent.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: IsEnvVariablePresent(name: str) -> bool - :module: PyOpenColorIO - - cpp:function:: - diff --git a/docs/api/python/frozen/pyopencolorio_legacyviewingpipeline.rst b/docs/api/python/frozen/pyopencolorio_legacyviewingpipeline.rst index 9b9d9e839a..e9252d94f1 100644 --- a/docs/api/python/frozen/pyopencolorio_legacyviewingpipeline.rst +++ b/docs/api/python/frozen/pyopencolorio_legacyviewingpipeline.rst @@ -5,6 +5,7 @@ .. py:class:: LegacyViewingPipeline :module: PyOpenColorIO + :canonical: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline Whereas the :ref:`DisplayViewTransform` simply applies a specific view from an OCIO display, the :ref:`LegacyViewingPipeline` provides an example of a complete viewing pipeline of the sort that could be used to implement a viewport in a typical application. It therefore adds, around the :ref:`DisplayViewTransform`, various optional color correction steps and RGBA channel view swizzling. The direction of the DisplayViewTranform is used as the direction of the pipeline. Note: The :ref:`LegacyViewingPipeline` class provides the same functionality as the OCIO v1 DisplayTransform. @@ -28,63 +29,63 @@ - Apply displayCC. Note that looks are applied even if the display transform involves data color spaces. - .. py:method:: LegacyViewingPipeline.__init__(self: PyOpenColorIO.LegacyViewingPipeline) -> None + .. py:method:: LegacyViewingPipeline.__init__(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline) -> None :module: PyOpenColorIO - .. py:method:: LegacyViewingPipeline.getChannelView(self: PyOpenColorIO.LegacyViewingPipeline) -> PyOpenColorIO.Transform + .. py:method:: LegacyViewingPipeline.getChannelView(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline) -> PyOpenColorIO.PyOpenColorIO.Transform :module: PyOpenColorIO - .. py:method:: LegacyViewingPipeline.getColorTimingCC(self: PyOpenColorIO.LegacyViewingPipeline) -> PyOpenColorIO.Transform + .. py:method:: LegacyViewingPipeline.getColorTimingCC(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline) -> PyOpenColorIO.PyOpenColorIO.Transform :module: PyOpenColorIO - .. py:method:: LegacyViewingPipeline.getDisplayCC(self: PyOpenColorIO.LegacyViewingPipeline) -> PyOpenColorIO.Transform + .. py:method:: LegacyViewingPipeline.getDisplayCC(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline) -> PyOpenColorIO.PyOpenColorIO.Transform :module: PyOpenColorIO - .. py:method:: LegacyViewingPipeline.getDisplayViewTransform(self: PyOpenColorIO.LegacyViewingPipeline) -> PyOpenColorIO.DisplayViewTransform + .. py:method:: LegacyViewingPipeline.getDisplayViewTransform(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline) -> PyOpenColorIO.PyOpenColorIO.DisplayViewTransform :module: PyOpenColorIO - .. py:method:: LegacyViewingPipeline.getLinearCC(self: PyOpenColorIO.LegacyViewingPipeline) -> PyOpenColorIO.Transform + .. py:method:: LegacyViewingPipeline.getLinearCC(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline) -> PyOpenColorIO.PyOpenColorIO.Transform :module: PyOpenColorIO - .. py:method:: LegacyViewingPipeline.getLooksOverride(self: PyOpenColorIO.LegacyViewingPipeline) -> str + .. py:method:: LegacyViewingPipeline.getLooksOverride(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline) -> str :module: PyOpenColorIO - .. py:method:: LegacyViewingPipeline.getLooksOverrideEnabled(self: PyOpenColorIO.LegacyViewingPipeline) -> bool + .. py:method:: LegacyViewingPipeline.getLooksOverrideEnabled(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline) -> bool :module: PyOpenColorIO - .. py:method:: LegacyViewingPipeline.getProcessor(self: PyOpenColorIO.LegacyViewingPipeline, config: PyOpenColorIO.Config, context: PyOpenColorIO.Context = None) -> PyOpenColorIO.Processor + .. py:method:: LegacyViewingPipeline.getProcessor(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline, config: PyOpenColorIO.PyOpenColorIO.Config, context: PyOpenColorIO.PyOpenColorIO.Context = None) -> PyOpenColorIO.PyOpenColorIO.Processor :module: PyOpenColorIO - .. py:method:: LegacyViewingPipeline.setChannelView(self: PyOpenColorIO.LegacyViewingPipeline, arg0: PyOpenColorIO.Transform) -> None + .. py:method:: LegacyViewingPipeline.setChannelView(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline, arg0: PyOpenColorIO.PyOpenColorIO.Transform) -> None :module: PyOpenColorIO - .. py:method:: LegacyViewingPipeline.setColorTimingCC(self: PyOpenColorIO.LegacyViewingPipeline, arg0: PyOpenColorIO.Transform) -> None + .. py:method:: LegacyViewingPipeline.setColorTimingCC(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline, arg0: PyOpenColorIO.PyOpenColorIO.Transform) -> None :module: PyOpenColorIO - .. py:method:: LegacyViewingPipeline.setDisplayCC(self: PyOpenColorIO.LegacyViewingPipeline, arg0: PyOpenColorIO.Transform) -> None + .. py:method:: LegacyViewingPipeline.setDisplayCC(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline, arg0: PyOpenColorIO.PyOpenColorIO.Transform) -> None :module: PyOpenColorIO - .. py:method:: LegacyViewingPipeline.setDisplayViewTransform(self: PyOpenColorIO.LegacyViewingPipeline, arg0: PyOpenColorIO.DisplayViewTransform) -> None + .. py:method:: LegacyViewingPipeline.setDisplayViewTransform(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline, arg0: PyOpenColorIO.PyOpenColorIO.DisplayViewTransform) -> None :module: PyOpenColorIO - .. py:method:: LegacyViewingPipeline.setLinearCC(self: PyOpenColorIO.LegacyViewingPipeline, arg0: PyOpenColorIO.Transform) -> None + .. py:method:: LegacyViewingPipeline.setLinearCC(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline, arg0: PyOpenColorIO.PyOpenColorIO.Transform) -> None :module: PyOpenColorIO - .. py:method:: LegacyViewingPipeline.setLooksOverride(self: PyOpenColorIO.LegacyViewingPipeline, looks: str) -> None + .. py:method:: LegacyViewingPipeline.setLooksOverride(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline, looks: str) -> None :module: PyOpenColorIO A user can optionally override the looks that are, by default, used with the expected display / view combination. A common use case for this functionality is in an image viewing app, where per-shot looks are supported. If for some reason a per-shot look is not defined for the current :ref:`Context`, the :ref:`Config::getProcessor` fcn will not succeed by default. Thus, with this mechanism the viewing app could override to looks = "", and this will allow image display to continue (though hopefully) the interface would reflect this fallback option. @@ -92,7 +93,7 @@ Looks is a potentially comma (or colon) delimited list of lookNames, where +/- prefixes are optionally allowed to denote forward/inverse look specification (and forward is assumed in the absence of either). - .. py:method:: LegacyViewingPipeline.setLooksOverrideEnabled(self: PyOpenColorIO.LegacyViewingPipeline, arg0: bool) -> None + .. py:method:: LegacyViewingPipeline.setLooksOverrideEnabled(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline, arg0: bool) -> None :module: PyOpenColorIO Specify whether the lookOverride should be used, or not. This is a separate flag, as it's often useful to override "looks" to an empty string. diff --git a/docs/api/python/frozen/pyopencolorio_logaffinetransform.rst b/docs/api/python/frozen/pyopencolorio_logaffinetransform.rst deleted file mode 100644 index 63026fa27e..0000000000 --- a/docs/api/python/frozen/pyopencolorio_logaffinetransform.rst +++ /dev/null @@ -1,95 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: LogAffineTransform - :module: PyOpenColorIO - - Applies a logarithm with an affine transform before and after. Represents the Cineon lin-to-log type transforms:: - - logSideSlope * log( linSideSlope * color + linSideOffset, base) + logSideOffset - - - Default values are: 1. * log( 1. * color + 0., 2.) + 0. - - The alpha channel is not affected. - - - .. py:method:: LogAffineTransform.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.LogAffineTransform) -> None - - 2. __init__(self: PyOpenColorIO.LogAffineTransform, logSideSlope: List[float[3]] = [1.0, 1.0, 1.0], logSideOffset: List[float[3]] = [0.0, 0.0, 0.0], linSideSlope: List[float[3]] = [1.0, 1.0, 1.0], linSideOffset: List[float[3]] = [0.0, 0.0, 0.0], direction: PyOpenColorIO.TransformDirection = ) -> None - - - .. py:method:: LogAffineTransform.equals(self: PyOpenColorIO.LogAffineTransform, other: PyOpenColorIO.LogAffineTransform) -> bool - :module: PyOpenColorIO - - Checks if this exactly equals other. - - - .. py:method:: LogAffineTransform.getBase(self: PyOpenColorIO.LogAffineTransform) -> float - :module: PyOpenColorIO - - - .. py:method:: LogAffineTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection - :module: PyOpenColorIO - - - .. py:method:: LogAffineTransform.getFormatMetadata(self: PyOpenColorIO.LogAffineTransform) -> PyOpenColorIO.FormatMetadata - :module: PyOpenColorIO - - - .. py:method:: LogAffineTransform.getLinSideOffsetValue(self: PyOpenColorIO.LogAffineTransform) -> List[float[3]] - :module: PyOpenColorIO - - - .. py:method:: LogAffineTransform.getLinSideSlopeValue(self: PyOpenColorIO.LogAffineTransform) -> List[float[3]] - :module: PyOpenColorIO - - - .. py:method:: LogAffineTransform.getLogSideOffsetValue(self: PyOpenColorIO.LogAffineTransform) -> List[float[3]] - :module: PyOpenColorIO - - - .. py:method:: LogAffineTransform.getLogSideSlopeValue(self: PyOpenColorIO.LogAffineTransform) -> List[float[3]] - :module: PyOpenColorIO - - - .. py:method:: LogAffineTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType - :module: PyOpenColorIO - - - .. py:method:: LogAffineTransform.setBase(self: PyOpenColorIO.LogAffineTransform, base: float) -> None - :module: PyOpenColorIO - - - .. py:method:: LogAffineTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None - :module: PyOpenColorIO - - Note that this only affects the evaluation and not the values stored in the object. - - - .. py:method:: LogAffineTransform.setLinSideOffsetValue(self: PyOpenColorIO.LogAffineTransform, values: List[float[3]]) -> None - :module: PyOpenColorIO - - - .. py:method:: LogAffineTransform.setLinSideSlopeValue(self: PyOpenColorIO.LogAffineTransform, values: List[float[3]]) -> None - :module: PyOpenColorIO - - - .. py:method:: LogAffineTransform.setLogSideOffsetValue(self: PyOpenColorIO.LogAffineTransform, values: List[float[3]]) -> None - :module: PyOpenColorIO - - - .. py:method:: LogAffineTransform.setLogSideSlopeValue(self: PyOpenColorIO.LogAffineTransform, values: List[float[3]]) -> None - :module: PyOpenColorIO - - - .. py:method:: LogAffineTransform.validate(self: PyOpenColorIO.Transform) -> None - :module: PyOpenColorIO - - Will throw if data is not valid. - diff --git a/docs/api/python/frozen/pyopencolorio_logcameratransform.rst b/docs/api/python/frozen/pyopencolorio_logcameratransform.rst deleted file mode 100644 index 24743f53cd..0000000000 --- a/docs/api/python/frozen/pyopencolorio_logcameratransform.rst +++ /dev/null @@ -1,125 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: LogCameraTransform - :module: PyOpenColorIO - - Same as :ref:`LogAffineTransform` but with the addition of a linear segment near black. This formula is used for many camera logs (e.g., LogC) as well as ACEScct. - - - The linSideBreak specifies the point on the linear axis where the log and linear segments meet. It must be set (there is no default). - - - The linearSlope specifies the slope of the linear segment of the forward (linToLog) transform. By default it is set equal to the slope of the log curve at the break point. - - - .. py:method:: LogCameraTransform.__init__(self: PyOpenColorIO.LogCameraTransform, linSideBreak: List[float[3]], base: float = 2.0, logSideSlope: List[float[3]] = [1.0, 1.0, 1.0], logSideOffset: List[float[3]] = [0.0, 0.0, 0.0], linSideSlope: List[float[3]] = [1.0, 1.0, 1.0], linSideOffset: List[float[3]] = [0.0, 0.0, 0.0], linearSlope: List[float] = [], direction: PyOpenColorIO.TransformDirection = ) -> None - :module: PyOpenColorIO - - LinSideBreak must be set for the transform to be valid (there is no default). - - - .. py:method:: LogCameraTransform.equals(self: PyOpenColorIO.LogCameraTransform, other: PyOpenColorIO.LogCameraTransform) -> bool - :module: PyOpenColorIO - - Checks if this exactly equals other. - - - .. py:method:: LogCameraTransform.getBase(self: PyOpenColorIO.LogCameraTransform) -> float - :module: PyOpenColorIO - - - .. py:method:: LogCameraTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection - :module: PyOpenColorIO - - - .. py:method:: LogCameraTransform.getFormatMetadata(self: PyOpenColorIO.LogCameraTransform) -> PyOpenColorIO.FormatMetadata - :module: PyOpenColorIO - - - .. py:method:: LogCameraTransform.getLinSideBreakValue(self: PyOpenColorIO.LogCameraTransform) -> List[float[3]] - :module: PyOpenColorIO - - - .. py:method:: LogCameraTransform.getLinSideOffsetValue(self: PyOpenColorIO.LogCameraTransform) -> List[float[3]] - :module: PyOpenColorIO - - - .. py:method:: LogCameraTransform.getLinSideSlopeValue(self: PyOpenColorIO.LogCameraTransform) -> List[float[3]] - :module: PyOpenColorIO - - - .. py:method:: LogCameraTransform.getLinearSlopeValue(self: PyOpenColorIO.LogCameraTransform) -> List[float[3]] - :module: PyOpenColorIO - - Return LinearSlope or 3 qnan values if not defined. - - - .. py:method:: LogCameraTransform.getLogSideOffsetValue(self: PyOpenColorIO.LogCameraTransform) -> List[float[3]] - :module: PyOpenColorIO - - - .. py:method:: LogCameraTransform.getLogSideSlopeValue(self: PyOpenColorIO.LogCameraTransform) -> List[float[3]] - :module: PyOpenColorIO - - Get/Set values for the R, G, B components. - - - .. py:method:: LogCameraTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType - :module: PyOpenColorIO - - - .. py:method:: LogCameraTransform.isLinearSlopeValueSet(self: PyOpenColorIO.LogCameraTransform) -> bool - :module: PyOpenColorIO - - - .. py:method:: LogCameraTransform.setBase(self: PyOpenColorIO.LogCameraTransform, base: float) -> None - :module: PyOpenColorIO - - - .. py:method:: LogCameraTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None - :module: PyOpenColorIO - - Note that this only affects the evaluation and not the values stored in the object. - - - .. py:method:: LogCameraTransform.setLinSideBreakValue(self: PyOpenColorIO.LogCameraTransform, values: List[float[3]]) -> None - :module: PyOpenColorIO - - - .. py:method:: LogCameraTransform.setLinSideOffsetValue(self: PyOpenColorIO.LogCameraTransform, values: List[float[3]]) -> None - :module: PyOpenColorIO - - - .. py:method:: LogCameraTransform.setLinSideSlopeValue(self: PyOpenColorIO.LogCameraTransform, values: List[float[3]]) -> None - :module: PyOpenColorIO - - - .. py:method:: LogCameraTransform.setLinearSlopeValue(self: PyOpenColorIO.LogCameraTransform, values: List[float[3]]) -> None - :module: PyOpenColorIO - - Set LinearSlope value. - - .. note:: - You must call setLinSideBreakValue before calling this. - - - .. py:method:: LogCameraTransform.setLogSideOffsetValue(self: PyOpenColorIO.LogCameraTransform, values: List[float[3]]) -> None - :module: PyOpenColorIO - - - .. py:method:: LogCameraTransform.setLogSideSlopeValue(self: PyOpenColorIO.LogCameraTransform, values: List[float[3]]) -> None - :module: PyOpenColorIO - - - .. py:method:: LogCameraTransform.unsetLinearSlopeValue(self: PyOpenColorIO.LogCameraTransform) -> None - :module: PyOpenColorIO - - Remove LinearSlope values so that default values are used. - - - .. py:method:: LogCameraTransform.validate(self: PyOpenColorIO.Transform) -> None - :module: PyOpenColorIO - - Will throw if data is not valid. - diff --git a/docs/api/python/frozen/pyopencolorio_logginglevel.rst b/docs/api/python/frozen/pyopencolorio_logginglevel.rst deleted file mode 100644 index 30c141c032..0000000000 --- a/docs/api/python/frozen/pyopencolorio_logginglevel.rst +++ /dev/null @@ -1,51 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: LoggingLevel - :module: PyOpenColorIO - - Members: - - LOGGING_LEVEL_NONE : - - LOGGING_LEVEL_WARNING : - - LOGGING_LEVEL_INFO : - - LOGGING_LEVEL_DEBUG : - - LOGGING_LEVEL_UNKNOWN : - - .. py:method:: name() -> str - :property: - - .. py:attribute:: LoggingLevel.LOGGING_LEVEL_DEBUG - :module: PyOpenColorIO - :value: - - - .. py:attribute:: LoggingLevel.LOGGING_LEVEL_INFO - :module: PyOpenColorIO - :value: - - - .. py:attribute:: LoggingLevel.LOGGING_LEVEL_NONE - :module: PyOpenColorIO - :value: - - - .. py:attribute:: LoggingLevel.LOGGING_LEVEL_UNKNOWN - :module: PyOpenColorIO - :value: - - - .. py:attribute:: LoggingLevel.LOGGING_LEVEL_WARNING - :module: PyOpenColorIO - :value: - - - .. py:property:: LoggingLevel.value - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_logginglevelfromstring.rst b/docs/api/python/frozen/pyopencolorio_logginglevelfromstring.rst deleted file mode 100644 index fce29b2821..0000000000 --- a/docs/api/python/frozen/pyopencolorio_logginglevelfromstring.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: LoggingLevelFromString(str: str) -> PyOpenColorIO.LoggingLevel - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_loggingleveltostring.rst b/docs/api/python/frozen/pyopencolorio_loggingleveltostring.rst deleted file mode 100644 index 99200cc451..0000000000 --- a/docs/api/python/frozen/pyopencolorio_loggingleveltostring.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: LoggingLevelToString(level: PyOpenColorIO.LoggingLevel) -> str - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_logmessage.rst b/docs/api/python/frozen/pyopencolorio_logmessage.rst deleted file mode 100644 index 88f54b8cfd..0000000000 --- a/docs/api/python/frozen/pyopencolorio_logmessage.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: LogMessage(level: PyOpenColorIO.LoggingLevel, message: str) -> None - :module: PyOpenColorIO - - Log a message using the library logging function. - diff --git a/docs/api/python/frozen/pyopencolorio_logtransform.rst b/docs/api/python/frozen/pyopencolorio_logtransform.rst deleted file mode 100644 index 37450ca799..0000000000 --- a/docs/api/python/frozen/pyopencolorio_logtransform.rst +++ /dev/null @@ -1,62 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: LogTransform - :module: PyOpenColorIO - - Represents log transform: log(color, base) - - - The input will be clamped for negative numbers. - - Default base is 2.0. - - The alpha channel is not affected. - - - .. py:method:: LogTransform.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.LogTransform) -> None - - 2. __init__(self: PyOpenColorIO.LogTransform, base: float = 2.0, direction: PyOpenColorIO.TransformDirection = ) -> None - - - .. py:method:: LogTransform.equals(self: PyOpenColorIO.LogTransform, other: PyOpenColorIO.LogTransform) -> bool - :module: PyOpenColorIO - - Checks if this exactly equals other. - - - .. py:method:: LogTransform.getBase(self: PyOpenColorIO.LogTransform) -> float - :module: PyOpenColorIO - - - .. py:method:: LogTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection - :module: PyOpenColorIO - - - .. py:method:: LogTransform.getFormatMetadata(self: PyOpenColorIO.LogTransform) -> PyOpenColorIO.FormatMetadata - :module: PyOpenColorIO - - - .. py:method:: LogTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType - :module: PyOpenColorIO - - - .. py:method:: LogTransform.setBase(self: PyOpenColorIO.LogTransform, base: float) -> None - :module: PyOpenColorIO - - - .. py:method:: LogTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None - :module: PyOpenColorIO - - Note that this only affects the evaluation and not the values stored in the object. - - - .. py:method:: LogTransform.validate(self: PyOpenColorIO.Transform) -> None - :module: PyOpenColorIO - - Will throw if data is not valid. - diff --git a/docs/api/python/frozen/pyopencolorio_look.rst b/docs/api/python/frozen/pyopencolorio_look.rst deleted file mode 100644 index 395cc8e268..0000000000 --- a/docs/api/python/frozen/pyopencolorio_look.rst +++ /dev/null @@ -1,64 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: Look - :module: PyOpenColorIO - - The *:ref:`Look`* is an 'artistic' image modification, in a specified image state. The processSpace defines the :ref:`ColorSpace` the image is required to be in, for the math to apply correctly. - - - .. py:method:: Look.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.Look) -> None - - 2. __init__(self: PyOpenColorIO.Look, name: str = '', processSpace: str = '', transform: PyOpenColorIO.Transform = None, inverseTransform: PyOpenColorIO.Transform = None, description: str = '') -> None - - - .. py:method:: Look.getDescription(self: PyOpenColorIO.Look) -> str - :module: PyOpenColorIO - - - .. py:method:: Look.getInverseTransform(self: PyOpenColorIO.Look) -> PyOpenColorIO.Transform - :module: PyOpenColorIO - - - .. py:method:: Look.getName(self: PyOpenColorIO.Look) -> str - :module: PyOpenColorIO - - - .. py:method:: Look.getProcessSpace(self: PyOpenColorIO.Look) -> str - :module: PyOpenColorIO - - - .. py:method:: Look.getTransform(self: PyOpenColorIO.Look) -> PyOpenColorIO.Transform - :module: PyOpenColorIO - - - .. py:method:: Look.setDescription(self: PyOpenColorIO.Look, description: str) -> None - :module: PyOpenColorIO - - - .. py:method:: Look.setInverseTransform(self: PyOpenColorIO.Look, transform: PyOpenColorIO.Transform) -> None - :module: PyOpenColorIO - - Setting a transform to a non-null call makes it allowed. - - - .. py:method:: Look.setName(self: PyOpenColorIO.Look, name: str) -> None - :module: PyOpenColorIO - - - .. py:method:: Look.setProcessSpace(self: PyOpenColorIO.Look, processSpace: str) -> None - :module: PyOpenColorIO - - - .. py:method:: Look.setTransform(self: PyOpenColorIO.Look, transform: PyOpenColorIO.Transform) -> None - :module: PyOpenColorIO - - Setting a transform to a non-null call makes it allowed. - diff --git a/docs/api/python/frozen/pyopencolorio_looktransform.rst b/docs/api/python/frozen/pyopencolorio_looktransform.rst deleted file mode 100644 index 7d7347b09c..0000000000 --- a/docs/api/python/frozen/pyopencolorio_looktransform.rst +++ /dev/null @@ -1,72 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: LookTransform - :module: PyOpenColorIO - - - .. py:method:: LookTransform.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.LookTransform) -> None - - 2. __init__(self: PyOpenColorIO.LookTransform, src: str, dst: str, looks: str = '', skipColorSpaceConversion: bool = False, direction: PyOpenColorIO.TransformDirection = ) -> None - - - .. py:method:: LookTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection - :module: PyOpenColorIO - - - .. py:method:: LookTransform.getDst(self: PyOpenColorIO.LookTransform) -> str - :module: PyOpenColorIO - - - .. py:method:: LookTransform.getLooks(self: PyOpenColorIO.LookTransform) -> str - :module: PyOpenColorIO - - - .. py:method:: LookTransform.getSkipColorSpaceConversion(self: PyOpenColorIO.LookTransform) -> bool - :module: PyOpenColorIO - - - .. py:method:: LookTransform.getSrc(self: PyOpenColorIO.LookTransform) -> str - :module: PyOpenColorIO - - - .. py:method:: LookTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType - :module: PyOpenColorIO - - - .. py:method:: LookTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None - :module: PyOpenColorIO - - Note that this only affects the evaluation and not the values stored in the object. - - - .. py:method:: LookTransform.setDst(self: PyOpenColorIO.LookTransform, dst: str) -> None - :module: PyOpenColorIO - - - .. py:method:: LookTransform.setLooks(self: PyOpenColorIO.LookTransform, looks: str) -> None - :module: PyOpenColorIO - - Specify looks to apply. Looks is a potentially comma (or colon) delimited list of look names, Where +/- prefixes are optionally allowed to denote forward/inverse look specification. (And forward is assumed in the absence of either) - - - .. py:method:: LookTransform.setSkipColorSpaceConversion(self: PyOpenColorIO.LookTransform, skipColorSpaceConversion: bool) -> None - :module: PyOpenColorIO - - - .. py:method:: LookTransform.setSrc(self: PyOpenColorIO.LookTransform, src: str) -> None - :module: PyOpenColorIO - - - .. py:method:: LookTransform.validate(self: PyOpenColorIO.Transform) -> None - :module: PyOpenColorIO - - Will throw if data is not valid. - diff --git a/docs/api/python/frozen/pyopencolorio_lut1dhueadjust.rst b/docs/api/python/frozen/pyopencolorio_lut1dhueadjust.rst deleted file mode 100644 index 05cdece8c9..0000000000 --- a/docs/api/python/frozen/pyopencolorio_lut1dhueadjust.rst +++ /dev/null @@ -1,39 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: Lut1DHueAdjust - :module: PyOpenColorIO - - Used by :cpp:class`:ref:`Lut1DTransform`` to control optional hue restoration algorithm. - - Members: - - HUE_NONE : No adjustment. - - HUE_DW3 : Algorithm used in ACES Output Transforms through v0.7. - - HUE_WYPN : Weighted Yellow Power Norm -- NOT IMPLEMENTED YET. - - .. py:method:: name() -> str - :property: - - .. py:attribute:: Lut1DHueAdjust.HUE_DW3 - :module: PyOpenColorIO - :value: - - - .. py:attribute:: Lut1DHueAdjust.HUE_NONE - :module: PyOpenColorIO - :value: - - - .. py:attribute:: Lut1DHueAdjust.HUE_WYPN - :module: PyOpenColorIO - :value: - - - .. py:property:: Lut1DHueAdjust.value - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_lut1dtransform.rst b/docs/api/python/frozen/pyopencolorio_lut1dtransform.rst deleted file mode 100644 index d30e448b88..0000000000 --- a/docs/api/python/frozen/pyopencolorio_lut1dtransform.rst +++ /dev/null @@ -1,140 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: Lut1DTransform - :module: PyOpenColorIO - - Represents a 1D-LUT transform. - - - .. py:method:: Lut1DTransform.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.Lut1DTransform) -> None - - Create an identity 1D-LUT of length two. - - 2. __init__(self: PyOpenColorIO.Lut1DTransform, length: int, inputHalfDomain: bool) -> None - - Create an identity 1D-LUT with specific length and half-domain setting. Will throw for lengths longer than 1024x1024. - - 3. __init__(self: PyOpenColorIO.Lut1DTransform, length: int = 2, inputHalfDomain: bool = False, outputRawHalfs: bool = False, fileOutputBitDepth: PyOpenColorIO.BitDepth = , hueAdjust: PyOpenColorIO.Lut1DHueAdjust = , interpolation: PyOpenColorIO.Interpolation = , direction: PyOpenColorIO.TransformDirection = ) -> None - - Create an identity 1D-LUT with specific length and half-domain setting. Will throw for lengths longer than 1024x1024. - - - .. py:method:: Lut1DTransform.equals(self: PyOpenColorIO.Lut1DTransform, other: PyOpenColorIO.Lut1DTransform) -> bool - :module: PyOpenColorIO - - Checks if this exactly equals other. - - - .. py:method:: Lut1DTransform.getData(self: PyOpenColorIO.Lut1DTransform) -> numpy.ndarray - :module: PyOpenColorIO - - - .. py:method:: Lut1DTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection - :module: PyOpenColorIO - - - .. py:method:: Lut1DTransform.getFileOutputBitDepth(self: PyOpenColorIO.Lut1DTransform) -> PyOpenColorIO.BitDepth - :module: PyOpenColorIO - - - .. py:method:: Lut1DTransform.getFormatMetadata(self: PyOpenColorIO.Lut1DTransform) -> PyOpenColorIO.FormatMetadata - :module: PyOpenColorIO - - - .. py:method:: Lut1DTransform.getHueAdjust(self: PyOpenColorIO.Lut1DTransform) -> PyOpenColorIO.Lut1DHueAdjust - :module: PyOpenColorIO - - - .. py:method:: Lut1DTransform.getInputHalfDomain(self: PyOpenColorIO.Lut1DTransform) -> bool - :module: PyOpenColorIO - - - .. py:method:: Lut1DTransform.getInterpolation(self: PyOpenColorIO.Lut1DTransform) -> PyOpenColorIO.Interpolation - :module: PyOpenColorIO - - - .. py:method:: Lut1DTransform.getLength(self: PyOpenColorIO.Lut1DTransform) -> int - :module: PyOpenColorIO - - - .. py:method:: Lut1DTransform.getOutputRawHalfs(self: PyOpenColorIO.Lut1DTransform) -> bool - :module: PyOpenColorIO - - - .. py:method:: Lut1DTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType - :module: PyOpenColorIO - - - .. py:method:: Lut1DTransform.getValue(self: PyOpenColorIO.Lut1DTransform, index: int) -> tuple - :module: PyOpenColorIO - - - .. py:method:: Lut1DTransform.setData(self: PyOpenColorIO.Lut1DTransform, data: buffer) -> None - :module: PyOpenColorIO - - - .. py:method:: Lut1DTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None - :module: PyOpenColorIO - - Note that this only affects the evaluation and not the values stored in the object. - - - .. py:method:: Lut1DTransform.setFileOutputBitDepth(self: PyOpenColorIO.Lut1DTransform, bitDepth: PyOpenColorIO.BitDepth) -> None - :module: PyOpenColorIO - - Get the bit-depth associated with the LUT values read from a file or set the bit-depth of values to be written to a file (for file formats such as CLF that support multiple bit-depths). However, note that the values stored in the object are always normalized. - - - .. py:method:: Lut1DTransform.setHueAdjust(self: PyOpenColorIO.Lut1DTransform, hueAdjust: PyOpenColorIO.Lut1DHueAdjust) -> None - :module: PyOpenColorIO - - The 1D-LUT transform optionally supports a hue adjustment feature that was used in some versions of ACES. This adjusts the hue of the result to approximately match the input. - - - .. py:method:: Lut1DTransform.setInputHalfDomain(self: PyOpenColorIO.Lut1DTransform, isHalfDomain: bool) -> None - :module: PyOpenColorIO - - In a half-domain LUT, the contents of the LUT specify the desired value of the function for each half-float value. Therefore, the length of the LUT must be 65536 entries or else :ref:`validate()` will throw. - - - .. py:method:: Lut1DTransform.setInterpolation(self: PyOpenColorIO.Lut1DTransform, interpolation: PyOpenColorIO.Interpolation) -> None - :module: PyOpenColorIO - - - .. py:method:: Lut1DTransform.setLength(self: PyOpenColorIO.Lut1DTransform, length: int) -> None - :module: PyOpenColorIO - - Changing the length will reset the LUT to identity. Will throw for lengths longer than 1024x1024. - - - .. py:method:: Lut1DTransform.setOutputRawHalfs(self: PyOpenColorIO.Lut1DTransform, isRawHalfs: bool) -> None - :module: PyOpenColorIO - - Set OutputRawHalfs to true if you want to output the LUT contents as 16-bit floating point values expressed as unsigned 16-bit integers representing the equivalent bit pattern. For example, the value 1.0 would be written as the integer 15360 because it has the same bit-pattern. Note that this implies the values will be quantized to a 16-bit float. Note that this setting only controls the output formatting (where supported) and not the values for getValue/setValue. The only file formats that currently support this are CLF and CTF. - - - .. py:method:: Lut1DTransform.setValue(self: PyOpenColorIO.Lut1DTransform, index: int, r: float, g: float, b: float) -> None - :module: PyOpenColorIO - - Set the values of a LUT1D. Will throw if the index is outside of the range from 0 to (length-1). - - The LUT values are always for the "forward" LUT, regardless of how the transform direction is set. - - These values are normalized relative to what may be stored in any given LUT files. For example in a CLF file using a "10i" output depth, a value of 1023 in the file is normalized to 1.0. The values here are unclamped and may extend outside [0,1]. - - LUTs in various file formats may only provide values for one channel where R, G, B are the same. Even in that case, you should provide three equal values to the setter. - - - .. py:method:: Lut1DTransform.validate(self: PyOpenColorIO.Transform) -> None - :module: PyOpenColorIO - - Will throw if data is not valid. - diff --git a/docs/api/python/frozen/pyopencolorio_lut3dtransform.rst b/docs/api/python/frozen/pyopencolorio_lut3dtransform.rst deleted file mode 100644 index c0deb63b1e..0000000000 --- a/docs/api/python/frozen/pyopencolorio_lut3dtransform.rst +++ /dev/null @@ -1,108 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: Lut3DTransform - :module: PyOpenColorIO - - Represents a 3D-LUT transform. - - - .. py:method:: Lut3DTransform.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.Lut3DTransform) -> None - - Create an identity 3D-LUT of size 2x2x2. - - 2. __init__(self: PyOpenColorIO.Lut3DTransform, gridSize: int) -> None - - Create an identity 3D-LUT with specific grid size. Will throw for grid size larger than 129. - - 3. __init__(self: PyOpenColorIO.Lut3DTransform, gridSize: int = 2, fileOutputBitDepth: PyOpenColorIO.BitDepth = , interpolation: PyOpenColorIO.Interpolation = , direction: PyOpenColorIO.TransformDirection = ) -> None - - Create an identity 3D-LUT with specific grid size. Will throw for grid size larger than 129. - - - .. py:method:: Lut3DTransform.equals(self: PyOpenColorIO.Lut3DTransform, other: PyOpenColorIO.Lut3DTransform) -> bool - :module: PyOpenColorIO - - Checks if this exactly equals other. - - - .. py:method:: Lut3DTransform.getData(self: PyOpenColorIO.Lut3DTransform) -> numpy.ndarray - :module: PyOpenColorIO - - - .. py:method:: Lut3DTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection - :module: PyOpenColorIO - - - .. py:method:: Lut3DTransform.getFileOutputBitDepth(self: PyOpenColorIO.Lut3DTransform) -> PyOpenColorIO.BitDepth - :module: PyOpenColorIO - - - .. py:method:: Lut3DTransform.getFormatMetadata(self: PyOpenColorIO.Lut3DTransform) -> PyOpenColorIO.FormatMetadata - :module: PyOpenColorIO - - - .. py:method:: Lut3DTransform.getGridSize(self: PyOpenColorIO.Lut3DTransform) -> int - :module: PyOpenColorIO - - - .. py:method:: Lut3DTransform.getInterpolation(self: PyOpenColorIO.Lut3DTransform) -> PyOpenColorIO.Interpolation - :module: PyOpenColorIO - - - .. py:method:: Lut3DTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType - :module: PyOpenColorIO - - - .. py:method:: Lut3DTransform.getValue(self: PyOpenColorIO.Lut3DTransform, indexR: int, indexG: int, indexB: int) -> tuple - :module: PyOpenColorIO - - - .. py:method:: Lut3DTransform.setData(self: PyOpenColorIO.Lut3DTransform, data: buffer) -> None - :module: PyOpenColorIO - - - .. py:method:: Lut3DTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None - :module: PyOpenColorIO - - Note that this only affects the evaluation and not the values stored in the object. - - - .. py:method:: Lut3DTransform.setFileOutputBitDepth(self: PyOpenColorIO.Lut3DTransform, bitDepth: PyOpenColorIO.BitDepth) -> None - :module: PyOpenColorIO - - Get the bit-depth associated with the LUT values read from a file or set the bit-depth of values to be written to a file (for file formats such as CLF that support multiple bit-depths). However, note that the values stored in the object are always normalized. - - - .. py:method:: Lut3DTransform.setGridSize(self: PyOpenColorIO.Lut3DTransform, gridSize: int) -> None - :module: PyOpenColorIO - - Changing the grid size will reset the LUT to identity. Will throw for grid sizes larger than 129. - - - .. py:method:: Lut3DTransform.setInterpolation(self: PyOpenColorIO.Lut3DTransform, interpolation: PyOpenColorIO.Interpolation) -> None - :module: PyOpenColorIO - - - .. py:method:: Lut3DTransform.setValue(self: PyOpenColorIO.Lut3DTransform, indexR: int, indexG: int, indexB: int, r: float, g: float, b: float) -> None - :module: PyOpenColorIO - - Set the values of a 3D-LUT. Will throw if an index is outside of the range from 0 to (gridSize-1). - - The LUT values are always for the "forward" LUT, regardless of how the transform direction is set. - - These values are normalized relative to what may be stored in any given LUT files. For example in a CLF file using a "10i" output depth, a value of 1023 in the file is normalized to 1.0. The values here are unclamped and may extend outside [0,1]. - - - .. py:method:: Lut3DTransform.validate(self: PyOpenColorIO.Transform) -> None - :module: PyOpenColorIO - - Will throw if data is not valid. - diff --git a/docs/api/python/frozen/pyopencolorio_matrixtransform.rst b/docs/api/python/frozen/pyopencolorio_matrixtransform.rst deleted file mode 100644 index 804069f7b9..0000000000 --- a/docs/api/python/frozen/pyopencolorio_matrixtransform.rst +++ /dev/null @@ -1,131 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: MatrixTransform - :module: PyOpenColorIO - - Represents an MX+B Matrix transform. - - .. note:: - For singular matrices, an inverse direction will throw an exception during finalization. - - - .. py:method:: MatrixTransform.Fit(oldMin: List[float[4]] = [0.0, 0.0, 0.0, 0.0], oldMax: List[float[4]] = [1.0, 1.0, 1.0, 1.0], newMin: List[float[4]] = [0.0, 0.0, 0.0, 0.0], newMax: List[float[4]] = [1.0, 1.0, 1.0, 1.0]) -> PyOpenColorIO.MatrixTransform - :module: PyOpenColorIO - :staticmethod: - - **Convenience functions** - - Build the matrix and offset corresponding to higher-level concepts. - - .. note:: - These can throw an exception if for any component `oldmin == oldmax. (divide by 0)` - - - .. py:method:: MatrixTransform.Identity() -> PyOpenColorIO.MatrixTransform - :module: PyOpenColorIO - :staticmethod: - - - .. py:method:: MatrixTransform.Sat(sat: float, lumaCoef: List[float[3]]) -> PyOpenColorIO.MatrixTransform - :module: PyOpenColorIO - :staticmethod: - - - .. py:method:: MatrixTransform.Scale(scale: List[float[4]]) -> PyOpenColorIO.MatrixTransform - :module: PyOpenColorIO - :staticmethod: - - - .. py:method:: MatrixTransform.View(channelHot: List[int[4]], lumaCoef: List[float[3]]) -> PyOpenColorIO.MatrixTransform - :module: PyOpenColorIO - :staticmethod: - - - .. py:method:: MatrixTransform.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.MatrixTransform) -> None - - 2. __init__(self: PyOpenColorIO.MatrixTransform, matrix: List[float[16]] = [1.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 1.0], offset: List[float[4]] = [0.0, 0.0, 0.0, 0.0], direction: PyOpenColorIO.TransformDirection = ) -> None - - - .. py:method:: MatrixTransform.equals(self: PyOpenColorIO.MatrixTransform, other: PyOpenColorIO.MatrixTransform) -> bool - :module: PyOpenColorIO - - Checks if this exactly equals other. - - - .. py:method:: MatrixTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection - :module: PyOpenColorIO - - - .. py:method:: MatrixTransform.getFileInputBitDepth(self: PyOpenColorIO.MatrixTransform) -> PyOpenColorIO.BitDepth - :module: PyOpenColorIO - - Get the bit-depths associated with the matrix values read from a file or set the bit-depths of values to be written to a file (for file formats such as CLF that support multiple bit-depths). - - In a format such as CLF, the matrix values are scaled to take pixels at the specified inBitDepth to pixels at the specified outBitDepth. This complicates the interpretation of the matrix values and so this object always holds normalized values and scaling is done on the way from or to file formats such as CLF. - - - .. py:method:: MatrixTransform.getFileOutputBitDepth(self: PyOpenColorIO.MatrixTransform) -> PyOpenColorIO.BitDepth - :module: PyOpenColorIO - - - .. py:method:: MatrixTransform.getFormatMetadata(self: PyOpenColorIO.MatrixTransform) -> PyOpenColorIO.FormatMetadata - :module: PyOpenColorIO - - - .. py:method:: MatrixTransform.getMatrix(self: PyOpenColorIO.MatrixTransform) -> List[float[16]] - :module: PyOpenColorIO - - - .. py:method:: MatrixTransform.getOffset(self: PyOpenColorIO.MatrixTransform) -> List[float[4]] - :module: PyOpenColorIO - - - .. py:method:: MatrixTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType - :module: PyOpenColorIO - - - .. py:method:: MatrixTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None - :module: PyOpenColorIO - - Note that this only affects the evaluation and not the values stored in the object. - - - .. py:method:: MatrixTransform.setFileInputBitDepth(self: PyOpenColorIO.MatrixTransform, bitDepth: PyOpenColorIO.BitDepth) -> None - :module: PyOpenColorIO - - - .. py:method:: MatrixTransform.setFileOutputBitDepth(self: PyOpenColorIO.MatrixTransform, bitDepth: PyOpenColorIO.BitDepth) -> None - :module: PyOpenColorIO - - - .. py:method:: MatrixTransform.setMatrix(self: PyOpenColorIO.MatrixTransform, matrix: List[float[16]]) -> None - :module: PyOpenColorIO - - Get or set the values of a Matrix. Expects 16 values, where the first four are the coefficients to generate the R output channel from R, G, B, A input channels. - - The Matrix values are always for the "forward" Matrix, regardless of how the transform direction is set. - - These values are normalized relative to what may be stored in file formats such as CLF. For example in a CLF file using a "32f" input depth and "10i" output depth, a value of 1023 in the file is normalized to 1.0. The values here are unclamped and may extend outside [0,1]. - - - .. py:method:: MatrixTransform.setOffset(self: PyOpenColorIO.MatrixTransform, offset: List[float[4]]) -> None - :module: PyOpenColorIO - - Get or set the R, G, B, A offsets to be applied after the matrix. - - These values are normalized relative to what may be stored in file formats such as CLF. For example, in a CLF file using a "10i" output depth, a value of 1023 in the file is normalized to 1.0. The values here are unclamped and may extend outside [0,1]. - - - .. py:method:: MatrixTransform.validate(self: PyOpenColorIO.Transform) -> None - :module: PyOpenColorIO - - Will throw if data is not valid. - diff --git a/docs/api/python/frozen/pyopencolorio_mixingcolorspacemanager.rst b/docs/api/python/frozen/pyopencolorio_mixingcolorspacemanager.rst index c867dae900..8f7fe7ca98 100644 --- a/docs/api/python/frozen/pyopencolorio_mixingcolorspacemanager.rst +++ b/docs/api/python/frozen/pyopencolorio_mixingcolorspacemanager.rst @@ -5,31 +5,32 @@ .. py:class:: MixingColorSpaceManager :module: PyOpenColorIO + :canonical: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager Used to mix (or pick/choose) colors. - .. py:method:: MixingColorSpaceManager.__init__(self: PyOpenColorIO.MixingColorSpaceManager, config: PyOpenColorIO.Config) -> None + .. py:method:: MixingColorSpaceManager.__init__(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager, config: PyOpenColorIO.PyOpenColorIO.Config) -> None :module: PyOpenColorIO - .. py:method:: MixingColorSpaceManager.getMixingEncodings(self: PyOpenColorIO.MixingColorSpaceManager) -> PyOpenColorIO.MixingColorSpaceManager.MixingEncodingIterator + .. py:method:: MixingColorSpaceManager.getMixingEncodings(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager) -> PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager.MixingEncodingIterator :module: PyOpenColorIO - .. py:method:: MixingColorSpaceManager.getMixingSpaces(self: PyOpenColorIO.MixingColorSpaceManager) -> PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator + .. py:method:: MixingColorSpaceManager.getMixingSpaces(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager) -> PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator :module: PyOpenColorIO - .. py:method:: MixingColorSpaceManager.getProcessor(self: PyOpenColorIO.MixingColorSpaceManager, workingSpaceName: str, displayName: str, viewName: str, direction: PyOpenColorIO.TransformDirection = ) -> PyOpenColorIO.Processor + .. py:method:: MixingColorSpaceManager.getProcessor(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager, workingSpaceName: str, displayName: str, viewName: str, direction: PyOpenColorIO.PyOpenColorIO.TransformDirection = ) -> PyOpenColorIO.PyOpenColorIO.Processor :module: PyOpenColorIO - .. py:method:: MixingColorSpaceManager.getSelectedMixingEncodingIdx(self: PyOpenColorIO.MixingColorSpaceManager) -> int + .. py:method:: MixingColorSpaceManager.getSelectedMixingEncodingIdx(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager) -> int :module: PyOpenColorIO - .. py:method:: MixingColorSpaceManager.getSelectedMixingSpaceIdx(self: PyOpenColorIO.MixingColorSpaceManager) -> int + .. py:method:: MixingColorSpaceManager.getSelectedMixingSpaceIdx(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager) -> int :module: PyOpenColorIO @@ -38,73 +39,75 @@ Overloaded function. - 1. getSlider(self: PyOpenColorIO.MixingColorSpaceManager) -> PyOpenColorIO.MixingSlider + 1. getSlider(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager) -> PyOpenColorIO.PyOpenColorIO.MixingSlider - 2. getSlider(self: PyOpenColorIO.MixingColorSpaceManager, sliderMixingMinEdge: float, sliderMixingMaxEdge: float) -> PyOpenColorIO.MixingSlider + 2. getSlider(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager, sliderMixingMinEdge: float, sliderMixingMaxEdge: float) -> PyOpenColorIO.PyOpenColorIO.MixingSlider - .. py:method:: MixingColorSpaceManager.isPerceptuallyUniform(self: PyOpenColorIO.MixingColorSpaceManager) -> bool + .. py:method:: MixingColorSpaceManager.isPerceptuallyUniform(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager) -> bool :module: PyOpenColorIO - .. py:method:: MixingColorSpaceManager.refresh(self: PyOpenColorIO.MixingColorSpaceManager, config: PyOpenColorIO.Config) -> None + .. py:method:: MixingColorSpaceManager.refresh(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager, config: PyOpenColorIO.PyOpenColorIO.Config) -> None :module: PyOpenColorIO Refresh the instance (i.e. needed following a configuration change for example). - .. py:method:: MixingColorSpaceManager.setSelectedMixingEncoding(self: PyOpenColorIO.MixingColorSpaceManager, mixingEncoding: str) -> None + .. py:method:: MixingColorSpaceManager.setSelectedMixingEncoding(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager, mixingEncoding: str) -> None :module: PyOpenColorIO - .. py:method:: MixingColorSpaceManager.setSelectedMixingEncodingIdx(self: PyOpenColorIO.MixingColorSpaceManager, arg0: int) -> None + .. py:method:: MixingColorSpaceManager.setSelectedMixingEncodingIdx(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager, arg0: int) -> None :module: PyOpenColorIO - .. py:method:: MixingColorSpaceManager.setSelectedMixingSpace(self: PyOpenColorIO.MixingColorSpaceManager, mixingSpace: str) -> None + .. py:method:: MixingColorSpaceManager.setSelectedMixingSpace(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager, mixingSpace: str) -> None :module: PyOpenColorIO - .. py:method:: MixingColorSpaceManager.setSelectedMixingSpaceIdx(self: PyOpenColorIO.MixingColorSpaceManager, arg0: int) -> None + .. py:method:: MixingColorSpaceManager.setSelectedMixingSpaceIdx(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager, arg0: int) -> None :module: PyOpenColorIO .. py:class:: MixingSpaceIterator :module: PyOpenColorIO.MixingColorSpaceManager + :canonical: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator - .. py:method:: MixingSpaceIterator.__getitem__(self: PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator, arg0: int) -> str + .. py:method:: MixingSpaceIterator.__getitem__(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator, arg0: int) -> str :module: PyOpenColorIO.MixingColorSpaceManager - .. py:method:: MixingSpaceIterator.__iter__(self: PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator) -> PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator + .. py:method:: MixingSpaceIterator.__iter__(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator) -> PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator :module: PyOpenColorIO.MixingColorSpaceManager - .. py:method:: MixingSpaceIterator.__len__(self: PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator) -> int + .. py:method:: MixingSpaceIterator.__len__(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator) -> int :module: PyOpenColorIO.MixingColorSpaceManager - .. py:method:: MixingSpaceIterator.__next__(self: PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator) -> str + .. py:method:: MixingSpaceIterator.__next__(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator) -> str :module: PyOpenColorIO.MixingColorSpaceManager .. py:class:: MixingEncodingIterator :module: PyOpenColorIO.MixingColorSpaceManager + :canonical: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager.MixingEncodingIterator - .. py:method:: MixingEncodingIterator.__getitem__(self: PyOpenColorIO.MixingColorSpaceManager.MixingEncodingIterator, arg0: int) -> str + .. py:method:: MixingEncodingIterator.__getitem__(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager.MixingEncodingIterator, arg0: int) -> str :module: PyOpenColorIO.MixingColorSpaceManager - .. py:method:: MixingEncodingIterator.__iter__(self: PyOpenColorIO.MixingColorSpaceManager.MixingEncodingIterator) -> PyOpenColorIO.MixingColorSpaceManager.MixingEncodingIterator + .. py:method:: MixingEncodingIterator.__iter__(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager.MixingEncodingIterator) -> PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager.MixingEncodingIterator :module: PyOpenColorIO.MixingColorSpaceManager - .. py:method:: MixingEncodingIterator.__len__(self: PyOpenColorIO.MixingColorSpaceManager.MixingEncodingIterator) -> int + .. py:method:: MixingEncodingIterator.__len__(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager.MixingEncodingIterator) -> int :module: PyOpenColorIO.MixingColorSpaceManager - .. py:method:: MixingEncodingIterator.__next__(self: PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator) -> str + .. py:method:: MixingEncodingIterator.__next__(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator) -> str :module: PyOpenColorIO.MixingColorSpaceManager diff --git a/docs/api/python/frozen/pyopencolorio_mixingslider.rst b/docs/api/python/frozen/pyopencolorio_mixingslider.rst index 4c7c09cc8c..e9537518ea 100644 --- a/docs/api/python/frozen/pyopencolorio_mixingslider.rst +++ b/docs/api/python/frozen/pyopencolorio_mixingslider.rst @@ -5,6 +5,7 @@ .. py:class:: MixingSlider :module: PyOpenColorIO + :canonical: PyOpenColorIO.PyOpenColorIO.MixingSlider The :ref:`MixingSlider` and :ref:`MixingColorSpaceManager` classes are to help applications implement correct color pickers. The term "color mixing" is used here to describe what is done in a typical application "color picker" user interface. @@ -21,37 +22,37 @@ :module: PyOpenColorIO - .. py:method:: MixingSlider.getSliderMaxEdge(self: PyOpenColorIO.MixingSlider) -> float + .. py:method:: MixingSlider.getSliderMaxEdge(self: PyOpenColorIO.PyOpenColorIO.MixingSlider) -> float :module: PyOpenColorIO Maximum edge of a UI slider for conversion to mixing space. - .. py:method:: MixingSlider.getSliderMinEdge(self: PyOpenColorIO.MixingSlider) -> float + .. py:method:: MixingSlider.getSliderMinEdge(self: PyOpenColorIO.PyOpenColorIO.MixingSlider) -> float :module: PyOpenColorIO Minimum edge of a UI slider for conversion to mixing space. - .. py:method:: MixingSlider.mixingToSlider(self: PyOpenColorIO.MixingSlider, mixingUnits: float) -> float + .. py:method:: MixingSlider.mixingToSlider(self: PyOpenColorIO.PyOpenColorIO.MixingSlider, mixingUnits: float) -> float :module: PyOpenColorIO Convert from mixing space units to distance along the slider. - .. py:method:: MixingSlider.setSliderMaxEdge(self: PyOpenColorIO.MixingSlider, arg0: float) -> None + .. py:method:: MixingSlider.setSliderMaxEdge(self: PyOpenColorIO.PyOpenColorIO.MixingSlider, arg0: float) -> None :module: PyOpenColorIO Set the maximum edge of a UI slider for conversion to mixing space. - .. py:method:: MixingSlider.setSliderMinEdge(self: PyOpenColorIO.MixingSlider, arg0: float) -> None + .. py:method:: MixingSlider.setSliderMinEdge(self: PyOpenColorIO.PyOpenColorIO.MixingSlider, arg0: float) -> None :module: PyOpenColorIO Set the minimum edge of a UI slider for conversion to mixing space. - .. py:method:: MixingSlider.sliderToMixing(self: PyOpenColorIO.MixingSlider, sliderUnits: float) -> float + .. py:method:: MixingSlider.sliderToMixing(self: PyOpenColorIO.PyOpenColorIO.MixingSlider, sliderUnits: float) -> float :module: PyOpenColorIO Convert from units in distance along the slider to mixing space units. diff --git a/docs/api/python/frozen/pyopencolorio_namedtransform.rst b/docs/api/python/frozen/pyopencolorio_namedtransform.rst deleted file mode 100644 index 3a0a7630e5..0000000000 --- a/docs/api/python/frozen/pyopencolorio_namedtransform.rst +++ /dev/null @@ -1,158 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: NamedTransform - :module: PyOpenColorIO - - :ref:`NamedTransform`. - - A :ref:`NamedTransform` provides a way for config authors to include a set of color transforms that are independent of the color space being processed. For example a "utility - curve" transform where there is no need to convert to or from a reference space. - - - .. py:method:: NamedTransform.GetTransform(transform: PyOpenColorIO.NamedTransform, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Transform - :module: PyOpenColorIO - :staticmethod: - - Get the requested transform, creating the transform from the inverse direction if the transform for the requested direction is missing. - - - .. py:class:: NamedTransform.NamedTransformAliasIterator - :module: PyOpenColorIO - - - .. py:method:: NamedTransform.NamedTransformAliasIterator.__init__(*args, **kwargs) - :module: PyOpenColorIO - - - .. py:method:: NamedTransform.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.NamedTransform) -> None - - 2. __init__(self: PyOpenColorIO.NamedTransform, name: str = '', aliases: List[str] = [], family: str = '', description: str = '', forwardTransform: PyOpenColorIO.Transform = None, inverseTransform: PyOpenColorIO.Transform = None, categories: List[str] = []) -> None - - - .. py:method:: NamedTransform.addAlias(self: PyOpenColorIO.NamedTransform, alias: str) -> None - :module: PyOpenColorIO - - Nothing is done if alias is NULL or empty, if it is already there, or if it is already the named transform name. - - - .. py:method:: NamedTransform.addCategory(self: PyOpenColorIO.NamedTransform, category: str) -> None - :module: PyOpenColorIO - - .. see:: - :ref:`ColorSpace::addCategory` - - - .. py:method:: NamedTransform.clearAliases(self: PyOpenColorIO.NamedTransform) -> None - :module: PyOpenColorIO - - - .. py:method:: NamedTransform.clearCategories(self: PyOpenColorIO.NamedTransform) -> None - :module: PyOpenColorIO - - .. see:: - :ref:`ColorSpace::clearCategories` - - - .. py:method:: NamedTransform.getAliases(self: PyOpenColorIO.NamedTransform) -> PyOpenColorIO.NamedTransform.NamedTransformAliasIterator - :module: PyOpenColorIO - - - .. py:method:: NamedTransform.getCategories(self: PyOpenColorIO.NamedTransform) -> PyOpenColorIO.NamedTransform.NamedTransformCategoryIterator - :module: PyOpenColorIO - - - .. py:method:: NamedTransform.getDescription(self: PyOpenColorIO.NamedTransform) -> str - :module: PyOpenColorIO - - - .. py:method:: NamedTransform.getEncoding(self: PyOpenColorIO.NamedTransform) -> str - :module: PyOpenColorIO - - A :ref:`NamedTransform` is not a color space and does not have an encoding in the same sense. However, it may be useful to associate a color space encoding that the transform is intended to be used with, for organizational purposes. - - - .. py:method:: NamedTransform.getFamily(self: PyOpenColorIO.NamedTransform) -> str - :module: PyOpenColorIO - - .. see:: - :ref:`ColorSpace::getFamily` - - - .. py:method:: NamedTransform.getName(self: PyOpenColorIO.NamedTransform) -> str - :module: PyOpenColorIO - - - .. py:method:: NamedTransform.getTransform(self: PyOpenColorIO.NamedTransform, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Transform - :module: PyOpenColorIO - - - .. py:method:: NamedTransform.hasCategory(self: PyOpenColorIO.NamedTransform, category: str) -> bool - :module: PyOpenColorIO - - .. see:: - :ref:`ColorSpace::hasCategory` - - - .. py:method:: NamedTransform.removeAlias(self: PyOpenColorIO.NamedTransform, alias: str) -> None - :module: PyOpenColorIO - - Does nothing if alias is not present. - - - .. py:method:: NamedTransform.removeCategory(self: PyOpenColorIO.NamedTransform, category: str) -> None - :module: PyOpenColorIO - - .. see:: - :ref:`ColorSpace::removeCategory` - - - .. py:method:: NamedTransform.setDescription(self: PyOpenColorIO.NamedTransform, description: str) -> None - :module: PyOpenColorIO - - - .. py:method:: NamedTransform.setEncoding(self: PyOpenColorIO.NamedTransform, encoding: str) -> None - :module: PyOpenColorIO - - - .. py:method:: NamedTransform.setFamily(self: PyOpenColorIO.NamedTransform, family: str) -> None - :module: PyOpenColorIO - - .. see:: - :ref:`ColorSpace::setFamily` - - - .. py:method:: NamedTransform.setName(self: PyOpenColorIO.NamedTransform, name: str) -> None - :module: PyOpenColorIO - - - .. py:method:: NamedTransform.setTransform(self: PyOpenColorIO.NamedTransform, transform: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None - :module: PyOpenColorIO - - -.. py:class:: NamedTransformCategoryIterator - :module: PyOpenColorIO.NamedTransform - - - .. py:method:: NamedTransformCategoryIterator.__getitem__(self: PyOpenColorIO.NamedTransform.NamedTransformCategoryIterator, arg0: int) -> str - :module: PyOpenColorIO.NamedTransform - - - .. py:method:: NamedTransformCategoryIterator.__iter__(self: PyOpenColorIO.NamedTransform.NamedTransformCategoryIterator) -> PyOpenColorIO.NamedTransform.NamedTransformCategoryIterator - :module: PyOpenColorIO.NamedTransform - - - .. py:method:: NamedTransformCategoryIterator.__len__(self: PyOpenColorIO.NamedTransform.NamedTransformCategoryIterator) -> int - :module: PyOpenColorIO.NamedTransform - - - .. py:method:: NamedTransformCategoryIterator.__next__(self: PyOpenColorIO.NamedTransform.NamedTransformCategoryIterator) -> str - :module: PyOpenColorIO.NamedTransform - diff --git a/docs/api/python/frozen/pyopencolorio_namedtransformvisibility.rst b/docs/api/python/frozen/pyopencolorio_namedtransformvisibility.rst deleted file mode 100644 index 81b25b1286..0000000000 --- a/docs/api/python/frozen/pyopencolorio_namedtransformvisibility.rst +++ /dev/null @@ -1,37 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: NamedTransformVisibility - :module: PyOpenColorIO - - Members: - - NAMEDTRANSFORM_ACTIVE : - - NAMEDTRANSFORM_INACTIVE : - - NAMEDTRANSFORM_ALL : - - .. py:method:: name() -> str - :property: - - .. py:attribute:: NamedTransformVisibility.NAMEDTRANSFORM_ACTIVE - :module: PyOpenColorIO - :value: - - - .. py:attribute:: NamedTransformVisibility.NAMEDTRANSFORM_ALL - :module: PyOpenColorIO - :value: - - - .. py:attribute:: NamedTransformVisibility.NAMEDTRANSFORM_INACTIVE - :module: PyOpenColorIO - :value: - - - .. py:property:: NamedTransformVisibility.value - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_negativestyle.rst b/docs/api/python/frozen/pyopencolorio_negativestyle.rst deleted file mode 100644 index 13d8c4d8fa..0000000000 --- a/docs/api/python/frozen/pyopencolorio_negativestyle.rst +++ /dev/null @@ -1,46 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: NegativeStyle - :module: PyOpenColorIO - - Negative values handling style for :ref:`ExponentTransform` and :ref:`ExponentWithLinearTransform` transform algorithms. - - Members: - - NEGATIVE_CLAMP : Clamp negative values. - - NEGATIVE_MIRROR : Positive curve is rotated 180 degrees around the origin to handle negatives. - - NEGATIVE_PASS_THRU : Negative values are passed through unchanged. - - NEGATIVE_LINEAR : Linearly extrapolate the curve for negative values. - - .. py:method:: name() -> str - :property: - - .. py:attribute:: NegativeStyle.NEGATIVE_CLAMP - :module: PyOpenColorIO - :value: - - - .. py:attribute:: NegativeStyle.NEGATIVE_LINEAR - :module: PyOpenColorIO - :value: - - - .. py:attribute:: NegativeStyle.NEGATIVE_MIRROR - :module: PyOpenColorIO - :value: - - - .. py:attribute:: NegativeStyle.NEGATIVE_PASS_THRU - :module: PyOpenColorIO - :value: - - - .. py:property:: NegativeStyle.value - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_negativestylefromstring.rst b/docs/api/python/frozen/pyopencolorio_negativestylefromstring.rst deleted file mode 100644 index 8645b46573..0000000000 --- a/docs/api/python/frozen/pyopencolorio_negativestylefromstring.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: NegativeStyleFromString(str: str) -> PyOpenColorIO.NegativeStyle - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_negativestyletostring.rst b/docs/api/python/frozen/pyopencolorio_negativestyletostring.rst deleted file mode 100644 index 0d01441e25..0000000000 --- a/docs/api/python/frozen/pyopencolorio_negativestyletostring.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: NegativeStyleToString(style: PyOpenColorIO.NegativeStyle) -> str - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_optimizationflags.rst b/docs/api/python/frozen/pyopencolorio_optimizationflags.rst deleted file mode 100644 index 3d7d680f38..0000000000 --- a/docs/api/python/frozen/pyopencolorio_optimizationflags.rst +++ /dev/null @@ -1,214 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: OptimizationFlags - :module: PyOpenColorIO - - Provides control over how the ops in a :ref:`Processor` are combined in order to improve performance. - - Members: - - OPTIMIZATION_NONE : Do not optimize. - - OPTIMIZATION_IDENTITY : Replace identity ops (other than gamma). - - OPTIMIZATION_IDENTITY_GAMMA : Replace identity gamma ops. - - OPTIMIZATION_PAIR_IDENTITY_CDL : Replace a pair of ops where one is the inverse of the other. - - OPTIMIZATION_PAIR_IDENTITY_EXPOSURE_CONTRAST : - - OPTIMIZATION_PAIR_IDENTITY_FIXED_FUNCTION : - - OPTIMIZATION_PAIR_IDENTITY_GAMMA : - - OPTIMIZATION_PAIR_IDENTITY_LUT1D : - - OPTIMIZATION_PAIR_IDENTITY_LUT3D : - - OPTIMIZATION_PAIR_IDENTITY_LOG : - - OPTIMIZATION_PAIR_IDENTITY_GRADING : - - OPTIMIZATION_COMP_EXPONENT : Compose a pair of ops into a single op. - - OPTIMIZATION_COMP_GAMMA : - - OPTIMIZATION_COMP_MATRIX : - - OPTIMIZATION_COMP_LUT1D : - - OPTIMIZATION_COMP_LUT3D : - - OPTIMIZATION_COMP_RANGE : - - OPTIMIZATION_COMP_SEPARABLE_PREFIX : For integer and half bit-depths only, replace separable ops (i.e. no channel crosstalk ops) by a single 1D LUT of input bit-depth domain. - - OPTIMIZATION_LUT_INV_FAST : Implement inverse Lut1D and Lut3D evaluations using a a forward LUT (faster but less accurate). Note that GPU evals always do FAST. - - OPTIMIZATION_FAST_LOG_EXP_POW : - - OPTIMIZATION_SIMPLIFY_OPS : - - OPTIMIZATION_NO_DYNAMIC_PROPERTIES : Turn off dynamic control of any ops that offer adjustment of parameter values after finalization (e.g. ExposureContrast). - - OPTIMIZATION_ALL : Apply all possible optimizations. - - OPTIMIZATION_LOSSLESS : - - OPTIMIZATION_VERY_GOOD : - - OPTIMIZATION_GOOD : - - OPTIMIZATION_DRAFT : For quite lossy optimizations. - - OPTIMIZATION_DEFAULT : - - .. py:method:: name() -> str - :property: - - .. py:attribute:: OptimizationFlags.OPTIMIZATION_ALL - :module: PyOpenColorIO - :value: - - - .. py:attribute:: OptimizationFlags.OPTIMIZATION_COMP_EXPONENT - :module: PyOpenColorIO - :value: - - - .. py:attribute:: OptimizationFlags.OPTIMIZATION_COMP_GAMMA - :module: PyOpenColorIO - :value: - - - .. py:attribute:: OptimizationFlags.OPTIMIZATION_COMP_LUT1D - :module: PyOpenColorIO - :value: - - - .. py:attribute:: OptimizationFlags.OPTIMIZATION_COMP_LUT3D - :module: PyOpenColorIO - :value: - - - .. py:attribute:: OptimizationFlags.OPTIMIZATION_COMP_MATRIX - :module: PyOpenColorIO - :value: - - - .. py:attribute:: OptimizationFlags.OPTIMIZATION_COMP_RANGE - :module: PyOpenColorIO - :value: - - - .. py:attribute:: OptimizationFlags.OPTIMIZATION_COMP_SEPARABLE_PREFIX - :module: PyOpenColorIO - :value: - - - .. py:attribute:: OptimizationFlags.OPTIMIZATION_DEFAULT - :module: PyOpenColorIO - :value: - - - .. py:attribute:: OptimizationFlags.OPTIMIZATION_DRAFT - :module: PyOpenColorIO - :value: - - - .. py:attribute:: OptimizationFlags.OPTIMIZATION_FAST_LOG_EXP_POW - :module: PyOpenColorIO - :value: - - - .. py:attribute:: OptimizationFlags.OPTIMIZATION_GOOD - :module: PyOpenColorIO - :value: - - - .. py:attribute:: OptimizationFlags.OPTIMIZATION_IDENTITY - :module: PyOpenColorIO - :value: - - - .. py:attribute:: OptimizationFlags.OPTIMIZATION_IDENTITY_GAMMA - :module: PyOpenColorIO - :value: - - - .. py:attribute:: OptimizationFlags.OPTIMIZATION_LOSSLESS - :module: PyOpenColorIO - :value: - - - .. py:attribute:: OptimizationFlags.OPTIMIZATION_LUT_INV_FAST - :module: PyOpenColorIO - :value: - - - .. py:attribute:: OptimizationFlags.OPTIMIZATION_NONE - :module: PyOpenColorIO - :value: - - - .. py:attribute:: OptimizationFlags.OPTIMIZATION_NO_DYNAMIC_PROPERTIES - :module: PyOpenColorIO - :value: - - - .. py:attribute:: OptimizationFlags.OPTIMIZATION_PAIR_IDENTITY_CDL - :module: PyOpenColorIO - :value: - - - .. py:attribute:: OptimizationFlags.OPTIMIZATION_PAIR_IDENTITY_EXPOSURE_CONTRAST - :module: PyOpenColorIO - :value: - - - .. py:attribute:: OptimizationFlags.OPTIMIZATION_PAIR_IDENTITY_FIXED_FUNCTION - :module: PyOpenColorIO - :value: - - - .. py:attribute:: OptimizationFlags.OPTIMIZATION_PAIR_IDENTITY_GAMMA - :module: PyOpenColorIO - :value: - - - .. py:attribute:: OptimizationFlags.OPTIMIZATION_PAIR_IDENTITY_GRADING - :module: PyOpenColorIO - :value: - - - .. py:attribute:: OptimizationFlags.OPTIMIZATION_PAIR_IDENTITY_LOG - :module: PyOpenColorIO - :value: - - - .. py:attribute:: OptimizationFlags.OPTIMIZATION_PAIR_IDENTITY_LUT1D - :module: PyOpenColorIO - :value: - - - .. py:attribute:: OptimizationFlags.OPTIMIZATION_PAIR_IDENTITY_LUT3D - :module: PyOpenColorIO - :value: - - - .. py:attribute:: OptimizationFlags.OPTIMIZATION_SIMPLIFY_OPS - :module: PyOpenColorIO - :value: - - - .. py:attribute:: OptimizationFlags.OPTIMIZATION_VERY_GOOD - :module: PyOpenColorIO - :value: - - - .. py:property:: OptimizationFlags.value - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_packedimagedesc.rst b/docs/api/python/frozen/pyopencolorio_packedimagedesc.rst deleted file mode 100644 index ffade9c4b4..0000000000 --- a/docs/api/python/frozen/pyopencolorio_packedimagedesc.rst +++ /dev/null @@ -1,95 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: PackedImageDesc - :module: PyOpenColorIO - - All the constructors expect a pointer to packed image data (such as rgbrgbrgb or rgbargbargba) starting at the first color channel of the first pixel to process (which does not need to be the first pixel of the image). The number of channels must be greater than or equal to 3. If a 4th channel is specified, it is assumed to be alpha information. Channels > 4 will be ignored. - - .. note:: - The methods assume the :ref:`CPUProcessor` bit-depth type for the data pointer. - - - .. py:method:: PackedImageDesc.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.PackedImageDesc, data: buffer, width: int, height: int, numChannels: int) -> None - - .. note:: - numChannels must be 3 (RGB) or 4 (RGBA). - - 2. __init__(self: PyOpenColorIO.PackedImageDesc, data: buffer, width: int, height: int, numChannels: int, bitDepth: PyOpenColorIO.BitDepth, chanStrideBytes: int, xStrideBytes: int, yStrideBytes: int) -> None - - .. note:: - numChannels must be 3 (RGB) or 4 (RGBA). - - 3. __init__(self: PyOpenColorIO.PackedImageDesc, data: buffer, width: int, height: int, chanOrder: PyOpenColorIO.ChannelOrdering) -> None - - 4. __init__(self: PyOpenColorIO.PackedImageDesc, data: buffer, width: int, height: int, chanOrder: PyOpenColorIO.ChannelOrdering, bitDepth: PyOpenColorIO.BitDepth, chanStrideBytes: int, xStrideBytes: int, yStrideBytes: int) -> None - - - .. py:method:: PackedImageDesc.getBitDepth(self: PyOpenColorIO.ImageDesc) -> PyOpenColorIO.BitDepth - :module: PyOpenColorIO - - Get the bit-depth. - - - .. py:method:: PackedImageDesc.getChanStrideBytes(self: PyOpenColorIO.PackedImageDesc) -> int - :module: PyOpenColorIO - - - .. py:method:: PackedImageDesc.getChannelOrder(self: PyOpenColorIO.PackedImageDesc) -> PyOpenColorIO.ChannelOrdering - :module: PyOpenColorIO - - Get the channel ordering of all the pixels. - - - .. py:method:: PackedImageDesc.getData(self: PyOpenColorIO.PackedImageDesc) -> numpy.ndarray - :module: PyOpenColorIO - - Get a pointer to the first color channel of the first pixel. - - - .. py:method:: PackedImageDesc.getHeight(self: PyOpenColorIO.ImageDesc) -> int - :module: PyOpenColorIO - - Get the height to process (where y position starts at 0 and ends at height-1). - - - .. py:method:: PackedImageDesc.getNumChannels(self: PyOpenColorIO.PackedImageDesc) -> int - :module: PyOpenColorIO - - - .. py:method:: PackedImageDesc.getWidth(self: PyOpenColorIO.ImageDesc) -> int - :module: PyOpenColorIO - - Get the width to process (where x position starts at 0 and ends at width-1). - - - .. py:method:: PackedImageDesc.getXStrideBytes(self: PyOpenColorIO.ImageDesc) -> int - :module: PyOpenColorIO - - Get the step in bytes to find the same color channel of the next pixel. - - - .. py:method:: PackedImageDesc.getYStrideBytes(self: PyOpenColorIO.ImageDesc) -> int - :module: PyOpenColorIO - - Get the step in bytes to find the same color channel of the pixel at the same position in the next line. - - - .. py:method:: PackedImageDesc.isFloat(self: PyOpenColorIO.ImageDesc) -> bool - :module: PyOpenColorIO - - Is the image buffer 32-bit float? - - - .. py:method:: PackedImageDesc.isRGBAPacked(self: PyOpenColorIO.ImageDesc) -> bool - :module: PyOpenColorIO - - Is the image buffer in packed mode with the 4 color channels? ("Packed" here means that XStrideBytes is 4x the bytes per channel, so it is more specific than simply any :ref:`PackedImageDesc`.) - diff --git a/docs/api/python/frozen/pyopencolorio_planarimagedesc.rst b/docs/api/python/frozen/pyopencolorio_planarimagedesc.rst deleted file mode 100644 index e5cbb3c27f..0000000000 --- a/docs/api/python/frozen/pyopencolorio_planarimagedesc.rst +++ /dev/null @@ -1,95 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: PlanarImageDesc - :module: PyOpenColorIO - - All the constructors expect pointers to the specified image planes (i.e. rrrr gggg bbbb) starting at the first color channel of the first pixel to process (which need not be the first pixel of the image). Pass NULL for aData if no alpha exists (r/g/bData must not be NULL). - - .. note:: - The methods assume the :ref:`CPUProcessor` bit-depth type for the R/G/B/A data pointers. - - - .. py:method:: PlanarImageDesc.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.PlanarImageDesc, rData: buffer, gData: buffer, bData: buffer, width: int, height: int) -> None - - 2. __init__(self: PyOpenColorIO.PlanarImageDesc, rData: buffer, gData: buffer, bData: buffer, aData: buffer, width: int, height: int) -> None - - Note that although :ref:`PlanarImageDesc` is powerful enough to also describe all :ref:`PackedImageDesc` scenarios, it is recommended to use a :ref:`PackedImageDesc` where possible since that allows for additional optimizations. - - 3. __init__(self: PyOpenColorIO.PlanarImageDesc, rData: buffer, gData: buffer, bData: buffer, width: int, height: int, bitDepth: PyOpenColorIO.BitDepth, xStrideBytes: int, yStrideBytes: int) -> None - - 4. __init__(self: PyOpenColorIO.PlanarImageDesc, rData: buffer, gData: buffer, bData: buffer, aData: buffer, width: int, height: int, bitDepth: PyOpenColorIO.BitDepth, xStrideBytes: int, yStrideBytes: int) -> None - - - .. py:method:: PlanarImageDesc.getAData(self: PyOpenColorIO.PlanarImageDesc) -> numpy.ndarray - :module: PyOpenColorIO - - Get a pointer to the alpha channel of the first pixel or null as alpha channel is optional. - - - .. py:method:: PlanarImageDesc.getBData(self: PyOpenColorIO.PlanarImageDesc) -> numpy.ndarray - :module: PyOpenColorIO - - Get a pointer to the blue channel of the first pixel. - - - .. py:method:: PlanarImageDesc.getBitDepth(self: PyOpenColorIO.ImageDesc) -> PyOpenColorIO.BitDepth - :module: PyOpenColorIO - - Get the bit-depth. - - - .. py:method:: PlanarImageDesc.getGData(self: PyOpenColorIO.PlanarImageDesc) -> numpy.ndarray - :module: PyOpenColorIO - - Get a pointer to the green channel of the first pixel. - - - .. py:method:: PlanarImageDesc.getHeight(self: PyOpenColorIO.ImageDesc) -> int - :module: PyOpenColorIO - - Get the height to process (where y position starts at 0 and ends at height-1). - - - .. py:method:: PlanarImageDesc.getRData(self: PyOpenColorIO.PlanarImageDesc) -> numpy.ndarray - :module: PyOpenColorIO - - Get a pointer to the red channel of the first pixel. - - - .. py:method:: PlanarImageDesc.getWidth(self: PyOpenColorIO.ImageDesc) -> int - :module: PyOpenColorIO - - Get the width to process (where x position starts at 0 and ends at width-1). - - - .. py:method:: PlanarImageDesc.getXStrideBytes(self: PyOpenColorIO.ImageDesc) -> int - :module: PyOpenColorIO - - Get the step in bytes to find the same color channel of the next pixel. - - - .. py:method:: PlanarImageDesc.getYStrideBytes(self: PyOpenColorIO.ImageDesc) -> int - :module: PyOpenColorIO - - Get the step in bytes to find the same color channel of the pixel at the same position in the next line. - - - .. py:method:: PlanarImageDesc.isFloat(self: PyOpenColorIO.ImageDesc) -> bool - :module: PyOpenColorIO - - Is the image buffer 32-bit float? - - - .. py:method:: PlanarImageDesc.isRGBAPacked(self: PyOpenColorIO.ImageDesc) -> bool - :module: PyOpenColorIO - - Is the image buffer in packed mode with the 4 color channels? ("Packed" here means that XStrideBytes is 4x the bytes per channel, so it is more specific than simply any :ref:`PackedImageDesc`.) - diff --git a/docs/api/python/frozen/pyopencolorio_processor.rst b/docs/api/python/frozen/pyopencolorio_processor.rst index 360f8c82a9..c83510b0c4 100644 --- a/docs/api/python/frozen/pyopencolorio_processor.rst +++ b/docs/api/python/frozen/pyopencolorio_processor.rst @@ -5,6 +5,7 @@ .. py:class:: Processor :module: PyOpenColorIO + :canonical: PyOpenColorIO.PyOpenColorIO.Processor The *:ref:`Processor`* represents a specific color transformation which is the result of :ref:`Config::getProcessor`. @@ -13,17 +14,19 @@ :module: PyOpenColorIO - .. py:method:: Processor.createGroupTransform(self: PyOpenColorIO.Processor) -> PyOpenColorIO.GroupTransform + .. py:method:: Processor.createGroupTransform(self: PyOpenColorIO.PyOpenColorIO.Processor) -> PyOpenColorIO.PyOpenColorIO.GroupTransform :module: PyOpenColorIO Return a :ref:`GroupTransform` that contains a copy of the transforms that comprise the processor. (Changes to it will not modify the original processor.) Note that the :ref:`GroupTransform::write` method may be used to serialize a :ref:`Processor`. Serializing to CTF format is a useful technique for debugging :ref:`Processor` contents. - .. py:method:: Processor.getCacheID(self: PyOpenColorIO.Processor) -> str + .. py:method:: Processor.getCacheID(self: PyOpenColorIO.PyOpenColorIO.Processor) -> str :module: PyOpenColorIO + Returns a hash string generated by hashing the cachedIDs of the (unoptimized) list of ops contained in the :ref:`Processor`. (This forms part of the key used by the config's processor cache.) - .. py:method:: Processor.getDefaultCPUProcessor(self: PyOpenColorIO.Processor) -> PyOpenColorIO.CPUProcessor + + .. py:method:: Processor.getDefaultCPUProcessor(self: PyOpenColorIO.PyOpenColorIO.Processor) -> PyOpenColorIO.PyOpenColorIO.CPUProcessor :module: PyOpenColorIO Get an optimized :ref:`CPUProcessor` instance. @@ -48,13 +51,13 @@ cpuProcessor->apply(img); - .. py:method:: Processor.getDefaultGPUProcessor(self: PyOpenColorIO.Processor) -> PyOpenColorIO.GPUProcessor + .. py:method:: Processor.getDefaultGPUProcessor(self: PyOpenColorIO.PyOpenColorIO.Processor) -> PyOpenColorIO.PyOpenColorIO.GPUProcessor :module: PyOpenColorIO Get an optimized :ref:`GPUProcessor` instance. - .. py:method:: Processor.getDynamicProperty(self: PyOpenColorIO.Processor, type: PyOpenColorIO.DynamicPropertyType) -> PyOpenColorIO.DynamicProperty + .. py:method:: Processor.getDynamicProperty(self: PyOpenColorIO.PyOpenColorIO.Processor, type: PyOpenColorIO.PyOpenColorIO.DynamicPropertyType) -> PyOpenColorIO.PyOpenColorIO.DynamicProperty :module: PyOpenColorIO The returned pointer may be used to set the default value of any dynamic properties of the requested type. Throws if the requested property is not found. Note that if the processor contains several ops that support the requested property, only one can be dynamic and only this one will be controlled. @@ -63,7 +66,7 @@ The dynamic properties are a convenient way to change on-the-fly values without generating again and again a CPU or GPU processor instance. Color transformations can contain dynamic properties from a :ref:`ExposureContrastTransform` for example. So, :ref:`Processor`, :ref:`CPUProcessor` and :ref:`GpuShaderCreator` all have ways to manage dynamic properties. However, the transform dynamic properties are decoupled between the types of processor instances so that the same :ref:`Processor` can generate several independent CPU and/or GPU processor instances i.e. changing the value of the exposure dynamic property from a CPU processor instance does not affect the corresponding GPU processor instance. :ref:`Processor` creation will log a warning if there are more than one property of a given type. There may be more than one property of a given type, but only one will respond to parameter updates, the others will use their original parameter values. - .. py:method:: Processor.getFormatMetadata(self: PyOpenColorIO.Processor) -> PyOpenColorIO.FormatMetadata + .. py:method:: Processor.getFormatMetadata(self: PyOpenColorIO.PyOpenColorIO.Processor) -> PyOpenColorIO.PyOpenColorIO.FormatMetadata :module: PyOpenColorIO Get a :ref:`FormatMetadata` containing the top level metadata for the processor. For a processor from a CLF file, this corresponds to the ProcessList metadata. @@ -74,12 +77,12 @@ Overloaded function. - 1. getOptimizedCPUProcessor(self: PyOpenColorIO.Processor, oFlags: PyOpenColorIO.OptimizationFlags) -> PyOpenColorIO.CPUProcessor + 1. getOptimizedCPUProcessor(self: PyOpenColorIO.PyOpenColorIO.Processor, oFlags: PyOpenColorIO.PyOpenColorIO.OptimizationFlags) -> PyOpenColorIO.PyOpenColorIO.CPUProcessor - 2. getOptimizedCPUProcessor(self: PyOpenColorIO.Processor, inBitDepth: PyOpenColorIO.BitDepth, outBitDepth: PyOpenColorIO.BitDepth, oFlags: PyOpenColorIO.OptimizationFlags) -> PyOpenColorIO.CPUProcessor + 2. getOptimizedCPUProcessor(self: PyOpenColorIO.PyOpenColorIO.Processor, inBitDepth: PyOpenColorIO.PyOpenColorIO.BitDepth, outBitDepth: PyOpenColorIO.PyOpenColorIO.BitDepth, oFlags: PyOpenColorIO.PyOpenColorIO.OptimizationFlags) -> PyOpenColorIO.PyOpenColorIO.CPUProcessor - .. py:method:: Processor.getOptimizedGPUProcessor(self: PyOpenColorIO.Processor, oFlags: PyOpenColorIO.OptimizationFlags) -> PyOpenColorIO.GPUProcessor + .. py:method:: Processor.getOptimizedGPUProcessor(self: PyOpenColorIO.PyOpenColorIO.Processor, oFlags: PyOpenColorIO.PyOpenColorIO.OptimizationFlags) -> PyOpenColorIO.PyOpenColorIO.GPUProcessor :module: PyOpenColorIO @@ -88,63 +91,64 @@ Overloaded function. - 1. getOptimizedProcessor(self: PyOpenColorIO.Processor, oFlags: PyOpenColorIO.OptimizationFlags) -> PyOpenColorIO.Processor + 1. getOptimizedProcessor(self: PyOpenColorIO.PyOpenColorIO.Processor, oFlags: PyOpenColorIO.PyOpenColorIO.OptimizationFlags) -> PyOpenColorIO.PyOpenColorIO.Processor Run the optimizer on a :ref:`Processor` to create a new :ref:`Processor`. It is usually not necessary to call this since getting a :ref:`CPUProcessor` or :ref:`GPUProcessor` will also optimize. However if you need both, calling this method first makes getting a CPU and GPU :ref:`Processor` faster since the optimization is effectively only done once. - 2. getOptimizedProcessor(self: PyOpenColorIO.Processor, inBitDepth: PyOpenColorIO.BitDepth, outBitDepth: PyOpenColorIO.BitDepth, oFlags: PyOpenColorIO.OptimizationFlags) -> PyOpenColorIO.Processor + 2. getOptimizedProcessor(self: PyOpenColorIO.PyOpenColorIO.Processor, inBitDepth: PyOpenColorIO.PyOpenColorIO.BitDepth, outBitDepth: PyOpenColorIO.PyOpenColorIO.BitDepth, oFlags: PyOpenColorIO.PyOpenColorIO.OptimizationFlags) -> PyOpenColorIO.PyOpenColorIO.Processor Run the optimizer on a :ref:`Processor` to create a new :ref:`Processor`. It is usually not necessary to call this since getting a :ref:`CPUProcessor` or :ref:`GPUProcessor` will also optimize. However if you need both, calling this method first makes getting a CPU and GPU :ref:`Processor` faster since the optimization is effectively only done once. - .. py:method:: Processor.getProcessorMetadata(self: PyOpenColorIO.Processor) -> PyOpenColorIO.ProcessorMetadata + .. py:method:: Processor.getProcessorMetadata(self: PyOpenColorIO.PyOpenColorIO.Processor) -> PyOpenColorIO.PyOpenColorIO.ProcessorMetadata :module: PyOpenColorIO The :ref:`ProcessorMetadata` contains technical information such as the number of files and looks used in the processor. - .. py:method:: Processor.getTransformFormatMetadata(self: PyOpenColorIO.Processor) -> PyOpenColorIO.Processor.TransformFormatMetadataIterator + .. py:method:: Processor.getTransformFormatMetadata(self: PyOpenColorIO.PyOpenColorIO.Processor) -> PyOpenColorIO.PyOpenColorIO.Processor.TransformFormatMetadataIterator :module: PyOpenColorIO - .. py:method:: Processor.hasChannelCrosstalk(self: PyOpenColorIO.Processor) -> bool + .. py:method:: Processor.hasChannelCrosstalk(self: PyOpenColorIO.PyOpenColorIO.Processor) -> bool :module: PyOpenColorIO True if the image transformation is non-separable. For example, if a change in red may also cause a change in green or blue. - .. py:method:: Processor.hasDynamicProperty(self: PyOpenColorIO.Processor, type: PyOpenColorIO.DynamicPropertyType) -> bool + .. py:method:: Processor.hasDynamicProperty(self: PyOpenColorIO.PyOpenColorIO.Processor, type: PyOpenColorIO.PyOpenColorIO.DynamicPropertyType) -> bool :module: PyOpenColorIO True if at least one dynamic property of that type exists. - .. py:method:: Processor.isDynamic(self: PyOpenColorIO.Processor) -> bool + .. py:method:: Processor.isDynamic(self: PyOpenColorIO.PyOpenColorIO.Processor) -> bool :module: PyOpenColorIO True if at least one dynamic property of any type exists and is dynamic. - .. py:method:: Processor.isNoOp(self: PyOpenColorIO.Processor) -> bool + .. py:method:: Processor.isNoOp(self: PyOpenColorIO.PyOpenColorIO.Processor) -> bool :module: PyOpenColorIO .. py:class:: TransformFormatMetadataIterator :module: PyOpenColorIO.Processor + :canonical: PyOpenColorIO.PyOpenColorIO.Processor.TransformFormatMetadataIterator - .. py:method:: TransformFormatMetadataIterator.__getitem__(self: PyOpenColorIO.Processor.TransformFormatMetadataIterator, arg0: int) -> PyOpenColorIO.FormatMetadata + .. py:method:: TransformFormatMetadataIterator.__getitem__(self: PyOpenColorIO.PyOpenColorIO.Processor.TransformFormatMetadataIterator, arg0: int) -> PyOpenColorIO.PyOpenColorIO.FormatMetadata :module: PyOpenColorIO.Processor - .. py:method:: TransformFormatMetadataIterator.__iter__(self: PyOpenColorIO.Processor.TransformFormatMetadataIterator) -> PyOpenColorIO.Processor.TransformFormatMetadataIterator + .. py:method:: TransformFormatMetadataIterator.__iter__(self: PyOpenColorIO.PyOpenColorIO.Processor.TransformFormatMetadataIterator) -> PyOpenColorIO.PyOpenColorIO.Processor.TransformFormatMetadataIterator :module: PyOpenColorIO.Processor - .. py:method:: TransformFormatMetadataIterator.__len__(self: PyOpenColorIO.Processor.TransformFormatMetadataIterator) -> int + .. py:method:: TransformFormatMetadataIterator.__len__(self: PyOpenColorIO.PyOpenColorIO.Processor.TransformFormatMetadataIterator) -> int :module: PyOpenColorIO.Processor - .. py:method:: TransformFormatMetadataIterator.__next__(self: PyOpenColorIO.Processor.TransformFormatMetadataIterator) -> PyOpenColorIO.FormatMetadata + .. py:method:: TransformFormatMetadataIterator.__next__(self: PyOpenColorIO.PyOpenColorIO.Processor.TransformFormatMetadataIterator) -> PyOpenColorIO.PyOpenColorIO.FormatMetadata :module: PyOpenColorIO.Processor diff --git a/docs/api/python/frozen/pyopencolorio_processorcacheflags.rst b/docs/api/python/frozen/pyopencolorio_processorcacheflags.rst deleted file mode 100644 index dc4d67b116..0000000000 --- a/docs/api/python/frozen/pyopencolorio_processorcacheflags.rst +++ /dev/null @@ -1,46 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: ProcessorCacheFlags - :module: PyOpenColorIO - - cpp:type:: Enum to control the behavior of the internal caches e.g. the processor cache in - - Members: - - PROCESSOR_CACHE_OFF : - - PROCESSOR_CACHE_ENABLED : - - PROCESSOR_CACHE_SHARE_DYN_PROPERTIES : - - PROCESSOR_CACHE_DEFAULT : - - .. py:method:: name() -> str - :property: - - .. py:attribute:: ProcessorCacheFlags.PROCESSOR_CACHE_DEFAULT - :module: PyOpenColorIO - :value: - - - .. py:attribute:: ProcessorCacheFlags.PROCESSOR_CACHE_ENABLED - :module: PyOpenColorIO - :value: - - - .. py:attribute:: ProcessorCacheFlags.PROCESSOR_CACHE_OFF - :module: PyOpenColorIO - :value: - - - .. py:attribute:: ProcessorCacheFlags.PROCESSOR_CACHE_SHARE_DYN_PROPERTIES - :module: PyOpenColorIO - :value: - - - .. py:property:: ProcessorCacheFlags.value - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_processormetadata.rst b/docs/api/python/frozen/pyopencolorio_processormetadata.rst index dc59890c9a..970118bb19 100644 --- a/docs/api/python/frozen/pyopencolorio_processormetadata.rst +++ b/docs/api/python/frozen/pyopencolorio_processormetadata.rst @@ -5,66 +5,69 @@ .. py:class:: ProcessorMetadata :module: PyOpenColorIO + :canonical: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata This class contains meta information about the process that generated this processor. The results of these functions do not impact the pixel processing. - .. py:method:: ProcessorMetadata.__init__(self: PyOpenColorIO.ProcessorMetadata) -> None + .. py:method:: ProcessorMetadata.__init__(self: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata) -> None :module: PyOpenColorIO - .. py:method:: ProcessorMetadata.addFile(self: PyOpenColorIO.ProcessorMetadata, fileName: str) -> None + .. py:method:: ProcessorMetadata.addFile(self: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata, fileName: str) -> None :module: PyOpenColorIO - .. py:method:: ProcessorMetadata.addLook(self: PyOpenColorIO.ProcessorMetadata, look: str) -> None + .. py:method:: ProcessorMetadata.addLook(self: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata, look: str) -> None :module: PyOpenColorIO - .. py:method:: ProcessorMetadata.getFiles(self: PyOpenColorIO.ProcessorMetadata) -> PyOpenColorIO.ProcessorMetadata.FileIterator + .. py:method:: ProcessorMetadata.getFiles(self: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata) -> PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.FileIterator :module: PyOpenColorIO - .. py:method:: ProcessorMetadata.getLooks(self: PyOpenColorIO.ProcessorMetadata) -> PyOpenColorIO.ProcessorMetadata.LookIterator + .. py:method:: ProcessorMetadata.getLooks(self: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata) -> PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.LookIterator :module: PyOpenColorIO .. py:class:: FileIterator :module: PyOpenColorIO.ProcessorMetadata + :canonical: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.FileIterator - .. py:method:: FileIterator.__getitem__(self: PyOpenColorIO.ProcessorMetadata.FileIterator, arg0: int) -> str + .. py:method:: FileIterator.__getitem__(self: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.FileIterator, arg0: int) -> str :module: PyOpenColorIO.ProcessorMetadata - .. py:method:: FileIterator.__iter__(self: PyOpenColorIO.ProcessorMetadata.FileIterator) -> PyOpenColorIO.ProcessorMetadata.FileIterator + .. py:method:: FileIterator.__iter__(self: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.FileIterator) -> PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.FileIterator :module: PyOpenColorIO.ProcessorMetadata - .. py:method:: FileIterator.__len__(self: PyOpenColorIO.ProcessorMetadata.FileIterator) -> int + .. py:method:: FileIterator.__len__(self: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.FileIterator) -> int :module: PyOpenColorIO.ProcessorMetadata - .. py:method:: FileIterator.__next__(self: PyOpenColorIO.ProcessorMetadata.FileIterator) -> str + .. py:method:: FileIterator.__next__(self: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.FileIterator) -> str :module: PyOpenColorIO.ProcessorMetadata .. py:class:: LookIterator :module: PyOpenColorIO.ProcessorMetadata + :canonical: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.LookIterator - .. py:method:: LookIterator.__getitem__(self: PyOpenColorIO.ProcessorMetadata.LookIterator, arg0: int) -> str + .. py:method:: LookIterator.__getitem__(self: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.LookIterator, arg0: int) -> str :module: PyOpenColorIO.ProcessorMetadata - .. py:method:: LookIterator.__iter__(self: PyOpenColorIO.ProcessorMetadata.LookIterator) -> PyOpenColorIO.ProcessorMetadata.LookIterator + .. py:method:: LookIterator.__iter__(self: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.LookIterator) -> PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.LookIterator :module: PyOpenColorIO.ProcessorMetadata - .. py:method:: LookIterator.__len__(self: PyOpenColorIO.ProcessorMetadata.LookIterator) -> int + .. py:method:: LookIterator.__len__(self: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.LookIterator) -> int :module: PyOpenColorIO.ProcessorMetadata - .. py:method:: LookIterator.__next__(self: PyOpenColorIO.ProcessorMetadata.LookIterator) -> str + .. py:method:: LookIterator.__next__(self: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.LookIterator) -> str :module: PyOpenColorIO.ProcessorMetadata diff --git a/docs/api/python/frozen/pyopencolorio_rangestyle.rst b/docs/api/python/frozen/pyopencolorio_rangestyle.rst deleted file mode 100644 index 23184f2d29..0000000000 --- a/docs/api/python/frozen/pyopencolorio_rangestyle.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: RangeStyle - :module: PyOpenColorIO - - A :ref:`RangeTransform` may be set to clamp the values, or not. - - Members: - - RANGE_NO_CLAMP : - - RANGE_CLAMP : - - .. py:method:: name() -> str - :property: - - .. py:attribute:: RangeStyle.RANGE_CLAMP - :module: PyOpenColorIO - :value: - - - .. py:attribute:: RangeStyle.RANGE_NO_CLAMP - :module: PyOpenColorIO - :value: - - - .. py:property:: RangeStyle.value - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_rangestylefromstring.rst b/docs/api/python/frozen/pyopencolorio_rangestylefromstring.rst deleted file mode 100644 index 32f1cc770c..0000000000 --- a/docs/api/python/frozen/pyopencolorio_rangestylefromstring.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: RangeStyleFromString(str: str) -> PyOpenColorIO.RangeStyle - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_rangestyletostring.rst b/docs/api/python/frozen/pyopencolorio_rangestyletostring.rst deleted file mode 100644 index 788c31679e..0000000000 --- a/docs/api/python/frozen/pyopencolorio_rangestyletostring.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: RangeStyleToString(style: PyOpenColorIO.RangeStyle) -> str - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_rangetransform.rst b/docs/api/python/frozen/pyopencolorio_rangetransform.rst deleted file mode 100644 index 97e51e6be6..0000000000 --- a/docs/api/python/frozen/pyopencolorio_rangetransform.rst +++ /dev/null @@ -1,195 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: RangeTransform - :module: PyOpenColorIO - - Represents a range transform - - The Range is used to apply an affine transform (scale & offset) and clamps values to min/max bounds on all color components except the alpha. The scale and offset values are computed from the input and output bounds. - - Refer to section 7.2.4 in specification S-2014-006 "A Common File Format - for Look-Up Tables" from the Academy of Motion Picture Arts and Sciences and the American Society of Cinematographers. - - .. note:: - The "noClamp" style described in the specification S-2014-006 becomes a MatrixOp at the processor level. - - .. note:: - Changing the transform direction does not modify the in/out values -- they are always specified with respect to the "forward" direction. - - - .. py:method:: RangeTransform.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.RangeTransform) -> None - - Creates an instance of :ref:`RangeTransform`. - - 2. __init__(self: PyOpenColorIO.RangeTransform, minInValue: float = nan, maxInValue: float = nan, minOutValue: float = nan, maxOutValue: float = nan, direction: PyOpenColorIO.TransformDirection = ) -> None - - Creates an instance of :ref:`RangeTransform`. - - - .. py:method:: RangeTransform.equals(self: PyOpenColorIO.RangeTransform, other: PyOpenColorIO.RangeTransform) -> bool - :module: PyOpenColorIO - - Checks if this equals other. - - - .. py:method:: RangeTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection - :module: PyOpenColorIO - - - .. py:method:: RangeTransform.getFileInputBitDepth(self: PyOpenColorIO.RangeTransform) -> PyOpenColorIO.BitDepth - :module: PyOpenColorIO - - **File bit-depth** - - In a format such as CLF, the range values are scaled to take pixels at the specified inBitDepth to pixels at the specified outBitDepth. This complicates the interpretation of the range values and so this object always holds normalized values and scaling is done on the way from or to file formats such as CLF. Get the bit-depths associated with the range values read from a file or set the bit-depths of values to be written to a file (for file formats such as CLF that support multiple bit-depths). - - - .. py:method:: RangeTransform.getFileOutputBitDepth(self: PyOpenColorIO.RangeTransform) -> PyOpenColorIO.BitDepth - :module: PyOpenColorIO - - - .. py:method:: RangeTransform.getFormatMetadata(self: PyOpenColorIO.RangeTransform) -> PyOpenColorIO.FormatMetadata - :module: PyOpenColorIO - - - .. py:method:: RangeTransform.getMaxInValue(self: PyOpenColorIO.RangeTransform) -> float - :module: PyOpenColorIO - - Get the maximum value for the input. - - - .. py:method:: RangeTransform.getMaxOutValue(self: PyOpenColorIO.RangeTransform) -> float - :module: PyOpenColorIO - - Get the maximum value for the output. - - - .. py:method:: RangeTransform.getMinInValue(self: PyOpenColorIO.RangeTransform) -> float - :module: PyOpenColorIO - - Get the minimum value for the input. - - **Range values** - - These values are normalized relative to what may be stored in file formats such as CLF. For example in a CLF file using a "10i" input depth, a MaxInValue of 1023 in the file is normalized to 1.0. Likewise, for an output depth of "12i", a MaxOutValue of 4095 in the file is normalized to 1.0. The values here are unclamped and may extend outside [0,1]. - - - .. py:method:: RangeTransform.getMinOutValue(self: PyOpenColorIO.RangeTransform) -> float - :module: PyOpenColorIO - - Get the minimum value for the output. - - - .. py:method:: RangeTransform.getStyle(self: PyOpenColorIO.RangeTransform) -> PyOpenColorIO.RangeStyle - :module: PyOpenColorIO - - - .. py:method:: RangeTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType - :module: PyOpenColorIO - - - .. py:method:: RangeTransform.hasMaxInValue(self: PyOpenColorIO.RangeTransform) -> bool - :module: PyOpenColorIO - - Is the maximum value for the input set? - - - .. py:method:: RangeTransform.hasMaxOutValue(self: PyOpenColorIO.RangeTransform) -> bool - :module: PyOpenColorIO - - Is the maximum value for the output set? - - - .. py:method:: RangeTransform.hasMinInValue(self: PyOpenColorIO.RangeTransform) -> bool - :module: PyOpenColorIO - - Is the minimum value for the input set? - - - .. py:method:: RangeTransform.hasMinOutValue(self: PyOpenColorIO.RangeTransform) -> bool - :module: PyOpenColorIO - - Is the minimum value for the output set? - - - .. py:method:: RangeTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None - :module: PyOpenColorIO - - Note that this only affects the evaluation and not the values stored in the object. - - - .. py:method:: RangeTransform.setFileInputBitDepth(self: PyOpenColorIO.RangeTransform, bitDepth: PyOpenColorIO.BitDepth) -> None - :module: PyOpenColorIO - - - .. py:method:: RangeTransform.setFileOutputBitDepth(self: PyOpenColorIO.RangeTransform, bitDepth: PyOpenColorIO.BitDepth) -> None - :module: PyOpenColorIO - - - .. py:method:: RangeTransform.setMaxInValue(self: PyOpenColorIO.RangeTransform, value: float) -> None - :module: PyOpenColorIO - - Set the maximum value for the input. - - - .. py:method:: RangeTransform.setMaxOutValue(self: PyOpenColorIO.RangeTransform, value: float) -> None - :module: PyOpenColorIO - - Set the maximum value for the output. - - - .. py:method:: RangeTransform.setMinInValue(self: PyOpenColorIO.RangeTransform, value: float) -> None - :module: PyOpenColorIO - - Set the minimum value for the input. - - - .. py:method:: RangeTransform.setMinOutValue(self: PyOpenColorIO.RangeTransform, value: float) -> None - :module: PyOpenColorIO - - Set the minimum value for the output. - - - .. py:method:: RangeTransform.setStyle(self: PyOpenColorIO.RangeTransform, style: PyOpenColorIO.RangeStyle) -> None - :module: PyOpenColorIO - - Set the Range style to clamp or not input values. - - - .. py:method:: RangeTransform.unsetMaxInValue(self: PyOpenColorIO.RangeTransform) -> None - :module: PyOpenColorIO - - Unset the maximum value for the input. - - - .. py:method:: RangeTransform.unsetMaxOutValue(self: PyOpenColorIO.RangeTransform) -> None - :module: PyOpenColorIO - - Unset the maximum value for the output. - - - .. py:method:: RangeTransform.unsetMinInValue(self: PyOpenColorIO.RangeTransform) -> None - :module: PyOpenColorIO - - Unset the minimum value for the input. - - - .. py:method:: RangeTransform.unsetMinOutValue(self: PyOpenColorIO.RangeTransform) -> None - :module: PyOpenColorIO - - Unset the minimum value for the output. - - - .. py:method:: RangeTransform.validate(self: PyOpenColorIO.Transform) -> None - :module: PyOpenColorIO - - Will throw if data is not valid. - diff --git a/docs/api/python/frozen/pyopencolorio_referencespacetype.rst b/docs/api/python/frozen/pyopencolorio_referencespacetype.rst deleted file mode 100644 index 993f0178a0..0000000000 --- a/docs/api/python/frozen/pyopencolorio_referencespacetype.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: ReferenceSpaceType - :module: PyOpenColorIO - - OCIO does not mandate the image state of the main reference space and it is not required to be scene-referred. This enum is used in connection with the display color space and view transform features which do assume that the main reference space is scene-referred and the display reference space is display-referred. If a config used a non-scene-referred reference space, presumably it would not use either display color spaces or view transforms, so this enum becomes irrelevant. - - Members: - - REFERENCE_SPACE_SCENE : the main scene reference space - - REFERENCE_SPACE_DISPLAY : the reference space for display color spaces - - .. py:method:: name() -> str - :property: - - .. py:attribute:: ReferenceSpaceType.REFERENCE_SPACE_DISPLAY - :module: PyOpenColorIO - :value: - - - .. py:attribute:: ReferenceSpaceType.REFERENCE_SPACE_SCENE - :module: PyOpenColorIO - :value: - - - .. py:property:: ReferenceSpaceType.value - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_resetcomputehashfunction.rst b/docs/api/python/frozen/pyopencolorio_resetcomputehashfunction.rst deleted file mode 100644 index 88e0b1858a..0000000000 --- a/docs/api/python/frozen/pyopencolorio_resetcomputehashfunction.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: ResetComputeHashFunction() -> None - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_resettodefaultloggingfunction.rst b/docs/api/python/frozen/pyopencolorio_resettodefaultloggingfunction.rst deleted file mode 100644 index 45b190b45c..0000000000 --- a/docs/api/python/frozen/pyopencolorio_resettodefaultloggingfunction.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: ResetToDefaultLoggingFunction() -> None - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_rgbcurvetype.rst b/docs/api/python/frozen/pyopencolorio_rgbcurvetype.rst deleted file mode 100644 index ff74b91aaf..0000000000 --- a/docs/api/python/frozen/pyopencolorio_rgbcurvetype.rst +++ /dev/null @@ -1,53 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: RGBCurveType - :module: PyOpenColorIO - - Types for :ref:`GradingRGBCurve`. - - Members: - - RGB_RED : - - RGB_GREEN : - - RGB_BLUE : - - RGB_MASTER : - - RGB_NUM_CURVES : - - .. py:method:: name() -> str - :property: - - .. py:attribute:: RGBCurveType.RGB_BLUE - :module: PyOpenColorIO - :value: - - - .. py:attribute:: RGBCurveType.RGB_GREEN - :module: PyOpenColorIO - :value: - - - .. py:attribute:: RGBCurveType.RGB_MASTER - :module: PyOpenColorIO - :value: - - - .. py:attribute:: RGBCurveType.RGB_NUM_CURVES - :module: PyOpenColorIO - :value: - - - .. py:attribute:: RGBCurveType.RGB_RED - :module: PyOpenColorIO - :value: - - - .. py:property:: RGBCurveType.value - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_searchreferencespacetype.rst b/docs/api/python/frozen/pyopencolorio_searchreferencespacetype.rst deleted file mode 100644 index 8dc9e306e6..0000000000 --- a/docs/api/python/frozen/pyopencolorio_searchreferencespacetype.rst +++ /dev/null @@ -1,37 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: SearchReferenceSpaceType - :module: PyOpenColorIO - - Members: - - SEARCH_REFERENCE_SPACE_SCENE : - - SEARCH_REFERENCE_SPACE_DISPLAY : - - SEARCH_REFERENCE_SPACE_ALL : - - .. py:method:: name() -> str - :property: - - .. py:attribute:: SearchReferenceSpaceType.SEARCH_REFERENCE_SPACE_ALL - :module: PyOpenColorIO - :value: - - - .. py:attribute:: SearchReferenceSpaceType.SEARCH_REFERENCE_SPACE_DISPLAY - :module: PyOpenColorIO - :value: - - - .. py:attribute:: SearchReferenceSpaceType.SEARCH_REFERENCE_SPACE_SCENE - :module: PyOpenColorIO - :value: - - - .. py:property:: SearchReferenceSpaceType.value - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_setcomputehashfunction.rst b/docs/api/python/frozen/pyopencolorio_setcomputehashfunction.rst deleted file mode 100644 index 1af5bde567..0000000000 --- a/docs/api/python/frozen/pyopencolorio_setcomputehashfunction.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: SetComputeHashFunction(hashFunction: Callable[[str], str]) -> None - :module: PyOpenColorIO - - Set the Compute Hash Function to use; otherwise, use the default. - - This is not used when using CreateFromFile with an OCIOZ archive or CreateFromConfigIOProxy. - - :param ComputeHashFunction: - diff --git a/docs/api/python/frozen/pyopencolorio_setenvvariable.rst b/docs/api/python/frozen/pyopencolorio_setenvvariable.rst deleted file mode 100644 index 76a5c57521..0000000000 --- a/docs/api/python/frozen/pyopencolorio_setenvvariable.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: SetEnvVariable(name: str, value: str) -> None - :module: PyOpenColorIO - - .. warning:: - This method is not thread safe. - diff --git a/docs/api/python/frozen/pyopencolorio_setloggingfunction.rst b/docs/api/python/frozen/pyopencolorio_setloggingfunction.rst deleted file mode 100644 index c6b8ce5127..0000000000 --- a/docs/api/python/frozen/pyopencolorio_setloggingfunction.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: SetLoggingFunction(logFunction: Callable[[str], None]) -> None - :module: PyOpenColorIO - - Set the logging function to use; otherwise, use the default (i.e. std::cerr). - - .. note:: - The logging mechanism is thread-safe. - diff --git a/docs/api/python/frozen/pyopencolorio_setlogginglevel.rst b/docs/api/python/frozen/pyopencolorio_setlogginglevel.rst deleted file mode 100644 index 3d6d930274..0000000000 --- a/docs/api/python/frozen/pyopencolorio_setlogginglevel.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: SetLoggingLevel(level: PyOpenColorIO.LoggingLevel) -> None - :module: PyOpenColorIO - - Set the global logging level. - diff --git a/docs/api/python/frozen/pyopencolorio_systemmonitors.rst b/docs/api/python/frozen/pyopencolorio_systemmonitors.rst deleted file mode 100644 index 27ab9b95de..0000000000 --- a/docs/api/python/frozen/pyopencolorio_systemmonitors.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: SystemMonitors - :module: PyOpenColorIO - - Provides access to the ICC monitor profile provided by the operating system for each active display. - - - .. py:method:: SystemMonitors.__init__(self: PyOpenColorIO.SystemMonitors) -> None - :module: PyOpenColorIO - - - .. py:method:: SystemMonitors.getMonitors(self: PyOpenColorIO.SystemMonitors) -> PyOpenColorIO.SystemMonitors.MonitorIterator - :module: PyOpenColorIO - - -.. py:class:: MonitorIterator - :module: PyOpenColorIO.SystemMonitors - - - .. py:method:: MonitorIterator.__getitem__(self: PyOpenColorIO.SystemMonitors.MonitorIterator, arg0: int) -> tuple - :module: PyOpenColorIO.SystemMonitors - - - .. py:method:: MonitorIterator.__iter__(self: PyOpenColorIO.SystemMonitors.MonitorIterator) -> PyOpenColorIO.SystemMonitors.MonitorIterator - :module: PyOpenColorIO.SystemMonitors - - - .. py:method:: MonitorIterator.__len__(self: PyOpenColorIO.SystemMonitors.MonitorIterator) -> int - :module: PyOpenColorIO.SystemMonitors - - - .. py:method:: MonitorIterator.__next__(self: PyOpenColorIO.SystemMonitors.MonitorIterator) -> tuple - :module: PyOpenColorIO.SystemMonitors - diff --git a/docs/api/python/frozen/pyopencolorio_transform.rst b/docs/api/python/frozen/pyopencolorio_transform.rst deleted file mode 100644 index 322ae9e988..0000000000 --- a/docs/api/python/frozen/pyopencolorio_transform.rst +++ /dev/null @@ -1,34 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: Transform - :module: PyOpenColorIO - - Base class for all the transform classes. - - - .. py:method:: Transform.__init__(*args, **kwargs) - :module: PyOpenColorIO - - - .. py:method:: Transform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection - :module: PyOpenColorIO - - - .. py:method:: Transform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType - :module: PyOpenColorIO - - - .. py:method:: Transform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None - :module: PyOpenColorIO - - Note that this only affects the evaluation and not the values stored in the object. - - - .. py:method:: Transform.validate(self: PyOpenColorIO.Transform) -> None - :module: PyOpenColorIO - - Will throw if data is not valid. - diff --git a/docs/api/python/frozen/pyopencolorio_transformdirection.rst b/docs/api/python/frozen/pyopencolorio_transformdirection.rst deleted file mode 100644 index 5623ecc4d7..0000000000 --- a/docs/api/python/frozen/pyopencolorio_transformdirection.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: TransformDirection - :module: PyOpenColorIO - - Members: - - TRANSFORM_DIR_FORWARD : - - TRANSFORM_DIR_INVERSE : - - .. py:method:: name() -> str - :property: - - .. py:attribute:: TransformDirection.TRANSFORM_DIR_FORWARD - :module: PyOpenColorIO - :value: - - - .. py:attribute:: TransformDirection.TRANSFORM_DIR_INVERSE - :module: PyOpenColorIO - :value: - - - .. py:property:: TransformDirection.value - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_transformdirectionfromstring.rst b/docs/api/python/frozen/pyopencolorio_transformdirectionfromstring.rst deleted file mode 100644 index 57aa8d5a21..0000000000 --- a/docs/api/python/frozen/pyopencolorio_transformdirectionfromstring.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: TransformDirectionFromString(str: str) -> PyOpenColorIO.TransformDirection - :module: PyOpenColorIO - - Will throw if string is not recognized. - diff --git a/docs/api/python/frozen/pyopencolorio_transformdirectiontostring.rst b/docs/api/python/frozen/pyopencolorio_transformdirectiontostring.rst deleted file mode 100644 index 9664daeb2d..0000000000 --- a/docs/api/python/frozen/pyopencolorio_transformdirectiontostring.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: TransformDirectionToString(direction: PyOpenColorIO.TransformDirection) -> str - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_transformtype.rst b/docs/api/python/frozen/pyopencolorio_transformtype.rst deleted file mode 100644 index 3f2c455fc7..0000000000 --- a/docs/api/python/frozen/pyopencolorio_transformtype.rst +++ /dev/null @@ -1,170 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: TransformType - :module: PyOpenColorIO - - Members: - - TRANSFORM_TYPE_ALLOCATION : - - TRANSFORM_TYPE_BUILTIN : - - TRANSFORM_TYPE_CDL : - - TRANSFORM_TYPE_COLORSPACE : - - TRANSFORM_TYPE_DISPLAY_VIEW : - - TRANSFORM_TYPE_EXPONENT : - - TRANSFORM_TYPE_EXPONENT_WITH_LINEAR : - - TRANSFORM_TYPE_EXPOSURE_CONTRAST : - - TRANSFORM_TYPE_FILE : - - TRANSFORM_TYPE_FIXED_FUNCTION : - - TRANSFORM_TYPE_GRADING_PRIMARY : - - TRANSFORM_TYPE_GRADING_RGB_CURVE : - - TRANSFORM_TYPE_GRADING_TONE : - - TRANSFORM_TYPE_GROUP : - - TRANSFORM_TYPE_LOG_AFFINE : - - TRANSFORM_TYPE_LOG_CAMERA : - - TRANSFORM_TYPE_LOG : - - TRANSFORM_TYPE_LOOK : - - TRANSFORM_TYPE_LUT1D : - - TRANSFORM_TYPE_LUT3D : - - TRANSFORM_TYPE_MATRIX : - - TRANSFORM_TYPE_RANGE : - - .. py:method:: name() -> str - :property: - - .. py:attribute:: TransformType.TRANSFORM_TYPE_ALLOCATION - :module: PyOpenColorIO - :value: - - - .. py:attribute:: TransformType.TRANSFORM_TYPE_BUILTIN - :module: PyOpenColorIO - :value: - - - .. py:attribute:: TransformType.TRANSFORM_TYPE_CDL - :module: PyOpenColorIO - :value: - - - .. py:attribute:: TransformType.TRANSFORM_TYPE_COLORSPACE - :module: PyOpenColorIO - :value: - - - .. py:attribute:: TransformType.TRANSFORM_TYPE_DISPLAY_VIEW - :module: PyOpenColorIO - :value: - - - .. py:attribute:: TransformType.TRANSFORM_TYPE_EXPONENT - :module: PyOpenColorIO - :value: - - - .. py:attribute:: TransformType.TRANSFORM_TYPE_EXPONENT_WITH_LINEAR - :module: PyOpenColorIO - :value: - - - .. py:attribute:: TransformType.TRANSFORM_TYPE_EXPOSURE_CONTRAST - :module: PyOpenColorIO - :value: - - - .. py:attribute:: TransformType.TRANSFORM_TYPE_FILE - :module: PyOpenColorIO - :value: - - - .. py:attribute:: TransformType.TRANSFORM_TYPE_FIXED_FUNCTION - :module: PyOpenColorIO - :value: - - - .. py:attribute:: TransformType.TRANSFORM_TYPE_GRADING_PRIMARY - :module: PyOpenColorIO - :value: - - - .. py:attribute:: TransformType.TRANSFORM_TYPE_GRADING_RGB_CURVE - :module: PyOpenColorIO - :value: - - - .. py:attribute:: TransformType.TRANSFORM_TYPE_GRADING_TONE - :module: PyOpenColorIO - :value: - - - .. py:attribute:: TransformType.TRANSFORM_TYPE_GROUP - :module: PyOpenColorIO - :value: - - - .. py:attribute:: TransformType.TRANSFORM_TYPE_LOG - :module: PyOpenColorIO - :value: - - - .. py:attribute:: TransformType.TRANSFORM_TYPE_LOG_AFFINE - :module: PyOpenColorIO - :value: - - - .. py:attribute:: TransformType.TRANSFORM_TYPE_LOG_CAMERA - :module: PyOpenColorIO - :value: - - - .. py:attribute:: TransformType.TRANSFORM_TYPE_LOOK - :module: PyOpenColorIO - :value: - - - .. py:attribute:: TransformType.TRANSFORM_TYPE_LUT1D - :module: PyOpenColorIO - :value: - - - .. py:attribute:: TransformType.TRANSFORM_TYPE_LUT3D - :module: PyOpenColorIO - :value: - - - .. py:attribute:: TransformType.TRANSFORM_TYPE_MATRIX - :module: PyOpenColorIO - :value: - - - .. py:attribute:: TransformType.TRANSFORM_TYPE_RANGE - :module: PyOpenColorIO - :value: - - - .. py:property:: TransformType.value - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_uniformdatatype.rst b/docs/api/python/frozen/pyopencolorio_uniformdatatype.rst deleted file mode 100644 index f6707c37bb..0000000000 --- a/docs/api/python/frozen/pyopencolorio_uniformdatatype.rst +++ /dev/null @@ -1,60 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: UniformDataType - :module: PyOpenColorIO - - Types for uniform data. - - Members: - - UNIFORM_DOUBLE : - - UNIFORM_BOOL : - - UNIFORM_FLOAT3 : Array of 3 floats. - - UNIFORM_VECTOR_FLOAT : Vector of floats (size is set by uniform). - - UNIFORM_VECTOR_INT : Vector of int pairs (size is set by uniform). - - UNIFORM_UNKNOWN : - - .. py:method:: name() -> str - :property: - - .. py:attribute:: UniformDataType.UNIFORM_BOOL - :module: PyOpenColorIO - :value: - - - .. py:attribute:: UniformDataType.UNIFORM_DOUBLE - :module: PyOpenColorIO - :value: - - - .. py:attribute:: UniformDataType.UNIFORM_FLOAT3 - :module: PyOpenColorIO - :value: - - - .. py:attribute:: UniformDataType.UNIFORM_UNKNOWN - :module: PyOpenColorIO - :value: - - - .. py:attribute:: UniformDataType.UNIFORM_VECTOR_FLOAT - :module: PyOpenColorIO - :value: - - - .. py:attribute:: UniformDataType.UNIFORM_VECTOR_INT - :module: PyOpenColorIO - :value: - - - .. py:property:: UniformDataType.value - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_unsetenvvariable.rst b/docs/api/python/frozen/pyopencolorio_unsetenvvariable.rst deleted file mode 100644 index 98fef1d15f..0000000000 --- a/docs/api/python/frozen/pyopencolorio_unsetenvvariable.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:function:: UnsetEnvVariable(name: str) -> None - :module: PyOpenColorIO - - .. warning:: - This method is not thread safe. - diff --git a/docs/api/python/frozen/pyopencolorio_viewingrules.rst b/docs/api/python/frozen/pyopencolorio_viewingrules.rst deleted file mode 100644 index 12cfc05d41..0000000000 --- a/docs/api/python/frozen/pyopencolorio_viewingrules.rst +++ /dev/null @@ -1,160 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: ViewingRules - :module: PyOpenColorIO - - :ref:`ViewingRules` - - Viewing Rules allow config authors to filter the list of views an application should offer based on the color space of an image. For example, a config may define a large number of views but not all of them may be appropriate for use with all color spaces. E.g., some views may be intended for use with scene-linear color space encodings and others with video color space encodings. - - Each rule has a name key for applications to refer to the rule. Name values must be unique (using case insensitive comparison). Viewing Rules may also have the following keys: - - - colorspaces: Either a single colorspace name or a list of names. - - encodings: One or more strings to be found in the colorspace's encoding attribute. Either this attribute or colorspaces must be present, but not both. - - custom : Allows arbitrary key / value string pairs, similar to :ref:`FileRules`. - - Getters and setters are using the rule position, they will throw if the position is not valid. - - - .. py:method:: ViewingRules.__init__(self: PyOpenColorIO.ViewingRules) -> None - :module: PyOpenColorIO - - Creates :ref:`ViewingRules` for a :ref:`Config`. - - - .. py:method:: ViewingRules.addColorSpace(self: PyOpenColorIO.ViewingRules, ruleIndex: int, colorSpaceName: str) -> None - :module: PyOpenColorIO - - Add colorspace name. Will throw if: - - - RuleIndex is invalid. - - :ref:`ViewingRules::getNumEncodings` is not 0. - - - .. py:method:: ViewingRules.addEncoding(self: PyOpenColorIO.ViewingRules, ruleIndex: int, encodingName: str) -> None - :module: PyOpenColorIO - - Add encoding name. Will throw if: - - - RuleIndex is invalid. - - :ref:`ViewingRules::getNumColorSpaces` is not 0. - - - .. py:method:: ViewingRules.getColorSpaces(self: PyOpenColorIO.ViewingRules, ruleIndex: int) -> PyOpenColorIO.ViewingRules.ViewingRuleColorSpaceIterator - :module: PyOpenColorIO - - - .. py:method:: ViewingRules.getCustomKeyName(self: PyOpenColorIO.ViewingRules, ruleIndex: int, key: int) -> str - :module: PyOpenColorIO - - Get name of key. Will throw if ruleIndex or keyIndex is invalid. - - - .. py:method:: ViewingRules.getCustomKeyValue(self: PyOpenColorIO.ViewingRules, ruleIndex: int, key: int) -> str - :module: PyOpenColorIO - - Get value for the key. Will throw if ruleIndex or keyIndex is invalid. - - - .. py:method:: ViewingRules.getEncodings(self: PyOpenColorIO.ViewingRules, ruleIndex: int) -> PyOpenColorIO.ViewingRules.ViewingRuleEncodingIterator - :module: PyOpenColorIO - - - .. py:method:: ViewingRules.getIndexForRule(self: PyOpenColorIO.ViewingRules, ruleName: str) -> int - :module: PyOpenColorIO - - Get the index from the rule name. Will throw if there is no rule named ruleName. - - - .. py:method:: ViewingRules.getName(self: PyOpenColorIO.ViewingRules, ruleIndex: int) -> str - :module: PyOpenColorIO - - Get name of the rule. Will throw if ruleIndex is invalid. - - - .. py:method:: ViewingRules.getNumCustomKeys(self: PyOpenColorIO.ViewingRules, ruleIndex: int) -> int - :module: PyOpenColorIO - - Get number of key/value pairs. Will throw if ruleIndex is invalid. - - - .. py:method:: ViewingRules.getNumEntries(self: PyOpenColorIO.ViewingRules) -> int - :module: PyOpenColorIO - - - .. py:method:: ViewingRules.insertRule(self: PyOpenColorIO.ViewingRules, ruleIndex: int, name: str) -> None - :module: PyOpenColorIO - - Insert a rule at a given ruleIndex. - - Rule currently at ruleIndex will be pushed to index: ruleIndex + 1. If ruleIndex is ViewingRules::getNumEntries, a new rule will be added at the end. Will throw if: - - RuleIndex is invalid (must be less than or equal to ViewingRules::getNumEntries). - - RuleName already exists. - - - .. py:method:: ViewingRules.removeColorSpace(self: PyOpenColorIO.ViewingRules, ruleIndex: int, colorSpaceIndex: int) -> None - :module: PyOpenColorIO - - Remove colorspace. Will throw if ruleIndex or colorSpaceIndex is invalid. - - - .. py:method:: ViewingRules.removeEncoding(self: PyOpenColorIO.ViewingRules, ruleIndex: int, encodingIndex: int) -> None - :module: PyOpenColorIO - - Remove encoding. Will throw if ruleIndex or encodingIndex is invalid. - - - .. py:method:: ViewingRules.removeRule(self: PyOpenColorIO.ViewingRules, ruleIndex: int) -> None - :module: PyOpenColorIO - - Remove a rule. Throws if ruleIndex is not valid. - - - .. py:method:: ViewingRules.setCustomKey(self: PyOpenColorIO.ViewingRules, ruleIndex: int, key: str, value: str) -> None - :module: PyOpenColorIO - - Adds a key/value or replace value if key exists. Setting a NULL or an empty value will erase the key. Will throw if ruleIndex is invalid. - - -.. py:class:: ViewingRuleColorSpaceIterator - :module: PyOpenColorIO.ViewingRules - - - .. py:method:: ViewingRuleColorSpaceIterator.__getitem__(self: PyOpenColorIO.ViewingRules.ViewingRuleColorSpaceIterator, arg0: int) -> str - :module: PyOpenColorIO.ViewingRules - - - .. py:method:: ViewingRuleColorSpaceIterator.__iter__(self: PyOpenColorIO.ViewingRules.ViewingRuleColorSpaceIterator) -> PyOpenColorIO.ViewingRules.ViewingRuleColorSpaceIterator - :module: PyOpenColorIO.ViewingRules - - - .. py:method:: ViewingRuleColorSpaceIterator.__len__(self: PyOpenColorIO.ViewingRules.ViewingRuleColorSpaceIterator) -> int - :module: PyOpenColorIO.ViewingRules - - - .. py:method:: ViewingRuleColorSpaceIterator.__next__(self: PyOpenColorIO.ViewingRules.ViewingRuleColorSpaceIterator) -> str - :module: PyOpenColorIO.ViewingRules - - -.. py:class:: ViewingRuleEncodingIterator - :module: PyOpenColorIO.ViewingRules - - - .. py:method:: ViewingRuleEncodingIterator.__getitem__(self: PyOpenColorIO.ViewingRules.ViewingRuleEncodingIterator, arg0: int) -> str - :module: PyOpenColorIO.ViewingRules - - - .. py:method:: ViewingRuleEncodingIterator.__iter__(self: PyOpenColorIO.ViewingRules.ViewingRuleEncodingIterator) -> PyOpenColorIO.ViewingRules.ViewingRuleEncodingIterator - :module: PyOpenColorIO.ViewingRules - - - .. py:method:: ViewingRuleEncodingIterator.__len__(self: PyOpenColorIO.ViewingRules.ViewingRuleEncodingIterator) -> int - :module: PyOpenColorIO.ViewingRules - - - .. py:method:: ViewingRuleEncodingIterator.__next__(self: PyOpenColorIO.ViewingRules.ViewingRuleEncodingIterator) -> str - :module: PyOpenColorIO.ViewingRules - diff --git a/docs/api/python/frozen/pyopencolorio_viewtransform.rst b/docs/api/python/frozen/pyopencolorio_viewtransform.rst deleted file mode 100644 index 5695594de9..0000000000 --- a/docs/api/python/frozen/pyopencolorio_viewtransform.rst +++ /dev/null @@ -1,124 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: ViewTransform - :module: PyOpenColorIO - - A *:ref:`ViewTransform`* provides a conversion from the main (usually scene-referred) reference space to the display-referred reference space. This allows splitting the conversion from the main reference space to a display into two parts: the :ref:`ViewTransform` plus a display color space. - - It is also possible to provide a :ref:`ViewTransform` that converts from the display-referred reference space back to that space. This is useful in cases when a :ref:`ViewTransform` is needed when converting between displays (such as HDR to SDR). - - The ReferenceSpaceType indicates whether the :ref:`ViewTransform` converts from scene-to-display reference or display-to-display reference. - - The from_reference transform direction is the one that is used when going out towards a display. - - - .. py:method:: ViewTransform.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.ViewTransform, referenceSpace: PyOpenColorIO.ReferenceSpaceType) -> None - - 2. __init__(self: PyOpenColorIO.ViewTransform, referenceSpace: PyOpenColorIO.ReferenceSpaceType = , name: str = '', family: str = '', description: str = '', toReference: PyOpenColorIO.Transform = None, fromReference: PyOpenColorIO.Transform = None, categories: List[str] = []) -> None - - - .. py:method:: ViewTransform.addCategory(self: PyOpenColorIO.ViewTransform, category: str) -> None - :module: PyOpenColorIO - - .. see:: - :ref:`ColorSpace::addCategory` - - - .. py:method:: ViewTransform.clearCategories(self: PyOpenColorIO.ViewTransform) -> None - :module: PyOpenColorIO - - .. see:: - :ref:`ColorSpace::clearCategories` - - - .. py:method:: ViewTransform.getCategories(self: PyOpenColorIO.ViewTransform) -> PyOpenColorIO.ViewTransform.ViewTransformCategoryIterator - :module: PyOpenColorIO - - - .. py:method:: ViewTransform.getDescription(self: PyOpenColorIO.ViewTransform) -> str - :module: PyOpenColorIO - - - .. py:method:: ViewTransform.getFamily(self: PyOpenColorIO.ViewTransform) -> str - :module: PyOpenColorIO - - .. see:: - :ref:`ColorSpace::getFamily` - - - .. py:method:: ViewTransform.getName(self: PyOpenColorIO.ViewTransform) -> str - :module: PyOpenColorIO - - - .. py:method:: ViewTransform.getReferenceSpaceType(self: PyOpenColorIO.ViewTransform) -> PyOpenColorIO.ReferenceSpaceType - :module: PyOpenColorIO - - - .. py:method:: ViewTransform.getTransform(self: PyOpenColorIO.ViewTransform, direction: PyOpenColorIO.ViewTransformDirection) -> PyOpenColorIO.Transform - :module: PyOpenColorIO - - If a transform in the specified direction has been specified, return it. Otherwise return a null ConstTransformRcPtr - - - .. py:method:: ViewTransform.hasCategory(self: PyOpenColorIO.ViewTransform, category: str) -> bool - :module: PyOpenColorIO - - .. see:: - :ref:`ColorSpace::hasCategory` - - - .. py:method:: ViewTransform.removeCategory(self: PyOpenColorIO.ViewTransform, category: str) -> None - :module: PyOpenColorIO - - .. see:: - :ref:`ColorSpace::removeCategory` - - - .. py:method:: ViewTransform.setDescription(self: PyOpenColorIO.ViewTransform, description: str) -> None - :module: PyOpenColorIO - - - .. py:method:: ViewTransform.setFamily(self: PyOpenColorIO.ViewTransform, family: str) -> None - :module: PyOpenColorIO - - .. see:: - :ref:`ColorSpace::setFamily` - - - .. py:method:: ViewTransform.setName(self: PyOpenColorIO.ViewTransform, name: str) -> None - :module: PyOpenColorIO - - - .. py:method:: ViewTransform.setTransform(self: PyOpenColorIO.ViewTransform, transform: PyOpenColorIO.Transform, direction: PyOpenColorIO.ViewTransformDirection) -> None - :module: PyOpenColorIO - - Specify the transform for the appropriate direction. Setting the transform to null will clear it. - - -.. py:class:: ViewTransformCategoryIterator - :module: PyOpenColorIO.ViewTransform - - - .. py:method:: ViewTransformCategoryIterator.__getitem__(self: PyOpenColorIO.ViewTransform.ViewTransformCategoryIterator, arg0: int) -> str - :module: PyOpenColorIO.ViewTransform - - - .. py:method:: ViewTransformCategoryIterator.__iter__(self: PyOpenColorIO.ViewTransform.ViewTransformCategoryIterator) -> PyOpenColorIO.ViewTransform.ViewTransformCategoryIterator - :module: PyOpenColorIO.ViewTransform - - - .. py:method:: ViewTransformCategoryIterator.__len__(self: PyOpenColorIO.ViewTransform.ViewTransformCategoryIterator) -> int - :module: PyOpenColorIO.ViewTransform - - - .. py:method:: ViewTransformCategoryIterator.__next__(self: PyOpenColorIO.ViewTransform.ViewTransformCategoryIterator) -> str - :module: PyOpenColorIO.ViewTransform - diff --git a/docs/api/python/frozen/pyopencolorio_viewtransformdirection.rst b/docs/api/python/frozen/pyopencolorio_viewtransformdirection.rst deleted file mode 100644 index 2745c7c858..0000000000 --- a/docs/api/python/frozen/pyopencolorio_viewtransformdirection.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: ViewTransformDirection - :module: PyOpenColorIO - - Members: - - VIEWTRANSFORM_DIR_TO_REFERENCE : - - VIEWTRANSFORM_DIR_FROM_REFERENCE : - - .. py:method:: name() -> str - :property: - - .. py:attribute:: ViewTransformDirection.VIEWTRANSFORM_DIR_FROM_REFERENCE - :module: PyOpenColorIO - :value: - - - .. py:attribute:: ViewTransformDirection.VIEWTRANSFORM_DIR_TO_REFERENCE - :module: PyOpenColorIO - :value: - - - .. py:property:: ViewTransformDirection.value - :module: PyOpenColorIO - diff --git a/docs/api/python/frozen/pyopencolorio_viewtype.rst b/docs/api/python/frozen/pyopencolorio_viewtype.rst deleted file mode 100644 index b4ae513fa9..0000000000 --- a/docs/api/python/frozen/pyopencolorio_viewtype.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - Do not edit! This file was automatically generated by share/docs/frozendoc.py. - -.. py:class:: ViewType - :module: PyOpenColorIO - - Members: - - VIEW_SHARED : - - VIEW_DISPLAY_DEFINED : - - .. py:method:: name() -> str - :property: - - .. py:attribute:: ViewType.VIEW_DISPLAY_DEFINED - :module: PyOpenColorIO - :value: - - - .. py:attribute:: ViewType.VIEW_SHARED - :module: PyOpenColorIO - :value: - - - .. py:property:: ViewType.value - :module: PyOpenColorIO - diff --git a/docs/conf.py b/docs/conf.py index 832df82a6a..5ccf4f9fe9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -88,7 +88,6 @@ master_doc = "index" exclude_patterns = [ "INSTALL.md", - "*.txt", "README*", "CHANGELOG.md", "build", @@ -131,6 +130,7 @@ # expandvars expandvars_define = { "PYDIR": "frozen" if RTD_BUILD else "src", + #"PYDIR": "frozen", "OCIO_NAMESPACE": ocio_namespace, } diff --git a/docs/guides/contributing/documentation_guidelines.rst b/docs/guides/contributing/documentation_guidelines.rst index 2cb6758b16..af8e1e0756 100644 --- a/docs/guides/contributing/documentation_guidelines.rst +++ b/docs/guides/contributing/documentation_guidelines.rst @@ -22,23 +22,35 @@ Installation of requirements Scripts are available, for each platform, to install the documentation requirements. -The ``install_docs_env.sh`` script in the share/ci/scripts/ directory +The ``install_docs_env.sh`` script in the ``share/ci/scripts/`` directory will install the Python-related requirements for building the documentation (Sphinx, six, testresources, recommonmark, sphinx-press-theme, sphinx-tabs, and breathe) and Doxygen. +**Note:** If you are on Linux using yum and don't already have Doxygen installed, you will have to +uncomment the relevant line in ``share/ci/scripts/linux/yum/install_docs_env.sh`` + Use GitBash (`provided with Git for Windows `_) to execute the script on Windows. Python 3 is required to build the documentation. If you have multiple Python installs you'll need to make sure pip and CMake find the correct version. You can manually inform CMake of which to use by adding this option to the below -`cmake` command, which configures the documentation build: +`cmake` command, which configures the documentation build:: -DPython_ROOT= -For the Python packages, ensure their locations are in your ``PYTHONPATH`` -environment variable prior to configuring the build. +You need to make sure these Python package locations are in your ``PYTHONPATH`` +environment variable prior to configuring the build. A good way to accomplish this is +with a virtual environment, which would look like:: + + $ python3 -m venv venv + $ source venv/bin/activate + $ share/ci/scripts//install_docs_env.sh + $ export PYTHONPATH=/venv/lib/python/site-packages + +Obviously, adjust for specific paths and python versions. Also, the above assumes a ``bash`` +environment - the commands may be slightly different for other shells. Building the docs ***************** @@ -58,25 +70,32 @@ Initial run:: Then after each change you wish to preview:: - $ cmake -D OCIO_BUILD_DOCS=ON .. && make docs + $ cmake -D OCIO_BUILD_DOCS=ON ../ && make docs + +Tip: + The ``-j`` option to ``make`` is your friend, eg, ``make -j 8`` will make things go much faster. + The exact number will depend on the resources of your particular machine. The ``nproc`` command (linux) will help you decide. Updating the Python docs ************************ If a contributor makes changes to any part of OCIO which affects the Python API docs (so, public headers, Python bindings, any documentation process code, etc.) they should -do a local build with the new CMake option -DOCIO_BUILD_FROZEN_DOCS=ON, and add the -modified rST files under docs/api/python/frozen to their PR. +do a local build with the new CMake option -DOCIO_BUILD_FROZEN_DOCS=ON:: + + $ cmake -DOCIO_BUILD_FROZEN_DOCS=ON ../ + +and add the modified rST files found under ``docs/api/python/frozen`` to their PR. -Note: If you run the scripts on Linux, the freezing process should work well. On other +**Note:** If you run the scripts on Linux, the freezing process should work well. On other platforms, the process may sometimes make spurious deltas to rST files unrelated to your changes. Please don't add these files to your PR. The OCIO conf.py module has a switch that detects when docs are being built on GH Actions -(CI env var == true) it will backup the frozen folder to a sibling backup folder on Sphinx -init, and following Sphinx build completion will do a file-by-file comparison of the new -frozen and the backup folders. If there are differences, the CI job may fail with an error -explaining where the differences were found and with instructions on how to fix them. +(CI env var == true); in that case it will backup the "frozen" folder to a sibling backup +folder on Sphinx init, and following Sphinx build completion will do a file-by-file comparison +of the new "frozen" and backup folders. If there are differences, the CI job may fail with +an error explaining where the differences were found and with instructions on how to fix them. The conf.py also has a switch that detects when it is being run on RTD, and in that case will itself run Doxygen to generate the XML needed by breathe prior to building the docs, @@ -88,14 +107,14 @@ nothing more. Right now that only works when the READTHEDOCS env var == True, bu be easily exposed another way if needed. These features required several custom Sphinx extensions tuned for our project which are -located under share/docs. +located under ``share/docs``. Building the docs -- Excluding the API docs ******************************************* If you don't need to build the API documentation, there is a quick and dirty way to do a docs build. This approach does not need to compile the C++ code but is not ideal -since it modifies files in the source directory rather than the build directory: +since it modifies files in the source directory rather than the build directory:: export READTHEDOCS=True cd docs (in the source directory) diff --git a/docs/guides/contributing/doxygen_style_guide.rst b/docs/guides/contributing/doxygen_style_guide.rst index a4973647a7..083f1614f3 100644 --- a/docs/guides/contributing/doxygen_style_guide.rst +++ b/docs/guides/contributing/doxygen_style_guide.rst @@ -67,8 +67,8 @@ Where possible please try to split the tag and names from the descriptive text. * * Compresses an input string using the foobar algorithm. * - * \param - * Uncompressed The input string. + * \param uncompressed + * The input string. * \return * A compressed version of the input string. */ From f4d54f1e09657bc736eb7cfadb9b4425532e92fc Mon Sep 17 00:00:00 2001 From: Craig Zerouni Date: Mon, 30 Sep 2024 19:20:55 -0700 Subject: [PATCH 6/6] Restore original frozen rst files Signed-off-by: Craig Zerouni --- .../frozen/pyopencolorio_allocation.rst | 37 + .../pyopencolorio_allocationfromstring.rst | 8 + .../pyopencolorio_allocationtostring.rst | 8 + .../pyopencolorio_allocationtransform.rst | 56 + .../api/python/frozen/pyopencolorio_baker.rst | 181 +++ .../python/frozen/pyopencolorio_bitdepth.rst | 81 + .../pyopencolorio_bitdepthfromstring.rst | 8 + .../frozen/pyopencolorio_bitdepthisfloat.rst | 8 + .../frozen/pyopencolorio_bitdepthtoint.rst | 8 + .../frozen/pyopencolorio_bitdepthtostring.rst | 8 + .../frozen/pyopencolorio_boolfromstring.rst | 8 + .../frozen/pyopencolorio_booltostring.rst | 8 + .../frozen/pyopencolorio_builtintransform.rst | 54 + ...pyopencolorio_builtintransformregistry.rst | 60 + .../python/frozen/pyopencolorio_cdlstyle.rst | 37 + .../pyopencolorio_cdlstylefromstring.rst | 8 + .../frozen/pyopencolorio_cdlstyletostring.rst | 8 + .../frozen/pyopencolorio_cdltransform.rst | 151 ++ .../frozen/pyopencolorio_channelordering.rst | 53 + .../frozen/pyopencolorio_clearallcaches.rst | 15 + .../frozen/pyopencolorio_colorspace.rst | 255 +++ .../pyopencolorio_colorspacedirection.rst | 30 + .../pyopencolorio_colorspacehelpers.rst | 2 +- .../pyopencolorio_colorspacemenuhelper.rst | 32 +- ...pyopencolorio_colorspacemenuparameters.rst | 47 +- .../frozen/pyopencolorio_colorspaceset.rst | 159 ++ .../pyopencolorio_colorspacetransform.rst | 64 + .../pyopencolorio_colorspacevisibility.rst | 37 + ...opencolorio_combinetransformdirections.rst | 8 + .../python/frozen/pyopencolorio_config.rst | 1387 +++++++++++++++++ .../python/frozen/pyopencolorio_context.rst | 191 +++ .../frozen/pyopencolorio_cpuprocessor.rst | 39 +- .../pyopencolorio_displayviewhelpers.rst | 8 +- .../pyopencolorio_displayviewtransform.rst | 88 ++ .../frozen/pyopencolorio_dynamicproperty.rst | 105 ++ .../pyopencolorio_dynamicpropertytype.rst | 60 + .../frozen/pyopencolorio_environmentmode.rst | 37 + ...yopencolorio_environmentmodefromstring.rst | 8 + .../pyopencolorio_environmentmodetostring.rst | 8 + .../python/frozen/pyopencolorio_exception.rst | 13 + .../pyopencolorio_exceptionmissingfile.rst | 12 + .../pyopencolorio_exponenttransform.rst | 75 + ...pencolorio_exponentwithlineartransform.rst | 95 ++ .../pyopencolorio_exposurecontraststyle.rst | 39 + ...olorio_exposurecontraststylefromstring.rst | 8 + ...ncolorio_exposurecontraststyletostring.rst | 8 + ...yopencolorio_exposurecontrasttransform.rst | 160 ++ .../python/frozen/pyopencolorio_filerules.rst | 181 +++ .../frozen/pyopencolorio_filetransform.rst | 101 ++ .../pyopencolorio_fixedfunctionstyle.rst | 109 ++ ...encolorio_fixedfunctionstylefromstring.rst | 8 + ...opencolorio_fixedfunctionstyletostring.rst | 8 + .../pyopencolorio_fixedfunctiontransform.rst | 64 + .../frozen/pyopencolorio_formatmetadata.rst | 184 +++ .../frozen/pyopencolorio_getenvvariable.rst | 10 + ...encolorio_getinversetransformdirection.rst | 8 + .../frozen/pyopencolorio_getlogginglevel.rst | 12 + .../frozen/pyopencolorio_getversion.rst | 12 + .../frozen/pyopencolorio_getversionhex.rst | 12 + .../frozen/pyopencolorio_gpulanguage.rst | 74 + .../pyopencolorio_gpulanguagefromstring.rst | 8 + .../pyopencolorio_gpulanguagetostring.rst | 8 + .../frozen/pyopencolorio_gpuprocessor.rst | 9 +- .../frozen/pyopencolorio_gpushadercreator.rst | 278 ++++ .../frozen/pyopencolorio_gpushaderdesc.rst | 568 +++++++ .../pyopencolorio_gradingbsplinecurve.rst | 60 + .../pyopencolorio_gradingcontrolpoint.rst | 28 + .../frozen/pyopencolorio_gradingprimary.rst | 82 + .../pyopencolorio_gradingprimarytransform.rst | 93 ++ .../frozen/pyopencolorio_gradingrgbcurve.rst | 38 + ...pyopencolorio_gradingrgbcurvetransform.rst | 114 ++ .../frozen/pyopencolorio_gradingrgbm.rst | 36 + .../frozen/pyopencolorio_gradingrgbmsw.rst | 46 + .../frozen/pyopencolorio_gradingstyle.rst | 39 + .../pyopencolorio_gradingstylefromstring.rst | 8 + .../pyopencolorio_gradingstyletostring.rst | 8 + .../frozen/pyopencolorio_gradingtone.rst | 44 + .../pyopencolorio_gradingtonetransform.rst | 99 ++ .../frozen/pyopencolorio_grouptransform.rst | 137 ++ .../python/frozen/pyopencolorio_imagedesc.rst | 56 + .../frozen/pyopencolorio_interpolation.rst | 77 + .../pyopencolorio_interpolationfromstring.rst | 8 + .../pyopencolorio_interpolationtostring.rst | 8 + .../pyopencolorio_isenvvariablepresent.rst | 10 + .../pyopencolorio_legacyviewingpipeline.rst | 33 +- .../pyopencolorio_logaffinetransform.rst | 95 ++ .../pyopencolorio_logcameratransform.rst | 125 ++ .../frozen/pyopencolorio_logginglevel.rst | 51 + .../pyopencolorio_logginglevelfromstring.rst | 8 + .../pyopencolorio_loggingleveltostring.rst | 8 + .../frozen/pyopencolorio_logmessage.rst | 10 + .../frozen/pyopencolorio_logtransform.rst | 62 + docs/api/python/frozen/pyopencolorio_look.rst | 64 + .../frozen/pyopencolorio_looktransform.rst | 72 + .../frozen/pyopencolorio_lut1dhueadjust.rst | 39 + .../frozen/pyopencolorio_lut1dtransform.rst | 140 ++ .../frozen/pyopencolorio_lut3dtransform.rst | 108 ++ .../frozen/pyopencolorio_matrixtransform.rst | 131 ++ .../pyopencolorio_mixingcolorspacemanager.rst | 47 +- .../frozen/pyopencolorio_mixingslider.rst | 13 +- .../frozen/pyopencolorio_namedtransform.rst | 158 ++ ...pyopencolorio_namedtransformvisibility.rst | 37 + .../frozen/pyopencolorio_negativestyle.rst | 46 + .../pyopencolorio_negativestylefromstring.rst | 8 + .../pyopencolorio_negativestyletostring.rst | 8 + .../pyopencolorio_optimizationflags.rst | 214 +++ .../frozen/pyopencolorio_packedimagedesc.rst | 95 ++ .../frozen/pyopencolorio_planarimagedesc.rst | 95 ++ .../python/frozen/pyopencolorio_processor.rst | 46 +- .../pyopencolorio_processorcacheflags.rst | 46 + .../pyopencolorio_processormetadata.rst | 29 +- .../frozen/pyopencolorio_rangestyle.rst | 32 + .../pyopencolorio_rangestylefromstring.rst | 8 + .../pyopencolorio_rangestyletostring.rst | 8 + .../frozen/pyopencolorio_rangetransform.rst | 195 +++ .../pyopencolorio_referencespacetype.rst | 32 + ...pyopencolorio_resetcomputehashfunction.rst | 8 + ...ncolorio_resettodefaultloggingfunction.rst | 8 + .../frozen/pyopencolorio_rgbcurvetype.rst | 53 + ...pyopencolorio_searchreferencespacetype.rst | 37 + .../pyopencolorio_setcomputehashfunction.rst | 14 + .../frozen/pyopencolorio_setenvvariable.rst | 11 + .../pyopencolorio_setloggingfunction.rst | 13 + .../frozen/pyopencolorio_setlogginglevel.rst | 10 + .../frozen/pyopencolorio_systemmonitors.rst | 38 + .../python/frozen/pyopencolorio_transform.rst | 34 + .../pyopencolorio_transformdirection.rst | 30 + ...encolorio_transformdirectionfromstring.rst | 10 + ...opencolorio_transformdirectiontostring.rst | 8 + .../frozen/pyopencolorio_transformtype.rst | 170 ++ .../frozen/pyopencolorio_uniformdatatype.rst | 60 + .../frozen/pyopencolorio_unsetenvvariable.rst | 11 + .../frozen/pyopencolorio_viewingrules.rst | 160 ++ .../frozen/pyopencolorio_viewtransform.rst | 124 ++ .../pyopencolorio_viewtransformdirection.rst | 30 + .../python/frozen/pyopencolorio_viewtype.rst | 30 + 136 files changed, 9180 insertions(+), 167 deletions(-) create mode 100644 docs/api/python/frozen/pyopencolorio_allocation.rst create mode 100644 docs/api/python/frozen/pyopencolorio_allocationfromstring.rst create mode 100644 docs/api/python/frozen/pyopencolorio_allocationtostring.rst create mode 100644 docs/api/python/frozen/pyopencolorio_allocationtransform.rst create mode 100644 docs/api/python/frozen/pyopencolorio_baker.rst create mode 100644 docs/api/python/frozen/pyopencolorio_bitdepth.rst create mode 100644 docs/api/python/frozen/pyopencolorio_bitdepthfromstring.rst create mode 100644 docs/api/python/frozen/pyopencolorio_bitdepthisfloat.rst create mode 100644 docs/api/python/frozen/pyopencolorio_bitdepthtoint.rst create mode 100644 docs/api/python/frozen/pyopencolorio_bitdepthtostring.rst create mode 100644 docs/api/python/frozen/pyopencolorio_boolfromstring.rst create mode 100644 docs/api/python/frozen/pyopencolorio_booltostring.rst create mode 100644 docs/api/python/frozen/pyopencolorio_builtintransform.rst create mode 100644 docs/api/python/frozen/pyopencolorio_builtintransformregistry.rst create mode 100644 docs/api/python/frozen/pyopencolorio_cdlstyle.rst create mode 100644 docs/api/python/frozen/pyopencolorio_cdlstylefromstring.rst create mode 100644 docs/api/python/frozen/pyopencolorio_cdlstyletostring.rst create mode 100644 docs/api/python/frozen/pyopencolorio_cdltransform.rst create mode 100644 docs/api/python/frozen/pyopencolorio_channelordering.rst create mode 100644 docs/api/python/frozen/pyopencolorio_clearallcaches.rst create mode 100644 docs/api/python/frozen/pyopencolorio_colorspace.rst create mode 100644 docs/api/python/frozen/pyopencolorio_colorspacedirection.rst create mode 100644 docs/api/python/frozen/pyopencolorio_colorspaceset.rst create mode 100644 docs/api/python/frozen/pyopencolorio_colorspacetransform.rst create mode 100644 docs/api/python/frozen/pyopencolorio_colorspacevisibility.rst create mode 100644 docs/api/python/frozen/pyopencolorio_combinetransformdirections.rst create mode 100644 docs/api/python/frozen/pyopencolorio_config.rst create mode 100644 docs/api/python/frozen/pyopencolorio_context.rst create mode 100644 docs/api/python/frozen/pyopencolorio_displayviewtransform.rst create mode 100644 docs/api/python/frozen/pyopencolorio_dynamicproperty.rst create mode 100644 docs/api/python/frozen/pyopencolorio_dynamicpropertytype.rst create mode 100644 docs/api/python/frozen/pyopencolorio_environmentmode.rst create mode 100644 docs/api/python/frozen/pyopencolorio_environmentmodefromstring.rst create mode 100644 docs/api/python/frozen/pyopencolorio_environmentmodetostring.rst create mode 100644 docs/api/python/frozen/pyopencolorio_exception.rst create mode 100644 docs/api/python/frozen/pyopencolorio_exceptionmissingfile.rst create mode 100644 docs/api/python/frozen/pyopencolorio_exponenttransform.rst create mode 100644 docs/api/python/frozen/pyopencolorio_exponentwithlineartransform.rst create mode 100644 docs/api/python/frozen/pyopencolorio_exposurecontraststyle.rst create mode 100644 docs/api/python/frozen/pyopencolorio_exposurecontraststylefromstring.rst create mode 100644 docs/api/python/frozen/pyopencolorio_exposurecontraststyletostring.rst create mode 100644 docs/api/python/frozen/pyopencolorio_exposurecontrasttransform.rst create mode 100644 docs/api/python/frozen/pyopencolorio_filerules.rst create mode 100644 docs/api/python/frozen/pyopencolorio_filetransform.rst create mode 100644 docs/api/python/frozen/pyopencolorio_fixedfunctionstyle.rst create mode 100644 docs/api/python/frozen/pyopencolorio_fixedfunctionstylefromstring.rst create mode 100644 docs/api/python/frozen/pyopencolorio_fixedfunctionstyletostring.rst create mode 100644 docs/api/python/frozen/pyopencolorio_fixedfunctiontransform.rst create mode 100644 docs/api/python/frozen/pyopencolorio_formatmetadata.rst create mode 100644 docs/api/python/frozen/pyopencolorio_getenvvariable.rst create mode 100644 docs/api/python/frozen/pyopencolorio_getinversetransformdirection.rst create mode 100644 docs/api/python/frozen/pyopencolorio_getlogginglevel.rst create mode 100644 docs/api/python/frozen/pyopencolorio_getversion.rst create mode 100644 docs/api/python/frozen/pyopencolorio_getversionhex.rst create mode 100644 docs/api/python/frozen/pyopencolorio_gpulanguage.rst create mode 100644 docs/api/python/frozen/pyopencolorio_gpulanguagefromstring.rst create mode 100644 docs/api/python/frozen/pyopencolorio_gpulanguagetostring.rst create mode 100644 docs/api/python/frozen/pyopencolorio_gpushadercreator.rst create mode 100644 docs/api/python/frozen/pyopencolorio_gpushaderdesc.rst create mode 100644 docs/api/python/frozen/pyopencolorio_gradingbsplinecurve.rst create mode 100644 docs/api/python/frozen/pyopencolorio_gradingcontrolpoint.rst create mode 100644 docs/api/python/frozen/pyopencolorio_gradingprimary.rst create mode 100644 docs/api/python/frozen/pyopencolorio_gradingprimarytransform.rst create mode 100644 docs/api/python/frozen/pyopencolorio_gradingrgbcurve.rst create mode 100644 docs/api/python/frozen/pyopencolorio_gradingrgbcurvetransform.rst create mode 100644 docs/api/python/frozen/pyopencolorio_gradingrgbm.rst create mode 100644 docs/api/python/frozen/pyopencolorio_gradingrgbmsw.rst create mode 100644 docs/api/python/frozen/pyopencolorio_gradingstyle.rst create mode 100644 docs/api/python/frozen/pyopencolorio_gradingstylefromstring.rst create mode 100644 docs/api/python/frozen/pyopencolorio_gradingstyletostring.rst create mode 100644 docs/api/python/frozen/pyopencolorio_gradingtone.rst create mode 100644 docs/api/python/frozen/pyopencolorio_gradingtonetransform.rst create mode 100644 docs/api/python/frozen/pyopencolorio_grouptransform.rst create mode 100644 docs/api/python/frozen/pyopencolorio_imagedesc.rst create mode 100644 docs/api/python/frozen/pyopencolorio_interpolation.rst create mode 100644 docs/api/python/frozen/pyopencolorio_interpolationfromstring.rst create mode 100644 docs/api/python/frozen/pyopencolorio_interpolationtostring.rst create mode 100644 docs/api/python/frozen/pyopencolorio_isenvvariablepresent.rst create mode 100644 docs/api/python/frozen/pyopencolorio_logaffinetransform.rst create mode 100644 docs/api/python/frozen/pyopencolorio_logcameratransform.rst create mode 100644 docs/api/python/frozen/pyopencolorio_logginglevel.rst create mode 100644 docs/api/python/frozen/pyopencolorio_logginglevelfromstring.rst create mode 100644 docs/api/python/frozen/pyopencolorio_loggingleveltostring.rst create mode 100644 docs/api/python/frozen/pyopencolorio_logmessage.rst create mode 100644 docs/api/python/frozen/pyopencolorio_logtransform.rst create mode 100644 docs/api/python/frozen/pyopencolorio_look.rst create mode 100644 docs/api/python/frozen/pyopencolorio_looktransform.rst create mode 100644 docs/api/python/frozen/pyopencolorio_lut1dhueadjust.rst create mode 100644 docs/api/python/frozen/pyopencolorio_lut1dtransform.rst create mode 100644 docs/api/python/frozen/pyopencolorio_lut3dtransform.rst create mode 100644 docs/api/python/frozen/pyopencolorio_matrixtransform.rst create mode 100644 docs/api/python/frozen/pyopencolorio_namedtransform.rst create mode 100644 docs/api/python/frozen/pyopencolorio_namedtransformvisibility.rst create mode 100644 docs/api/python/frozen/pyopencolorio_negativestyle.rst create mode 100644 docs/api/python/frozen/pyopencolorio_negativestylefromstring.rst create mode 100644 docs/api/python/frozen/pyopencolorio_negativestyletostring.rst create mode 100644 docs/api/python/frozen/pyopencolorio_optimizationflags.rst create mode 100644 docs/api/python/frozen/pyopencolorio_packedimagedesc.rst create mode 100644 docs/api/python/frozen/pyopencolorio_planarimagedesc.rst create mode 100644 docs/api/python/frozen/pyopencolorio_processorcacheflags.rst create mode 100644 docs/api/python/frozen/pyopencolorio_rangestyle.rst create mode 100644 docs/api/python/frozen/pyopencolorio_rangestylefromstring.rst create mode 100644 docs/api/python/frozen/pyopencolorio_rangestyletostring.rst create mode 100644 docs/api/python/frozen/pyopencolorio_rangetransform.rst create mode 100644 docs/api/python/frozen/pyopencolorio_referencespacetype.rst create mode 100644 docs/api/python/frozen/pyopencolorio_resetcomputehashfunction.rst create mode 100644 docs/api/python/frozen/pyopencolorio_resettodefaultloggingfunction.rst create mode 100644 docs/api/python/frozen/pyopencolorio_rgbcurvetype.rst create mode 100644 docs/api/python/frozen/pyopencolorio_searchreferencespacetype.rst create mode 100644 docs/api/python/frozen/pyopencolorio_setcomputehashfunction.rst create mode 100644 docs/api/python/frozen/pyopencolorio_setenvvariable.rst create mode 100644 docs/api/python/frozen/pyopencolorio_setloggingfunction.rst create mode 100644 docs/api/python/frozen/pyopencolorio_setlogginglevel.rst create mode 100644 docs/api/python/frozen/pyopencolorio_systemmonitors.rst create mode 100644 docs/api/python/frozen/pyopencolorio_transform.rst create mode 100644 docs/api/python/frozen/pyopencolorio_transformdirection.rst create mode 100644 docs/api/python/frozen/pyopencolorio_transformdirectionfromstring.rst create mode 100644 docs/api/python/frozen/pyopencolorio_transformdirectiontostring.rst create mode 100644 docs/api/python/frozen/pyopencolorio_transformtype.rst create mode 100644 docs/api/python/frozen/pyopencolorio_uniformdatatype.rst create mode 100644 docs/api/python/frozen/pyopencolorio_unsetenvvariable.rst create mode 100644 docs/api/python/frozen/pyopencolorio_viewingrules.rst create mode 100644 docs/api/python/frozen/pyopencolorio_viewtransform.rst create mode 100644 docs/api/python/frozen/pyopencolorio_viewtransformdirection.rst create mode 100644 docs/api/python/frozen/pyopencolorio_viewtype.rst diff --git a/docs/api/python/frozen/pyopencolorio_allocation.rst b/docs/api/python/frozen/pyopencolorio_allocation.rst new file mode 100644 index 0000000000..673e1fd072 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_allocation.rst @@ -0,0 +1,37 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: Allocation + :module: PyOpenColorIO + + Members: + + ALLOCATION_UNKNOWN : + + ALLOCATION_UNIFORM : + + ALLOCATION_LG2 : + + .. py:method:: name() -> str + :property: + + .. py:attribute:: Allocation.ALLOCATION_LG2 + :module: PyOpenColorIO + :value: + + + .. py:attribute:: Allocation.ALLOCATION_UNIFORM + :module: PyOpenColorIO + :value: + + + .. py:attribute:: Allocation.ALLOCATION_UNKNOWN + :module: PyOpenColorIO + :value: + + + .. py:property:: Allocation.value + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_allocationfromstring.rst b/docs/api/python/frozen/pyopencolorio_allocationfromstring.rst new file mode 100644 index 0000000000..139fec379f --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_allocationfromstring.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: AllocationFromString(str: str) -> PyOpenColorIO.Allocation + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_allocationtostring.rst b/docs/api/python/frozen/pyopencolorio_allocationtostring.rst new file mode 100644 index 0000000000..cdd396f39b --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_allocationtostring.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: AllocationToString(allocation: PyOpenColorIO.Allocation) -> str + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_allocationtransform.rst b/docs/api/python/frozen/pyopencolorio_allocationtransform.rst new file mode 100644 index 0000000000..3c2cc65619 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_allocationtransform.rst @@ -0,0 +1,56 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: AllocationTransform + :module: PyOpenColorIO + + Forward direction wraps the 'expanded' range into the specified, often compressed, range. + + + .. py:method:: AllocationTransform.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.AllocationTransform) -> None + + 2. __init__(self: PyOpenColorIO.AllocationTransform, allocation: PyOpenColorIO.Allocation = , vars: List[float] = [], direction: PyOpenColorIO.TransformDirection = ) -> None + + + .. py:method:: AllocationTransform.getAllocation(self: PyOpenColorIO.AllocationTransform) -> PyOpenColorIO.Allocation + :module: PyOpenColorIO + + + .. py:method:: AllocationTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection + :module: PyOpenColorIO + + + .. py:method:: AllocationTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType + :module: PyOpenColorIO + + + .. py:method:: AllocationTransform.getVars(self: PyOpenColorIO.AllocationTransform) -> List[float] + :module: PyOpenColorIO + + + .. py:method:: AllocationTransform.setAllocation(self: PyOpenColorIO.AllocationTransform, allocation: PyOpenColorIO.Allocation) -> None + :module: PyOpenColorIO + + + .. py:method:: AllocationTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None + :module: PyOpenColorIO + + Note that this only affects the evaluation and not the values stored in the object. + + + .. py:method:: AllocationTransform.setVars(self: PyOpenColorIO.AllocationTransform, vars: List[float]) -> None + :module: PyOpenColorIO + + + .. py:method:: AllocationTransform.validate(self: PyOpenColorIO.Transform) -> None + :module: PyOpenColorIO + + Will throw if data is not valid. + diff --git a/docs/api/python/frozen/pyopencolorio_baker.rst b/docs/api/python/frozen/pyopencolorio_baker.rst new file mode 100644 index 0000000000..48721c0fef --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_baker.rst @@ -0,0 +1,181 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: Baker + :module: PyOpenColorIO + + In certain situations it is necessary to serialize transforms into a variety of application specific LUT formats. Note that not all file formats that may be read also support baking. + + **Usage Example:** *Bake a CSP sRGB viewer LUT* + + .. code-block:: cpp + + OCIO::ConstConfigRcPtr config = OCIO::Config::CreateFromEnv(); + OCIO::BakerRcPtr baker = OCIO::Baker::Create(); + baker->setConfig(config); + baker->setFormat("csp"); + baker->setInputSpace("lnf"); + baker->setShaperSpace("log"); + baker->setTargetSpace("sRGB"); + auto & metadata = baker->getFormatMetadata(); + metadata.addChildElement(:ref:`OCIO::METADATA_DESCRIPTION`, "A first comment"); + metadata.addChildElement(:ref:`OCIO::METADATA_DESCRIPTION`, "A second comment"); + std::ostringstream out; + baker->bake(out); // fresh bread anyone! + std::cout << out.str(); + + + .. py:method:: Baker.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.Baker) -> None + + Create a new :ref:`Baker`. + + 2. __init__(self: PyOpenColorIO.Baker, config: PyOpenColorIO.Config, format: str, inputSpace: str, targetSpace: str, looks: str = '', cubeSize: int = -1, shaperSpace: str = '', shaperSize: int = -1) -> None + + Create a new :ref:`Baker`. + + + .. py:method:: Baker.bake(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. bake(self: PyOpenColorIO.Baker, fileName: str) -> None + + 2. bake(self: PyOpenColorIO.Baker) -> str + + Bake the LUT into the output stream. + + + .. py:method:: Baker.getConfig(self: PyOpenColorIO.Baker) -> PyOpenColorIO.Config + :module: PyOpenColorIO + + + .. py:method:: Baker.getCubeSize(self: PyOpenColorIO.Baker) -> int + :module: PyOpenColorIO + + + .. py:method:: Baker.getDisplay(self: PyOpenColorIO.Baker) -> str + :module: PyOpenColorIO + + + .. py:method:: Baker.getFormat(self: PyOpenColorIO.Baker) -> str + :module: PyOpenColorIO + + + .. py:method:: Baker.getFormatMetadata(self: PyOpenColorIO.Baker) -> PyOpenColorIO.FormatMetadata + :module: PyOpenColorIO + + + .. py:method:: Baker.getFormats() -> PyOpenColorIO.Baker.FormatIterator + :module: PyOpenColorIO + :staticmethod: + + + .. py:method:: Baker.getInputSpace(self: PyOpenColorIO.Baker) -> str + :module: PyOpenColorIO + + + .. py:method:: Baker.getLooks(self: PyOpenColorIO.Baker) -> str + :module: PyOpenColorIO + + + .. py:method:: Baker.getShaperSize(self: PyOpenColorIO.Baker) -> int + :module: PyOpenColorIO + + + .. py:method:: Baker.getShaperSpace(self: PyOpenColorIO.Baker) -> str + :module: PyOpenColorIO + + + .. py:method:: Baker.getTargetSpace(self: PyOpenColorIO.Baker) -> str + :module: PyOpenColorIO + + + .. py:method:: Baker.getView(self: PyOpenColorIO.Baker) -> str + :module: PyOpenColorIO + + + .. py:method:: Baker.setConfig(self: PyOpenColorIO.Baker, config: PyOpenColorIO.Config) -> None + :module: PyOpenColorIO + + Set the config to use. + + + .. py:method:: Baker.setCubeSize(self: PyOpenColorIO.Baker, cubeSize: int) -> None + :module: PyOpenColorIO + + Override the main LUT (3d or 1d) sample size. Default value is -1, which allows each format to use its own most appropriate size. + + + .. py:method:: Baker.setDisplayView(self: PyOpenColorIO.Baker, display: str, view: str) -> None + :module: PyOpenColorIO + + Set the display and view to apply during the baking. Must not be used if setTargetSpace is used. + + + .. py:method:: Baker.setFormat(self: PyOpenColorIO.Baker, formatName: str) -> None + :module: PyOpenColorIO + + Set the LUT output format. + + + .. py:method:: Baker.setInputSpace(self: PyOpenColorIO.Baker, inputSpace: str) -> None + :module: PyOpenColorIO + + Set the input :ref:`ColorSpace` that the LUT will be applied to. + + + .. py:method:: Baker.setLooks(self: PyOpenColorIO.Baker, looks: str) -> None + :module: PyOpenColorIO + + Set the looks to be applied during baking. Looks is a potentially comma (or colon) delimited list of lookNames, where +/- prefixes are optionally allowed to denote forward/inverse look specification. (And forward is assumed in the absence of either). + + + .. py:method:: Baker.setShaperSize(self: PyOpenColorIO.Baker, shaperSize: int) -> None + :module: PyOpenColorIO + + Override the default shaper LUT size. Default value is -1, which allows each format to use its own most appropriate size. For the CLF format, the default uses a half-domain LUT1D (which is ideal for scene-linear inputs). + + + .. py:method:: Baker.setShaperSpace(self: PyOpenColorIO.Baker, shaperSpace: str) -> None + :module: PyOpenColorIO + + Set an *optional* :ref:`ColorSpace` to shape the incoming values of the LUT. When baking 3DLUT, this will correspond to the 1D shaper used to normalise incoming values to the unit range. When baking 1D LUT, this will be used to determine the input range of the LUT. + + + .. py:method:: Baker.setTargetSpace(self: PyOpenColorIO.Baker, targetSpace: str) -> None + :module: PyOpenColorIO + + Set the target (i.e., output) color space for the LUT. Must not be used if setDisplayView is used. + + +.. py:class:: FormatIterator + :module: PyOpenColorIO.Baker + + Iterator on LUT baker Formats. + + Each item is a tuple containing format name and format extension. + + + .. py:method:: FormatIterator.__getitem__(self: PyOpenColorIO.Baker.FormatIterator, arg0: int) -> tuple + :module: PyOpenColorIO.Baker + + + .. py:method:: FormatIterator.__iter__(self: PyOpenColorIO.Baker.FormatIterator) -> PyOpenColorIO.Baker.FormatIterator + :module: PyOpenColorIO.Baker + + + .. py:method:: FormatIterator.__len__(self: PyOpenColorIO.Baker.FormatIterator) -> int + :module: PyOpenColorIO.Baker + + + .. py:method:: FormatIterator.__next__(self: PyOpenColorIO.Baker.FormatIterator) -> tuple + :module: PyOpenColorIO.Baker + diff --git a/docs/api/python/frozen/pyopencolorio_bitdepth.rst b/docs/api/python/frozen/pyopencolorio_bitdepth.rst new file mode 100644 index 0000000000..982778f0b8 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_bitdepth.rst @@ -0,0 +1,81 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: BitDepth + :module: PyOpenColorIO + + Used in a configuration file to indicate the bit-depth of a color space, and by the :ref:`Processor` to specify the input and output bit-depths of images to process. Note that :ref:`Processor` only supports: UINT8, UINT10, UINT12, UINT16, F16 and F32. + + Members: + + BIT_DEPTH_UNKNOWN : + + BIT_DEPTH_UINT8 : + + BIT_DEPTH_UINT10 : + + BIT_DEPTH_UINT12 : + + BIT_DEPTH_UINT14 : + + BIT_DEPTH_UINT16 : + + BIT_DEPTH_UINT32 : Here for historical reason but that's not supported. + + BIT_DEPTH_F16 : + + BIT_DEPTH_F32 : + + .. py:method:: name() -> str + :property: + + .. py:attribute:: BitDepth.BIT_DEPTH_F16 + :module: PyOpenColorIO + :value: + + + .. py:attribute:: BitDepth.BIT_DEPTH_F32 + :module: PyOpenColorIO + :value: + + + .. py:attribute:: BitDepth.BIT_DEPTH_UINT10 + :module: PyOpenColorIO + :value: + + + .. py:attribute:: BitDepth.BIT_DEPTH_UINT12 + :module: PyOpenColorIO + :value: + + + .. py:attribute:: BitDepth.BIT_DEPTH_UINT14 + :module: PyOpenColorIO + :value: + + + .. py:attribute:: BitDepth.BIT_DEPTH_UINT16 + :module: PyOpenColorIO + :value: + + + .. py:attribute:: BitDepth.BIT_DEPTH_UINT32 + :module: PyOpenColorIO + :value: + + + .. py:attribute:: BitDepth.BIT_DEPTH_UINT8 + :module: PyOpenColorIO + :value: + + + .. py:attribute:: BitDepth.BIT_DEPTH_UNKNOWN + :module: PyOpenColorIO + :value: + + + .. py:property:: BitDepth.value + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_bitdepthfromstring.rst b/docs/api/python/frozen/pyopencolorio_bitdepthfromstring.rst new file mode 100644 index 0000000000..1480a4fbc1 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_bitdepthfromstring.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: BitDepthFromString(str: str) -> PyOpenColorIO.BitDepth + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_bitdepthisfloat.rst b/docs/api/python/frozen/pyopencolorio_bitdepthisfloat.rst new file mode 100644 index 0000000000..e939b924f7 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_bitdepthisfloat.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: BitDepthIsFloat(bitDepth: PyOpenColorIO.BitDepth) -> bool + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_bitdepthtoint.rst b/docs/api/python/frozen/pyopencolorio_bitdepthtoint.rst new file mode 100644 index 0000000000..751498c402 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_bitdepthtoint.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: BitDepthToInt(bitDepth: PyOpenColorIO.BitDepth) -> int + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_bitdepthtostring.rst b/docs/api/python/frozen/pyopencolorio_bitdepthtostring.rst new file mode 100644 index 0000000000..2aca2f39fd --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_bitdepthtostring.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: BitDepthToString(bitDepth: PyOpenColorIO.BitDepth) -> str + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_boolfromstring.rst b/docs/api/python/frozen/pyopencolorio_boolfromstring.rst new file mode 100644 index 0000000000..9907e10ece --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_boolfromstring.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: BoolFromString(str: str) -> bool + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_booltostring.rst b/docs/api/python/frozen/pyopencolorio_booltostring.rst new file mode 100644 index 0000000000..31de782aa6 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_booltostring.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: BoolToString(value: bool) -> str + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_builtintransform.rst b/docs/api/python/frozen/pyopencolorio_builtintransform.rst new file mode 100644 index 0000000000..9f9f5ca9c9 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_builtintransform.rst @@ -0,0 +1,54 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: BuiltinTransform + :module: PyOpenColorIO + + A built-in transform is similar to a :ref:`FileTransform`, but without the file. OCIO knows how to build a set of commonly used transforms on-demand, thus avoiding the need for external files and simplifying config authoring. + + + .. py:method:: BuiltinTransform.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.BuiltinTransform) -> None + + 2. __init__(self: PyOpenColorIO.BuiltinTransform, style: str = 'IDENTITY', direction: PyOpenColorIO.TransformDirection = ) -> None + + + .. py:method:: BuiltinTransform.getDescription(self: PyOpenColorIO.BuiltinTransform) -> str + :module: PyOpenColorIO + + + .. py:method:: BuiltinTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection + :module: PyOpenColorIO + + + .. py:method:: BuiltinTransform.getStyle(self: PyOpenColorIO.BuiltinTransform) -> str + :module: PyOpenColorIO + + + .. py:method:: BuiltinTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType + :module: PyOpenColorIO + + + .. py:method:: BuiltinTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None + :module: PyOpenColorIO + + Note that this only affects the evaluation and not the values stored in the object. + + + .. py:method:: BuiltinTransform.setStyle(self: PyOpenColorIO.BuiltinTransform, style: str) -> None + :module: PyOpenColorIO + + Select an existing built-in transform style from the list accessible through :cpp:class:`:ref:`BuiltinTransformRegistry``. The style is the ID string that identifies which transform to apply. + + + .. py:method:: BuiltinTransform.validate(self: PyOpenColorIO.Transform) -> None + :module: PyOpenColorIO + + Will throw if data is not valid. + diff --git a/docs/api/python/frozen/pyopencolorio_builtintransformregistry.rst b/docs/api/python/frozen/pyopencolorio_builtintransformregistry.rst new file mode 100644 index 0000000000..be93f40fe8 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_builtintransformregistry.rst @@ -0,0 +1,60 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: BuiltinTransformRegistry + :module: PyOpenColorIO + + The built-in transform registry contains all the existing built-in transforms which can be used by a configuration (version 2 or higher only). + + + .. py:method:: BuiltinTransformRegistry.__init__(self: PyOpenColorIO.BuiltinTransformRegistry) -> None + :module: PyOpenColorIO + + Get the current built-in transform registry. + + + .. py:method:: BuiltinTransformRegistry.getBuiltins(self: PyOpenColorIO.BuiltinTransformRegistry) -> PyOpenColorIO.BuiltinTransformRegistry.BuiltinIterator + :module: PyOpenColorIO + + +.. py:class:: BuiltinStyleIterator + :module: PyOpenColorIO.BuiltinTransformRegistry + + + .. py:method:: BuiltinStyleIterator.__getitem__(self: PyOpenColorIO.BuiltinTransformRegistry.BuiltinStyleIterator, arg0: int) -> str + :module: PyOpenColorIO.BuiltinTransformRegistry + + + .. py:method:: BuiltinStyleIterator.__iter__(self: PyOpenColorIO.BuiltinTransformRegistry.BuiltinStyleIterator) -> PyOpenColorIO.BuiltinTransformRegistry.BuiltinStyleIterator + :module: PyOpenColorIO.BuiltinTransformRegistry + + + .. py:method:: BuiltinStyleIterator.__len__(self: PyOpenColorIO.BuiltinTransformRegistry.BuiltinStyleIterator) -> int + :module: PyOpenColorIO.BuiltinTransformRegistry + + + .. py:method:: BuiltinStyleIterator.__next__(self: PyOpenColorIO.BuiltinTransformRegistry.BuiltinStyleIterator) -> str + :module: PyOpenColorIO.BuiltinTransformRegistry + + +.. py:class:: BuiltinIterator + :module: PyOpenColorIO.BuiltinTransformRegistry + + + .. py:method:: BuiltinIterator.__getitem__(self: PyOpenColorIO.BuiltinTransformRegistry.BuiltinIterator, arg0: int) -> tuple + :module: PyOpenColorIO.BuiltinTransformRegistry + + + .. py:method:: BuiltinIterator.__iter__(self: PyOpenColorIO.BuiltinTransformRegistry.BuiltinIterator) -> PyOpenColorIO.BuiltinTransformRegistry.BuiltinIterator + :module: PyOpenColorIO.BuiltinTransformRegistry + + + .. py:method:: BuiltinIterator.__len__(self: PyOpenColorIO.BuiltinTransformRegistry.BuiltinIterator) -> int + :module: PyOpenColorIO.BuiltinTransformRegistry + + + .. py:method:: BuiltinIterator.__next__(self: PyOpenColorIO.BuiltinTransformRegistry.BuiltinIterator) -> tuple + :module: PyOpenColorIO.BuiltinTransformRegistry + diff --git a/docs/api/python/frozen/pyopencolorio_cdlstyle.rst b/docs/api/python/frozen/pyopencolorio_cdlstyle.rst new file mode 100644 index 0000000000..8130dbb3f3 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_cdlstyle.rst @@ -0,0 +1,37 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: CDLStyle + :module: PyOpenColorIO + + Members: + + CDL_ASC : ASC CDL specification v1.2. + + CDL_NO_CLAMP : CDL that does not clamp. + + CDL_TRANSFORM_DEFAULT : + + .. py:method:: name() -> str + :property: + + .. py:attribute:: CDLStyle.CDL_ASC + :module: PyOpenColorIO + :value: + + + .. py:attribute:: CDLStyle.CDL_NO_CLAMP + :module: PyOpenColorIO + :value: + + + .. py:attribute:: CDLStyle.CDL_TRANSFORM_DEFAULT + :module: PyOpenColorIO + :value: + + + .. py:property:: CDLStyle.value + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_cdlstylefromstring.rst b/docs/api/python/frozen/pyopencolorio_cdlstylefromstring.rst new file mode 100644 index 0000000000..dd20c3a311 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_cdlstylefromstring.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: CDLStyleFromString(str: str) -> PyOpenColorIO.CDLStyle + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_cdlstyletostring.rst b/docs/api/python/frozen/pyopencolorio_cdlstyletostring.rst new file mode 100644 index 0000000000..81f65d6fd7 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_cdlstyletostring.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: CDLStyleToString(style: PyOpenColorIO.CDLStyle) -> str + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_cdltransform.rst b/docs/api/python/frozen/pyopencolorio_cdltransform.rst new file mode 100644 index 0000000000..b7be310f53 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_cdltransform.rst @@ -0,0 +1,151 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: CDLTransform + :module: PyOpenColorIO + + An implementation of the ASC Color Decision List (CDL), based on the ASC v1.2 specification. + + **ASC_SOP** + + Slope, offset, power:: out = clamp( (in * slope) + offset ) ^ power + + .. note:: + ​ If the config version is 1, negative values are clamped if the power is not 1.0. For config version 2 and higher, the negative handling is controlled by the CDL style. + + + .. py:method:: CDLTransform.CreateFromFile(src: str, id: str) -> PyOpenColorIO.CDLTransform + :module: PyOpenColorIO + :staticmethod: + + Load the CDL from the src .cdl, .cc, or .ccc file. + + .. note:: + The cccid can be the ID of a CDL or the index of the CDL (as string). If cccid is NULL or empty the first CDL is returned. The cccid is case-sensitive. The src must be an absolute path reference, no relative directory or envvar resolution is performed. Throws if file does not contain any CDL or if the specified cccid is not found. + + + .. py:method:: CDLTransform.CreateGroupFromFile(src: str) -> PyOpenColorIO.GroupTransform + :module: PyOpenColorIO + :staticmethod: + + Load all of the CDLs in a .cdl or .ccc file into a single :ref:`GroupTransform`. + + .. note:: + This may be useful as a quicker way for applications to check the contents of each of the CDLs. The src must be an absolute path reference, no relative directory or envvar resolution is performed. + + + .. py:method:: CDLTransform.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.CDLTransform) -> None + + 2. __init__(self: PyOpenColorIO.CDLTransform, direction: PyOpenColorIO.TransformDirection = ) -> None + + 3. __init__(self: PyOpenColorIO.CDLTransform, slope: List[float[3]] = [1.0, 1.0, 1.0], offset: List[float[3]] = [0.0, 0.0, 0.0], power: List[float[3]] = [1.0, 1.0, 1.0], sat: float = 1.0, id: str = '', description: str = '', direction: PyOpenColorIO.TransformDirection = ) -> None + + + .. py:method:: CDLTransform.equals(self: PyOpenColorIO.CDLTransform, other: PyOpenColorIO.CDLTransform) -> bool + :module: PyOpenColorIO + + + .. py:method:: CDLTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection + :module: PyOpenColorIO + + + .. py:method:: CDLTransform.getFirstSOPDescription(self: PyOpenColorIO.CDLTransform) -> str + :module: PyOpenColorIO + + + .. py:method:: CDLTransform.getFormatMetadata(self: PyOpenColorIO.CDLTransform) -> PyOpenColorIO.FormatMetadata + :module: PyOpenColorIO + + + .. py:method:: CDLTransform.getID(self: PyOpenColorIO.CDLTransform) -> str + :module: PyOpenColorIO + + The get/setID methods are now deprecated. The preferred way of interacting with the ID is now via the transform's formatMetadata. + + + .. py:method:: CDLTransform.getOffset(self: PyOpenColorIO.CDLTransform) -> List[float[3]] + :module: PyOpenColorIO + + + .. py:method:: CDLTransform.getPower(self: PyOpenColorIO.CDLTransform) -> List[float[3]] + :module: PyOpenColorIO + + + .. py:method:: CDLTransform.getSOP(self: PyOpenColorIO.CDLTransform) -> List[float[9]] + :module: PyOpenColorIO + + + .. py:method:: CDLTransform.getSat(self: PyOpenColorIO.CDLTransform) -> float + :module: PyOpenColorIO + + + .. py:method:: CDLTransform.getSatLumaCoefs(self: PyOpenColorIO.CDLTransform) -> List[float[3]] + :module: PyOpenColorIO + + These are hard-coded, by spec, to r709. + + + .. py:method:: CDLTransform.getSlope(self: PyOpenColorIO.CDLTransform) -> List[float[3]] + :module: PyOpenColorIO + + + .. py:method:: CDLTransform.getStyle(self: PyOpenColorIO.CDLTransform) -> PyOpenColorIO.CDLStyle + :module: PyOpenColorIO + + + .. py:method:: CDLTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType + :module: PyOpenColorIO + + + .. py:method:: CDLTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None + :module: PyOpenColorIO + + Note that this only affects the evaluation and not the values stored in the object. + + + .. py:method:: CDLTransform.setFirstSOPDescription(self: PyOpenColorIO.CDLTransform, description: str) -> None + :module: PyOpenColorIO + + + .. py:method:: CDLTransform.setID(self: PyOpenColorIO.CDLTransform, id: str) -> None + :module: PyOpenColorIO + + + .. py:method:: CDLTransform.setOffset(self: PyOpenColorIO.CDLTransform, rgb: List[float[3]]) -> None + :module: PyOpenColorIO + + + .. py:method:: CDLTransform.setPower(self: PyOpenColorIO.CDLTransform, rgb: List[float[3]]) -> None + :module: PyOpenColorIO + + + .. py:method:: CDLTransform.setSOP(self: PyOpenColorIO.CDLTransform, vec9: List[float[9]]) -> None + :module: PyOpenColorIO + + + .. py:method:: CDLTransform.setSat(self: PyOpenColorIO.CDLTransform, sat: float) -> None + :module: PyOpenColorIO + + + .. py:method:: CDLTransform.setSlope(self: PyOpenColorIO.CDLTransform, rgb: List[float[3]]) -> None + :module: PyOpenColorIO + + + .. py:method:: CDLTransform.setStyle(self: PyOpenColorIO.CDLTransform, style: PyOpenColorIO.CDLStyle) -> None + :module: PyOpenColorIO + + Use CDL_ASC to clamp values to [0,1] per the ASC spec. Use NO_CLAMP to never clamp values (regardless of whether power is 1.0). The NO_CLAMP option passes negatives through unchanged (like the NEGATIVE_PASS_THRU style of :ref:`ExponentTransform`). The default style is CDL_NO_CLAMP. + + + .. py:method:: CDLTransform.validate(self: PyOpenColorIO.Transform) -> None + :module: PyOpenColorIO + + Will throw if data is not valid. + diff --git a/docs/api/python/frozen/pyopencolorio_channelordering.rst b/docs/api/python/frozen/pyopencolorio_channelordering.rst new file mode 100644 index 0000000000..4163c1fc4b --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_channelordering.rst @@ -0,0 +1,53 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: ChannelOrdering + :module: PyOpenColorIO + + Used by :ref:`PackedImageDesc` to indicate the channel ordering of the image to process. + + Members: + + CHANNEL_ORDERING_RGBA : + + CHANNEL_ORDERING_BGRA : + + CHANNEL_ORDERING_ABGR : + + CHANNEL_ORDERING_RGB : + + CHANNEL_ORDERING_BGR : + + .. py:method:: name() -> str + :property: + + .. py:attribute:: ChannelOrdering.CHANNEL_ORDERING_ABGR + :module: PyOpenColorIO + :value: + + + .. py:attribute:: ChannelOrdering.CHANNEL_ORDERING_BGR + :module: PyOpenColorIO + :value: + + + .. py:attribute:: ChannelOrdering.CHANNEL_ORDERING_BGRA + :module: PyOpenColorIO + :value: + + + .. py:attribute:: ChannelOrdering.CHANNEL_ORDERING_RGB + :module: PyOpenColorIO + :value: + + + .. py:attribute:: ChannelOrdering.CHANNEL_ORDERING_RGBA + :module: PyOpenColorIO + :value: + + + .. py:property:: ChannelOrdering.value + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_clearallcaches.rst b/docs/api/python/frozen/pyopencolorio_clearallcaches.rst new file mode 100644 index 0000000000..1e01d698de --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_clearallcaches.rst @@ -0,0 +1,15 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: ClearAllCaches() -> None + :module: PyOpenColorIO + + During normal usage, OpenColorIO tends to cache certain global information (such as the contents of LUTs on disk, intermediate results, etc.). Calling this function will flush all such information. The global information are related to LUT file identifications, loaded LUT file content and CDL transforms from loaded CDL files. + + Under normal usage, this is not necessary, but it can be helpful in particular instances, such as designing OCIO profiles, and wanting to re-read luts without restarting. + + .. note:: + The method does not apply to instance specific caches such as the processor cache in a config instance or the GPU and CPU processor caches in a processor instance. Here deleting the instance flushes the cache. + diff --git a/docs/api/python/frozen/pyopencolorio_colorspace.rst b/docs/api/python/frozen/pyopencolorio_colorspace.rst new file mode 100644 index 0000000000..5a6adf8d99 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_colorspace.rst @@ -0,0 +1,255 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: ColorSpace + :module: PyOpenColorIO + + The *:ref:`ColorSpace`* is the state of an image with respect to colorimetry and color encoding. Transforming images between different *ColorSpaces* is the primary motivation for this library. + + While a complete discussion of color spaces is beyond the scope of header documentation, traditional uses would be to have *ColorSpaces* corresponding to: physical capture devices (known cameras, scanners), and internal 'convenience' spaces (such as scene linear, logarithmic). + + + .. py:method:: ColorSpace.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.ColorSpace) -> None + + 2. __init__(self: PyOpenColorIO.ColorSpace, referenceSpace: PyOpenColorIO.ReferenceSpaceType) -> None + + 3. __init__(self: PyOpenColorIO.ColorSpace, referenceSpace: PyOpenColorIO.ReferenceSpaceType = , name: str = '', aliases: List[str] = [], family: str = '', encoding: str = '', equalityGroup: str = '', description: str = '', bitDepth: PyOpenColorIO.BitDepth = , isData: bool = False, allocation: PyOpenColorIO.Allocation = , allocationVars: List[float] = [], toReference: PyOpenColorIO.Transform = None, fromReference: PyOpenColorIO.Transform = None, categories: List[str] = []) -> None + + + .. py:method:: ColorSpace.addAlias(self: PyOpenColorIO.ColorSpace, alias: str) -> None + :module: PyOpenColorIO + + Add an alias for the color space name (the aliases may be used as a synonym for the name). Nothing will be added if the alias is already the color space name, one of its aliases, or the argument is null. The aliases must not conflict with existing roles, color space names, named transform names, or other aliases. This is verified when adding the color space to the config. + + + .. py:method:: ColorSpace.addCategory(self: PyOpenColorIO.ColorSpace, category: str) -> None + :module: PyOpenColorIO + + Add a single category. + + .. note:: + Will do nothing if the category already exists. + + + .. py:method:: ColorSpace.clearAliases(self: PyOpenColorIO.ColorSpace) -> None + :module: PyOpenColorIO + + + .. py:method:: ColorSpace.clearCategories(self: PyOpenColorIO.ColorSpace) -> None + :module: PyOpenColorIO + + Clear all the categories. + + + .. py:method:: ColorSpace.getAliases(self: PyOpenColorIO.ColorSpace) -> PyOpenColorIO.ColorSpace.ColorSpaceAliasIterator + :module: PyOpenColorIO + + + .. py:method:: ColorSpace.getAllocation(self: PyOpenColorIO.ColorSpace) -> PyOpenColorIO.Allocation + :module: PyOpenColorIO + + *Allocation* + + If this colorspace needs to be transferred to a limited dynamic range coding space (such as during display with a GPU path), use this allocation to maximize bit efficiency. + + + .. py:method:: ColorSpace.getAllocationVars(self: PyOpenColorIO.ColorSpace) -> List[float] + :module: PyOpenColorIO + + + .. py:method:: ColorSpace.getBitDepth(self: PyOpenColorIO.ColorSpace) -> PyOpenColorIO.BitDepth + :module: PyOpenColorIO + + + .. py:method:: ColorSpace.getCategories(self: PyOpenColorIO.ColorSpace) -> PyOpenColorIO.ColorSpace.ColorSpaceCategoryIterator + :module: PyOpenColorIO + + + .. py:method:: ColorSpace.getDescription(self: PyOpenColorIO.ColorSpace) -> str + :module: PyOpenColorIO + + + .. py:method:: ColorSpace.getEncoding(self: PyOpenColorIO.ColorSpace) -> str + :module: PyOpenColorIO + + *Encodings* + + It is sometimes useful for applications to group color spaces based on how the color values are digitally encoded. For example, images in scene-linear, logarithmic, video, and data color spaces could have different default views. Unlike the Family and EqualityGroup attributes of a color space, the list of Encodings is predefined in the OCIO documentation (rather than being config-specific) to make it easier for applications to utilize. + + Here is an example config entry that could appear under a :ref:`ColorSpace`: + + .. code-block:: cpp + + encoding: scene-linear + + Encoding strings are not case-sensitive. Although users may add their own encodings, the strings will typically come from a fixed set listed in the documentation (similar to roles). + + + .. py:method:: ColorSpace.getEqualityGroup(self: PyOpenColorIO.ColorSpace) -> str + :module: PyOpenColorIO + + Get the :ref:`ColorSpace` group name (used for equality comparisons) This allows no-op transforms between different colorspaces. If an equalityGroup is not defined (an empty string), it will be considered unique (i.e., it will not compare as equal to other ColorSpaces with an empty equality group). + + + .. py:method:: ColorSpace.getFamily(self: PyOpenColorIO.ColorSpace) -> str + :module: PyOpenColorIO + + Get the family, for use in user interfaces (optional) The family string could use a '/' separator to indicate levels to be used by hierarchical menus. + + + .. py:method:: ColorSpace.getName(self: PyOpenColorIO.ColorSpace) -> str + :module: PyOpenColorIO + + + .. py:method:: ColorSpace.getReferenceSpaceType(self: PyOpenColorIO.ColorSpace) -> PyOpenColorIO.ReferenceSpaceType + :module: PyOpenColorIO + + A display color space will use the display-referred reference space. + + + .. py:method:: ColorSpace.getTransform(self: PyOpenColorIO.ColorSpace, direction: PyOpenColorIO.ColorSpaceDirection) -> PyOpenColorIO.Transform + :module: PyOpenColorIO + + *:ref:`Transform`* + + If a transform in the specified direction has been specified, return it. Otherwise return a null ConstTransformRcPtr + + + .. py:method:: ColorSpace.hasCategory(self: PyOpenColorIO.ColorSpace, category: str) -> bool + :module: PyOpenColorIO + + Return true if the category is present. + + A category is used to allow applications to filter the list of color spaces they display in menus based on what that color space is used for. + + Here is an example config entry that could appear under a :ref:`ColorSpace`: + + .. code-block:: cpp + + categories: [ file-io, working-space, basic-3d ] + + The example contains three categories: 'file-io', 'working-space' and 'basic-3d'. + + .. note:: + Category strings are not case-sensitive and the order is not significant. + + There is no limit imposed on length or number. Although users may add their own categories, the strings will typically come from a fixed set listed in the documentation (similar to roles). + + + .. py:method:: ColorSpace.isData(self: PyOpenColorIO.ColorSpace) -> bool + :module: PyOpenColorIO + + *Data* + + ColorSpaces that are data are treated a bit special. Basically, any colorspace transforms you try to apply to them are ignored. (Think of applying a gamut mapping transform to an ID pass). However, the setDataBypass method on :ref:`ColorSpaceTransform` and :ref:`DisplayViewTransform` allow applications to process data when necessary. (Think of sending mattes to an HDR monitor.) + + This is traditionally used for pixel data that represents non-color pixel data, such as normals, point positions, ID information, etc. + + + .. py:method:: ColorSpace.removeAlias(self: PyOpenColorIO.ColorSpace, alias: str) -> None + :module: PyOpenColorIO + + Does nothing if alias is not present. + + + .. py:method:: ColorSpace.removeCategory(self: PyOpenColorIO.ColorSpace, category: str) -> None + :module: PyOpenColorIO + + Remove a category. + + .. note:: + Will do nothing if the category is missing. + + + .. py:method:: ColorSpace.setAllocation(self: PyOpenColorIO.ColorSpace, allocation: PyOpenColorIO.Allocation) -> None + :module: PyOpenColorIO + + + .. py:method:: ColorSpace.setAllocationVars(self: PyOpenColorIO.ColorSpace, vars: List[float]) -> None + :module: PyOpenColorIO + + + .. py:method:: ColorSpace.setBitDepth(self: PyOpenColorIO.ColorSpace, bitDepth: PyOpenColorIO.BitDepth) -> None + :module: PyOpenColorIO + + + .. py:method:: ColorSpace.setDescription(self: PyOpenColorIO.ColorSpace, description: str) -> None + :module: PyOpenColorIO + + + .. py:method:: ColorSpace.setEncoding(self: PyOpenColorIO.ColorSpace, encoding: str) -> None + :module: PyOpenColorIO + + + .. py:method:: ColorSpace.setEqualityGroup(self: PyOpenColorIO.ColorSpace, equalityGroup: str) -> None + :module: PyOpenColorIO + + + .. py:method:: ColorSpace.setFamily(self: PyOpenColorIO.ColorSpace, family: str) -> None + :module: PyOpenColorIO + + Set the family, for use in user interfaces (optional) + + + .. py:method:: ColorSpace.setIsData(self: PyOpenColorIO.ColorSpace, isData: bool) -> None + :module: PyOpenColorIO + + + .. py:method:: ColorSpace.setName(self: PyOpenColorIO.ColorSpace, name: str) -> None + :module: PyOpenColorIO + + If the name is already an alias, that alias is removed. + + + .. py:method:: ColorSpace.setTransform(self: PyOpenColorIO.ColorSpace, transform: PyOpenColorIO.Transform, direction: PyOpenColorIO.ColorSpaceDirection) -> None + :module: PyOpenColorIO + + Specify the transform for the appropriate direction. Setting the transform to null will clear it. + + +.. py:class:: ColorSpaceCategoryIterator + :module: PyOpenColorIO.ColorSpace + + + .. py:method:: ColorSpaceCategoryIterator.__getitem__(self: PyOpenColorIO.ColorSpace.ColorSpaceCategoryIterator, arg0: int) -> str + :module: PyOpenColorIO.ColorSpace + + + .. py:method:: ColorSpaceCategoryIterator.__iter__(self: PyOpenColorIO.ColorSpace.ColorSpaceCategoryIterator) -> PyOpenColorIO.ColorSpace.ColorSpaceCategoryIterator + :module: PyOpenColorIO.ColorSpace + + + .. py:method:: ColorSpaceCategoryIterator.__len__(self: PyOpenColorIO.ColorSpace.ColorSpaceCategoryIterator) -> int + :module: PyOpenColorIO.ColorSpace + + + .. py:method:: ColorSpaceCategoryIterator.__next__(self: PyOpenColorIO.ColorSpace.ColorSpaceCategoryIterator) -> str + :module: PyOpenColorIO.ColorSpace + + +.. py:class:: ColorSpaceAliasIterator + :module: PyOpenColorIO.ColorSpace + + + .. py:method:: ColorSpaceAliasIterator.__getitem__(self: PyOpenColorIO.ColorSpace.ColorSpaceAliasIterator, arg0: int) -> str + :module: PyOpenColorIO.ColorSpace + + + .. py:method:: ColorSpaceAliasIterator.__iter__(self: PyOpenColorIO.ColorSpace.ColorSpaceAliasIterator) -> PyOpenColorIO.ColorSpace.ColorSpaceAliasIterator + :module: PyOpenColorIO.ColorSpace + + + .. py:method:: ColorSpaceAliasIterator.__len__(self: PyOpenColorIO.ColorSpace.ColorSpaceAliasIterator) -> int + :module: PyOpenColorIO.ColorSpace + + + .. py:method:: ColorSpaceAliasIterator.__next__(self: PyOpenColorIO.ColorSpace.ColorSpaceAliasIterator) -> str + :module: PyOpenColorIO.ColorSpace + diff --git a/docs/api/python/frozen/pyopencolorio_colorspacedirection.rst b/docs/api/python/frozen/pyopencolorio_colorspacedirection.rst new file mode 100644 index 0000000000..dd0ea99c02 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_colorspacedirection.rst @@ -0,0 +1,30 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: ColorSpaceDirection + :module: PyOpenColorIO + + Members: + + COLORSPACE_DIR_TO_REFERENCE : + + COLORSPACE_DIR_FROM_REFERENCE : + + .. py:method:: name() -> str + :property: + + .. py:attribute:: ColorSpaceDirection.COLORSPACE_DIR_FROM_REFERENCE + :module: PyOpenColorIO + :value: + + + .. py:attribute:: ColorSpaceDirection.COLORSPACE_DIR_TO_REFERENCE + :module: PyOpenColorIO + :value: + + + .. py:property:: ColorSpaceDirection.value + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_colorspacehelpers.rst b/docs/api/python/frozen/pyopencolorio_colorspacehelpers.rst index 977888f18a..938855a665 100644 --- a/docs/api/python/frozen/pyopencolorio_colorspacehelpers.rst +++ b/docs/api/python/frozen/pyopencolorio_colorspacehelpers.rst @@ -3,7 +3,7 @@ Copyright Contributors to the OpenColorIO Project. Do not edit! This file was automatically generated by share/docs/frozendoc.py. -.. py:function:: AddColorSpace(config: PyOpenColorIO.PyOpenColorIO.Config, name: str, transformFilePath: str, categories: str = '', connectionColorSpaceName: str) -> None +.. py:function:: AddColorSpace(config: PyOpenColorIO.Config, name: str, transformFilePath: str, categories: str = '', connectionColorSpaceName: str) -> None :module: PyOpenColorIO.ColorSpaceHelpers Add a new color space to the config instance. The output of the userTransform must be in the specified connectionColorSpace. diff --git a/docs/api/python/frozen/pyopencolorio_colorspacemenuhelper.rst b/docs/api/python/frozen/pyopencolorio_colorspacemenuhelper.rst index 99a350fea8..ad7514adaa 100644 --- a/docs/api/python/frozen/pyopencolorio_colorspacemenuhelper.rst +++ b/docs/api/python/frozen/pyopencolorio_colorspacemenuhelper.rst @@ -5,7 +5,6 @@ .. py:class:: ColorSpaceMenuHelper :module: PyOpenColorIO - :canonical: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper Helper class to create menus for the content of a config. @@ -16,57 +15,57 @@ The overall ordering of items is: color spaces, named transforms, roles, and additional color spaces. The display color spaces will either come before or after the other color spaces based on where that block of spaces appears in the config. The order of items returned by the menu helper preserves the order of items in the config itself for each type of elements, thus preserving the intent of the config author. For example, if you call getName at idx and idx+1, the name returned at idx+1 will be from farther down in the config than the one at idx as long as both are of the same type. (An application may ask for only the items in one of those blocks if it wants to handle them separately.) If the application makes use of hierarchical menus, that will obviously impose a different order on what the user sees in the menu. Though even with hierarchical menus, applications should try to preserve config ordering (which is equivalent to index ordering) for items within the same sub-menu. - .. py:method:: ColorSpaceMenuHelper.__init__(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper, parameters: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters) -> None + .. py:method:: ColorSpaceMenuHelper.__init__(self: PyOpenColorIO.ColorSpaceMenuHelper, parameters: PyOpenColorIO.ColorSpaceMenuParameters) -> None :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuHelper.getDescription(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper, index: int) -> str + .. py:method:: ColorSpaceMenuHelper.getDescription(self: PyOpenColorIO.ColorSpaceMenuHelper, index: int) -> str :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuHelper.getFamily(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper, index: int) -> str + .. py:method:: ColorSpaceMenuHelper.getFamily(self: PyOpenColorIO.ColorSpaceMenuHelper, index: int) -> str :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuHelper.getHierarchyLevels(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper, index: int) -> PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator + .. py:method:: ColorSpaceMenuHelper.getHierarchyLevels(self: PyOpenColorIO.ColorSpaceMenuHelper, index: int) -> PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuHelper.getIndexFromName(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper, name: str) -> int + .. py:method:: ColorSpaceMenuHelper.getIndexFromName(self: PyOpenColorIO.ColorSpaceMenuHelper, name: str) -> int :module: PyOpenColorIO Get the index of the element of a given name. Return (size_t)-1 name if NULL or empty, or if no element with that name is found. - .. py:method:: ColorSpaceMenuHelper.getIndexFromUIName(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper, name: str) -> int + .. py:method:: ColorSpaceMenuHelper.getIndexFromUIName(self: PyOpenColorIO.ColorSpaceMenuHelper, name: str) -> int :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuHelper.getName(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper, index: int) -> str + .. py:method:: ColorSpaceMenuHelper.getName(self: PyOpenColorIO.ColorSpaceMenuHelper, index: int) -> str :module: PyOpenColorIO Get the color space (or role) name used in the config for this menu item. Will be empty if the index is out of range. - .. py:method:: ColorSpaceMenuHelper.getNameFromUIName(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper, name: str) -> str + .. py:method:: ColorSpaceMenuHelper.getNameFromUIName(self: PyOpenColorIO.ColorSpaceMenuHelper, name: str) -> str :module: PyOpenColorIO Get the color space name from the UI name. - .. py:method:: ColorSpaceMenuHelper.getNumColorSpaces(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper) -> int + .. py:method:: ColorSpaceMenuHelper.getNumColorSpaces(self: PyOpenColorIO.ColorSpaceMenuHelper) -> int :module: PyOpenColorIO Access to the color spaces (or roles). - .. py:method:: ColorSpaceMenuHelper.getUIName(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper, index: int) -> str + .. py:method:: ColorSpaceMenuHelper.getUIName(self: PyOpenColorIO.ColorSpaceMenuHelper, index: int) -> str :module: PyOpenColorIO Get the name to use in the menu UI. This might be different from the config name, for example in the case of roles. Will be empty if the index is out of range. - .. py:method:: ColorSpaceMenuHelper.getUINameFromName(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper, name: str) -> str + .. py:method:: ColorSpaceMenuHelper.getUINameFromName(self: PyOpenColorIO.ColorSpaceMenuHelper, name: str) -> str :module: PyOpenColorIO Get the color space UI name from the name. @@ -74,21 +73,20 @@ .. py:class:: ColorSpaceLevelIterator :module: PyOpenColorIO.ColorSpaceMenuHelper - :canonical: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator - .. py:method:: ColorSpaceLevelIterator.__getitem__(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator, arg0: int) -> str + .. py:method:: ColorSpaceLevelIterator.__getitem__(self: PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator, arg0: int) -> str :module: PyOpenColorIO.ColorSpaceMenuHelper - .. py:method:: ColorSpaceLevelIterator.__iter__(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator) -> PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator + .. py:method:: ColorSpaceLevelIterator.__iter__(self: PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator) -> PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator :module: PyOpenColorIO.ColorSpaceMenuHelper - .. py:method:: ColorSpaceLevelIterator.__len__(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator) -> int + .. py:method:: ColorSpaceLevelIterator.__len__(self: PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator) -> int :module: PyOpenColorIO.ColorSpaceMenuHelper - .. py:method:: ColorSpaceLevelIterator.__next__(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator) -> str + .. py:method:: ColorSpaceLevelIterator.__next__(self: PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator) -> str :module: PyOpenColorIO.ColorSpaceMenuHelper diff --git a/docs/api/python/frozen/pyopencolorio_colorspacemenuparameters.rst b/docs/api/python/frozen/pyopencolorio_colorspacemenuparameters.rst index d08c4b441a..e197942522 100644 --- a/docs/api/python/frozen/pyopencolorio_colorspacemenuparameters.rst +++ b/docs/api/python/frozen/pyopencolorio_colorspacemenuparameters.rst @@ -5,7 +5,6 @@ .. py:class:: ColorSpaceMenuParameters :module: PyOpenColorIO - :canonical: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters Parameters controlling which color spaces appear in menus. @@ -52,12 +51,12 @@ Overloaded function. - 1. __init__(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters, config: PyOpenColorIO.PyOpenColorIO.Config) -> None + 1. __init__(self: PyOpenColorIO.ColorSpaceMenuParameters, config: PyOpenColorIO.Config) -> None - 2. __init__(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters, config: PyOpenColorIO.PyOpenColorIO.Config, role: str = '', includeColorSpaces: bool = True, searchReferenceSpaceType: PyOpenColorIO.PyOpenColorIO.SearchReferenceSpaceType = , includeNamedTransforms: bool = False, appCategories: str = '', encodings: str = '', userCategories: str = '', includeRoles: bool = False) -> None + 2. __init__(self: PyOpenColorIO.ColorSpaceMenuParameters, config: PyOpenColorIO.Config, role: str = '', includeColorSpaces: bool = True, searchReferenceSpaceType: PyOpenColorIO.SearchReferenceSpaceType = , includeNamedTransforms: bool = False, appCategories: str = '', encodings: str = '', userCategories: str = '', includeRoles: bool = False) -> None - .. py:method:: ColorSpaceMenuParameters.addColorSpace(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters, colorSpace: str) -> None + .. py:method:: ColorSpaceMenuParameters.addColorSpace(self: PyOpenColorIO.ColorSpaceMenuParameters, colorSpace: str) -> None :module: PyOpenColorIO Add an additional color space (or named transform) to the menu. @@ -68,99 +67,99 @@ - a newly created color space. Will throw when creating the menu if color space is not part of the config. Nothing is done if it is already part of the menu. It's ok to call this multiple times with the same color space, it will only be added to the menu once. If a role name is passed in, the name in the menu will be the color space name the role points to. - .. py:method:: ColorSpaceMenuParameters.clearAddedColorSpaces(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters) -> None + .. py:method:: ColorSpaceMenuParameters.clearAddedColorSpaces(self: PyOpenColorIO.ColorSpaceMenuParameters) -> None :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuParameters.getAddedColorSpaces(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters) -> PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters.AddedColorSpaceIterator + .. py:method:: ColorSpaceMenuParameters.getAddedColorSpaces(self: PyOpenColorIO.ColorSpaceMenuParameters) -> PyOpenColorIO.ColorSpaceMenuParameters.AddedColorSpaceIterator :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuParameters.getAppCategories(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters) -> str + .. py:method:: ColorSpaceMenuParameters.getAppCategories(self: PyOpenColorIO.ColorSpaceMenuParameters) -> str :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuParameters.getConfig(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters) -> PyOpenColorIO.PyOpenColorIO.Config + .. py:method:: ColorSpaceMenuParameters.getConfig(self: PyOpenColorIO.ColorSpaceMenuParameters) -> PyOpenColorIO.Config :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuParameters.getEncodings(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters) -> str + .. py:method:: ColorSpaceMenuParameters.getEncodings(self: PyOpenColorIO.ColorSpaceMenuParameters) -> str :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuParameters.getIncludeColorSpaces(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters) -> bool + .. py:method:: ColorSpaceMenuParameters.getIncludeColorSpaces(self: PyOpenColorIO.ColorSpaceMenuParameters) -> bool :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuParameters.getIncludeNamedTransforms(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters) -> bool + .. py:method:: ColorSpaceMenuParameters.getIncludeNamedTransforms(self: PyOpenColorIO.ColorSpaceMenuParameters) -> bool :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuParameters.getIncludeRoles(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters) -> bool + .. py:method:: ColorSpaceMenuParameters.getIncludeRoles(self: PyOpenColorIO.ColorSpaceMenuParameters) -> bool :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuParameters.getRole(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters) -> str + .. py:method:: ColorSpaceMenuParameters.getRole(self: PyOpenColorIO.ColorSpaceMenuParameters) -> str :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuParameters.getSearchReferenceSpaceType(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters) -> PyOpenColorIO.PyOpenColorIO.SearchReferenceSpaceType + .. py:method:: ColorSpaceMenuParameters.getSearchReferenceSpaceType(self: PyOpenColorIO.ColorSpaceMenuParameters) -> PyOpenColorIO.SearchReferenceSpaceType :module: PyOpenColorIO Can be used to restrict the search using the ReferenceSpaceType of the color spaces. It has no effect on roles and named transforms. - .. py:method:: ColorSpaceMenuParameters.getUserCategories(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters) -> str + .. py:method:: ColorSpaceMenuParameters.getUserCategories(self: PyOpenColorIO.ColorSpaceMenuParameters) -> str :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuParameters.setAppCategories(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters, appCategories: str) -> None + .. py:method:: ColorSpaceMenuParameters.setAppCategories(self: PyOpenColorIO.ColorSpaceMenuParameters, appCategories: str) -> None :module: PyOpenColorIO App categories is a comma separated list of categories. If appCategories is not NULL and not empty, all color spaces that have one of the categories will be part of the menu. - .. py:method:: ColorSpaceMenuParameters.setConfig(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters, config: PyOpenColorIO.PyOpenColorIO.Config) -> None + .. py:method:: ColorSpaceMenuParameters.setConfig(self: PyOpenColorIO.ColorSpaceMenuParameters, config: PyOpenColorIO.Config) -> None :module: PyOpenColorIO :ref:`Config` is required to be able to create a :ref:`ColorSpaceMenuHelper`. - .. py:method:: ColorSpaceMenuParameters.setEncodings(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters, encodings: str) -> None + .. py:method:: ColorSpaceMenuParameters.setEncodings(self: PyOpenColorIO.ColorSpaceMenuParameters, encodings: str) -> None :module: PyOpenColorIO Encodings is a comma separated list of encodings. When not empty, is retricting the search to color spaces that are using one of the encodings. - .. py:method:: ColorSpaceMenuParameters.setIncludeColorSpaces(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters, includeColorSpaces: bool = True) -> None + .. py:method:: ColorSpaceMenuParameters.setIncludeColorSpaces(self: PyOpenColorIO.ColorSpaceMenuParameters, includeColorSpaces: bool = True) -> None :module: PyOpenColorIO Include all color spaces (or not) to :ref:`ColorSpaceMenuHelper`. Default is to include color spaces. - .. py:method:: ColorSpaceMenuParameters.setIncludeNamedTransforms(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters, includeNamedTransforms: bool = True) -> None + .. py:method:: ColorSpaceMenuParameters.setIncludeNamedTransforms(self: PyOpenColorIO.ColorSpaceMenuParameters, includeNamedTransforms: bool = True) -> None :module: PyOpenColorIO Include all named transforms (or not) to :ref:`ColorSpaceMenuHelper`. Default is not to include named transforms. - .. py:method:: ColorSpaceMenuParameters.setIncludeRoles(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters, includeRoles: bool = True) -> None + .. py:method:: ColorSpaceMenuParameters.setIncludeRoles(self: PyOpenColorIO.ColorSpaceMenuParameters, includeRoles: bool = True) -> None :module: PyOpenColorIO Include all roles (or not) to :ref:`ColorSpaceMenuHelper`. Default is not to include roles. Roles are added after color spaces with an single hierarchy level named "Roles". - .. py:method:: ColorSpaceMenuParameters.setRole(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters, role: str) -> None + .. py:method:: ColorSpaceMenuParameters.setRole(self: PyOpenColorIO.ColorSpaceMenuParameters, role: str) -> None :module: PyOpenColorIO If role is a valid role, other parameters are ignored and menu will contain only that role. - .. py:method:: ColorSpaceMenuParameters.setSearchReferenceSpaceType(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters, searchReferenceSpaceType: PyOpenColorIO.PyOpenColorIO.SearchReferenceSpaceType) -> None + .. py:method:: ColorSpaceMenuParameters.setSearchReferenceSpaceType(self: PyOpenColorIO.ColorSpaceMenuParameters, searchReferenceSpaceType: PyOpenColorIO.SearchReferenceSpaceType) -> None :module: PyOpenColorIO - .. py:method:: ColorSpaceMenuParameters.setUserCategories(self: PyOpenColorIO.PyOpenColorIO.ColorSpaceMenuParameters, categories: str) -> None + .. py:method:: ColorSpaceMenuParameters.setUserCategories(self: PyOpenColorIO.ColorSpaceMenuParameters, categories: str) -> None :module: PyOpenColorIO User categories is a comma separated list of categories. If OCIO_USER_CATEGORIES_ENVVAR env. variable is defined and not empty, this parameter is ignored and the value of the env. variable is used for user categories. diff --git a/docs/api/python/frozen/pyopencolorio_colorspaceset.rst b/docs/api/python/frozen/pyopencolorio_colorspaceset.rst new file mode 100644 index 0000000000..a31481df10 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_colorspaceset.rst @@ -0,0 +1,159 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: ColorSpaceSet + :module: PyOpenColorIO + + The *:ref:`ColorSpaceSet`* is a set of color spaces (i.e. no color space duplication) which could be the result of :ref:`Config::getColorSpaces` or built from scratch. + + .. note:: + The color spaces are decoupled from the config ones, i.e., any changes to the set itself or to its color spaces do not affect the original color spaces from the configuration. If needed, use :ref:`Config::addColorSpace` to update the configuration. + + + .. py:method:: ColorSpaceSet.__and__(self: PyOpenColorIO.ColorSpaceSet, arg0: PyOpenColorIO.ColorSpaceSet) -> PyOpenColorIO.ColorSpaceSet + :module: PyOpenColorIO + + Perform the intersection of two sets. + + .. note:: + This function provides operations on two color space sets where the result contains copied color spaces and no duplicates. + + :param lcss: + :param rcss: + + + .. py:method:: ColorSpaceSet.__eq__(self: PyOpenColorIO.ColorSpaceSet, arg0: PyOpenColorIO.ColorSpaceSet) -> bool + :module: PyOpenColorIO + + Return true if the two sets are equal. + + .. note:: + The comparison is done on the color space names (not a deep comparison). + + + .. py:method:: ColorSpaceSet.__init__(self: PyOpenColorIO.ColorSpaceSet) -> None + :module: PyOpenColorIO + + Create an empty set of color spaces. + + + .. py:method:: ColorSpaceSet.__ne__(self: PyOpenColorIO.ColorSpaceSet, arg0: PyOpenColorIO.ColorSpaceSet) -> bool + :module: PyOpenColorIO + + Return true if the two sets are different. + + + .. py:method:: ColorSpaceSet.__or__(self: PyOpenColorIO.ColorSpaceSet, arg0: PyOpenColorIO.ColorSpaceSet) -> PyOpenColorIO.ColorSpaceSet + :module: PyOpenColorIO + + Perform the union of two sets. + + .. note:: + This function provides operations on two color space sets where the result contains copied color spaces and no duplicates. + + :param lcss: + :param rcss: + + + .. py:method:: ColorSpaceSet.__sub__(self: PyOpenColorIO.ColorSpaceSet, arg0: PyOpenColorIO.ColorSpaceSet) -> PyOpenColorIO.ColorSpaceSet + :module: PyOpenColorIO + + Perform the difference of two sets. + + .. note:: + This function provides operations on two color space sets where the result contains copied color spaces and no duplicates. + + :param lcss: + :param rcss: + + + .. py:method:: ColorSpaceSet.addColorSpace(self: PyOpenColorIO.ColorSpaceSet, colorSpace: PyOpenColorIO.ColorSpace) -> None + :module: PyOpenColorIO + + Add color space(s). + + .. note:: + If another color space is already registered with the same name, this will overwrite it. This stores a copy of the specified color space(s). Throws if one of the aliases is already assigned as a name or alias to an existing color space. + + + .. py:method:: ColorSpaceSet.addColorSpaces(self: PyOpenColorIO.ColorSpaceSet, colorSpaces: PyOpenColorIO.ColorSpaceSet) -> None + :module: PyOpenColorIO + + + .. py:method:: ColorSpaceSet.clearColorSpaces(self: PyOpenColorIO.ColorSpaceSet) -> None + :module: PyOpenColorIO + + Clear all color spaces. + + + .. py:method:: ColorSpaceSet.getColorSpace(self: PyOpenColorIO.ColorSpaceSet, name: str) -> PyOpenColorIO.ColorSpace + :module: PyOpenColorIO + + .. note:: + Only accepts color space names (i.e. no role name). + + Will return null if the name is not found. + + + .. py:method:: ColorSpaceSet.getColorSpaceNames(self: PyOpenColorIO.ColorSpaceSet) -> PyOpenColorIO.ColorSpaceSet.ColorSpaceNameIterator + :module: PyOpenColorIO + + + .. py:method:: ColorSpaceSet.getColorSpaces(self: PyOpenColorIO.ColorSpaceSet) -> PyOpenColorIO.ColorSpaceSet.ColorSpaceIterator + :module: PyOpenColorIO + + + .. py:method:: ColorSpaceSet.removeColorSpace(self: PyOpenColorIO.ColorSpaceSet, colorSpace: str) -> None + :module: PyOpenColorIO + + Remove color space(s) using color space names (i.e. no role name). + + .. note:: + The removal of a missing color space does nothing. + + + .. py:method:: ColorSpaceSet.removeColorSpaces(self: PyOpenColorIO.ColorSpaceSet, colorSpaces: PyOpenColorIO.ColorSpaceSet) -> None + :module: PyOpenColorIO + + +.. py:class:: ColorSpaceNameIterator + :module: PyOpenColorIO.ColorSpaceSet + + + .. py:method:: ColorSpaceNameIterator.__getitem__(self: PyOpenColorIO.ColorSpaceSet.ColorSpaceNameIterator, arg0: int) -> str + :module: PyOpenColorIO.ColorSpaceSet + + + .. py:method:: ColorSpaceNameIterator.__iter__(self: PyOpenColorIO.ColorSpaceSet.ColorSpaceNameIterator) -> PyOpenColorIO.ColorSpaceSet.ColorSpaceNameIterator + :module: PyOpenColorIO.ColorSpaceSet + + + .. py:method:: ColorSpaceNameIterator.__len__(self: PyOpenColorIO.ColorSpaceSet.ColorSpaceNameIterator) -> int + :module: PyOpenColorIO.ColorSpaceSet + + + .. py:method:: ColorSpaceNameIterator.__next__(self: PyOpenColorIO.ColorSpaceSet.ColorSpaceNameIterator) -> str + :module: PyOpenColorIO.ColorSpaceSet + + +.. py:class:: ColorSpaceIterator + :module: PyOpenColorIO.ColorSpaceSet + + + .. py:method:: ColorSpaceIterator.__getitem__(self: PyOpenColorIO.ColorSpaceSet.ColorSpaceIterator, arg0: int) -> PyOpenColorIO.ColorSpace + :module: PyOpenColorIO.ColorSpaceSet + + + .. py:method:: ColorSpaceIterator.__iter__(self: PyOpenColorIO.ColorSpaceSet.ColorSpaceIterator) -> PyOpenColorIO.ColorSpaceSet.ColorSpaceIterator + :module: PyOpenColorIO.ColorSpaceSet + + + .. py:method:: ColorSpaceIterator.__len__(self: PyOpenColorIO.ColorSpaceSet.ColorSpaceIterator) -> int + :module: PyOpenColorIO.ColorSpaceSet + + + .. py:method:: ColorSpaceIterator.__next__(self: PyOpenColorIO.ColorSpaceSet.ColorSpaceIterator) -> PyOpenColorIO.ColorSpace + :module: PyOpenColorIO.ColorSpaceSet + diff --git a/docs/api/python/frozen/pyopencolorio_colorspacetransform.rst b/docs/api/python/frozen/pyopencolorio_colorspacetransform.rst new file mode 100644 index 0000000000..bb918b5deb --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_colorspacetransform.rst @@ -0,0 +1,64 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: ColorSpaceTransform + :module: PyOpenColorIO + + + .. py:method:: ColorSpaceTransform.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.ColorSpaceTransform) -> None + + 2. __init__(self: PyOpenColorIO.ColorSpaceTransform, src: str = '', dst: str = '', direction: PyOpenColorIO.TransformDirection = , dataBypass: bool = True) -> None + + + .. py:method:: ColorSpaceTransform.getDataBypass(self: PyOpenColorIO.ColorSpaceTransform) -> bool + :module: PyOpenColorIO + + Data color spaces do not get processed when true (which is the default). + + + .. py:method:: ColorSpaceTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection + :module: PyOpenColorIO + + + .. py:method:: ColorSpaceTransform.getDst(self: PyOpenColorIO.ColorSpaceTransform) -> str + :module: PyOpenColorIO + + + .. py:method:: ColorSpaceTransform.getSrc(self: PyOpenColorIO.ColorSpaceTransform) -> str + :module: PyOpenColorIO + + + .. py:method:: ColorSpaceTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType + :module: PyOpenColorIO + + + .. py:method:: ColorSpaceTransform.setDataBypass(self: PyOpenColorIO.ColorSpaceTransform, dataBypass: bool) -> None + :module: PyOpenColorIO + + + .. py:method:: ColorSpaceTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None + :module: PyOpenColorIO + + Note that this only affects the evaluation and not the values stored in the object. + + + .. py:method:: ColorSpaceTransform.setDst(self: PyOpenColorIO.ColorSpaceTransform, dst: str) -> None + :module: PyOpenColorIO + + + .. py:method:: ColorSpaceTransform.setSrc(self: PyOpenColorIO.ColorSpaceTransform, src: str) -> None + :module: PyOpenColorIO + + + .. py:method:: ColorSpaceTransform.validate(self: PyOpenColorIO.Transform) -> None + :module: PyOpenColorIO + + Will throw if data is not valid. + diff --git a/docs/api/python/frozen/pyopencolorio_colorspacevisibility.rst b/docs/api/python/frozen/pyopencolorio_colorspacevisibility.rst new file mode 100644 index 0000000000..f9270be856 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_colorspacevisibility.rst @@ -0,0 +1,37 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: ColorSpaceVisibility + :module: PyOpenColorIO + + Members: + + COLORSPACE_ACTIVE : + + COLORSPACE_INACTIVE : + + COLORSPACE_ALL : + + .. py:method:: name() -> str + :property: + + .. py:attribute:: ColorSpaceVisibility.COLORSPACE_ACTIVE + :module: PyOpenColorIO + :value: + + + .. py:attribute:: ColorSpaceVisibility.COLORSPACE_ALL + :module: PyOpenColorIO + :value: + + + .. py:attribute:: ColorSpaceVisibility.COLORSPACE_INACTIVE + :module: PyOpenColorIO + :value: + + + .. py:property:: ColorSpaceVisibility.value + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_combinetransformdirections.rst b/docs/api/python/frozen/pyopencolorio_combinetransformdirections.rst new file mode 100644 index 0000000000..9524270149 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_combinetransformdirections.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: CombineTransformDirections(direction1: PyOpenColorIO.TransformDirection, direction2: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.TransformDirection + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_config.rst b/docs/api/python/frozen/pyopencolorio_config.rst new file mode 100644 index 0000000000..9329939862 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_config.rst @@ -0,0 +1,1387 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: Config + :module: PyOpenColorIO + + A config defines all the color spaces to be available at runtime. + + The color configuration (:ref:`Config`) is the main object for interacting with this library. It encapsulates all of the information necessary to use customized :ref:`ColorSpaceTransform` and :ref:`DisplayViewTransform` operations. + + See the user-guide for more information on selecting, creating, and working with custom color configurations. + + For applications interested in using only one color config at a time (this is the vast majority of apps), their API would traditionally get the global configuration and use that, as opposed to creating a new one. This simplifies the use case for plugins and bindings, as it alleviates the need to pass around configuration handles. + + An example of an application where this would not be sufficient would be a multi-threaded image proxy server (daemon), which wished to handle multiple show configurations in a single process concurrently. This app would need to keep multiple configurations alive, and to manage them appropriately. + + Roughly speaking, a novice user should select a default configuration that most closely approximates the use case (animation, visual effects, etc.), and set the :envvar:`OCIO` environment variable to point at the root of that configuration. + + .. note:: + Initialization using environment variables is typically preferable in a multi-app ecosystem, as it allows all applications to be consistently configured. + + See developers-usageexamples + + + .. py:method:: Config.CreateFromBuiltinConfig(arg0: str) -> PyOpenColorIO.Config + :module: PyOpenColorIO + :staticmethod: + + Create a configuration using an OCIO built-in config. + + :param configName: Built-in config name. + + The available configNames are: "cg-config-v0.1.0_aces-v1.3_ocio-v2.1.1"-- ACES CG config, basic color spaces for computer graphics apps. More information about these configs is available at: https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES + + Information about the available configs is available from the :ref:`BuiltinConfigRegistry`. + + :exception :ref:`Exception`: If the configName is not recognized. + + :return: One of the configs built into the OCIO library. + + + .. py:method:: Config.CreateFromConfigIOProxy(arg0: OpenColorIO_v2_2dev::ConfigIOProxy) -> PyOpenColorIO.Config + :module: PyOpenColorIO + :staticmethod: + + Create a config from the supplied :ref:`ConfigIOProxy` object. This allows the calling program to directly provide the config and associated LUTs rather than reading them from the standard file system. + + See the :ref:`ConfigIOProxy` class documentation for more info. + + :param ciop: :ref:`ConfigIOProxy` object providing access to the config's files. + + :exception :ref:`Exception`: If the config may not be read from the proxy, or does not parse. + + :return: The :ref:`Config` object. + + + .. py:method:: Config.CreateFromEnv() -> PyOpenColorIO.Config + :module: PyOpenColorIO + :staticmethod: + + Create a configuration using the OCIO environment variable. + + Also supports the OCIO URI format for Built-in configs and supports archived configs. See :ref:`Config::CreateFromFile`. + + If the variable is missing or empty, returns the same result as :ref:`Config::CreateRaw`. :return: The :ref:`Config` object. + + + .. py:method:: Config.CreateFromFile(fileName: str) -> PyOpenColorIO.Config + :module: PyOpenColorIO + :staticmethod: + + Create a configuration using a specific config file. + + Also supports the following OCIO URI format for Built-in configs: "ocio://default" - Default Built-in config. "ocio://" - A specific Built-in config. For the list of available strings, see :ref:`Config::CreateFromBuiltinConfig`. + + Also supports archived configs (.ocioz files). + + :exception :ref:`Exception`: If the file may not be read or does not parse. + + :return: The :ref:`Config` object. + + + .. py:method:: Config.CreateFromStream(str: str) -> PyOpenColorIO.Config + :module: PyOpenColorIO + :staticmethod: + + Create a configuration using a stream. + + Note that CreateFromStream does not set the working directory so the caller would need to set that separately in order to resolve FileTransforms. This function is typically only used for self-contained configs (no LUTs). + + Configs created from CreateFromStream can not be archived unless the working directory is set and contains any necessary LUT files. + + :param istream: Stream to the config. + + :exception :ref:`Exception`: If the stream does not parse. + + :return: The :ref:`Config` object. + + + .. py:method:: Config.CreateRaw() -> PyOpenColorIO.Config + :module: PyOpenColorIO + :staticmethod: + + Create a fall-back config. + + This may be useful to allow client apps to launch in cases when the supplied config path is not loadable. :return: The :ref:`Config` object. + + + .. py:class:: Config.DisplayAllIterator + :module: PyOpenColorIO + + + .. py:method:: Config.DisplayAllIterator.__init__(*args, **kwargs) + :module: PyOpenColorIO + + + .. py:method:: Config.GetProcessorFromConfigs(*args, **kwargs) + :module: PyOpenColorIO + :staticmethod: + + Overloaded function. + + 1. GetProcessorFromConfigs(srcConfig: PyOpenColorIO.Config, srcColorSpaceName: str, dstConfig: PyOpenColorIO.Config, dstColorSpaceName: str) -> PyOpenColorIO.Processor + + Get a processor to convert between color spaces in two separate configs. + + This relies on both configs having the aces_interchange role (when srcName is scene-referred) or the role cie_xyz_d65_interchange (when srcName is display-referred) defined. An exception is thrown if that is not the case. + + 2. GetProcessorFromConfigs(srcContext: PyOpenColorIO.Context, srcConfig: PyOpenColorIO.Config, srcColorSpaceName: str, dstContext: PyOpenColorIO.Context, dstConfig: PyOpenColorIO.Config, dstColorSpaceName: str) -> PyOpenColorIO.Processor + + 3. GetProcessorFromConfigs(srcConfig: PyOpenColorIO.Config, srcColorSpaceName: str, srcInterchangeName: str, dstConfig: PyOpenColorIO.Config, dstColorSpaceName: str, dstInterchangeName: str) -> PyOpenColorIO.Processor + + The srcInterchangeName and dstInterchangeName must refer to a pair of color spaces in the two configs that are the same. A role name may also be used. + + 4. GetProcessorFromConfigs(srcContext: PyOpenColorIO.Context, srcConfig: PyOpenColorIO.Config, srcColorSpaceName: str, srcInterchangeName: str, dstContext: PyOpenColorIO.Context, dstConfig: PyOpenColorIO.Config, dstColorSpaceName: str, dstInterchangeName: str) -> PyOpenColorIO.Processor + + + .. py:class:: Config.ViewForViewTypeIterator + :module: PyOpenColorIO + + + .. py:method:: Config.ViewForViewTypeIterator.__init__(*args, **kwargs) + :module: PyOpenColorIO + + + .. py:class:: Config.VirtualViewIterator + :module: PyOpenColorIO + + + .. py:method:: Config.VirtualViewIterator.__init__(*args, **kwargs) + :module: PyOpenColorIO + + + .. py:method:: Config.__init__(self: PyOpenColorIO.Config) -> None + :module: PyOpenColorIO + + Create an empty config of the current version. + + Note that an empty config will not pass validation since required elements will be missing. :return: The :ref:`Config` object. + + + .. py:method:: Config.__str__(self: PyOpenColorIO.Config) -> str + :module: PyOpenColorIO + + + .. py:method:: Config.addColorSpace(self: PyOpenColorIO.Config, colorSpace: PyOpenColorIO.ColorSpace) -> None + :module: PyOpenColorIO + + Add a color space to the configuration. + + .. note:: + If another color space is already present with the same name, this will overwrite it. This stores a copy of the specified color space. + + .. note:: + Adding a color space to a :ref:`Config` does not affect any :ref:`ColorSpaceSet` sets that have already been created. + + + .. py:method:: Config.addDisplaySharedView(self: PyOpenColorIO.Config, display: str, view: str) -> None + :module: PyOpenColorIO + + Add a (reference to a) shared view to a display. + + The shared view must be part of the config. See :ref:`Config::addSharedView` + + This will throw if: + - Display or view are null or empty. + - Display already has a view (shared or not) with the same name. + + + .. py:method:: Config.addDisplayView(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. addDisplayView(self: PyOpenColorIO.Config, display: str, view: str, colorSpaceName: str, looks: str = '') -> None + + For the (display, view) pair, specify which color space and look to use. If a look is not desired, then just pass a null or empty string. + + 2. addDisplayView(self: PyOpenColorIO.Config, display: str, view: str, viewTransform: str, displayColorSpaceName: str, looks: str = '', ruleName: str = '', description: str = '') -> None + + For the (display, view) pair, specify which color space and look to use. If a look is not desired, then just pass a null or empty string. + + + .. py:method:: Config.addEnvironmentVar(self: PyOpenColorIO.Config, name: str, defaultValue: str) -> None + :module: PyOpenColorIO + + Add (or update) an environment variable with a default value. But it removes it if the default value is null. + + + .. py:method:: Config.addLook(self: PyOpenColorIO.Config, look: PyOpenColorIO.Look) -> None + :module: PyOpenColorIO + + + .. py:method:: Config.addNamedTransform(self: PyOpenColorIO.Config, namedTransform: PyOpenColorIO.NamedTransform) -> None + :module: PyOpenColorIO + + + .. py:method:: Config.addSearchPath(self: PyOpenColorIO.Config, path: str) -> None + :module: PyOpenColorIO + + Add a single search path to the end of the list. + + Paths may be either absolute or relative. Relative paths are relative to the working directory. Forward slashes will be normalized to reverse for Windows. Environment (context) variables may be used in paths. + + + .. py:method:: Config.addSharedView(self: PyOpenColorIO.Config, view: str, viewTransformName: str, colorSpaceName: str, looks: str = '', ruleName: str = '', description: str = '') -> None + :module: PyOpenColorIO + + Will throw if view or colorSpaceName are null or empty. + + The following methods only manipulate active displays and views. Active displays and views are defined from an env. variable or from the config file. + + Looks is a potentially comma (or colon) delimited list of lookNames, Where +/- prefixes are optionally allowed to denote forward/inverse look specification. (And forward is assumed in the absence of either) + + Add shared view (or replace existing one with same name). Shared views are defined at config level and can be referenced by several displays. Either provide a view transform and a display color space or just a color space (and a null view transform). Looks, rule and description are optional, they can be null or empty. + + Shared views using a view transform may use the token for the color space (see :c:var:`OCIO_VIEW_USE_DISPLAY_NAME`). In that case, when the view is referenced in a display, the display color space that is used will be the one matching the display name. In other words, the view will be customized based on the display it is used in. :ref:`Config::validate` will throw if the config does not contain the matching display color space. + + + .. py:method:: Config.addViewTransform(self: PyOpenColorIO.Config, viewTransform: PyOpenColorIO.ViewTransform) -> None + :module: PyOpenColorIO + + + .. py:method:: Config.addVirtualDisplaySharedView(self: PyOpenColorIO.Config, sharedView: str) -> None + :module: PyOpenColorIO + + + .. py:method:: Config.addVirtualDisplayView(self: PyOpenColorIO.Config, view: str, viewTransformName: str, colorSpaceName: str, looks: str = '', ruleName: str = '', description: str = '') -> None + :module: PyOpenColorIO + + + .. py:method:: Config.archive(self: PyOpenColorIO.Config, arg0: str) -> None + :module: PyOpenColorIO + + Archive the config and its LUTs into the specified output stream. + + The config is archived by serializing the :ref:`Config` object into a file named "config.ocio" and then walking through the current working directory and any sub-directories. Any files that have an extension matching a supported LUT file format are added to the archive. Any files that do not have an extension (or have some unsupported LUT extension, including .ocio), will not be added to the archive. To reiterate, it is the in-memory :ref:`Config` object that is archived, and not any .ocio file in the current working directory. The directory structure relative to the working directory is preserved. No files outside the working directory are archived so that if it is later expanded, no files will be created outside the working dir. + + The reason the archive is created using all supported LUT file extensions rather than by trying to resolve all the FileTransforms in the :ref:`Config` to specific files is because of the goal to allow context variables to continue to work. + + If a :ref:`Config` is created with CreateFromStream, CreateFromFile with an OCIOZ archive, or CreateFromConfigIOProxy, it cannot be archived unless the working directory is manually set to a directory that contains any necessary LUT files. + + The provided output stream must be closed by the caller, if necessary (e.g., an ofstream). + + :param ostream: The output stream to write to. + + + .. py:method:: Config.clearColorSpaces(self: PyOpenColorIO.Config) -> None + :module: PyOpenColorIO + + Remove all the color spaces from the configuration. + + .. note:: + Removing color spaces from a :ref:`Config` does not affect any :ref:`ColorSpaceSet` sets that have already been created. + + + .. py:method:: Config.clearDisplays(self: PyOpenColorIO.Config) -> None + :module: PyOpenColorIO + + Clear all the displays. + + + .. py:method:: Config.clearEnvironmentVars(self: PyOpenColorIO.Config) -> None + :module: PyOpenColorIO + + + .. py:method:: Config.clearLooks(self: PyOpenColorIO.Config) -> None + :module: PyOpenColorIO + + + .. py:method:: Config.clearNamedTransforms(self: PyOpenColorIO.Config) -> None + :module: PyOpenColorIO + + + .. py:method:: Config.clearSearchPaths(self: PyOpenColorIO.Config) -> None + :module: PyOpenColorIO + + + .. py:method:: Config.clearViewTransforms(self: PyOpenColorIO.Config) -> None + :module: PyOpenColorIO + + + .. py:method:: Config.clearVirtualDisplay(self: PyOpenColorIO.Config) -> None + :module: PyOpenColorIO + + Clear the virtual display. + + + .. py:method:: Config.filepathOnlyMatchesDefaultRule(self: PyOpenColorIO.Config, filePath: str) -> bool + :module: PyOpenColorIO + + Returns true if the only rule matched by filePath is the default rule. This is a convenience method for applications that want to require the user to manually choose a color space when strictParsing is true and no other rules match. + + + .. py:method:: Config.getActiveDisplays(self: PyOpenColorIO.Config) -> str + :module: PyOpenColorIO + + + .. py:method:: Config.getActiveViews(self: PyOpenColorIO.Config) -> str + :module: PyOpenColorIO + + + .. py:method:: Config.getCacheID(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. getCacheID(self: PyOpenColorIO.Config) -> str + + This will produce a hash of the all colorspace definitions, etc. All external references, such as files used in FileTransforms, etc., will be incorporated into the cacheID. While the contents of the files are not read, the file system is queried for relevant information (mtime, inode) so that the config's cacheID will change when the underlying luts are updated. + + If a context is not provided, the current :ref:`Context` will be used. + + If a null context is provided, file references will not be taken into account (this is essentially a hash of :ref:`Config::serialize`). + + 2. getCacheID(self: PyOpenColorIO.Config, context: PyOpenColorIO.Context) -> str + + This will produce a hash of the all colorspace definitions, etc. All external references, such as files used in FileTransforms, etc., will be incorporated into the cacheID. While the contents of the files are not read, the file system is queried for relevant information (mtime, inode) so that the config's cacheID will change when the underlying luts are updated. + + If a context is not provided, the current :ref:`Context` will be used. + + If a null context is provided, file references will not be taken into account (this is essentially a hash of :ref:`Config::serialize`). + + + .. py:method:: Config.getCanonicalName(self: PyOpenColorIO.Config, name: str) -> str + :module: PyOpenColorIO + + Accepts an alias, role name, named transform name, or color space name and returns the color space name or the named transform name. + + + .. py:method:: Config.getColorSpace(self: PyOpenColorIO.Config, name: str) -> PyOpenColorIO.ColorSpace + :module: PyOpenColorIO + + Get the color space from all the color spaces (i.e. active and inactive) and return null if the name is not found. + + .. note:: + The fcn accepts either a color space name, role name, or alias. (Color space names take precedence over roles.) + + + .. py:method:: Config.getColorSpaceFromFilepath(self: PyOpenColorIO.Config, filePath: str) -> tuple + :module: PyOpenColorIO + + Get the color space of the first rule that matched filePath. (For v1 configs, this is equivalent to calling parseColorSpaceFromString with strictparsing set to false.) + + + .. py:method:: Config.getColorSpaceNames(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. getColorSpaceNames(self: PyOpenColorIO.Config, searchReferenceType: PyOpenColorIO.SearchReferenceSpaceType, visibility: PyOpenColorIO.ColorSpaceVisibility) -> PyOpenColorIO.Config.ColorSpaceNameIterator + + 2. getColorSpaceNames(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.ActiveColorSpaceNameIterator + + + .. py:method:: Config.getColorSpaces(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. getColorSpaces(self: PyOpenColorIO.Config, category: str) -> PyOpenColorIO.ColorSpaceSet + + Get all active color spaces having a specific category in the order they appear in the config file. + + .. note:: + If the category is null or empty, the method returns all the active color spaces like :ref:`Config::getNumColorSpaces` and :ref:`Config::getColorSpaceNameByIndex` do. + + .. note:: + It's worth noticing that the method returns a copy of the selected color spaces decoupling the result from the config. Hence, any changes on the config do not affect the existing color space sets, and vice-versa. + + 2. getColorSpaces(self: PyOpenColorIO.Config, searchReferenceType: PyOpenColorIO.SearchReferenceSpaceType, visibility: PyOpenColorIO.ColorSpaceVisibility) -> PyOpenColorIO.Config.ColorSpaceIterator + + 3. getColorSpaces(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.ActiveColorSpaceIterator + + + .. py:method:: Config.getCurrentContext(self: PyOpenColorIO.Config) -> PyOpenColorIO.Context + :module: PyOpenColorIO + + + .. py:method:: Config.getDefaultDisplay(self: PyOpenColorIO.Config) -> str + :module: PyOpenColorIO + + + .. py:method:: Config.getDefaultLumaCoefs(self: PyOpenColorIO.Config) -> List[float[3]] + :module: PyOpenColorIO + + Get the default coefficients for computing luma. + + .. note:: + There is no "1 size fits all" set of luma coefficients. (The values are typically different for each colorspace, and the application of them may be nonsensical depending on the intensity coding anyways). Thus, the 'right' answer is to make these functions on the :ref:`ColorSpace` class. However, it's often useful to have a config-wide default so here it is. We will add the colorspace specific luma call if/when another client is interesting in using it. + + + .. py:method:: Config.getDefaultSceneToDisplayViewTransform(self: PyOpenColorIO.Config) -> PyOpenColorIO.ViewTransform + :module: PyOpenColorIO + + This view transform is the one that will be used by default if a :ref:`ColorSpaceTransform` is needed between a scene-referred and display-referred color space. The config author may specify a transform to use via the default_view_transform entry in the config. If that is not present, or does not return a valid view transform from the scene-referred connection space, the fall-back is to use the first valid view transform in the config. Returns a null ConstTransformRcPtr if there isn't one. + + + .. py:method:: Config.getDefaultView(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. getDefaultView(self: PyOpenColorIO.Config, display: str) -> str + + 2. getDefaultView(self: PyOpenColorIO.Config, display: str, colorSpacename: str) -> str + + + .. py:method:: Config.getDefaultViewTransformName(self: PyOpenColorIO.Config) -> str + :module: PyOpenColorIO + + Get or set the default_view_transform string from the config. + + Note that if this is not the name of a valid view transform from the scene-referred connection space, it will be ignored. + + + .. py:method:: Config.getDescription(self: PyOpenColorIO.Config) -> str + :module: PyOpenColorIO + + + .. py:method:: Config.getDisplayViewColorSpaceName(self: PyOpenColorIO.Config, display: str, view: str) -> str + :module: PyOpenColorIO + + Returns the colorspace attribute of the (display, view) pair. (Note that this may be either a color space or a display color space.) + + + .. py:method:: Config.getDisplayViewDescription(self: PyOpenColorIO.Config, display: str, view: str) -> str + :module: PyOpenColorIO + + Returns the description attribute of a (display, view) pair. + + + .. py:method:: Config.getDisplayViewLooks(self: PyOpenColorIO.Config, display: str, view: str) -> str + :module: PyOpenColorIO + + Returns the looks attribute of a (display, view) pair. + + + .. py:method:: Config.getDisplayViewRule(self: PyOpenColorIO.Config, display: str, view: str) -> str + :module: PyOpenColorIO + + Returns the rule attribute of a (display, view) pair. + + + .. py:method:: Config.getDisplayViewTransformName(self: PyOpenColorIO.Config, display: str, view: str) -> str + :module: PyOpenColorIO + + Returns the view_transform attribute of the (display, view) pair. View can be a shared view of the display. If display is null or empty, config shared views are used. + + + .. py:method:: Config.getDisplays(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.DisplayIterator + :module: PyOpenColorIO + + + .. py:method:: Config.getDisplaysAll(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.DisplayAllIterator + :module: PyOpenColorIO + + + .. py:method:: Config.getEnvironmentMode(self: PyOpenColorIO.Config) -> PyOpenColorIO.EnvironmentMode + :module: PyOpenColorIO + + + .. py:method:: Config.getEnvironmentVarDefault(self: PyOpenColorIO.Config, name: str) -> str + :module: PyOpenColorIO + + + .. py:method:: Config.getEnvironmentVarNames(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.EnvironmentVarNameIterator + :module: PyOpenColorIO + + + .. py:method:: Config.getFamilySeparator(self: PyOpenColorIO.Config) -> str + :module: PyOpenColorIO + + Get the family separator. + + A single character used to separate the family string into tokens for use in hierarchical menus. Defaults to '/'. + + + .. py:method:: Config.getFileRules(self: PyOpenColorIO.Config) -> PyOpenColorIO.FileRules + :module: PyOpenColorIO + + Get read-only version of the file rules. + + + .. py:method:: Config.getInactiveColorSpaces(self: PyOpenColorIO.Config) -> str + :module: PyOpenColorIO + + + .. py:method:: Config.getLook(self: PyOpenColorIO.Config, name: str) -> PyOpenColorIO.Look + :module: PyOpenColorIO + + + .. py:method:: Config.getLookNames(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.LookNameIterator + :module: PyOpenColorIO + + + .. py:method:: Config.getLooks(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.LookIterator + :module: PyOpenColorIO + + + .. py:method:: Config.getMajorVersion(self: PyOpenColorIO.Config) -> int + :module: PyOpenColorIO + + Get the configuration major version. + + + .. py:method:: Config.getMinorVersion(self: PyOpenColorIO.Config) -> int + :module: PyOpenColorIO + + Get the configuration minor version. + + + .. py:method:: Config.getName(self: PyOpenColorIO.Config) -> str + :module: PyOpenColorIO + + Get/set a name string for the config. + + The name string may be used to communicate config update details or similar information to workflows external to OCIO in cases where the config path/filename itself does not provide adequate information. + + + .. py:method:: Config.getNamedTransform(self: PyOpenColorIO.Config, name: str) -> PyOpenColorIO.NamedTransform + :module: PyOpenColorIO + + + .. py:method:: Config.getNamedTransformNames(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. getNamedTransformNames(self: PyOpenColorIO.Config, visibility: PyOpenColorIO.NamedTransformVisibility) -> PyOpenColorIO.Config.NamedTransformNameIterator + + 2. getNamedTransformNames(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.ActiveNamedTransformNameIterator + + + .. py:method:: Config.getNamedTransforms(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. getNamedTransforms(self: PyOpenColorIO.Config, visibility: PyOpenColorIO.NamedTransformVisibility) -> PyOpenColorIO.Config.NamedTransformIterator + + 2. getNamedTransforms(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.ActiveNamedTransformIterator + + + .. py:method:: Config.getProcessor(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. getProcessor(self: PyOpenColorIO.Config, srcColorSpace: PyOpenColorIO.ColorSpace, dstColorSpace: PyOpenColorIO.ColorSpace) -> PyOpenColorIO.Processor + + Get the processor to apply a :ref:`ColorSpaceTransform` from a source to a destination color space. + + 2. getProcessor(self: PyOpenColorIO.Config, context: PyOpenColorIO.Context, srcColorSpace: PyOpenColorIO.ColorSpace, dstColorSpace: PyOpenColorIO.ColorSpace) -> PyOpenColorIO.Processor + + 3. getProcessor(self: PyOpenColorIO.Config, srcColorSpaceName: str, dstColorSpaceName: str) -> PyOpenColorIO.Processor + + .. note:: + Names can be colorspace name, role name, or a combination of both. + + 4. getProcessor(self: PyOpenColorIO.Config, context: PyOpenColorIO.Context, srcColorSpaceName: str, dstColorSpaceName: str) -> PyOpenColorIO.Processor + + 5. getProcessor(self: PyOpenColorIO.Config, srcColorSpaceName: str, display: str, view: str, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Processor + + Get the processor to apply a :ref:`DisplayViewTransform` for a display and view. Refer to the Display/View Registration section above for more info on the display and view arguments. + + 6. getProcessor(self: PyOpenColorIO.Config, context: PyOpenColorIO.Context, srcColorSpaceName: str, display: str, view: str, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Processor + + 7. getProcessor(self: PyOpenColorIO.Config, namedTransform: PyOpenColorIO.NamedTransform, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Processor + + Get the processor to apply a :ref:`NamedTransform` in the specified direction. + + 8. getProcessor(self: PyOpenColorIO.Config, context: PyOpenColorIO.Context, namedTransform: PyOpenColorIO.NamedTransform, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Processor + + 9. getProcessor(self: PyOpenColorIO.Config, namedTransformName: str, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Processor + + 10. getProcessor(self: PyOpenColorIO.Config, context: PyOpenColorIO.Context, namedTransformName: str, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Processor + + 11. getProcessor(self: PyOpenColorIO.Config, transform: PyOpenColorIO.Transform) -> PyOpenColorIO.Processor + + Get the processor for the specified transform. + + Not often needed, but will allow for the re-use of atomic OCIO functionality (such as to apply an individual LUT file). + + 12. getProcessor(self: PyOpenColorIO.Config, transform: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Processor + + 13. getProcessor(self: PyOpenColorIO.Config, context: PyOpenColorIO.Context, transform: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Processor + + + .. py:method:: Config.getRoleNames(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.RoleNameIterator + :module: PyOpenColorIO + + + .. py:method:: Config.getRoles(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.RoleColorSpaceIterator + :module: PyOpenColorIO + + + .. py:method:: Config.getSearchPath(self: PyOpenColorIO.Config) -> str + :module: PyOpenColorIO + + + .. py:method:: Config.getSearchPaths(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.SearchPathIterator + :module: PyOpenColorIO + + + .. py:method:: Config.getSharedViews(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.SharedViewIterator + :module: PyOpenColorIO + + + .. py:method:: Config.getViewTransform(self: PyOpenColorIO.Config, name: str) -> PyOpenColorIO.ViewTransform + :module: PyOpenColorIO + + + .. py:method:: Config.getViewTransformNames(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.ViewTransformNameIterator + :module: PyOpenColorIO + + + .. py:method:: Config.getViewTransforms(self: PyOpenColorIO.Config) -> PyOpenColorIO.Config.ViewTransformIterator + :module: PyOpenColorIO + + + .. py:method:: Config.getViewingRules(self: PyOpenColorIO.Config) -> PyOpenColorIO.ViewingRules + :module: PyOpenColorIO + + Get read-only version of the viewing rules. + + + .. py:method:: Config.getViews(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. getViews(self: PyOpenColorIO.Config, display: str) -> PyOpenColorIO.Config.ViewIterator + + 2. getViews(self: PyOpenColorIO.Config, type: PyOpenColorIO.ViewType, display: str) -> PyOpenColorIO.Config.ViewForViewTypeIterator + + 3. getViews(self: PyOpenColorIO.Config, display: str, colorSpaceName: str) -> PyOpenColorIO.Config.ViewForColorSpaceIterator + + + .. py:method:: Config.getVirtualDisplayViewColorSpaceName(self: PyOpenColorIO.Config, view: str) -> str + :module: PyOpenColorIO + + + .. py:method:: Config.getVirtualDisplayViewDescription(self: PyOpenColorIO.Config, view: str) -> str + :module: PyOpenColorIO + + + .. py:method:: Config.getVirtualDisplayViewLooks(self: PyOpenColorIO.Config, view: str) -> str + :module: PyOpenColorIO + + + .. py:method:: Config.getVirtualDisplayViewRule(self: PyOpenColorIO.Config, view: str) -> str + :module: PyOpenColorIO + + + .. py:method:: Config.getVirtualDisplayViewTransformName(self: PyOpenColorIO.Config, view: str) -> str + :module: PyOpenColorIO + + + .. py:method:: Config.getVirtualDisplayViews(self: PyOpenColorIO.Config, display: PyOpenColorIO.ViewType) -> PyOpenColorIO.Config.VirtualViewIterator + :module: PyOpenColorIO + + + .. py:method:: Config.getWorkingDir(self: PyOpenColorIO.Config) -> str + :module: PyOpenColorIO + + + .. py:method:: Config.hasRole(self: PyOpenColorIO.Config, role: str) -> bool + :module: PyOpenColorIO + + Return true if the role has been defined. + + + .. py:method:: Config.instantiateDisplayFromICCProfile(self: PyOpenColorIO.Config, ICCProfileFilepath: str) -> int + :module: PyOpenColorIO + + Instantiate a new display from a virtual display, using an ICC profile. + + On platforms such as Linux, where the :ref:`SystemMonitors` class is not able to obtain a list of ICC profiles from the OS, this method may be used to manually specify a path to an ICC profile. + + Will throw if the virtual display definition is missing from the config. + + Returns the index of the display. + + + .. py:method:: Config.instantiateDisplayFromMonitorName(self: PyOpenColorIO.Config, monitorName: str) -> int + :module: PyOpenColorIO + + Instantiate a new display from a virtual display, using the monitor name. + + This method uses the virtual display to create an actual display for the given monitorName. The new display will receive the views from the virtual display. + + After the ICC profile is read, a display name will be created by combining the description text from the profile with the monitorName obtained from the OS. Use the :ref:`SystemMonitors` class to obtain the list of monitorName strings for the displays connected to the computer. + + A new display color space will also be created using the display name. It will have a from_display_reference transform that is a :ref:`FileTransform` pointing to the ICC profile. + + Any instantiated display color spaces for a virtual display are intended to be temporary (i.e. last as long as the current session). By default, they are not saved when writing a config file. If there is a need to make it a permanent color space, it may be desirable to copy the ICC profile somewhere under the config search_path. + + Will throw if the config does not have a virtual display or if the monitorName does not exist. + + If there is already a display or a display color space with the name monitorName, it will be replaced/updated. + + Returns the index of the display. + + + .. py:method:: Config.isArchivable(self: PyOpenColorIO.Config) -> bool + :module: PyOpenColorIO + + Verify if the config is archivable. + + A config is not archivable if any of the following are true: -- The working directory is not set -- It contains FileTransforms with a src outside the working directory -- The search path contains paths outside the working directory -- The search path contains paths that start with a context variable + + :ref:`Context` variables are allowed but the intent is that they may only resolve to paths that are within or below the working directory. This is because the archiving function will only archive files that are within the working directory in order to ensure that if it is later expanded, that it will not create any files outside this directory. + + For example, a context variable on the search path intended to contain the name of a sub-directory under the working directory must have the form "./$DIR_NAME" rather than just "$DIR_NAME" to be considered archivable. This is imperfect since there is no way to prevent the context variable from creating a path outside the working dir, but it should at least draw attention to the fact that the archive would fail if used with context vars that try to abuse the intended functionality. + + :return: bool Archivable if true. + + + .. py:method:: Config.isColorSpaceLinear(self: PyOpenColorIO.Config, colorSpace: str, referenceSpaceType: PyOpenColorIO.ReferenceSpaceType) -> bool + :module: PyOpenColorIO + + Return true if the specified color space is linear. + + The determination of linearity is made with respect to one of the two reference spaces (i.e., either the scene-referred one or the display-referred one). If the reference space type of the color space is the opposite of the requested reference space type, false is returned immediately rather than trying to invoke the default view transform to convert between the reference spaces. + + Note: This function relies on heuristics that may sometimes give an incorrect result. For example, if the encoding attribute is not set appropriately or the sampled values fail to detect non-linearity. + + The algorithm proceeds as follows: -- If the color space isdata attribute is true, return false. -- If the reference space type of the color space differs from the requested reference space type, return false. -- If the color space's encoding attribute is present, return true if it matches the expected reference space type (i.e., "scene-linear" for REFERENCE_SPACE_SCENE or "display-linear" for REFERENCE_SPACE_DISPLAY) and false otherwise. -- If the color space has no to_reference or from_reference transform, return true. -- Evaluate several points through the color space's transform and check if the output only differs by a scale factor (which may be different per channel, e.g. allowing an arbitrary matrix transform, with no offset). + + Note that the encoding test happens before the sampled value test to give config authors ultimate control over the linearity determination. For example, they could set the encoding attribute to indicate linearity if they want to ignore some areas of non-linearity (e.g., at extreme values). Or they could set it to indicate that a color space should not be considered linear, even if it is, in a mathematical sense. + + :param colorSpace: Color space to evaluate. + :param referenceSpaceType: Evaluate linearity with respect to the specified reference space (either scene-referred or display-referred). + + + .. py:method:: Config.isColorSpaceUsed(self: PyOpenColorIO.Config, name: str) -> bool + :module: PyOpenColorIO + + Return true if the color space is used by a transform, a role, or a look. + + .. note:: + Name must be the canonical name. + + + .. py:method:: Config.isDisplayTemporary(self: PyOpenColorIO.Config, display: str) -> bool + :module: PyOpenColorIO + + + .. py:method:: Config.isStrictParsingEnabled(self: PyOpenColorIO.Config) -> bool + :module: PyOpenColorIO + + + .. py:method:: Config.loadEnvironment(self: PyOpenColorIO.Config) -> None + :module: PyOpenColorIO + + + .. py:method:: Config.parseColorSpaceFromString(self: PyOpenColorIO.Config, str: str) -> str + :module: PyOpenColorIO + + Given the specified string, get the longest, right-most, colorspace substring that appears. + + - If strict parsing is enabled, and no color space is found, return an empty string. + - If strict parsing is disabled, return ROLE_DEFAULT (if defined). + - If the default role is not defined, return an empty string. + + + .. py:method:: Config.removeColorSpace(self: PyOpenColorIO.Config, name: str) -> None + :module: PyOpenColorIO + + Remove a color space from the configuration. + + .. note:: + It does not throw an exception. Name must be the canonical name. If a role name or alias is provided or if the name is not in the config, nothing is done. + + .. note:: + Removing a color space from a :ref:`Config` does not affect any :ref:`ColorSpaceSet` sets that have already been created. + + + .. py:method:: Config.removeDisplayView(self: PyOpenColorIO.Config, display: str, view: str) -> None + :module: PyOpenColorIO + + Remove the view and the display if no more views. + + It does not remove the associated color space. If the view name is a shared view, it only removes the reference to the view from the display but the shared view, remains in the config. + + Will throw if the view does not exist. + + + .. py:method:: Config.removeSharedView(self: PyOpenColorIO.Config, view: str) -> None + :module: PyOpenColorIO + + Remove a shared view. Will throw if the view does not exist. + + + .. py:method:: Config.removeVirtualDisplayView(self: PyOpenColorIO.Config, view: str) -> None + :module: PyOpenColorIO + + Remove the view from the virtual display. + + + .. py:method:: Config.serialize(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. serialize(self: PyOpenColorIO.Config, fileName: str) -> None + + 2. serialize(self: PyOpenColorIO.Config) -> str + + Returns the string representation of the :ref:`Config` in YAML text form. + + This is typically stored on disk in a file with the extension .ocio. NB: This does not validate the config. Applications should validate before serializing. + + + .. py:method:: Config.setActiveDisplays(self: PyOpenColorIO.Config, displays: str) -> None + :module: PyOpenColorIO + + $OCIO_ACTIVE_DISPLAYS envvar can, at runtime, optionally override the allowed displays. It is a comma or colon delimited list. Active displays that are not in the specified profile will be ignored, and the left-most defined display will be the default. + + Comma-delimited list of names to filter and order the active displays. + + .. note:: + The setter does not override the envvar. The getter does not take into account the envvar value and thus may not represent what the user is seeing. + + + .. py:method:: Config.setActiveViews(self: PyOpenColorIO.Config, views: str) -> None + :module: PyOpenColorIO + + $OCIO_ACTIVE_VIEWS envvar can, at runtime, optionally override the allowed views. It is a comma or colon delimited list. Active views that are not in the specified profile will be ignored, and the left-most defined view will be the default. + + Comma-delimited list of names to filter and order the active views. + + .. note:: + The setter does not override the envvar. The getter does not take into account the envvar value and thus may not represent what the user is seeing. + + + .. py:method:: Config.setDefaultLumaCoefs(self: PyOpenColorIO.Config, rgb: List[float[3]]) -> None + :module: PyOpenColorIO + + These should be normalized (sum to 1.0 exactly). + + + .. py:method:: Config.setDefaultViewTransformName(self: PyOpenColorIO.Config, name: str) -> None + :module: PyOpenColorIO + + + .. py:method:: Config.setDescription(self: PyOpenColorIO.Config, description: str) -> None + :module: PyOpenColorIO + + + .. py:method:: Config.setEnvironmentMode(self: PyOpenColorIO.Config, mode: PyOpenColorIO.EnvironmentMode) -> None + :module: PyOpenColorIO + + + .. py:method:: Config.setFamilySeparator(self: PyOpenColorIO.Config, separator: str) -> None + :module: PyOpenColorIO + + Set the family separator. + + Succeeds if the characters is null or a valid character from the ASCII table i.e. from value 32 (i.e. space) to 126 (i.e. '~'); otherwise, it throws an exception. + + + .. py:method:: Config.setFileRules(self: PyOpenColorIO.Config, fileRules: PyOpenColorIO.FileRules) -> None + :module: PyOpenColorIO + + Set file rules. + + .. note:: + The argument is cloned. + + + .. py:method:: Config.setInactiveColorSpaces(self: PyOpenColorIO.Config, inactiveColorSpaces: str) -> None + :module: PyOpenColorIO + + Set/get a list of inactive color space or named transform names. + + Notes: + - List can contain color space and/or named transform names. + - The inactive spaces are color spaces that should not appear in application menus. + - These color spaces will still work in :ref:`Config::getProcessor` calls. + - The argument is a comma-delimited string. A null or empty string empties the list. + - The environment variable OCIO_INACTIVE_COLORSPACES may also be used to set the inactive color space list. + - The env. var. takes precedence over the inactive_colorspaces list in the config file. + - Setting the list via the API takes precedence over either the env. var. or the config file list. + + + .. py:method:: Config.setMajorVersion(self: PyOpenColorIO.Config, major: int) -> None + :module: PyOpenColorIO + + Set the configuration major version. + + Throws if it is not supported. Resets minor to the most recent minor for the given major. + + + .. py:method:: Config.setMinorVersion(self: PyOpenColorIO.Config, minor: int) -> None + :module: PyOpenColorIO + + Set the configuration minor version. Throws if it is not supported for the current major. + + + .. py:method:: Config.setName(self: PyOpenColorIO.Config, name: str) -> None + :module: PyOpenColorIO + + + .. py:method:: Config.setProcessorCacheFlags(self: PyOpenColorIO.Config, flags: PyOpenColorIO.ProcessorCacheFlags) -> None + :module: PyOpenColorIO + + Control the caching of processors in the config instance. By default, caching is on. + The flags allow turning caching off entirely or only turning it off if dynamic properties are being used by the processor. + + + .. py:method:: Config.setRole(self: PyOpenColorIO.Config, role: str, colorSpaceName: str) -> None + :module: PyOpenColorIO + + .. note:: + Setting the `colorSpaceName` name to a null string unsets it. + + + .. py:method:: Config.setSearchPath(self: PyOpenColorIO.Config, path: str) -> None + :module: PyOpenColorIO + + Set all search paths as a concatenated string, ':' to separate the paths. + + See :ref:`addSearchPath` for a more robust and platform-agnostic method of setting the search paths. + + + .. py:method:: Config.setStrictParsingEnabled(self: PyOpenColorIO.Config, enabled: bool) -> None + :module: PyOpenColorIO + + + .. py:method:: Config.setVersion(self: PyOpenColorIO.Config, major: int, minor: int) -> None + :module: PyOpenColorIO + + Set the configuration major and minor versions. Throws if version is not supported. + + + .. py:method:: Config.setViewingRules(self: PyOpenColorIO.Config, ViewingRules: PyOpenColorIO.ViewingRules) -> None + :module: PyOpenColorIO + + Set viewing rules. + + .. note:: + The argument is cloned. + + + .. py:method:: Config.setWorkingDir(self: PyOpenColorIO.Config, dirName: str) -> None + :module: PyOpenColorIO + + The working directory defaults to the location of the config file. It is used to convert any relative paths to absolute. If no search paths have been set, the working directory will be used as the fallback search path. No environment (context) variables may be used in the working directory. + + + .. py:method:: Config.upgradeToLatestVersion(self: PyOpenColorIO.Config) -> None + :module: PyOpenColorIO + + Allows an older config to be serialized as the current version. + + + .. py:method:: Config.validate(self: PyOpenColorIO.Config) -> None + :module: PyOpenColorIO + + Performs a thorough validation for the most common user errors. + + This will throw an exception if the config is malformed. The most common error occurs when references are made to colorspaces that do not exist. + + +.. py:class:: EnvironmentVarNameIterator + :module: PyOpenColorIO.Config + + + .. py:method:: EnvironmentVarNameIterator.__getitem__(self: PyOpenColorIO.Config.EnvironmentVarNameIterator, arg0: int) -> str + :module: PyOpenColorIO.Config + + + .. py:method:: EnvironmentVarNameIterator.__iter__(self: PyOpenColorIO.Config.EnvironmentVarNameIterator) -> PyOpenColorIO.Config.EnvironmentVarNameIterator + :module: PyOpenColorIO.Config + + + .. py:method:: EnvironmentVarNameIterator.__len__(self: PyOpenColorIO.Config.EnvironmentVarNameIterator) -> int + :module: PyOpenColorIO.Config + + + .. py:method:: EnvironmentVarNameIterator.__next__(self: PyOpenColorIO.Config.EnvironmentVarNameIterator) -> str + :module: PyOpenColorIO.Config + + +.. py:class:: SearchPathIterator + :module: PyOpenColorIO.Config + + + .. py:method:: SearchPathIterator.__getitem__(self: PyOpenColorIO.Config.SearchPathIterator, arg0: int) -> str + :module: PyOpenColorIO.Config + + + .. py:method:: SearchPathIterator.__iter__(self: PyOpenColorIO.Config.SearchPathIterator) -> PyOpenColorIO.Config.SearchPathIterator + :module: PyOpenColorIO.Config + + + .. py:method:: SearchPathIterator.__len__(self: PyOpenColorIO.Config.SearchPathIterator) -> int + :module: PyOpenColorIO.Config + + + .. py:method:: SearchPathIterator.__next__(self: PyOpenColorIO.Config.SearchPathIterator) -> str + :module: PyOpenColorIO.Config + + +.. py:class:: ColorSpaceNameIterator + :module: PyOpenColorIO.Config + + + .. py:method:: ColorSpaceNameIterator.__getitem__(self: PyOpenColorIO.Config.ColorSpaceNameIterator, arg0: int) -> str + :module: PyOpenColorIO.Config + + + .. py:method:: ColorSpaceNameIterator.__iter__(self: PyOpenColorIO.Config.ColorSpaceNameIterator) -> PyOpenColorIO.Config.ColorSpaceNameIterator + :module: PyOpenColorIO.Config + + + .. py:method:: ColorSpaceNameIterator.__len__(self: PyOpenColorIO.Config.ColorSpaceNameIterator) -> int + :module: PyOpenColorIO.Config + + + .. py:method:: ColorSpaceNameIterator.__next__(self: PyOpenColorIO.Config.ColorSpaceNameIterator) -> str + :module: PyOpenColorIO.Config + + +.. py:class:: ColorSpaceIterator + :module: PyOpenColorIO.Config + + + .. py:method:: ColorSpaceIterator.__getitem__(self: PyOpenColorIO.Config.ColorSpaceIterator, arg0: int) -> PyOpenColorIO.ColorSpace + :module: PyOpenColorIO.Config + + + .. py:method:: ColorSpaceIterator.__iter__(self: PyOpenColorIO.Config.ColorSpaceIterator) -> PyOpenColorIO.Config.ColorSpaceIterator + :module: PyOpenColorIO.Config + + + .. py:method:: ColorSpaceIterator.__len__(self: PyOpenColorIO.Config.ColorSpaceIterator) -> int + :module: PyOpenColorIO.Config + + + .. py:method:: ColorSpaceIterator.__next__(self: PyOpenColorIO.Config.ColorSpaceIterator) -> PyOpenColorIO.ColorSpace + :module: PyOpenColorIO.Config + + +.. py:class:: ActiveColorSpaceNameIterator + :module: PyOpenColorIO.Config + + + .. py:method:: ActiveColorSpaceNameIterator.__getitem__(self: PyOpenColorIO.Config.ActiveColorSpaceNameIterator, arg0: int) -> str + :module: PyOpenColorIO.Config + + + .. py:method:: ActiveColorSpaceNameIterator.__iter__(self: PyOpenColorIO.Config.ActiveColorSpaceNameIterator) -> PyOpenColorIO.Config.ActiveColorSpaceNameIterator + :module: PyOpenColorIO.Config + + + .. py:method:: ActiveColorSpaceNameIterator.__len__(self: PyOpenColorIO.Config.ActiveColorSpaceNameIterator) -> int + :module: PyOpenColorIO.Config + + + .. py:method:: ActiveColorSpaceNameIterator.__next__(self: PyOpenColorIO.Config.ActiveColorSpaceNameIterator) -> str + :module: PyOpenColorIO.Config + + +.. py:class:: ActiveColorSpaceIterator + :module: PyOpenColorIO.Config + + + .. py:method:: ActiveColorSpaceIterator.__getitem__(self: PyOpenColorIO.Config.ActiveColorSpaceIterator, arg0: int) -> PyOpenColorIO.ColorSpace + :module: PyOpenColorIO.Config + + + .. py:method:: ActiveColorSpaceIterator.__iter__(self: PyOpenColorIO.Config.ActiveColorSpaceIterator) -> PyOpenColorIO.Config.ActiveColorSpaceIterator + :module: PyOpenColorIO.Config + + + .. py:method:: ActiveColorSpaceIterator.__len__(self: PyOpenColorIO.Config.ActiveColorSpaceIterator) -> int + :module: PyOpenColorIO.Config + + + .. py:method:: ActiveColorSpaceIterator.__next__(self: PyOpenColorIO.Config.ActiveColorSpaceIterator) -> PyOpenColorIO.ColorSpace + :module: PyOpenColorIO.Config + + +.. py:class:: RoleNameIterator + :module: PyOpenColorIO.Config + + + .. py:method:: RoleNameIterator.__getitem__(self: PyOpenColorIO.Config.RoleNameIterator, arg0: int) -> str + :module: PyOpenColorIO.Config + + + .. py:method:: RoleNameIterator.__iter__(self: PyOpenColorIO.Config.RoleNameIterator) -> PyOpenColorIO.Config.RoleNameIterator + :module: PyOpenColorIO.Config + + + .. py:method:: RoleNameIterator.__len__(self: PyOpenColorIO.Config.RoleNameIterator) -> int + :module: PyOpenColorIO.Config + + + .. py:method:: RoleNameIterator.__next__(self: PyOpenColorIO.Config.RoleNameIterator) -> str + :module: PyOpenColorIO.Config + + +.. py:class:: RoleColorSpaceIterator + :module: PyOpenColorIO.Config + + + .. py:method:: RoleColorSpaceIterator.__getitem__(self: PyOpenColorIO.Config.RoleColorSpaceIterator, arg0: int) -> tuple + :module: PyOpenColorIO.Config + + + .. py:method:: RoleColorSpaceIterator.__iter__(self: PyOpenColorIO.Config.RoleColorSpaceIterator) -> PyOpenColorIO.Config.RoleColorSpaceIterator + :module: PyOpenColorIO.Config + + + .. py:method:: RoleColorSpaceIterator.__len__(self: PyOpenColorIO.Config.RoleColorSpaceIterator) -> int + :module: PyOpenColorIO.Config + + + .. py:method:: RoleColorSpaceIterator.__next__(self: PyOpenColorIO.Config.RoleColorSpaceIterator) -> tuple + :module: PyOpenColorIO.Config + + +.. py:class:: DisplayIterator + :module: PyOpenColorIO.Config + + + .. py:method:: DisplayIterator.__getitem__(self: PyOpenColorIO.Config.DisplayIterator, arg0: int) -> str + :module: PyOpenColorIO.Config + + + .. py:method:: DisplayIterator.__iter__(self: PyOpenColorIO.Config.DisplayIterator) -> PyOpenColorIO.Config.DisplayIterator + :module: PyOpenColorIO.Config + + + .. py:method:: DisplayIterator.__len__(self: PyOpenColorIO.Config.DisplayIterator) -> int + :module: PyOpenColorIO.Config + + + .. py:method:: DisplayIterator.__next__(self: PyOpenColorIO.Config.DisplayIterator) -> str + :module: PyOpenColorIO.Config + + +.. py:class:: SharedViewIterator + :module: PyOpenColorIO.Config + + + .. py:method:: SharedViewIterator.__getitem__(self: PyOpenColorIO.Config.SharedViewIterator, arg0: int) -> str + :module: PyOpenColorIO.Config + + + .. py:method:: SharedViewIterator.__iter__(self: PyOpenColorIO.Config.SharedViewIterator) -> PyOpenColorIO.Config.SharedViewIterator + :module: PyOpenColorIO.Config + + + .. py:method:: SharedViewIterator.__len__(self: PyOpenColorIO.Config.SharedViewIterator) -> int + :module: PyOpenColorIO.Config + + + .. py:method:: SharedViewIterator.__next__(self: PyOpenColorIO.Config.SharedViewIterator) -> str + :module: PyOpenColorIO.Config + + +.. py:class:: ViewIterator + :module: PyOpenColorIO.Config + + + .. py:method:: ViewIterator.__getitem__(self: PyOpenColorIO.Config.ViewIterator, arg0: int) -> str + :module: PyOpenColorIO.Config + + + .. py:method:: ViewIterator.__iter__(self: PyOpenColorIO.Config.ViewIterator) -> PyOpenColorIO.Config.ViewIterator + :module: PyOpenColorIO.Config + + + .. py:method:: ViewIterator.__len__(self: PyOpenColorIO.Config.ViewIterator) -> int + :module: PyOpenColorIO.Config + + + .. py:method:: ViewIterator.__next__(self: PyOpenColorIO.Config.ViewIterator) -> str + :module: PyOpenColorIO.Config + + +.. py:class:: ViewForColorSpaceIterator + :module: PyOpenColorIO.Config + + + .. py:method:: ViewForColorSpaceIterator.__getitem__(self: PyOpenColorIO.Config.ViewForColorSpaceIterator, arg0: int) -> str + :module: PyOpenColorIO.Config + + + .. py:method:: ViewForColorSpaceIterator.__iter__(self: PyOpenColorIO.Config.ViewForColorSpaceIterator) -> PyOpenColorIO.Config.ViewForColorSpaceIterator + :module: PyOpenColorIO.Config + + + .. py:method:: ViewForColorSpaceIterator.__len__(self: PyOpenColorIO.Config.ViewForColorSpaceIterator) -> int + :module: PyOpenColorIO.Config + + + .. py:method:: ViewForColorSpaceIterator.__next__(self: PyOpenColorIO.Config.ViewForColorSpaceIterator) -> str + :module: PyOpenColorIO.Config + + +.. py:class:: LookNameIterator + :module: PyOpenColorIO.Config + + + .. py:method:: LookNameIterator.__getitem__(self: PyOpenColorIO.Config.LookNameIterator, arg0: int) -> str + :module: PyOpenColorIO.Config + + + .. py:method:: LookNameIterator.__iter__(self: PyOpenColorIO.Config.LookNameIterator) -> PyOpenColorIO.Config.LookNameIterator + :module: PyOpenColorIO.Config + + + .. py:method:: LookNameIterator.__len__(self: PyOpenColorIO.Config.LookNameIterator) -> int + :module: PyOpenColorIO.Config + + + .. py:method:: LookNameIterator.__next__(self: PyOpenColorIO.Config.LookNameIterator) -> str + :module: PyOpenColorIO.Config + + +.. py:class:: LookIterator + :module: PyOpenColorIO.Config + + + .. py:method:: LookIterator.__getitem__(self: PyOpenColorIO.Config.LookIterator, arg0: int) -> PyOpenColorIO.Look + :module: PyOpenColorIO.Config + + + .. py:method:: LookIterator.__iter__(self: PyOpenColorIO.Config.LookIterator) -> PyOpenColorIO.Config.LookIterator + :module: PyOpenColorIO.Config + + + .. py:method:: LookIterator.__len__(self: PyOpenColorIO.Config.LookIterator) -> int + :module: PyOpenColorIO.Config + + + .. py:method:: LookIterator.__next__(self: PyOpenColorIO.Config.LookIterator) -> PyOpenColorIO.Look + :module: PyOpenColorIO.Config + + +.. py:class:: ViewTransformNameIterator + :module: PyOpenColorIO.Config + + + .. py:method:: ViewTransformNameIterator.__getitem__(self: PyOpenColorIO.Config.ViewTransformNameIterator, arg0: int) -> str + :module: PyOpenColorIO.Config + + + .. py:method:: ViewTransformNameIterator.__iter__(self: PyOpenColorIO.Config.ViewTransformNameIterator) -> PyOpenColorIO.Config.ViewTransformNameIterator + :module: PyOpenColorIO.Config + + + .. py:method:: ViewTransformNameIterator.__len__(self: PyOpenColorIO.Config.ViewTransformNameIterator) -> int + :module: PyOpenColorIO.Config + + + .. py:method:: ViewTransformNameIterator.__next__(self: PyOpenColorIO.Config.ViewTransformNameIterator) -> str + :module: PyOpenColorIO.Config + + +.. py:class:: ViewTransformIterator + :module: PyOpenColorIO.Config + + + .. py:method:: ViewTransformIterator.__getitem__(self: PyOpenColorIO.Config.ViewTransformIterator, arg0: int) -> PyOpenColorIO.ViewTransform + :module: PyOpenColorIO.Config + + + .. py:method:: ViewTransformIterator.__iter__(self: PyOpenColorIO.Config.ViewTransformIterator) -> PyOpenColorIO.Config.ViewTransformIterator + :module: PyOpenColorIO.Config + + + .. py:method:: ViewTransformIterator.__len__(self: PyOpenColorIO.Config.ViewTransformIterator) -> int + :module: PyOpenColorIO.Config + + + .. py:method:: ViewTransformIterator.__next__(self: PyOpenColorIO.Config.ViewTransformIterator) -> PyOpenColorIO.ViewTransform + :module: PyOpenColorIO.Config + + +.. py:class:: NamedTransformNameIterator + :module: PyOpenColorIO.Config + + + .. py:method:: NamedTransformNameIterator.__getitem__(self: PyOpenColorIO.Config.NamedTransformNameIterator, arg0: int) -> str + :module: PyOpenColorIO.Config + + + .. py:method:: NamedTransformNameIterator.__iter__(self: PyOpenColorIO.Config.NamedTransformNameIterator) -> PyOpenColorIO.Config.NamedTransformNameIterator + :module: PyOpenColorIO.Config + + + .. py:method:: NamedTransformNameIterator.__len__(self: PyOpenColorIO.Config.NamedTransformNameIterator) -> int + :module: PyOpenColorIO.Config + + + .. py:method:: NamedTransformNameIterator.__next__(self: PyOpenColorIO.Config.NamedTransformNameIterator) -> str + :module: PyOpenColorIO.Config + + +.. py:class:: NamedTransformIterator + :module: PyOpenColorIO.Config + + + .. py:method:: NamedTransformIterator.__getitem__(self: PyOpenColorIO.Config.NamedTransformIterator, arg0: int) -> PyOpenColorIO.NamedTransform + :module: PyOpenColorIO.Config + + + .. py:method:: NamedTransformIterator.__iter__(self: PyOpenColorIO.Config.NamedTransformIterator) -> PyOpenColorIO.Config.NamedTransformIterator + :module: PyOpenColorIO.Config + + + .. py:method:: NamedTransformIterator.__len__(self: PyOpenColorIO.Config.NamedTransformIterator) -> int + :module: PyOpenColorIO.Config + + + .. py:method:: NamedTransformIterator.__next__(self: PyOpenColorIO.Config.NamedTransformIterator) -> PyOpenColorIO.NamedTransform + :module: PyOpenColorIO.Config + + +.. py:class:: ActiveNamedTransformNameIterator + :module: PyOpenColorIO.Config + + + .. py:method:: ActiveNamedTransformNameIterator.__getitem__(self: PyOpenColorIO.Config.ActiveNamedTransformNameIterator, arg0: int) -> str + :module: PyOpenColorIO.Config + + + .. py:method:: ActiveNamedTransformNameIterator.__iter__(self: PyOpenColorIO.Config.ActiveNamedTransformNameIterator) -> PyOpenColorIO.Config.ActiveNamedTransformNameIterator + :module: PyOpenColorIO.Config + + + .. py:method:: ActiveNamedTransformNameIterator.__len__(self: PyOpenColorIO.Config.ActiveNamedTransformNameIterator) -> int + :module: PyOpenColorIO.Config + + + .. py:method:: ActiveNamedTransformNameIterator.__next__(self: PyOpenColorIO.Config.ActiveNamedTransformNameIterator) -> str + :module: PyOpenColorIO.Config + + +.. py:class:: ActiveNamedTransformIterator + :module: PyOpenColorIO.Config + + + .. py:method:: ActiveNamedTransformIterator.__getitem__(self: PyOpenColorIO.Config.ActiveNamedTransformIterator, arg0: int) -> PyOpenColorIO.NamedTransform + :module: PyOpenColorIO.Config + + + .. py:method:: ActiveNamedTransformIterator.__iter__(self: PyOpenColorIO.Config.ActiveNamedTransformIterator) -> PyOpenColorIO.Config.ActiveNamedTransformIterator + :module: PyOpenColorIO.Config + + + .. py:method:: ActiveNamedTransformIterator.__len__(self: PyOpenColorIO.Config.ActiveNamedTransformIterator) -> int + :module: PyOpenColorIO.Config + + + .. py:method:: ActiveNamedTransformIterator.__next__(self: PyOpenColorIO.Config.ActiveNamedTransformIterator) -> PyOpenColorIO.NamedTransform + :module: PyOpenColorIO.Config + diff --git a/docs/api/python/frozen/pyopencolorio_context.rst b/docs/api/python/frozen/pyopencolorio_context.rst new file mode 100644 index 0000000000..9766d703d2 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_context.rst @@ -0,0 +1,191 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: Context + :module: PyOpenColorIO + + :ref:`Context` + + A context defines some overrides to a :ref:`Config`. For example, it can override the search path or change the value of a context variable. + + .. note:: + Only some :ref:`Config::getProcessor` methods accept a custom context; otherwise, the default context instance is used (see Config::getCurrentContext). + + :ref:`Context` Variables + + The context variables allow changes at runtime using environment variables. For example, a color space name (such as src & dst for the :ref:`ColorSpaceTransform`) or a file name (such as LUT file name for the :ref:`FileTransform`) could be defined by context variables. The color transformation is then customized based on some environment variables. + + In a config the context variables support three syntaxes (i.e. ${VAR}, $VAR and VAR%) and the parsing starts from longest to shortest. So, the resolve works like '$TEST_$TESTING_$TE' expands in this order '2 1 3'. + + :ref:`Config` authors are recommended to include the "environment" section in their configs. This improves performance as well as making the config more readable. When present, this section must declare all context variables used in the config. It may also provide a default value, in case the variable is not present in the user's environment. + + A context variable may only be used in the following places: + - the `:ref:`ColorSpaceTransform`` to define the source and the destination color space names, + - the `:ref:`FileTransform`` to define the source file name (e.g. a LUT file name), + - the search_path, + - the cccid of the `:ref:`FileTransform`` to only extract one specific transform from the CDL & CCC files. + + Some specific restrictions are worth calling out: + - they cannot be used as either the name or value of a role, + - the context variable characters $ and % are prohibited in a color space name. + + + .. py:method:: Context.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.Context) -> None + + 2. __init__(self: PyOpenColorIO.Context, workingDir: str = '', searchPaths: List[str] = [], stringVars: Dict[str, str] = {}, environmentMode: PyOpenColorIO.EnvironmentMode = ) -> None + + + .. py:method:: Context.addSearchPath(self: PyOpenColorIO.Context, path: str) -> None + :module: PyOpenColorIO + + + .. py:method:: Context.clearSearchPaths(self: PyOpenColorIO.Context) -> None + :module: PyOpenColorIO + + + .. py:method:: Context.clearStringVars(self: PyOpenColorIO.Context) -> None + :module: PyOpenColorIO + + + .. py:method:: Context.getCacheID(self: PyOpenColorIO.Context) -> str + :module: PyOpenColorIO + + + .. py:method:: Context.getEnvironmentMode(self: PyOpenColorIO.Context) -> PyOpenColorIO.EnvironmentMode + :module: PyOpenColorIO + + + .. py:method:: Context.getSearchPath(self: PyOpenColorIO.Context) -> str + :module: PyOpenColorIO + + + .. py:method:: Context.getSearchPaths(self: PyOpenColorIO.Context) -> PyOpenColorIO.Context.SearchPathIterator + :module: PyOpenColorIO + + + .. py:method:: Context.getStringVars(self: PyOpenColorIO.Context) -> PyOpenColorIO.Context.StringVarIterator + :module: PyOpenColorIO + + + .. py:method:: Context.getWorkingDir(self: PyOpenColorIO.Context) -> str + :module: PyOpenColorIO + + + .. py:method:: Context.loadEnvironment(self: PyOpenColorIO.Context) -> None + :module: PyOpenColorIO + + Seed all string vars with the current environment. + + + .. py:method:: Context.resolveFileLocation(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. resolveFileLocation(self: PyOpenColorIO.Context, filename: str) -> str + + Build the resolved and expanded filepath using the search_path when needed, and check if the filepath exists. If it cannot be resolved or found, an exception will be thrown. The method argument is directly from the config file so it can be an absolute or relative file path or a file name. + + .. note:: + The filepath existence check could add a performance hit. + + .. note:: + The context variable resolution is performed using :cpp:func:`resolveStringVar`. + + 2. resolveFileLocation(self: PyOpenColorIO.Context, filename: str, usedContextVars: PyOpenColorIO.Context) -> str + + Build the resolved and expanded filepath and return all the context variables used to resolve the filename (empty if no context variables were used). + + + .. py:method:: Context.resolveStringVar(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. resolveStringVar(self: PyOpenColorIO.Context, string: str) -> str + + Resolve all the context variables from the string. It could be color space names or file names. Note that it recursively applies the context variable resolution. Returns the string unchanged if it does not contain any context variable. + + 2. resolveStringVar(self: PyOpenColorIO.Context, string: str, usedContextVars: PyOpenColorIO.Context) -> str + + Resolve all the context variables from the string and return all the context variables used to resolve the string (empty if no context variables were used). + + + .. py:method:: Context.setEnvironmentMode(self: PyOpenColorIO.Context, mode: PyOpenColorIO.EnvironmentMode) -> None + :module: PyOpenColorIO + + + .. py:method:: Context.setSearchPath(self: PyOpenColorIO.Context, path: str) -> None + :module: PyOpenColorIO + + + .. py:method:: Context.setWorkingDir(self: PyOpenColorIO.Context, dirName: str) -> None + :module: PyOpenColorIO + + +.. py:class:: StringVarNameIterator + :module: PyOpenColorIO.Context + + + .. py:method:: StringVarNameIterator.__getitem__(self: PyOpenColorIO.Context.StringVarNameIterator, arg0: int) -> str + :module: PyOpenColorIO.Context + + + .. py:method:: StringVarNameIterator.__iter__(self: PyOpenColorIO.Context.StringVarNameIterator) -> PyOpenColorIO.Context.StringVarNameIterator + :module: PyOpenColorIO.Context + + + .. py:method:: StringVarNameIterator.__len__(self: PyOpenColorIO.Context.StringVarNameIterator) -> int + :module: PyOpenColorIO.Context + + + .. py:method:: StringVarNameIterator.__next__(self: PyOpenColorIO.Context.StringVarNameIterator) -> str + :module: PyOpenColorIO.Context + + +.. py:class:: StringVarIterator + :module: PyOpenColorIO.Context + + + .. py:method:: StringVarIterator.__getitem__(self: PyOpenColorIO.Context.StringVarIterator, arg0: int) -> tuple + :module: PyOpenColorIO.Context + + + .. py:method:: StringVarIterator.__iter__(self: PyOpenColorIO.Context.StringVarIterator) -> PyOpenColorIO.Context.StringVarIterator + :module: PyOpenColorIO.Context + + + .. py:method:: StringVarIterator.__len__(self: PyOpenColorIO.Context.StringVarIterator) -> int + :module: PyOpenColorIO.Context + + + .. py:method:: StringVarIterator.__next__(self: PyOpenColorIO.Context.StringVarIterator) -> tuple + :module: PyOpenColorIO.Context + + +.. py:class:: SearchPathIterator + :module: PyOpenColorIO.Context + + + .. py:method:: SearchPathIterator.__getitem__(self: PyOpenColorIO.Context.SearchPathIterator, arg0: int) -> str + :module: PyOpenColorIO.Context + + + .. py:method:: SearchPathIterator.__iter__(self: PyOpenColorIO.Context.SearchPathIterator) -> PyOpenColorIO.Context.SearchPathIterator + :module: PyOpenColorIO.Context + + + .. py:method:: SearchPathIterator.__len__(self: PyOpenColorIO.Context.SearchPathIterator) -> int + :module: PyOpenColorIO.Context + + + .. py:method:: SearchPathIterator.__next__(self: PyOpenColorIO.Context.SearchPathIterator) -> str + :module: PyOpenColorIO.Context + diff --git a/docs/api/python/frozen/pyopencolorio_cpuprocessor.rst b/docs/api/python/frozen/pyopencolorio_cpuprocessor.rst index 088b4bde8b..748413280f 100644 --- a/docs/api/python/frozen/pyopencolorio_cpuprocessor.rst +++ b/docs/api/python/frozen/pyopencolorio_cpuprocessor.rst @@ -5,7 +5,6 @@ .. py:class:: CPUProcessor :module: PyOpenColorIO - :canonical: PyOpenColorIO.PyOpenColorIO.CPUProcessor .. py:method:: CPUProcessor.__init__(*args, **kwargs) @@ -17,7 +16,7 @@ Overloaded function. - 1. apply(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor, imgDesc: PyOpenColorIO.PyOpenColorIO.ImageDesc) -> None + 1. apply(self: PyOpenColorIO.CPUProcessor, imgDesc: PyOpenColorIO.ImageDesc) -> None Apply to an image with any kind of channel ordering while respecting @@ -36,7 +35,7 @@ - 2. apply(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor, srcImgDesc: PyOpenColorIO.PyOpenColorIO.ImageDesc, dstImgDesc: PyOpenColorIO.PyOpenColorIO.ImageDesc) -> None + 2. apply(self: PyOpenColorIO.CPUProcessor, srcImgDesc: PyOpenColorIO.ImageDesc, dstImgDesc: PyOpenColorIO.ImageDesc) -> None Apply to an image with any kind of channel ordering while respecting @@ -60,7 +59,7 @@ Overloaded function. - 1. applyRGB(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor, data: buffer) -> None + 1. applyRGB(self: PyOpenColorIO.CPUProcessor, data: buffer) -> None Apply to a packed RGB array adhering to the Python buffer protocol. @@ -78,7 +77,7 @@ - 2. applyRGB(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor, data: List[float]) -> List[float] + 2. applyRGB(self: PyOpenColorIO.CPUProcessor, data: List[float]) -> List[float] Apply to a packed RGB list of float values. Any size is supported as @@ -103,7 +102,7 @@ Overloaded function. - 1. applyRGBA(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor, data: buffer) -> None + 1. applyRGBA(self: PyOpenColorIO.CPUProcessor, data: buffer) -> None Apply to a packed RGBA array adhering to the Python buffer protocol. @@ -121,7 +120,7 @@ - 2. applyRGBA(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor, data: List[float]) -> List[float] + 2. applyRGBA(self: PyOpenColorIO.CPUProcessor, data: List[float]) -> List[float] Apply to a packed RGBA list of float values. Any size is supported as @@ -141,11 +140,11 @@ modified in place. - .. py:method:: CPUProcessor.getCacheID(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor) -> str + .. py:method:: CPUProcessor.getCacheID(self: PyOpenColorIO.CPUProcessor) -> str :module: PyOpenColorIO - .. py:method:: CPUProcessor.getDynamicProperty(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor, type: PyOpenColorIO.PyOpenColorIO.DynamicPropertyType) -> PyOpenColorIO.PyOpenColorIO.DynamicProperty + .. py:method:: CPUProcessor.getDynamicProperty(self: PyOpenColorIO.CPUProcessor, type: PyOpenColorIO.DynamicPropertyType) -> PyOpenColorIO.DynamicProperty :module: PyOpenColorIO The returned pointer may be used to set the value of any dynamic properties of the requested type. Throws if the requested property is not found. Note that if the processor contains several ops that support the requested property, only one can be dynamic. @@ -154,41 +153,29 @@ The dynamic properties in this object are decoupled from the ones in the :ref:`Processor` it was generated from. For each dynamic property in the :ref:`Processor`, there is one in the CPU processor. - .. py:method:: CPUProcessor.getInputBitDepth(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor) -> PyOpenColorIO.PyOpenColorIO.BitDepth + .. py:method:: CPUProcessor.getInputBitDepth(self: PyOpenColorIO.CPUProcessor) -> PyOpenColorIO.BitDepth :module: PyOpenColorIO Bit-depth of the input pixel buffer. - .. py:method:: CPUProcessor.getOutputBitDepth(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor) -> PyOpenColorIO.PyOpenColorIO.BitDepth + .. py:method:: CPUProcessor.getOutputBitDepth(self: PyOpenColorIO.CPUProcessor) -> PyOpenColorIO.BitDepth :module: PyOpenColorIO Bit-depth of the output pixel buffer. - .. py:method:: CPUProcessor.hasChannelCrosstalk(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor) -> bool + .. py:method:: CPUProcessor.hasChannelCrosstalk(self: PyOpenColorIO.CPUProcessor) -> bool :module: PyOpenColorIO - .. py:method:: CPUProcessor.hasDynamicProperty(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor, type: PyOpenColorIO.PyOpenColorIO.DynamicPropertyType) -> bool - :module: PyOpenColorIO - - True if at least one dynamic property of that type exists. - - - .. py:method:: CPUProcessor.isDynamic(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor) -> bool - :module: PyOpenColorIO - - True if at least one dynamic property of any type exists and is dynamic. - - - .. py:method:: CPUProcessor.isIdentity(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor) -> bool + .. py:method:: CPUProcessor.isIdentity(self: PyOpenColorIO.CPUProcessor) -> bool :module: PyOpenColorIO Equivalent to isNoOp from the underlying :ref:`Processor`, i.e., it ignores in/out bit-depth differences. - .. py:method:: CPUProcessor.isNoOp(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor) -> bool + .. py:method:: CPUProcessor.isNoOp(self: PyOpenColorIO.CPUProcessor) -> bool :module: PyOpenColorIO The in and out bit-depths must be equal for isNoOp to be true. diff --git a/docs/api/python/frozen/pyopencolorio_displayviewhelpers.rst b/docs/api/python/frozen/pyopencolorio_displayviewhelpers.rst index f186a7f009..c99237493c 100644 --- a/docs/api/python/frozen/pyopencolorio_displayviewhelpers.rst +++ b/docs/api/python/frozen/pyopencolorio_displayviewhelpers.rst @@ -3,25 +3,25 @@ Copyright Contributors to the OpenColorIO Project. Do not edit! This file was automatically generated by share/docs/frozendoc.py. -.. py:function:: GetProcessor(config: PyOpenColorIO.PyOpenColorIO.Config, context: PyOpenColorIO.PyOpenColorIO.Context = None, workingSpaceName: str, displayName: str, viewName: str, channelView: PyOpenColorIO.PyOpenColorIO.MatrixTransform = None, direction: PyOpenColorIO.PyOpenColorIO.TransformDirection = ) -> PyOpenColorIO.PyOpenColorIO.Processor +.. py:function:: GetProcessor(config: PyOpenColorIO.Config, context: PyOpenColorIO.Context = None, workingSpaceName: str, displayName: str, viewName: str, channelView: PyOpenColorIO.MatrixTransform = None, direction: PyOpenColorIO.TransformDirection = ) -> PyOpenColorIO.Processor :module: PyOpenColorIO.DisplayViewHelpers Get the processor from the working color space to (display, view) pair (forward) or (display, view) pair to working (inverse). The working color space name could be a role name or a color space name. ChannelView can be empty. If not already present, each of these functions adds ExposureContrastTransforms to enable changing exposure, contrast, and gamma after the processor has been created using dynamic properties. -.. py:function:: GetIdentityProcessor(config: PyOpenColorIO.PyOpenColorIO.Config) -> PyOpenColorIO.PyOpenColorIO.Processor +.. py:function:: GetIdentityProcessor(config: PyOpenColorIO.Config) -> PyOpenColorIO.Processor :module: PyOpenColorIO.DisplayViewHelpers Get an identity processor containing only the ExposureContrastTransforms. -.. py:function:: AddDisplayView(config: PyOpenColorIO.PyOpenColorIO.Config, displayName: str, viewName: str, lookName: str = '', colorSpaceName: str = '', colorSpaceFamily: str = '', colorSpaceDescription: str = '', colorSpaceCategories: str = '', transformFilePath: str, connectionColorSpaceName: str) -> None +.. py:function:: AddDisplayView(config: PyOpenColorIO.Config, displayName: str, viewName: str, lookName: str = '', colorSpaceName: str = '', colorSpaceFamily: str = '', colorSpaceDescription: str = '', colorSpaceCategories: str = '', transformFilePath: str, connectionColorSpaceName: str) -> None :module: PyOpenColorIO.DisplayViewHelpers Add a new (display, view) pair and the new color space to a configuration instance. The input to the userTransform must be in the specified connectionColorSpace. -.. py:function:: RemoveDisplayView(config: PyOpenColorIO.PyOpenColorIO.Config, displayName: str, viewName: str) -> None +.. py:function:: RemoveDisplayView(config: PyOpenColorIO.Config, displayName: str, viewName: str) -> None :module: PyOpenColorIO.DisplayViewHelpers Remove a (display, view) pair including the associated color space (only if not used). Note that the view is always removed but the display is only removed if empty. diff --git a/docs/api/python/frozen/pyopencolorio_displayviewtransform.rst b/docs/api/python/frozen/pyopencolorio_displayviewtransform.rst new file mode 100644 index 0000000000..3d780e17f5 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_displayviewtransform.rst @@ -0,0 +1,88 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: DisplayViewTransform + :module: PyOpenColorIO + + + .. py:method:: DisplayViewTransform.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.DisplayViewTransform) -> None + + 2. __init__(self: PyOpenColorIO.DisplayViewTransform, src: str = '', display: str = '', view: str = '', looksBypass: bool = False, dataBypass: bool = True, direction: PyOpenColorIO.TransformDirection = ) -> None + + + .. py:method:: DisplayViewTransform.getDataBypass(self: PyOpenColorIO.DisplayViewTransform) -> bool + :module: PyOpenColorIO + + + .. py:method:: DisplayViewTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection + :module: PyOpenColorIO + + + .. py:method:: DisplayViewTransform.getDisplay(self: PyOpenColorIO.DisplayViewTransform) -> str + :module: PyOpenColorIO + + + .. py:method:: DisplayViewTransform.getLooksBypass(self: PyOpenColorIO.DisplayViewTransform) -> bool + :module: PyOpenColorIO + + + .. py:method:: DisplayViewTransform.getSrc(self: PyOpenColorIO.DisplayViewTransform) -> str + :module: PyOpenColorIO + + + .. py:method:: DisplayViewTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType + :module: PyOpenColorIO + + + .. py:method:: DisplayViewTransform.getView(self: PyOpenColorIO.DisplayViewTransform) -> str + :module: PyOpenColorIO + + + .. py:method:: DisplayViewTransform.setDataBypass(self: PyOpenColorIO.DisplayViewTransform, dataBypass: bool) -> None + :module: PyOpenColorIO + + Data color spaces do not get processed when true (which is the default). + + + .. py:method:: DisplayViewTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None + :module: PyOpenColorIO + + Note that this only affects the evaluation and not the values stored in the object. + + + .. py:method:: DisplayViewTransform.setDisplay(self: PyOpenColorIO.DisplayViewTransform, display: str) -> None + :module: PyOpenColorIO + + Specify which display to use. + + + .. py:method:: DisplayViewTransform.setLooksBypass(self: PyOpenColorIO.DisplayViewTransform, looksBypass: bool) -> None + :module: PyOpenColorIO + + Looks will be bypassed when true (the default is false). + + + .. py:method:: DisplayViewTransform.setSrc(self: PyOpenColorIO.DisplayViewTransform, src: str) -> None + :module: PyOpenColorIO + + Specify the incoming color space. + + + .. py:method:: DisplayViewTransform.setView(self: PyOpenColorIO.DisplayViewTransform, view: str) -> None + :module: PyOpenColorIO + + Specify which view transform to use. + + + .. py:method:: DisplayViewTransform.validate(self: PyOpenColorIO.Transform) -> None + :module: PyOpenColorIO + + Will throw if data is not valid. + diff --git a/docs/api/python/frozen/pyopencolorio_dynamicproperty.rst b/docs/api/python/frozen/pyopencolorio_dynamicproperty.rst new file mode 100644 index 0000000000..6c031451a1 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_dynamicproperty.rst @@ -0,0 +1,105 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: DynamicProperty + :module: PyOpenColorIO + + Allows transform parameter values to be set on-the-fly (after finalization). For example, to modify the exposure in a viewport. Dynamic properties can be accessed from the `:ref:`CPUProcessor`` or `:ref:`GpuShaderCreator`` to change values between processing. + + .. code-block:: cpp + + OCIO::ConstConfigRcPtr config = OCIO::GetCurrentConfig(); + OCIO::ConstProcessorRcPtr processor = config->getProcessor(colorSpace1, colorSpace2); + OCIO::ConstCPUProcessorRcPtr cpuProcessor = processor->getDefaultCPUProcessor(); + + if (cpuProcessor->hasDynamicProperty(OCIO::DYNAMIC_PROPERTY_EXPOSURE)) + { + // Get the in-memory implementation of the dynamic property. + OCIO::DynamicPropertyRcPtr dynProp = + cpuProcessor->getDynamicProperty(OCIO::DYNAMIC_PROPERTY_EXPOSURE); + // Get the interface used to change the double value. + OCIO::DynamicPropertyDoubleRcPtr exposure = + OCIO::DynamicPropertyValue::AsDouble(dynProp); + // Update of the dynamic property instance with the new value. + exposure->setValue(1.1f); + } + if (cpuProcessor->hasDynamicProperty(OCIO::DYNAMIC_PROPERTY_GRADING_PRIMARY)) + { + OCIO::DynamicPropertyRcPtr dynProp = + cpuProcessor->getDynamicProperty(OCIO::DYNAMIC_PROPERTY_GRADING_PRIMARY); + OCIO::DynamicPropertyGradingPrimaryRcPtr primaryProp = + OCIO::DynamicPropertyValue::AsGradingPrimary(dynProp); + OCIO::GradingPrimary primary = primaryProp->getValue(); + primary.m_saturation += 0.1f; + rgbCurveProp->setValue(primary); + } + if (cpuProcessor->hasDynamicProperty(OCIO::DYNAMIC_PROPERTY_GRADING_RGBCURVE)) + { + OCIO::DynamicPropertyRcPtr dynProp = + cpuProcessor->getDynamicProperty(OCIO::DYNAMIC_PROPERTY_GRADING_RGBCURVE); + OCIO::DynamicPropertyGradingRGBCurveRcPtr rgbCurveProp = + OCIO::DynamicPropertyValue::AsGradingRGBCurve(dynProp); + OCIO::ConstGradingRGBCurveRcPtr rgbCurve = rgbCurveProp->getValue()->createEditableCopy(); + OCIO::GradingBSplineCurveRcPtr rCurve = rgbCurve->getCurve(OCIO::RGB_RED); + rCurve->getControlPoint(1).m_y += 0.1f; + rgbCurveProp->setValue(rgbCurve); + } + + + .. py:method:: DynamicProperty.__init__(*args, **kwargs) + :module: PyOpenColorIO + + + .. py:method:: DynamicProperty.getDouble(self: PyOpenColorIO.DynamicProperty) -> float + :module: PyOpenColorIO + + Get the property as DynamicPropertyDoubleRcPtr to access the double value. Will throw if property type is not a type that holds a double such as DYNAMIC_PROPERTY_EXPOSURE. + + + .. py:method:: DynamicProperty.getGradingPrimary(self: PyOpenColorIO.DynamicProperty) -> PyOpenColorIO.GradingPrimary + :module: PyOpenColorIO + + Get the property as DynamicPropertyGradingPrimaryRcPtr to access the :ref:`GradingPrimary` value. Will throw if property type is not DYNAMIC_PROPERTY_GRADING_PRIMARY. + + + .. py:method:: DynamicProperty.getGradingRGBCurve(self: PyOpenColorIO.DynamicProperty) -> PyOpenColorIO.GradingRGBCurve + :module: PyOpenColorIO + + Get the property as DynamicPropertyGradingRGBCurveRcPtr to access the GradingRGBCurveRcPtr value. Will throw if property type is not DYNAMIC_PROPERTY_GRADING_RGBCURVE. + + + .. py:method:: DynamicProperty.getGradingTone(self: PyOpenColorIO.DynamicProperty) -> PyOpenColorIO.GradingTone + :module: PyOpenColorIO + + Get the property as DynamicPropertyGradingToneRcPtr to access the :ref:`GradingTone` value. Will throw if property type is not DYNAMIC_PROPERTY_GRADING_TONE. + + + .. py:method:: DynamicProperty.getType(self: PyOpenColorIO.DynamicProperty) -> PyOpenColorIO.DynamicPropertyType + :module: PyOpenColorIO + + + .. py:method:: DynamicProperty.setDouble(self: PyOpenColorIO.DynamicProperty, val: float) -> None + :module: PyOpenColorIO + + Get the property as DynamicPropertyDoubleRcPtr to access the double value. Will throw if property type is not a type that holds a double such as DYNAMIC_PROPERTY_EXPOSURE. + + + .. py:method:: DynamicProperty.setGradingPrimary(self: PyOpenColorIO.DynamicProperty, val: PyOpenColorIO.GradingPrimary) -> None + :module: PyOpenColorIO + + Get the property as DynamicPropertyGradingPrimaryRcPtr to access the :ref:`GradingPrimary` value. Will throw if property type is not DYNAMIC_PROPERTY_GRADING_PRIMARY. + + + .. py:method:: DynamicProperty.setGradingRGBCurve(self: PyOpenColorIO.DynamicProperty, val: PyOpenColorIO.GradingRGBCurve) -> None + :module: PyOpenColorIO + + Get the property as DynamicPropertyGradingRGBCurveRcPtr to access the GradingRGBCurveRcPtr value. Will throw if property type is not DYNAMIC_PROPERTY_GRADING_RGBCURVE. + + + .. py:method:: DynamicProperty.setGradingTone(self: PyOpenColorIO.DynamicProperty, val: PyOpenColorIO.GradingTone) -> None + :module: PyOpenColorIO + + Get the property as DynamicPropertyGradingToneRcPtr to access the :ref:`GradingTone` value. Will throw if property type is not DYNAMIC_PROPERTY_GRADING_TONE. + diff --git a/docs/api/python/frozen/pyopencolorio_dynamicpropertytype.rst b/docs/api/python/frozen/pyopencolorio_dynamicpropertytype.rst new file mode 100644 index 0000000000..479ddc2df1 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_dynamicpropertytype.rst @@ -0,0 +1,60 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: DynamicPropertyType + :module: PyOpenColorIO + + Types for dynamic properties. + + Members: + + DYNAMIC_PROPERTY_EXPOSURE : Image exposure value (double floating point value) + + DYNAMIC_PROPERTY_CONTRAST : Image contrast value (double floating point value) + + DYNAMIC_PROPERTY_GAMMA : Image gamma value (double floating point value) + + DYNAMIC_PROPERTY_GRADING_PRIMARY : Used by :ref:`GradingPrimaryTransform`. + + DYNAMIC_PROPERTY_GRADING_RGBCURVE : Used by :ref:`GradingRGBCurveTransform`. + + DYNAMIC_PROPERTY_GRADING_TONE : Used by :ref:`GradingToneTransform`. + + .. py:method:: name() -> str + :property: + + .. py:attribute:: DynamicPropertyType.DYNAMIC_PROPERTY_CONTRAST + :module: PyOpenColorIO + :value: + + + .. py:attribute:: DynamicPropertyType.DYNAMIC_PROPERTY_EXPOSURE + :module: PyOpenColorIO + :value: + + + .. py:attribute:: DynamicPropertyType.DYNAMIC_PROPERTY_GAMMA + :module: PyOpenColorIO + :value: + + + .. py:attribute:: DynamicPropertyType.DYNAMIC_PROPERTY_GRADING_PRIMARY + :module: PyOpenColorIO + :value: + + + .. py:attribute:: DynamicPropertyType.DYNAMIC_PROPERTY_GRADING_RGBCURVE + :module: PyOpenColorIO + :value: + + + .. py:attribute:: DynamicPropertyType.DYNAMIC_PROPERTY_GRADING_TONE + :module: PyOpenColorIO + :value: + + + .. py:property:: DynamicPropertyType.value + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_environmentmode.rst b/docs/api/python/frozen/pyopencolorio_environmentmode.rst new file mode 100644 index 0000000000..f86bcc35a1 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_environmentmode.rst @@ -0,0 +1,37 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: EnvironmentMode + :module: PyOpenColorIO + + Members: + + ENV_ENVIRONMENT_UNKNOWN : + + ENV_ENVIRONMENT_LOAD_PREDEFINED : + + ENV_ENVIRONMENT_LOAD_ALL : + + .. py:method:: name() -> str + :property: + + .. py:attribute:: EnvironmentMode.ENV_ENVIRONMENT_LOAD_ALL + :module: PyOpenColorIO + :value: + + + .. py:attribute:: EnvironmentMode.ENV_ENVIRONMENT_LOAD_PREDEFINED + :module: PyOpenColorIO + :value: + + + .. py:attribute:: EnvironmentMode.ENV_ENVIRONMENT_UNKNOWN + :module: PyOpenColorIO + :value: + + + .. py:property:: EnvironmentMode.value + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_environmentmodefromstring.rst b/docs/api/python/frozen/pyopencolorio_environmentmodefromstring.rst new file mode 100644 index 0000000000..5d7baedb4d --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_environmentmodefromstring.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: EnvironmentModeFromString(str: str) -> PyOpenColorIO.EnvironmentMode + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_environmentmodetostring.rst b/docs/api/python/frozen/pyopencolorio_environmentmodetostring.rst new file mode 100644 index 0000000000..3f3eccaf53 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_environmentmodetostring.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: EnvironmentModeToString(mode: PyOpenColorIO.EnvironmentMode) -> str + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_exception.rst b/docs/api/python/frozen/pyopencolorio_exception.rst new file mode 100644 index 0000000000..f22ab45b97 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_exception.rst @@ -0,0 +1,13 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:exception:: Exception + :module: PyOpenColorIO + + An exception class to throw for errors detected at runtime. + + .. warning:: + All functions in the :ref:`Config` class can potentially throw this exception. + diff --git a/docs/api/python/frozen/pyopencolorio_exceptionmissingfile.rst b/docs/api/python/frozen/pyopencolorio_exceptionmissingfile.rst new file mode 100644 index 0000000000..6bbf70207f --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_exceptionmissingfile.rst @@ -0,0 +1,12 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:exception:: ExceptionMissingFile + :module: PyOpenColorIO + + An exception class for errors detected at runtime. + + Thrown when OCIO cannot find a file that is expected to exist. This is provided as a custom type to distinguish cases where one wants to continue looking for missing files, but wants to properly fail for other error conditions. + diff --git a/docs/api/python/frozen/pyopencolorio_exponenttransform.rst b/docs/api/python/frozen/pyopencolorio_exponenttransform.rst new file mode 100644 index 0000000000..d350668af9 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_exponenttransform.rst @@ -0,0 +1,75 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: ExponentTransform + :module: PyOpenColorIO + + Represents exponent transform: pow( clamp(color), value ). + + .. note:: + For configs with version == 1: Negative style is ignored and if the exponent is 1.0, this will not clamp. Otherwise, the input color will be clamped between [0.0, inf]. For configs with version > 1: Negative value handling may be specified via setNegativeStyle. + + + .. py:method:: ExponentTransform.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.ExponentTransform) -> None + + 2. __init__(self: PyOpenColorIO.ExponentTransform, value: List[float[4]] = [1.0, 1.0, 1.0, 1.0], negativeStyle: PyOpenColorIO.NegativeStyle = , direction: PyOpenColorIO.TransformDirection = ) -> None + + + .. py:method:: ExponentTransform.equals(self: PyOpenColorIO.ExponentTransform, other: PyOpenColorIO.ExponentTransform) -> bool + :module: PyOpenColorIO + + Checks if this exactly equals other. + + + .. py:method:: ExponentTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection + :module: PyOpenColorIO + + + .. py:method:: ExponentTransform.getFormatMetadata(self: PyOpenColorIO.ExponentTransform) -> PyOpenColorIO.FormatMetadata + :module: PyOpenColorIO + + + .. py:method:: ExponentTransform.getNegativeStyle(self: PyOpenColorIO.ExponentTransform) -> PyOpenColorIO.NegativeStyle + :module: PyOpenColorIO + + Specifies how negative values are handled. Legal values: + + - NEGATIVE_CLAMP -- Clamp negative values (default). + - NEGATIVE_MIRROR -- Positive curve is rotated 180 degrees around the origin to handle negatives. + - NEGATIVE_PASS_THRU -- Negative values are passed through unchanged. + + + .. py:method:: ExponentTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType + :module: PyOpenColorIO + + + .. py:method:: ExponentTransform.getValue(self: PyOpenColorIO.ExponentTransform) -> List[float[4]] + :module: PyOpenColorIO + + + .. py:method:: ExponentTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None + :module: PyOpenColorIO + + Note that this only affects the evaluation and not the values stored in the object. + + + .. py:method:: ExponentTransform.setNegativeStyle(self: PyOpenColorIO.ExponentTransform, style: PyOpenColorIO.NegativeStyle) -> None + :module: PyOpenColorIO + + + .. py:method:: ExponentTransform.setValue(self: PyOpenColorIO.ExponentTransform, value: List[float[4]]) -> None + :module: PyOpenColorIO + + + .. py:method:: ExponentTransform.validate(self: PyOpenColorIO.Transform) -> None + :module: PyOpenColorIO + + Will throw if data is not valid. + diff --git a/docs/api/python/frozen/pyopencolorio_exponentwithlineartransform.rst b/docs/api/python/frozen/pyopencolorio_exponentwithlineartransform.rst new file mode 100644 index 0000000000..aad657a7b5 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_exponentwithlineartransform.rst @@ -0,0 +1,95 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: ExponentWithLinearTransform + :module: PyOpenColorIO + + Represents power functions with a linear section in the shadows such as sRGB and L*. + + The basic formula is:: + + pow( (x + offset)/(1 + offset), gamma ) with the breakpoint at offset/(gamma - 1). + + Negative values are never clamped. + + + .. py:method:: ExponentWithLinearTransform.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.ExponentWithLinearTransform) -> None + + 2. __init__(self: PyOpenColorIO.ExponentWithLinearTransform, gamma: List[float[4]] = [1.0, 1.0, 1.0, 1.0], offset: List[float[4]] = [0.0, 0.0, 0.0, 0.0], negativeStyle: PyOpenColorIO.NegativeStyle = , direction: PyOpenColorIO.TransformDirection = ) -> None + + + .. py:method:: ExponentWithLinearTransform.equals(self: PyOpenColorIO.ExponentWithLinearTransform, other: PyOpenColorIO.ExponentWithLinearTransform) -> bool + :module: PyOpenColorIO + + Checks if this exactly equals other. + + + .. py:method:: ExponentWithLinearTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection + :module: PyOpenColorIO + + + .. py:method:: ExponentWithLinearTransform.getFormatMetadata(self: PyOpenColorIO.ExponentWithLinearTransform) -> PyOpenColorIO.FormatMetadata + :module: PyOpenColorIO + + + .. py:method:: ExponentWithLinearTransform.getGamma(self: PyOpenColorIO.ExponentWithLinearTransform) -> List[float[4]] + :module: PyOpenColorIO + + + .. py:method:: ExponentWithLinearTransform.getNegativeStyle(self: PyOpenColorIO.ExponentWithLinearTransform) -> PyOpenColorIO.NegativeStyle + :module: PyOpenColorIO + + Specifies how negative values are handled. Legal values: + + - NEGATIVE_LINEAR -- Linear segment continues into negatives (default). + - NEGATIVE_MIRROR -- Positive curve is rotated 180 degrees around the origin to handle negatives. + + + .. py:method:: ExponentWithLinearTransform.getOffset(self: PyOpenColorIO.ExponentWithLinearTransform) -> List[float[4]] + :module: PyOpenColorIO + + + .. py:method:: ExponentWithLinearTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType + :module: PyOpenColorIO + + + .. py:method:: ExponentWithLinearTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None + :module: PyOpenColorIO + + Note that this only affects the evaluation and not the values stored in the object. + + + .. py:method:: ExponentWithLinearTransform.setGamma(self: PyOpenColorIO.ExponentWithLinearTransform, values: List[float[4]]) -> None + :module: PyOpenColorIO + + Set the exponent value for the power function for R, G, B, A. + + .. note:: + The gamma values must be in the range of [1, 10]. Set the transform direction to inverse to obtain the effect of values less than 1. + + + .. py:method:: ExponentWithLinearTransform.setNegativeStyle(self: PyOpenColorIO.ExponentWithLinearTransform, style: PyOpenColorIO.NegativeStyle) -> None + :module: PyOpenColorIO + + + .. py:method:: ExponentWithLinearTransform.setOffset(self: PyOpenColorIO.ExponentWithLinearTransform, values: List[float[4]]) -> None + :module: PyOpenColorIO + + Set the offset value for the power function for R, G, B, A. + + .. note:: + The offset values must be in the range [0, 0.9]. + + + .. py:method:: ExponentWithLinearTransform.validate(self: PyOpenColorIO.Transform) -> None + :module: PyOpenColorIO + + Will throw if data is not valid. + diff --git a/docs/api/python/frozen/pyopencolorio_exposurecontraststyle.rst b/docs/api/python/frozen/pyopencolorio_exposurecontraststyle.rst new file mode 100644 index 0000000000..b3ef1b4ca1 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_exposurecontraststyle.rst @@ -0,0 +1,39 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: ExposureContrastStyle + :module: PyOpenColorIO + + Enumeration of the :cpp:class:`:ref:`ExposureContrastTransform`` transform algorithms. + + Members: + + EXPOSURE_CONTRAST_LINEAR : E/C to be applied to a linear space image. + + EXPOSURE_CONTRAST_VIDEO : E/C to be applied to a video space image. + + EXPOSURE_CONTRAST_LOGARITHMIC : E/C to be applied to a log space image. + + .. py:method:: name() -> str + :property: + + .. py:attribute:: ExposureContrastStyle.EXPOSURE_CONTRAST_LINEAR + :module: PyOpenColorIO + :value: + + + .. py:attribute:: ExposureContrastStyle.EXPOSURE_CONTRAST_LOGARITHMIC + :module: PyOpenColorIO + :value: + + + .. py:attribute:: ExposureContrastStyle.EXPOSURE_CONTRAST_VIDEO + :module: PyOpenColorIO + :value: + + + .. py:property:: ExposureContrastStyle.value + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_exposurecontraststylefromstring.rst b/docs/api/python/frozen/pyopencolorio_exposurecontraststylefromstring.rst new file mode 100644 index 0000000000..086ecd5301 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_exposurecontraststylefromstring.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: ExposureContrastStyleFromString(str: str) -> PyOpenColorIO.ExposureContrastStyle + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_exposurecontraststyletostring.rst b/docs/api/python/frozen/pyopencolorio_exposurecontraststyletostring.rst new file mode 100644 index 0000000000..1f6b2bfc95 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_exposurecontraststyletostring.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: ExposureContrastStyleToString(style: PyOpenColorIO.ExposureContrastStyle) -> str + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_exposurecontrasttransform.rst b/docs/api/python/frozen/pyopencolorio_exposurecontrasttransform.rst new file mode 100644 index 0000000000..5245656a42 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_exposurecontrasttransform.rst @@ -0,0 +1,160 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: ExposureContrastTransform + :module: PyOpenColorIO + + Applies exposure, gamma, and pivoted contrast adjustments. Adjusts the math to be appropriate for linear, logarithmic, or video color spaces. + + + .. py:method:: ExposureContrastTransform.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.ExposureContrastTransform) -> None + + 2. __init__(self: PyOpenColorIO.ExposureContrastTransform, style: PyOpenColorIO.ExposureContrastStyle = , exposure: float = 0.0, contrast: float = 1.0, gamma: float = 1.0, pivot: float = 0.18, logExposureStep: float = 0.088, logMidGray: float = 0.435, dynamicExposure: bool = False, dynamicContrast: bool = False, dynamicGamma: bool = False, direction: PyOpenColorIO.TransformDirection = ) -> None + + + .. py:method:: ExposureContrastTransform.equals(self: PyOpenColorIO.ExposureContrastTransform, other: PyOpenColorIO.ExposureContrastTransform) -> bool + :module: PyOpenColorIO + + Checks if this exactly equals other. + + + .. py:method:: ExposureContrastTransform.getContrast(self: PyOpenColorIO.ExposureContrastTransform) -> float + :module: PyOpenColorIO + + + .. py:method:: ExposureContrastTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection + :module: PyOpenColorIO + + + .. py:method:: ExposureContrastTransform.getExposure(self: PyOpenColorIO.ExposureContrastTransform) -> float + :module: PyOpenColorIO + + + .. py:method:: ExposureContrastTransform.getFormatMetadata(self: PyOpenColorIO.ExposureContrastTransform) -> PyOpenColorIO.FormatMetadata + :module: PyOpenColorIO + + + .. py:method:: ExposureContrastTransform.getGamma(self: PyOpenColorIO.ExposureContrastTransform) -> float + :module: PyOpenColorIO + + + .. py:method:: ExposureContrastTransform.getLogExposureStep(self: PyOpenColorIO.ExposureContrastTransform) -> float + :module: PyOpenColorIO + + + .. py:method:: ExposureContrastTransform.getLogMidGray(self: PyOpenColorIO.ExposureContrastTransform) -> float + :module: PyOpenColorIO + + + .. py:method:: ExposureContrastTransform.getPivot(self: PyOpenColorIO.ExposureContrastTransform) -> float + :module: PyOpenColorIO + + + .. py:method:: ExposureContrastTransform.getStyle(self: PyOpenColorIO.ExposureContrastTransform) -> PyOpenColorIO.ExposureContrastStyle + :module: PyOpenColorIO + + + .. py:method:: ExposureContrastTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType + :module: PyOpenColorIO + + + .. py:method:: ExposureContrastTransform.isContrastDynamic(self: PyOpenColorIO.ExposureContrastTransform) -> bool + :module: PyOpenColorIO + + Contrast can be made dynamic so the value can be changed through the CPU or GPU processor, but if there are several :ref:`ExposureContrastTransform` only one can have a dynamic contrast. + + + .. py:method:: ExposureContrastTransform.isExposureDynamic(self: PyOpenColorIO.ExposureContrastTransform) -> bool + :module: PyOpenColorIO + + Exposure can be made dynamic so the value can be changed through the CPU or GPU processor, but if there are several :ref:`ExposureContrastTransform` only one can have a dynamic exposure. + + + .. py:method:: ExposureContrastTransform.isGammaDynamic(self: PyOpenColorIO.ExposureContrastTransform) -> bool + :module: PyOpenColorIO + + Gamma can be made dynamic so the value can be changed through the CPU or GPU processor, but if there are several :ref:`ExposureContrastTransform` only one can have a dynamic gamma. + + + .. py:method:: ExposureContrastTransform.makeContrastDynamic(self: PyOpenColorIO.ExposureContrastTransform) -> None + :module: PyOpenColorIO + + + .. py:method:: ExposureContrastTransform.makeContrastNonDynamic(self: PyOpenColorIO.ExposureContrastTransform) -> None + :module: PyOpenColorIO + + + .. py:method:: ExposureContrastTransform.makeExposureDynamic(self: PyOpenColorIO.ExposureContrastTransform) -> None + :module: PyOpenColorIO + + + .. py:method:: ExposureContrastTransform.makeExposureNonDynamic(self: PyOpenColorIO.ExposureContrastTransform) -> None + :module: PyOpenColorIO + + + .. py:method:: ExposureContrastTransform.makeGammaDynamic(self: PyOpenColorIO.ExposureContrastTransform) -> None + :module: PyOpenColorIO + + + .. py:method:: ExposureContrastTransform.makeGammaNonDynamic(self: PyOpenColorIO.ExposureContrastTransform) -> None + :module: PyOpenColorIO + + + .. py:method:: ExposureContrastTransform.setContrast(self: PyOpenColorIO.ExposureContrastTransform, contrast: float) -> None + :module: PyOpenColorIO + + Applies a contrast/gamma adjustment around a pivot point. The contrast and gamma are mathematically the same, but two controls are provided to enable the use of separate dynamic parameters. Contrast is usually a scene-referred adjustment that pivots around gray whereas gamma is usually a display-referred adjustment that pivots around white. + + + .. py:method:: ExposureContrastTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None + :module: PyOpenColorIO + + Note that this only affects the evaluation and not the values stored in the object. + + + .. py:method:: ExposureContrastTransform.setExposure(self: PyOpenColorIO.ExposureContrastTransform, exposure: float) -> None + :module: PyOpenColorIO + + Applies an exposure adjustment. The value is in units of stops (regardless of style), for example, a value of -1 would be equivalent to reducing the lighting by one half. + + + .. py:method:: ExposureContrastTransform.setGamma(self: PyOpenColorIO.ExposureContrastTransform, gamma: float) -> None + :module: PyOpenColorIO + + + .. py:method:: ExposureContrastTransform.setLogExposureStep(self: PyOpenColorIO.ExposureContrastTransform, logExposureStep: float) -> None + :module: PyOpenColorIO + + Set the increment needed to move one stop for the log-style algorithm. For example, ACEScct is 0.057, LogC is roughly 0.074, and Cineon is roughly 90/1023 = 0.088. The default value is 0.088. + + + .. py:method:: ExposureContrastTransform.setLogMidGray(self: PyOpenColorIO.ExposureContrastTransform, logMidGray: float) -> None + :module: PyOpenColorIO + + Set the position of 18% gray for use by the log-style algorithm. For example, ACEScct is about 0.41, LogC is about 0.39, and ADX10 is 445/1023 = 0.435. The default value is 0.435. + + + .. py:method:: ExposureContrastTransform.setPivot(self: PyOpenColorIO.ExposureContrastTransform, pivot: float) -> None + :module: PyOpenColorIO + + Set the pivot point around which the contrast and gamma controls will work. Regardless of whether linear/video/log-style is being used, the pivot is always expressed in linear. In other words, a pivot of 0.18 is always mid-gray. + + + .. py:method:: ExposureContrastTransform.setStyle(self: PyOpenColorIO.ExposureContrastTransform, style: PyOpenColorIO.ExposureContrastStyle) -> None + :module: PyOpenColorIO + + Select the algorithm for linear, video or log color spaces. + + + .. py:method:: ExposureContrastTransform.validate(self: PyOpenColorIO.Transform) -> None + :module: PyOpenColorIO + + Will throw if data is not valid. + diff --git a/docs/api/python/frozen/pyopencolorio_filerules.rst b/docs/api/python/frozen/pyopencolorio_filerules.rst new file mode 100644 index 0000000000..9835c7a21b --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_filerules.rst @@ -0,0 +1,181 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: FileRules + :module: PyOpenColorIO + + The File Rules are a set of filepath to color space mappings that are evaluated from first to last. The first rule to match is what determines which color space is returned. There are four types of rules available. Each rule type has a name key that may be used by applications to refer to that rule. Name values must be unique i.e. using a case insensitive comparison. The other keys depend on the rule type: + + - *Basic Rule*: This is the basic rule type that uses Unix glob style pattern matching and is thus very easy to use. It contains the keys: + - name: Name of the rule + - colorspace: Color space name to be returned. + - pattern: Glob pattern to be used for the main part of the name/path. + - extension: Glob pattern to be used for the file extension. Note that if glob tokens are not used, the extension will be used in a non-case-sensitive way by default. + + - *Regex Rule*: This is similar to the basic rule but allows additional capabilities for power-users. It contains the keys: + - name: Name of the rule + - colorspace: Color space name to be returned. + - regex: Regular expression to be evaluated. + + - *OCIO v1 style Rule*: This rule allows the use of the OCIO v1 style, where the string is searched for color space names from the config. This rule may occur 0 or 1 times in the list. The position in the list prioritizes it with respect to the other rules. StrictParsing is not used. If no color space is found in the path, the rule will not match and the next rule will be considered. see :ref:`insertPathSearchRule`. It has the key: + - name: Must be "ColorSpaceNamePathSearch". + + - *Default Rule*: The file_rules must always end with this rule. If no prior rules match, this rule specifies the color space applications will use. see :ref:`setDefaultRuleColorSpace`. It has the keys: + - name: must be "Default". + - colorspace : Color space name to be returned. + + Custom string keys and associated string values may be used to convey app or workflow-specific information, e.g. whether the color space should be left as is or converted into a working space. + + Getters and setters are using the rule position, they will throw if the position is not valid. If the rule at the specified position does not implement the requested property getter will return NULL and setter will throw. + + When loading a v1 config, a set of :ref:`FileRules` are created with ColorSpaceNamePathSearch followed by the Default rule pointing to the default role. This allows getColorSpaceFromFilepath to emulate OCIO v1 code that used parseColorSpaceFromString with strictparsing set to false. + + + .. py:method:: FileRules.__init__(self: PyOpenColorIO.FileRules) -> None + :module: PyOpenColorIO + + Creates :ref:`FileRules` for a :ref:`Config`. File rules will contain the default rule using the default role. The default rule cannot be removed. + + + .. py:method:: FileRules.decreaseRulePriority(self: PyOpenColorIO.FileRules, ruleIndex: int) -> None + :module: PyOpenColorIO + + Move a rule closer to the end of the list by one position. + + + .. py:method:: FileRules.getColorSpace(self: PyOpenColorIO.FileRules, ruleIndex: int) -> str + :module: PyOpenColorIO + + Set the rule's color space (may also be a role). + + + .. py:method:: FileRules.getCustomKeyName(self: PyOpenColorIO.FileRules, ruleIndex: int, key: int) -> str + :module: PyOpenColorIO + + Get name of key. + + + .. py:method:: FileRules.getCustomKeyValue(self: PyOpenColorIO.FileRules, ruleIndex: int, key: int) -> str + :module: PyOpenColorIO + + Get value for the key. + + + .. py:method:: FileRules.getExtension(self: PyOpenColorIO.FileRules, ruleIndex: int) -> str + :module: PyOpenColorIO + + Setting extension will erase regex. + + + .. py:method:: FileRules.getIndexForRule(self: PyOpenColorIO.FileRules, ruleName: str) -> int + :module: PyOpenColorIO + + Get the index from the rule name. + + + .. py:method:: FileRules.getName(self: PyOpenColorIO.FileRules, ruleIndex: int) -> str + :module: PyOpenColorIO + + Get name of the rule. + + + .. py:method:: FileRules.getNumCustomKeys(self: PyOpenColorIO.FileRules, ruleIndex: int) -> int + :module: PyOpenColorIO + + Get number of key/value pairs. + + + .. py:method:: FileRules.getNumEntries(self: PyOpenColorIO.FileRules) -> int + :module: PyOpenColorIO + + Does include default rule. Result will be at least 1. + + + .. py:method:: FileRules.getPattern(self: PyOpenColorIO.FileRules, ruleIndex: int) -> str + :module: PyOpenColorIO + + Setting pattern will erase regex. + + + .. py:method:: FileRules.getRegex(self: PyOpenColorIO.FileRules, ruleIndex: int) -> str + :module: PyOpenColorIO + + Setting a regex will erase pattern & extension. + + + .. py:method:: FileRules.increaseRulePriority(self: PyOpenColorIO.FileRules, ruleIndex: int) -> None + :module: PyOpenColorIO + + Move a rule closer to the start of the list by one position. + + + .. py:method:: FileRules.insertPathSearchRule(self: PyOpenColorIO.FileRules, ruleIndex: int) -> None + :module: PyOpenColorIO + + Helper function to insert a rule. + + Uses Config:parseColorSpaceFromString to search the path for any of the color spaces named in the config (as per OCIO v1). + + + .. py:method:: FileRules.insertRule(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. insertRule(self: PyOpenColorIO.FileRules, ruleIndex: int, name: str, colorSpace: str, pattern: str, extension: str) -> None + + Insert a rule at a given ruleIndex. + + Rule currently at ruleIndex will be pushed to index: ruleIndex + 1. Name must be unique. + - "Default" is a reserved name for the default rule. The default rule is automatically added and can't be removed. (see :ref:`FileRules::setDefaultRuleColorSpace` ). + - "ColorSpaceNamePathSearch" is also a reserved name (see :ref:`FileRules::insertPathSearchRule` ). + + Will throw if pattern, extension or regex is a null or empty string. + + Will throw if ruleIndex is not less than :ref:`FileRules::getNumEntries` . + + 2. insertRule(self: PyOpenColorIO.FileRules, ruleIndex: int, name: str, colorSpace: str, regex: str) -> None + + + .. py:method:: FileRules.isDefault(self: PyOpenColorIO.FileRules) -> bool + :module: PyOpenColorIO + + Check if there is only the default rule using default role and no custom key. This is the default :ref:`FileRules` state when creating a new config. + + + .. py:method:: FileRules.removeRule(self: PyOpenColorIO.FileRules, ruleIndex: int) -> None + :module: PyOpenColorIO + + .. note:: + Default rule can't be removed. Will throw if ruleIndex + 1 is not less than :ref:`FileRules::getNumEntries` . + + + .. py:method:: FileRules.setColorSpace(self: PyOpenColorIO.FileRules, ruleIndex: int, colorSpace: str) -> None + :module: PyOpenColorIO + + + .. py:method:: FileRules.setCustomKey(self: PyOpenColorIO.FileRules, ruleIndex: int, key: str, value: str) -> None + :module: PyOpenColorIO + + Adds a key/value or replace value if key exists. Setting a NULL or an empty value will erase the key. + + + .. py:method:: FileRules.setDefaultRuleColorSpace(self: PyOpenColorIO.FileRules, colorSpace: str) -> None + :module: PyOpenColorIO + + Helper function to set the color space for the default rule. + + + .. py:method:: FileRules.setExtension(self: PyOpenColorIO.FileRules, ruleIndex: int, extension: str) -> None + :module: PyOpenColorIO + + + .. py:method:: FileRules.setPattern(self: PyOpenColorIO.FileRules, ruleIndex: int, pattern: str) -> None + :module: PyOpenColorIO + + + .. py:method:: FileRules.setRegex(self: PyOpenColorIO.FileRules, ruleIndex: int, regex: str) -> None + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_filetransform.rst b/docs/api/python/frozen/pyopencolorio_filetransform.rst new file mode 100644 index 0000000000..120daa0778 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_filetransform.rst @@ -0,0 +1,101 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: FileTransform + :module: PyOpenColorIO + + + .. py:method:: FileTransform.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.FileTransform) -> None + + 2. __init__(self: PyOpenColorIO.FileTransform, src: str = '', cccId: str = '', interpolation: PyOpenColorIO.Interpolation = , direction: PyOpenColorIO.TransformDirection = ) -> None + + + .. py:method:: FileTransform.getCCCId(self: PyOpenColorIO.FileTransform) -> str + :module: PyOpenColorIO + + The cccid can be the ID of a CDL or the index of the CDL (as string). If cccid is NULL or empty the first CDL is returned. The cccid is case-sensitive. + + + .. py:method:: FileTransform.getCDLStyle(self: PyOpenColorIO.FileTransform) -> PyOpenColorIO.CDLStyle + :module: PyOpenColorIO + + + .. py:method:: FileTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection + :module: PyOpenColorIO + + + .. py:method:: FileTransform.getFormats() -> PyOpenColorIO.FileTransform.FormatIterator + :module: PyOpenColorIO + :staticmethod: + + + .. py:method:: FileTransform.getInterpolation(self: PyOpenColorIO.FileTransform) -> PyOpenColorIO.Interpolation + :module: PyOpenColorIO + + The file parsers that care about interpolation (LUTs) will try to make use of the requested interpolation method when loading the file. In these cases, if the requested method could not be used, a warning is logged. If no method is provided, or a method cannot be used, INTERP_DEFAULT is used. + + + .. py:method:: FileTransform.getSrc(self: PyOpenColorIO.FileTransform) -> str + :module: PyOpenColorIO + + + .. py:method:: FileTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType + :module: PyOpenColorIO + + + .. py:method:: FileTransform.setCCCId(self: PyOpenColorIO.FileTransform, cccId: str) -> None + :module: PyOpenColorIO + + + .. py:method:: FileTransform.setCDLStyle(self: PyOpenColorIO.FileTransform, style: PyOpenColorIO.CDLStyle) -> None + :module: PyOpenColorIO + + Can be used with CDL, CC & CCC formats to specify the clamping behavior of the :ref:`CDLTransform`. Default is CDL_NO_CLAMP. + + + .. py:method:: FileTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None + :module: PyOpenColorIO + + Note that this only affects the evaluation and not the values stored in the object. + + + .. py:method:: FileTransform.setInterpolation(self: PyOpenColorIO.FileTransform, interpolation: PyOpenColorIO.Interpolation) -> None + :module: PyOpenColorIO + + + .. py:method:: FileTransform.setSrc(self: PyOpenColorIO.FileTransform, src: str) -> None + :module: PyOpenColorIO + + + .. py:method:: FileTransform.validate(self: PyOpenColorIO.Transform) -> None + :module: PyOpenColorIO + + Will throw if data is not valid. + + +.. py:class:: FormatIterator + :module: PyOpenColorIO.FileTransform + + + .. py:method:: FormatIterator.__getitem__(self: PyOpenColorIO.FileTransform.FormatIterator, arg0: int) -> tuple + :module: PyOpenColorIO.FileTransform + + + .. py:method:: FormatIterator.__iter__(self: PyOpenColorIO.FileTransform.FormatIterator) -> PyOpenColorIO.FileTransform.FormatIterator + :module: PyOpenColorIO.FileTransform + + + .. py:method:: FormatIterator.__len__(self: PyOpenColorIO.FileTransform.FormatIterator) -> int + :module: PyOpenColorIO.FileTransform + + + .. py:method:: FormatIterator.__next__(self: PyOpenColorIO.FileTransform.FormatIterator) -> tuple + :module: PyOpenColorIO.FileTransform + diff --git a/docs/api/python/frozen/pyopencolorio_fixedfunctionstyle.rst b/docs/api/python/frozen/pyopencolorio_fixedfunctionstyle.rst new file mode 100644 index 0000000000..c4cba43d7b --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_fixedfunctionstyle.rst @@ -0,0 +1,109 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: FixedFunctionStyle + :module: PyOpenColorIO + + Enumeration of the :cpp:class:`:ref:`FixedFunctionTransform`` transform algorithms. + + Members: + + FIXED_FUNCTION_ACES_RED_MOD_03 : Red modifier (ACES 0.3/0.7) + + FIXED_FUNCTION_ACES_RED_MOD_10 : Red modifier (ACES 1.0) + + FIXED_FUNCTION_ACES_GLOW_03 : Glow function (ACES 0.3/0.7) + + FIXED_FUNCTION_ACES_GLOW_10 : Glow function (ACES 1.0) + + FIXED_FUNCTION_ACES_DARK_TO_DIM_10 : Dark to dim surround correction (ACES 1.0) + + FIXED_FUNCTION_REC2100_SURROUND : Rec.2100 surround correction (takes one double for the gamma param) + + FIXED_FUNCTION_RGB_TO_HSV : Classic RGB to HSV function. + + FIXED_FUNCTION_XYZ_TO_xyY : CIE XYZ to 1931 xy chromaticity coordinates. + + FIXED_FUNCTION_XYZ_TO_uvY : CIE XYZ to 1976 u'v' chromaticity coordinates. + + FIXED_FUNCTION_XYZ_TO_LUV : CIE XYZ to 1976 CIELUV colour space (D65 white) + + FIXED_FUNCTION_ACES_GAMUTMAP_02 : ACES 0.2 Gamut clamping algorithm -- NOT IMPLEMENTED YET. + + FIXED_FUNCTION_ACES_GAMUTMAP_07 : ACES 0.7 Gamut clamping algorithm -- NOT IMPLEMENTED YET. + + FIXED_FUNCTION_ACES_GAMUT_COMP_13 : ACES 1.3 Parametric Gamut Compression (expects ACEScg values) + + .. py:method:: name() -> str + :property: + + .. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_ACES_DARK_TO_DIM_10 + :module: PyOpenColorIO + :value: + + + .. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_ACES_GAMUTMAP_02 + :module: PyOpenColorIO + :value: + + + .. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_ACES_GAMUTMAP_07 + :module: PyOpenColorIO + :value: + + + .. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_ACES_GAMUT_COMP_13 + :module: PyOpenColorIO + :value: + + + .. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_ACES_GLOW_03 + :module: PyOpenColorIO + :value: + + + .. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_ACES_GLOW_10 + :module: PyOpenColorIO + :value: + + + .. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_ACES_RED_MOD_03 + :module: PyOpenColorIO + :value: + + + .. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_ACES_RED_MOD_10 + :module: PyOpenColorIO + :value: + + + .. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_REC2100_SURROUND + :module: PyOpenColorIO + :value: + + + .. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_RGB_TO_HSV + :module: PyOpenColorIO + :value: + + + .. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_XYZ_TO_LUV + :module: PyOpenColorIO + :value: + + + .. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_XYZ_TO_uvY + :module: PyOpenColorIO + :value: + + + .. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_XYZ_TO_xyY + :module: PyOpenColorIO + :value: + + + .. py:property:: FixedFunctionStyle.value + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_fixedfunctionstylefromstring.rst b/docs/api/python/frozen/pyopencolorio_fixedfunctionstylefromstring.rst new file mode 100644 index 0000000000..aa3376a0bc --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_fixedfunctionstylefromstring.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: FixedFunctionStyleFromString(str: str) -> PyOpenColorIO.FixedFunctionStyle + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_fixedfunctionstyletostring.rst b/docs/api/python/frozen/pyopencolorio_fixedfunctionstyletostring.rst new file mode 100644 index 0000000000..29bd85d7af --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_fixedfunctionstyletostring.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: FixedFunctionStyleToString(style: PyOpenColorIO.FixedFunctionStyle) -> str + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_fixedfunctiontransform.rst b/docs/api/python/frozen/pyopencolorio_fixedfunctiontransform.rst new file mode 100644 index 0000000000..06ea28fa09 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_fixedfunctiontransform.rst @@ -0,0 +1,64 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: FixedFunctionTransform + :module: PyOpenColorIO + + Provides a set of hard-coded algorithmic building blocks that are needed to accurately implement various common color transformations. + + + .. py:method:: FixedFunctionTransform.__init__(self: PyOpenColorIO.FixedFunctionTransform, style: PyOpenColorIO.FixedFunctionStyle, params: List[float] = [], direction: PyOpenColorIO.TransformDirection = ) -> None + :module: PyOpenColorIO + + + .. py:method:: FixedFunctionTransform.equals(self: PyOpenColorIO.FixedFunctionTransform, other: PyOpenColorIO.FixedFunctionTransform) -> bool + :module: PyOpenColorIO + + Checks if this exactly equals other. + + + .. py:method:: FixedFunctionTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection + :module: PyOpenColorIO + + + .. py:method:: FixedFunctionTransform.getFormatMetadata(self: PyOpenColorIO.FixedFunctionTransform) -> PyOpenColorIO.FormatMetadata + :module: PyOpenColorIO + + + .. py:method:: FixedFunctionTransform.getParams(self: PyOpenColorIO.FixedFunctionTransform) -> List[float] + :module: PyOpenColorIO + + + .. py:method:: FixedFunctionTransform.getStyle(self: PyOpenColorIO.FixedFunctionTransform) -> PyOpenColorIO.FixedFunctionStyle + :module: PyOpenColorIO + + + .. py:method:: FixedFunctionTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType + :module: PyOpenColorIO + + + .. py:method:: FixedFunctionTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None + :module: PyOpenColorIO + + Note that this only affects the evaluation and not the values stored in the object. + + + .. py:method:: FixedFunctionTransform.setParams(self: PyOpenColorIO.FixedFunctionTransform, params: List[float]) -> None + :module: PyOpenColorIO + + Set the parameters (for functions that require them). + + + .. py:method:: FixedFunctionTransform.setStyle(self: PyOpenColorIO.FixedFunctionTransform, style: PyOpenColorIO.FixedFunctionStyle) -> None + :module: PyOpenColorIO + + Select which algorithm to use. + + + .. py:method:: FixedFunctionTransform.validate(self: PyOpenColorIO.Transform) -> None + :module: PyOpenColorIO + + Will throw if data is not valid. + diff --git a/docs/api/python/frozen/pyopencolorio_formatmetadata.rst b/docs/api/python/frozen/pyopencolorio_formatmetadata.rst new file mode 100644 index 0000000000..747f773c1d --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_formatmetadata.rst @@ -0,0 +1,184 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: FormatMetadata + :module: PyOpenColorIO + + The :ref:`FormatMetadata` class is intended to be a generic container to hold metadata from various file formats. + + This class provides a hierarchical metadata container. A metadata object is similar to an element in XML. The top level element is named "ROOT" and can't be renamed. Several transforms have a :ref:`FormatMetadata`. The root element and all of the sub-elements may contain: + - A name string (e.g. "ROOT", "Description"...). Name can't be empty. + - A value string (e.g. "updated viewing LUT"). Value can be empty. + - A list of attributes (name, value) string pairs (e.g. "version", "1.5"). There are helper functions to get and set "id" and "name" attributes. Attribute names are unique. + - And a list of child sub-elements, which are also objects implementing :ref:`FormatMetadata`. There can be several sub-elements with the same name. + + + .. py:method:: FormatMetadata.__contains__(self: PyOpenColorIO.FormatMetadata, name: str) -> bool + :module: PyOpenColorIO + + + .. py:method:: FormatMetadata.__getitem__(self: PyOpenColorIO.FormatMetadata, name: str) -> str + :module: PyOpenColorIO + + Get the value of a attribute ("" if attribute does not exist). + + + .. py:method:: FormatMetadata.__init__(*args, **kwargs) + :module: PyOpenColorIO + + + .. py:method:: FormatMetadata.__iter__(self: PyOpenColorIO.FormatMetadata) -> PyOpenColorIO.FormatMetadata.AttributeNameIterator + :module: PyOpenColorIO + + + .. py:method:: FormatMetadata.__len__(self: PyOpenColorIO.FormatMetadata) -> int + :module: PyOpenColorIO + + + .. py:method:: FormatMetadata.__setitem__(self: PyOpenColorIO.FormatMetadata, name: str, value: str) -> None + :module: PyOpenColorIO + + Add an attribute with a given name and value. If an attribute with the same name already exists, its value is replaced. Throw if name is NULL or empty. + + + .. py:method:: FormatMetadata.addChildElement(self: PyOpenColorIO.FormatMetadata, name: str, value: str) -> None + :module: PyOpenColorIO + + Add a child element with a given name and value. + + Name has to be non-empty. Value may be empty, particularly if this element will have children. Element is added after all existing children. Use getChildElement(getNumChildrenElements()-1) to access the added element. + + + .. py:method:: FormatMetadata.clear(self: PyOpenColorIO.FormatMetadata) -> None + :module: PyOpenColorIO + + Remove all children, all attributes and the value. + + + .. py:method:: FormatMetadata.getAttributes(self: PyOpenColorIO.FormatMetadata) -> PyOpenColorIO.FormatMetadata.AttributeIterator + :module: PyOpenColorIO + + + .. py:method:: FormatMetadata.getChildElements(self: PyOpenColorIO.FormatMetadata) -> PyOpenColorIO.FormatMetadata.ChildElementIterator + :module: PyOpenColorIO + + + .. py:method:: FormatMetadata.getElementName(self: PyOpenColorIO.FormatMetadata) -> str + :module: PyOpenColorIO + + + .. py:method:: FormatMetadata.getElementValue(self: PyOpenColorIO.FormatMetadata) -> str + :module: PyOpenColorIO + + + .. py:method:: FormatMetadata.getID(self: PyOpenColorIO.FormatMetadata) -> str + :module: PyOpenColorIO + + Convenience method to easily get/set the 'id' attribute. This corresponds to the ProcessNode id attribute from a CLF/CTF file or the ColorCorrection id attribute from a CC/CCC/CDL file. + + + .. py:method:: FormatMetadata.getName(self: PyOpenColorIO.FormatMetadata) -> str + :module: PyOpenColorIO + + Convenience method to easily get/set the 'name' attribute. This corresponds to the ProcessNode name attribute from a CLF / CTF file or the name key of a transform in the config YAML. + + + .. py:method:: FormatMetadata.setElementName(self: PyOpenColorIO.FormatMetadata, name: str) -> None + :module: PyOpenColorIO + + Name has to be a non-empty string. Top-level element can't be renamed. 'ROOT' is reserved. + + + .. py:method:: FormatMetadata.setElementValue(self: PyOpenColorIO.FormatMetadata, value: str) -> None + :module: PyOpenColorIO + + + .. py:method:: FormatMetadata.setID(self: PyOpenColorIO.FormatMetadata, id: str) -> None + :module: PyOpenColorIO + + + .. py:method:: FormatMetadata.setName(self: PyOpenColorIO.FormatMetadata, name: str) -> None + :module: PyOpenColorIO + + +.. py:class:: AttributeNameIterator + :module: PyOpenColorIO.FormatMetadata + + + .. py:method:: AttributeNameIterator.__getitem__(self: PyOpenColorIO.FormatMetadata.AttributeNameIterator, arg0: int) -> str + :module: PyOpenColorIO.FormatMetadata + + + .. py:method:: AttributeNameIterator.__iter__(self: PyOpenColorIO.FormatMetadata.AttributeNameIterator) -> PyOpenColorIO.FormatMetadata.AttributeNameIterator + :module: PyOpenColorIO.FormatMetadata + + + .. py:method:: AttributeNameIterator.__len__(self: PyOpenColorIO.FormatMetadata.AttributeNameIterator) -> int + :module: PyOpenColorIO.FormatMetadata + + + .. py:method:: AttributeNameIterator.__next__(self: PyOpenColorIO.FormatMetadata.AttributeNameIterator) -> str + :module: PyOpenColorIO.FormatMetadata + + +.. py:class:: AttributeIterator + :module: PyOpenColorIO.FormatMetadata + + + .. py:method:: AttributeIterator.__getitem__(self: PyOpenColorIO.FormatMetadata.AttributeIterator, arg0: int) -> tuple + :module: PyOpenColorIO.FormatMetadata + + + .. py:method:: AttributeIterator.__iter__(self: PyOpenColorIO.FormatMetadata.AttributeIterator) -> PyOpenColorIO.FormatMetadata.AttributeIterator + :module: PyOpenColorIO.FormatMetadata + + + .. py:method:: AttributeIterator.__len__(self: PyOpenColorIO.FormatMetadata.AttributeIterator) -> int + :module: PyOpenColorIO.FormatMetadata + + + .. py:method:: AttributeIterator.__next__(self: PyOpenColorIO.FormatMetadata.AttributeIterator) -> tuple + :module: PyOpenColorIO.FormatMetadata + + +.. py:class:: ConstChildElementIterator + :module: PyOpenColorIO.FormatMetadata + + + .. py:method:: ConstChildElementIterator.__getitem__(self: PyOpenColorIO.FormatMetadata.ConstChildElementIterator, arg0: int) -> PyOpenColorIO.FormatMetadata + :module: PyOpenColorIO.FormatMetadata + + + .. py:method:: ConstChildElementIterator.__iter__(self: PyOpenColorIO.FormatMetadata.ConstChildElementIterator) -> PyOpenColorIO.FormatMetadata.ConstChildElementIterator + :module: PyOpenColorIO.FormatMetadata + + + .. py:method:: ConstChildElementIterator.__len__(self: PyOpenColorIO.FormatMetadata.ConstChildElementIterator) -> int + :module: PyOpenColorIO.FormatMetadata + + + .. py:method:: ConstChildElementIterator.__next__(self: PyOpenColorIO.FormatMetadata.ConstChildElementIterator) -> PyOpenColorIO.FormatMetadata + :module: PyOpenColorIO.FormatMetadata + + +.. py:class:: ChildElementIterator + :module: PyOpenColorIO.FormatMetadata + + + .. py:method:: ChildElementIterator.__getitem__(self: PyOpenColorIO.FormatMetadata.ChildElementIterator, arg0: int) -> PyOpenColorIO.FormatMetadata + :module: PyOpenColorIO.FormatMetadata + + + .. py:method:: ChildElementIterator.__iter__(self: PyOpenColorIO.FormatMetadata.ChildElementIterator) -> PyOpenColorIO.FormatMetadata.ChildElementIterator + :module: PyOpenColorIO.FormatMetadata + + + .. py:method:: ChildElementIterator.__len__(self: PyOpenColorIO.FormatMetadata.ChildElementIterator) -> int + :module: PyOpenColorIO.FormatMetadata + + + .. py:method:: ChildElementIterator.__next__(self: PyOpenColorIO.FormatMetadata.ChildElementIterator) -> PyOpenColorIO.FormatMetadata + :module: PyOpenColorIO.FormatMetadata + diff --git a/docs/api/python/frozen/pyopencolorio_getenvvariable.rst b/docs/api/python/frozen/pyopencolorio_getenvvariable.rst new file mode 100644 index 0000000000..ee5450f57b --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_getenvvariable.rst @@ -0,0 +1,10 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: GetEnvVariable(name: str) -> str + :module: PyOpenColorIO + + Another call modifies the string obtained from a previous call as the method always uses the same memory buffer. + diff --git a/docs/api/python/frozen/pyopencolorio_getinversetransformdirection.rst b/docs/api/python/frozen/pyopencolorio_getinversetransformdirection.rst new file mode 100644 index 0000000000..2729420ea6 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_getinversetransformdirection.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: GetInverseTransformDirection(direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.TransformDirection + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_getlogginglevel.rst b/docs/api/python/frozen/pyopencolorio_getlogginglevel.rst new file mode 100644 index 0000000000..1c60f9b80f --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_getlogginglevel.rst @@ -0,0 +1,12 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: GetLoggingLevel() -> PyOpenColorIO.LoggingLevel + :module: PyOpenColorIO + + Get the global logging level. + + You can override this at runtime using the OCIO_LOGGING_LEVEL environment variable. The client application that sets this should use :ref:`SetLoggingLevel`, and not the environment variable. The default value is INFO. + diff --git a/docs/api/python/frozen/pyopencolorio_getversion.rst b/docs/api/python/frozen/pyopencolorio_getversion.rst new file mode 100644 index 0000000000..a66022a087 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_getversion.rst @@ -0,0 +1,12 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: GetVersion() -> str + :module: PyOpenColorIO + + Get the version number for the library, as a dot-delimited string (e.g., "1.0.0"). + + This is also available at compile time as OCIO_VERSION_FULL_STR. + diff --git a/docs/api/python/frozen/pyopencolorio_getversionhex.rst b/docs/api/python/frozen/pyopencolorio_getversionhex.rst new file mode 100644 index 0000000000..471332fe04 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_getversionhex.rst @@ -0,0 +1,12 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: GetVersionHex() -> int + :module: PyOpenColorIO + + Get the version number for the library, as a single 4-byte hex number (e.g., 0x01050200 for "1.5.2"), to be used for numeric comparisons. + + This is also at compile time as OCIO_VERSION_HEX. + diff --git a/docs/api/python/frozen/pyopencolorio_gpulanguage.rst b/docs/api/python/frozen/pyopencolorio_gpulanguage.rst new file mode 100644 index 0000000000..aa679428c7 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_gpulanguage.rst @@ -0,0 +1,74 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: GpuLanguage + :module: PyOpenColorIO + + Used when there is a choice of hardware shader language. + + Members: + + GPU_LANGUAGE_CG : Nvidia Cg shader. + + GPU_LANGUAGE_GLSL_1_2 : OpenGL Shading Language. + + GPU_LANGUAGE_GLSL_1_3 : OpenGL Shading Language. + + GPU_LANGUAGE_GLSL_4_0 : OpenGL Shading Language. + + GPU_LANGUAGE_GLSL_ES_1_0 : OpenGL ES Shading Language. + + GPU_LANGUAGE_GLSL_ES_3_0 : OpenGL ES Shading Language. + + GPU_LANGUAGE_HLSL_DX11 : DirectX Shading Language. + + GPU_LANGUAGE_MSL_2_0 : Metal Shading Language. + + .. py:method:: name() -> str + :property: + + .. py:attribute:: GpuLanguage.GPU_LANGUAGE_CG + :module: PyOpenColorIO + :value: + + + .. py:attribute:: GpuLanguage.GPU_LANGUAGE_GLSL_1_2 + :module: PyOpenColorIO + :value: + + + .. py:attribute:: GpuLanguage.GPU_LANGUAGE_GLSL_1_3 + :module: PyOpenColorIO + :value: + + + .. py:attribute:: GpuLanguage.GPU_LANGUAGE_GLSL_4_0 + :module: PyOpenColorIO + :value: + + + .. py:attribute:: GpuLanguage.GPU_LANGUAGE_GLSL_ES_1_0 + :module: PyOpenColorIO + :value: + + + .. py:attribute:: GpuLanguage.GPU_LANGUAGE_GLSL_ES_3_0 + :module: PyOpenColorIO + :value: + + + .. py:attribute:: GpuLanguage.GPU_LANGUAGE_HLSL_DX11 + :module: PyOpenColorIO + :value: + + + .. py:attribute:: GpuLanguage.GPU_LANGUAGE_MSL_2_0 + :module: PyOpenColorIO + :value: + + + .. py:property:: GpuLanguage.value + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_gpulanguagefromstring.rst b/docs/api/python/frozen/pyopencolorio_gpulanguagefromstring.rst new file mode 100644 index 0000000000..738f51c50e --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_gpulanguagefromstring.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: GpuLanguageFromString(str: str) -> PyOpenColorIO.GpuLanguage + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_gpulanguagetostring.rst b/docs/api/python/frozen/pyopencolorio_gpulanguagetostring.rst new file mode 100644 index 0000000000..e79d729eda --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_gpulanguagetostring.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: GpuLanguageToString(language: PyOpenColorIO.GpuLanguage) -> str + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_gpuprocessor.rst b/docs/api/python/frozen/pyopencolorio_gpuprocessor.rst index 1bb440937a..4afdec714e 100644 --- a/docs/api/python/frozen/pyopencolorio_gpuprocessor.rst +++ b/docs/api/python/frozen/pyopencolorio_gpuprocessor.rst @@ -5,27 +5,26 @@ .. py:class:: GPUProcessor :module: PyOpenColorIO - :canonical: PyOpenColorIO.PyOpenColorIO.GPUProcessor .. py:method:: GPUProcessor.__init__(*args, **kwargs) :module: PyOpenColorIO - .. py:method:: GPUProcessor.extractGpuShaderInfo(self: PyOpenColorIO.PyOpenColorIO.GPUProcessor, shaderDesc: PyOpenColorIO.PyOpenColorIO.GpuShaderDesc) -> None + .. py:method:: GPUProcessor.extractGpuShaderInfo(self: PyOpenColorIO.GPUProcessor, shaderDesc: PyOpenColorIO.GpuShaderDesc) -> None :module: PyOpenColorIO Extract & Store the shader information to implement the color processing. - .. py:method:: GPUProcessor.getCacheID(self: PyOpenColorIO.PyOpenColorIO.GPUProcessor) -> str + .. py:method:: GPUProcessor.getCacheID(self: PyOpenColorIO.GPUProcessor) -> str :module: PyOpenColorIO - .. py:method:: GPUProcessor.hasChannelCrosstalk(self: PyOpenColorIO.PyOpenColorIO.GPUProcessor) -> bool + .. py:method:: GPUProcessor.hasChannelCrosstalk(self: PyOpenColorIO.GPUProcessor) -> bool :module: PyOpenColorIO - .. py:method:: GPUProcessor.isNoOp(self: PyOpenColorIO.PyOpenColorIO.GPUProcessor) -> bool + .. py:method:: GPUProcessor.isNoOp(self: PyOpenColorIO.GPUProcessor) -> bool :module: PyOpenColorIO diff --git a/docs/api/python/frozen/pyopencolorio_gpushadercreator.rst b/docs/api/python/frozen/pyopencolorio_gpushadercreator.rst new file mode 100644 index 0000000000..d55fe2a7b2 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_gpushadercreator.rst @@ -0,0 +1,278 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: GpuShaderCreator + :module: PyOpenColorIO + + Inherit from the class to fully customize the implementation of a GPU shader program from a color transformation. + + When no customizations are needed and the intermediate in-memory step is acceptable then the :ref:`GpuShaderDesc` is a better choice. + + .. note:: + To better decouple the DynamicProperties from their GPU implementation, the code provides several addUniform() methods i.e. one per access function types. For example, an :ref:`ExposureContrastTransform` instance owns three DynamicProperties and they are all implemented by a double. When creating the GPU fragment shader program, the addUniform() with :ref:`GpuShaderCreator::DoubleGetter` is called when property is dynamic, up to three times. + + **An OCIO shader program could contain:** + + - A declaration part e.g., uniform sampled3D tex3; + - Some helper methods + - The OCIO shader function may be broken down as: + - The function header e.g., void OCIODisplay(in vec4 inColor) { + - The function body e.g., vec4 outColor.rgb = texture3D(tex3, inColor.rgb).rgb; + - The function footer e.g., return outColor; } + + **Usage Example:** + + Below is a code snippet to highlight the different parts of the OCIO shader program. + + .. code-block:: cpp + + // All global declarations + uniform sampled3D tex3; + + // All helper methods + vec3 computePosition(vec3 color) + { + vec3 coords = color; + // Some processing... + return coords; + } + + // The shader function + vec4 OCIODisplay(in vec4 inColor) // + { // Function Header + vec4 outColor = inColor; // + + outColor.rgb = texture3D(tex3, computePosition(inColor.rgb)).rgb; + + return outColor; // Function Footer + } // + + + .. py:attribute:: GpuShaderCreator.TEXTURE_1D + :module: PyOpenColorIO + :value: + + + .. py:attribute:: GpuShaderCreator.TEXTURE_2D + :module: PyOpenColorIO + :value: + + + .. py:class:: GpuShaderCreator.TextureDimensions + :module: PyOpenColorIO + :canonical: PyOpenColorIO.GpuShaderCreator.TextureDimensions + + Dimension enum used to differentiate between 1D and 2D object/resource types. + + Members: + + TEXTURE_1D + + TEXTURE_2D + + + .. py:attribute:: GpuShaderCreator.TextureDimensions.TEXTURE_1D + :module: PyOpenColorIO + :value: + + + .. py:attribute:: GpuShaderCreator.TextureDimensions.TEXTURE_2D + :module: PyOpenColorIO + :value: + + + .. py:property:: GpuShaderCreator.TextureDimensions.name + :module: PyOpenColorIO + + + .. py:property:: GpuShaderCreator.TextureDimensions.value + :module: PyOpenColorIO + + + .. py:method:: GpuShaderCreator.addToDeclareShaderCode(self: PyOpenColorIO.GpuShaderCreator, shaderCode: str) -> None + :module: PyOpenColorIO + + + .. py:method:: GpuShaderCreator.addToFunctionFooterShaderCode(self: PyOpenColorIO.GpuShaderCreator, shaderCode: str) -> None + :module: PyOpenColorIO + + + .. py:method:: GpuShaderCreator.addToFunctionHeaderShaderCode(self: PyOpenColorIO.GpuShaderCreator, shaderCode: str) -> None + :module: PyOpenColorIO + + + .. py:method:: GpuShaderCreator.addToFunctionShaderCode(self: PyOpenColorIO.GpuShaderCreator, shaderCode: str) -> None + :module: PyOpenColorIO + + + .. py:method:: GpuShaderCreator.addToHelperShaderCode(self: PyOpenColorIO.GpuShaderCreator, shaderCode: str) -> None + :module: PyOpenColorIO + + + .. py:method:: GpuShaderCreator.begin(self: PyOpenColorIO.GpuShaderCreator, uid: str) -> None + :module: PyOpenColorIO + + Start to collect the shader data. + + + .. py:method:: GpuShaderCreator.clone(self: PyOpenColorIO.GpuShaderCreator) -> PyOpenColorIO.GpuShaderCreator + :module: PyOpenColorIO + + + .. py:method:: GpuShaderCreator.createShaderText(self: PyOpenColorIO.GpuShaderCreator, shaderDeclarations: str, shaderHelperMethods: str, shaderFunctionHeader: str, shaderFunctionBody: str, shaderFunctionFooter: str) -> None + :module: PyOpenColorIO + + Create the OCIO shader program. + + .. note:: + The OCIO shader program is decomposed to allow a specific implementation to change some parts. Some product integrations add the color processing within a client shader program, imposing constraints requiring this flexibility. + + + .. py:method:: GpuShaderCreator.end(self: PyOpenColorIO.GpuShaderCreator) -> None + :module: PyOpenColorIO + + End to collect the shader data. + + + .. py:method:: GpuShaderCreator.finalize(self: PyOpenColorIO.GpuShaderCreator) -> None + :module: PyOpenColorIO + + + .. py:method:: GpuShaderCreator.getAllowTexture1D(self: PyOpenColorIO.GpuShaderCreator) -> bool + :module: PyOpenColorIO + + + .. py:method:: GpuShaderCreator.getCacheID(self: PyOpenColorIO.GpuShaderCreator) -> str + :module: PyOpenColorIO + + + .. py:method:: GpuShaderCreator.getDynamicProperties(self: PyOpenColorIO.GpuShaderCreator) -> PyOpenColorIO.GpuShaderCreator.DynamicPropertyIterator + :module: PyOpenColorIO + + + .. py:method:: GpuShaderCreator.getDynamicProperty(self: PyOpenColorIO.GpuShaderCreator, type: PyOpenColorIO.DynamicPropertyType) -> PyOpenColorIO.DynamicProperty + :module: PyOpenColorIO + + + .. py:method:: GpuShaderCreator.getFunctionName(self: PyOpenColorIO.GpuShaderCreator) -> str + :module: PyOpenColorIO + + + .. py:method:: GpuShaderCreator.getLanguage(self: PyOpenColorIO.GpuShaderCreator) -> PyOpenColorIO.GpuLanguage + :module: PyOpenColorIO + + + .. py:method:: GpuShaderCreator.getNextResourceIndex(self: PyOpenColorIO.GpuShaderCreator) -> int + :module: PyOpenColorIO + + To avoid global texture sampler and uniform name clashes always append an increasing index to the resource name. + + + .. py:method:: GpuShaderCreator.getPixelName(self: PyOpenColorIO.GpuShaderCreator) -> str + :module: PyOpenColorIO + + + .. py:method:: GpuShaderCreator.getResourcePrefix(self: PyOpenColorIO.GpuShaderCreator) -> str + :module: PyOpenColorIO + + .. note:: + Some applications require that textures, uniforms, and helper methods be uniquely named because several processor instances could coexist. + + + .. py:method:: GpuShaderCreator.getTextureMaxWidth(self: PyOpenColorIO.GpuShaderCreator) -> int + :module: PyOpenColorIO + + + .. py:method:: GpuShaderCreator.getUniqueID(self: PyOpenColorIO.GpuShaderCreator) -> str + :module: PyOpenColorIO + + + .. py:method:: GpuShaderCreator.hasDynamicProperty(self: PyOpenColorIO.GpuShaderCreator, type: PyOpenColorIO.DynamicPropertyType) -> bool + :module: PyOpenColorIO + + + .. py:method:: GpuShaderCreator.setAllowTexture1D(self: PyOpenColorIO.GpuShaderCreator, allowed: bool) -> None + :module: PyOpenColorIO + + Allow 1D GPU resource type, otherwise always using 2D resources for 1D LUTs. + + + .. py:method:: GpuShaderCreator.setFunctionName(self: PyOpenColorIO.GpuShaderCreator, name: str) -> None + :module: PyOpenColorIO + + + .. py:method:: GpuShaderCreator.setLanguage(self: PyOpenColorIO.GpuShaderCreator, language: PyOpenColorIO.GpuLanguage) -> None + :module: PyOpenColorIO + + Set the shader program language. + + + .. py:method:: GpuShaderCreator.setPixelName(self: PyOpenColorIO.GpuShaderCreator, name: str) -> None + :module: PyOpenColorIO + + Set the pixel name variable holding the color values. + + + .. py:method:: GpuShaderCreator.setResourcePrefix(self: PyOpenColorIO.GpuShaderCreator, prefix: str) -> None + :module: PyOpenColorIO + + Set a prefix to the resource name. + + + .. py:method:: GpuShaderCreator.setTextureMaxWidth(self: PyOpenColorIO.GpuShaderCreator, maxWidth: int) -> None + :module: PyOpenColorIO + + Some graphic cards could have 1D & 2D textures with size limitations. + + + .. py:method:: GpuShaderCreator.setUniqueID(self: PyOpenColorIO.GpuShaderCreator, uid: str) -> None + :module: PyOpenColorIO + + +.. py:class:: TextureType + :module: PyOpenColorIO.GpuShaderCreator + + Members: + + TEXTURE_RED_CHANNEL + + TEXTURE_RGB_CHANNEL + + .. py:method:: name() -> str + :property: + + .. py:attribute:: TextureType.TEXTURE_RED_CHANNEL + :module: PyOpenColorIO.GpuShaderCreator + :value: + + + .. py:attribute:: TextureType.TEXTURE_RGB_CHANNEL + :module: PyOpenColorIO.GpuShaderCreator + :value: + + + .. py:property:: TextureType.value + :module: PyOpenColorIO.GpuShaderCreator + + +.. py:class:: DynamicPropertyIterator + :module: PyOpenColorIO.GpuShaderCreator + + + .. py:method:: DynamicPropertyIterator.__getitem__(self: PyOpenColorIO.GpuShaderCreator.DynamicPropertyIterator, arg0: int) -> PyOpenColorIO.DynamicProperty + :module: PyOpenColorIO.GpuShaderCreator + + + .. py:method:: DynamicPropertyIterator.__iter__(self: PyOpenColorIO.GpuShaderCreator.DynamicPropertyIterator) -> PyOpenColorIO.GpuShaderCreator.DynamicPropertyIterator + :module: PyOpenColorIO.GpuShaderCreator + + + .. py:method:: DynamicPropertyIterator.__len__(self: PyOpenColorIO.GpuShaderCreator.DynamicPropertyIterator) -> int + :module: PyOpenColorIO.GpuShaderCreator + + + .. py:method:: DynamicPropertyIterator.__next__(self: PyOpenColorIO.GpuShaderCreator.DynamicPropertyIterator) -> PyOpenColorIO.DynamicProperty + :module: PyOpenColorIO.GpuShaderCreator + diff --git a/docs/api/python/frozen/pyopencolorio_gpushaderdesc.rst b/docs/api/python/frozen/pyopencolorio_gpushaderdesc.rst new file mode 100644 index 0000000000..6fb50e827b --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_gpushaderdesc.rst @@ -0,0 +1,568 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: GpuShaderDesc + :module: PyOpenColorIO + + This class holds the GPU-related information needed to build a shader program from a specific processor. + + This class defines the interface and there are two implementations provided. The "legacy" mode implements the OCIO v1 approach of baking certain ops in order to have at most one 3D-LUT. The "generic" mode is the v2 default and allows all the ops to be processed as-is, without baking, like the CPU renderer. Custom implementations could be written to accommodate the GPU needs of a specific client app. + + The complete fragment shader program is decomposed in two main parts: the OCIO shader program for the color processing and the client shader program which consumes the pixel color processing. + + The OCIO shader program is fully described by the :ref:`GpuShaderDesc` independently from the client shader program. The only critical point is the agreement on the OCIO function shader name. + + To summarize, the complete shader program is: + + .. code-block:: cpp + + // // + // The complete fragment shader program // + // // + // // + // ////////////////////////////////////////////////////////////// // + // // // // + // // The OCIO shader program // // + // // // // + // ////////////////////////////////////////////////////////////// // + // // // // + // // // All global declarations // // + // // uniform sampled3D tex3; // // + // // // // + // // // All helper methods // // + // // vec3 computePos(vec3 color) // // + // // { // // + // // vec3 coords = color; // // + // // ... // // + // // return coords; // // + // // } // // + // // // // + // // // The OCIO shader function // // + // // vec4 OCIODisplay(in vec4 inColor) // // + // // { // // + // // vec4 outColor = inColor; // // + // // ... // // + // // outColor.rbg // // + // // = texture3D(tex3, computePos(inColor.rgb)).rgb; // // + // // ... // // + // // return outColor; // // + // // } // // + // // // // + // ////////////////////////////////////////////////////////////// // + // // + // ////////////////////////////////////////////////////////////// // + // // // // + // // The client shader program // // + // // // // + // ////////////////////////////////////////////////////////////// // + // // // // + // // uniform sampler2D image; // // + // // // // + // // void main() // // + // // { // // + // // vec4 inColor = texture2D(image, gl_TexCoord[0].st); // // + // // ... // // + // // vec4 outColor = OCIODisplay(inColor); // // + // // ... // // + // // gl_FragColor = outColor; // // + // // } // // + // // // // + // ////////////////////////////////////////////////////////////// // + // // + //////////////////////////////////////////////////////////////////////// + + **Usage Example:** *Building a GPU shader* + + This example is based on the code in: src/apps/ociodisplay/main.cpp + + .. code-block:: cpp + + // Get the processor + // + OCIO::ConstConfigRcPtr config = OCIO::Config::CreateFromEnv(); + OCIO::ConstProcessorRcPtr processor + = config->getProcessor("ACES - ACEScg", "Output - sRGB"); + + // Step 1: Create a GPU shader description + // + // The two potential scenarios are: + // + // 1. Instantiate the generic shader description. The color processor + // is used as-is (i.e. without any baking step) and could contain + // any number of 1D & 3D luts. + // + // This is the default OCIO v2 behavior and allows a much better + // match between the CPU and GPU renderers. + // + OCIO::GpuShaderDescRcPtr shaderDesc = OCIO::GpuShaderDesc::Create(); + // + // 2. Instantiate a custom shader description. + // + // Writing a custom shader description is a way to tailor the shaders + // to the needs of a given client program. This involves writing a + // new class inheriting from the pure virtual class GpuShaderDesc. + // + // Please refer to the GenericGpuShaderDesc class for an example. + // + OCIO::GpuShaderDescRcPtr shaderDesc = MyCustomGpuShader::Create(); + + shaderDesc->setLanguage(OCIO::GPU_LANGUAGE_GLSL_1_2); + shaderDesc->setFunctionName("OCIODisplay"); + + // Step 2: Collect the shader program information for a specific processor + // + processor->extractGpuShaderInfo(shaderDesc); + + // Step 3: Create a helper to build the shader. Here we use a helper for + // OpenGL but there will also be helpers for other languages. + // + OpenGLBuilderRcPtr oglBuilder = OpenGLBuilder::Create(shaderDesc); + + // Step 4: Allocate & upload all the LUTs + // + oglBuilder->allocateAllTextures(); + + // Step 5: Build the complete fragment shader program using + // g_fragShaderText which is the client shader program. + // + g_programId = oglBuilder->buildProgram(g_fragShaderText); + + // Step 6: Enable the fragment shader program, and all needed textures + // + glUseProgram(g_programId); + glUniform1i(glGetUniformLocation(g_programId, "tex1"), 1); // image texture + oglBuilder->useAllTextures(g_programId); // LUT textures + + // Step 7: Update uniforms from dynamic property instances. + m_oglBuilder->useAllUniforms(); + + + .. py:method:: GpuShaderDesc.CreateShaderDesc(language: PyOpenColorIO.GpuLanguage = , functionName: str = 'OCIOMain', pixelName: str = 'outColor', resourcePrefix: str = 'ocio', uid: str = '') -> PyOpenColorIO.GpuShaderDesc + :module: PyOpenColorIO + :staticmethod: + + Create the default shader description. + + + .. py:attribute:: GpuShaderDesc.TEXTURE_1D + :module: PyOpenColorIO + :value: + + + .. py:attribute:: GpuShaderDesc.TEXTURE_2D + :module: PyOpenColorIO + :value: + + + .. py:class:: GpuShaderDesc.TextureDimensions + :module: PyOpenColorIO + :canonical: PyOpenColorIO.GpuShaderCreator.TextureDimensions + + Dimension enum used to differentiate between 1D and 2D object/resource types. + + Members: + + TEXTURE_1D + + TEXTURE_2D + + + .. py:attribute:: GpuShaderDesc.TextureDimensions.TEXTURE_1D + :module: PyOpenColorIO + :value: + + + .. py:attribute:: GpuShaderDesc.TextureDimensions.TEXTURE_2D + :module: PyOpenColorIO + :value: + + + .. py:method:: GpuShaderDesc.TextureDimensions.__init__(self: PyOpenColorIO.GpuShaderCreator.TextureDimensions, value: int) -> None + :module: PyOpenColorIO + + + .. py:property:: GpuShaderDesc.TextureDimensions.name + :module: PyOpenColorIO + + + .. py:property:: GpuShaderDesc.TextureDimensions.value + :module: PyOpenColorIO + + + .. py:method:: GpuShaderDesc.__init__(*args, **kwargs) + :module: PyOpenColorIO + + + .. py:method:: GpuShaderDesc.add3DTexture(self: PyOpenColorIO.GpuShaderDesc, textureName: str, samplerName: str, edgeLen: int, interpolation: PyOpenColorIO.Interpolation, values: buffer) -> None + :module: PyOpenColorIO + + Add a 3D texture with RGB channel type. + + .. note:: + The 'values' parameter contains the 3D LUT data which must be used as-is as the dimension and origin are hard-coded in the fragment shader program. So, it means one GPU 3D texture per entry. + + + .. py:method:: GpuShaderDesc.addTexture(self: PyOpenColorIO.GpuShaderDesc, textureName: str, samplerName: str, width: int, height: int, channel: PyOpenColorIO.GpuShaderCreator.TextureType, dimensions: PyOpenColorIO.GpuShaderCreator.TextureDimensions, interpolation: PyOpenColorIO.Interpolation, values: buffer) -> None + :module: PyOpenColorIO + + Add a 1D or 2D texture + + .. note:: + The 'values' parameter contains the LUT data which must be used as-is as the dimensions and origin are hard-coded in the fragment shader program. So, it means one GPU texture per entry. + + + .. py:method:: GpuShaderDesc.addToDeclareShaderCode(self: PyOpenColorIO.GpuShaderCreator, shaderCode: str) -> None + :module: PyOpenColorIO + + + .. py:method:: GpuShaderDesc.addToFunctionFooterShaderCode(self: PyOpenColorIO.GpuShaderCreator, shaderCode: str) -> None + :module: PyOpenColorIO + + + .. py:method:: GpuShaderDesc.addToFunctionHeaderShaderCode(self: PyOpenColorIO.GpuShaderCreator, shaderCode: str) -> None + :module: PyOpenColorIO + + + .. py:method:: GpuShaderDesc.addToFunctionShaderCode(self: PyOpenColorIO.GpuShaderCreator, shaderCode: str) -> None + :module: PyOpenColorIO + + + .. py:method:: GpuShaderDesc.addToHelperShaderCode(self: PyOpenColorIO.GpuShaderCreator, shaderCode: str) -> None + :module: PyOpenColorIO + + + .. py:method:: GpuShaderDesc.begin(self: PyOpenColorIO.GpuShaderCreator, uid: str) -> None + :module: PyOpenColorIO + + Start to collect the shader data. + + + .. py:method:: GpuShaderDesc.clone(self: PyOpenColorIO.GpuShaderDesc) -> PyOpenColorIO.GpuShaderCreator + :module: PyOpenColorIO + + + .. py:method:: GpuShaderDesc.createShaderText(self: PyOpenColorIO.GpuShaderCreator, shaderDeclarations: str, shaderHelperMethods: str, shaderFunctionHeader: str, shaderFunctionBody: str, shaderFunctionFooter: str) -> None + :module: PyOpenColorIO + + Create the OCIO shader program. + + .. note:: + The OCIO shader program is decomposed to allow a specific implementation to change some parts. Some product integrations add the color processing within a client shader program, imposing constraints requiring this flexibility. + + + .. py:method:: GpuShaderDesc.end(self: PyOpenColorIO.GpuShaderCreator) -> None + :module: PyOpenColorIO + + End to collect the shader data. + + + .. py:method:: GpuShaderDesc.finalize(self: PyOpenColorIO.GpuShaderCreator) -> None + :module: PyOpenColorIO + + + .. py:method:: GpuShaderDesc.get3DTextures(self: PyOpenColorIO.GpuShaderDesc) -> PyOpenColorIO.GpuShaderDesc.Texture3DIterator + :module: PyOpenColorIO + + + .. py:method:: GpuShaderDesc.getAllowTexture1D(self: PyOpenColorIO.GpuShaderCreator) -> bool + :module: PyOpenColorIO + + + .. py:method:: GpuShaderDesc.getCacheID(self: PyOpenColorIO.GpuShaderCreator) -> str + :module: PyOpenColorIO + + + .. py:method:: GpuShaderDesc.getDynamicProperties(self: PyOpenColorIO.GpuShaderCreator) -> PyOpenColorIO.GpuShaderCreator.DynamicPropertyIterator + :module: PyOpenColorIO + + + .. py:method:: GpuShaderDesc.getDynamicProperty(self: PyOpenColorIO.GpuShaderCreator, type: PyOpenColorIO.DynamicPropertyType) -> PyOpenColorIO.DynamicProperty + :module: PyOpenColorIO + + + .. py:method:: GpuShaderDesc.getFunctionName(self: PyOpenColorIO.GpuShaderCreator) -> str + :module: PyOpenColorIO + + + .. py:method:: GpuShaderDesc.getLanguage(self: PyOpenColorIO.GpuShaderCreator) -> PyOpenColorIO.GpuLanguage + :module: PyOpenColorIO + + + .. py:method:: GpuShaderDesc.getNextResourceIndex(self: PyOpenColorIO.GpuShaderCreator) -> int + :module: PyOpenColorIO + + To avoid global texture sampler and uniform name clashes always append an increasing index to the resource name. + + + .. py:method:: GpuShaderDesc.getPixelName(self: PyOpenColorIO.GpuShaderCreator) -> str + :module: PyOpenColorIO + + + .. py:method:: GpuShaderDesc.getResourcePrefix(self: PyOpenColorIO.GpuShaderCreator) -> str + :module: PyOpenColorIO + + .. note:: + Some applications require that textures, uniforms, and helper methods be uniquely named because several processor instances could coexist. + + + .. py:method:: GpuShaderDesc.getShaderText(self: PyOpenColorIO.GpuShaderDesc) -> str + :module: PyOpenColorIO + + Get the complete OCIO shader program. + + + .. py:method:: GpuShaderDesc.getTextureMaxWidth(self: PyOpenColorIO.GpuShaderCreator) -> int + :module: PyOpenColorIO + + + .. py:method:: GpuShaderDesc.getTextures(self: PyOpenColorIO.GpuShaderDesc) -> PyOpenColorIO.GpuShaderDesc.TextureIterator + :module: PyOpenColorIO + + + .. py:method:: GpuShaderDesc.getUniforms(self: PyOpenColorIO.GpuShaderDesc) -> PyOpenColorIO.GpuShaderDesc.UniformIterator + :module: PyOpenColorIO + + + .. py:method:: GpuShaderDesc.getUniqueID(self: PyOpenColorIO.GpuShaderCreator) -> str + :module: PyOpenColorIO + + + .. py:method:: GpuShaderDesc.hasDynamicProperty(self: PyOpenColorIO.GpuShaderCreator, type: PyOpenColorIO.DynamicPropertyType) -> bool + :module: PyOpenColorIO + + + .. py:method:: GpuShaderDesc.setAllowTexture1D(self: PyOpenColorIO.GpuShaderCreator, allowed: bool) -> None + :module: PyOpenColorIO + + Allow 1D GPU resource type, otherwise always using 2D resources for 1D LUTs. + + + .. py:method:: GpuShaderDesc.setFunctionName(self: PyOpenColorIO.GpuShaderCreator, name: str) -> None + :module: PyOpenColorIO + + + .. py:method:: GpuShaderDesc.setLanguage(self: PyOpenColorIO.GpuShaderCreator, language: PyOpenColorIO.GpuLanguage) -> None + :module: PyOpenColorIO + + Set the shader program language. + + + .. py:method:: GpuShaderDesc.setPixelName(self: PyOpenColorIO.GpuShaderCreator, name: str) -> None + :module: PyOpenColorIO + + Set the pixel name variable holding the color values. + + + .. py:method:: GpuShaderDesc.setResourcePrefix(self: PyOpenColorIO.GpuShaderCreator, prefix: str) -> None + :module: PyOpenColorIO + + Set a prefix to the resource name. + + + .. py:method:: GpuShaderDesc.setTextureMaxWidth(self: PyOpenColorIO.GpuShaderCreator, maxWidth: int) -> None + :module: PyOpenColorIO + + Some graphic cards could have 1D & 2D textures with size limitations. + + + .. py:method:: GpuShaderDesc.setUniqueID(self: PyOpenColorIO.GpuShaderCreator, uid: str) -> None + :module: PyOpenColorIO + + +.. py:class:: TextureType + :module: PyOpenColorIO.GpuShaderDesc + :canonical: PyOpenColorIO.GpuShaderCreator.TextureType + + Members: + + TEXTURE_RED_CHANNEL + + TEXTURE_RGB_CHANNEL + + .. py:method:: name() -> str + :property: + + .. py:attribute:: TextureType.TEXTURE_RED_CHANNEL + :module: PyOpenColorIO.GpuShaderDesc + :value: + + + .. py:attribute:: TextureType.TEXTURE_RGB_CHANNEL + :module: PyOpenColorIO.GpuShaderDesc + :value: + + + .. py:property:: TextureType.value + :module: PyOpenColorIO.GpuShaderDesc + + +.. py:class:: UniformData + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:method:: UniformData.getBool(self: PyOpenColorIO.GpuShaderDesc.UniformData) -> bool + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:method:: UniformData.getDouble(self: PyOpenColorIO.GpuShaderDesc.UniformData) -> float + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:method:: UniformData.getFloat3(self: PyOpenColorIO.GpuShaderDesc.UniformData) -> List[float[3]] + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:method:: UniformData.getVectorFloat(self: PyOpenColorIO.GpuShaderDesc.UniformData) -> numpy.ndarray + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:method:: UniformData.getVectorInt(self: PyOpenColorIO.GpuShaderDesc.UniformData) -> numpy.ndarray + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:property:: UniformData.type + :module: PyOpenColorIO.GpuShaderDesc + + +.. py:class:: Texture + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:property:: Texture.channel + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:property:: Texture.dimensions + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:method:: Texture.getValues(self: PyOpenColorIO.GpuShaderDesc.Texture) -> numpy.ndarray + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:property:: Texture.height + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:property:: Texture.interpolation + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:property:: Texture.samplerName + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:property:: Texture.textureName + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:property:: Texture.width + :module: PyOpenColorIO.GpuShaderDesc + + +.. py:class:: Texture3D + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:property:: Texture3D.edgeLen + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:method:: Texture3D.getValues(self: PyOpenColorIO.GpuShaderDesc.Texture3D) -> numpy.ndarray + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:property:: Texture3D.interpolation + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:property:: Texture3D.samplerName + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:property:: Texture3D.textureName + :module: PyOpenColorIO.GpuShaderDesc + + +.. py:class:: UniformIterator + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:method:: UniformIterator.__getitem__(self: PyOpenColorIO.GpuShaderDesc.UniformIterator, arg0: int) -> tuple + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:method:: UniformIterator.__iter__(self: PyOpenColorIO.GpuShaderDesc.UniformIterator) -> PyOpenColorIO.GpuShaderDesc.UniformIterator + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:method:: UniformIterator.__len__(self: PyOpenColorIO.GpuShaderDesc.UniformIterator) -> int + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:method:: UniformIterator.__next__(self: PyOpenColorIO.GpuShaderDesc.UniformIterator) -> tuple + :module: PyOpenColorIO.GpuShaderDesc + + +.. py:class:: TextureIterator + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:method:: TextureIterator.__getitem__(self: PyOpenColorIO.GpuShaderDesc.TextureIterator, arg0: int) -> PyOpenColorIO.GpuShaderDesc.Texture + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:method:: TextureIterator.__iter__(self: PyOpenColorIO.GpuShaderDesc.TextureIterator) -> PyOpenColorIO.GpuShaderDesc.TextureIterator + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:method:: TextureIterator.__len__(self: PyOpenColorIO.GpuShaderDesc.TextureIterator) -> int + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:method:: TextureIterator.__next__(self: PyOpenColorIO.GpuShaderDesc.TextureIterator) -> PyOpenColorIO.GpuShaderDesc.Texture + :module: PyOpenColorIO.GpuShaderDesc + + +.. py:class:: Texture3DIterator + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:method:: Texture3DIterator.__getitem__(self: PyOpenColorIO.GpuShaderDesc.Texture3DIterator, arg0: int) -> PyOpenColorIO.GpuShaderDesc.Texture3D + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:method:: Texture3DIterator.__iter__(self: PyOpenColorIO.GpuShaderDesc.Texture3DIterator) -> PyOpenColorIO.GpuShaderDesc.Texture3DIterator + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:method:: Texture3DIterator.__len__(self: PyOpenColorIO.GpuShaderDesc.Texture3DIterator) -> int + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:method:: Texture3DIterator.__next__(self: PyOpenColorIO.GpuShaderDesc.Texture3DIterator) -> PyOpenColorIO.GpuShaderDesc.Texture3D + :module: PyOpenColorIO.GpuShaderDesc + + +.. py:class:: DynamicPropertyIterator + :module: PyOpenColorIO.GpuShaderDesc + :canonical: PyOpenColorIO.GpuShaderCreator.DynamicPropertyIterator + + + .. py:method:: DynamicPropertyIterator.__getitem__(self: PyOpenColorIO.GpuShaderCreator.DynamicPropertyIterator, arg0: int) -> PyOpenColorIO.DynamicProperty + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:method:: DynamicPropertyIterator.__iter__(self: PyOpenColorIO.GpuShaderCreator.DynamicPropertyIterator) -> PyOpenColorIO.GpuShaderCreator.DynamicPropertyIterator + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:method:: DynamicPropertyIterator.__len__(self: PyOpenColorIO.GpuShaderCreator.DynamicPropertyIterator) -> int + :module: PyOpenColorIO.GpuShaderDesc + + + .. py:method:: DynamicPropertyIterator.__next__(self: PyOpenColorIO.GpuShaderCreator.DynamicPropertyIterator) -> PyOpenColorIO.DynamicProperty + :module: PyOpenColorIO.GpuShaderDesc + diff --git a/docs/api/python/frozen/pyopencolorio_gradingbsplinecurve.rst b/docs/api/python/frozen/pyopencolorio_gradingbsplinecurve.rst new file mode 100644 index 0000000000..56f0fc0dc8 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_gradingbsplinecurve.rst @@ -0,0 +1,60 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: GradingBSplineCurve + :module: PyOpenColorIO + + A BSpline curve defined with :ref:`GradingControlPoint`. + + + .. py:method:: GradingBSplineCurve.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.GradingBSplineCurve, size: int) -> None + + Create a BSpline curve with a specified number of control points. + + 2. __init__(self: PyOpenColorIO.GradingBSplineCurve, arg0: List[float]) -> None + + Create a BSpline curve with a list of control points. + + + .. py:method:: GradingBSplineCurve.getControlPoints(self: PyOpenColorIO.GradingBSplineCurve) -> PyOpenColorIO.GradingBSplineCurve.GradingControlPointIterator + :module: PyOpenColorIO + + + .. py:method:: GradingBSplineCurve.setNumControlPoints(self: PyOpenColorIO.GradingBSplineCurve, size: int) -> None + :module: PyOpenColorIO + + + .. py:method:: GradingBSplineCurve.validate(self: PyOpenColorIO.GradingBSplineCurve) -> None + :module: PyOpenColorIO + + +.. py:class:: GradingControlPointIterator + :module: PyOpenColorIO.GradingBSplineCurve + + + .. py:method:: GradingControlPointIterator.__getitem__(self: PyOpenColorIO.GradingBSplineCurve.GradingControlPointIterator, arg0: int) -> PyOpenColorIO.GradingControlPoint + :module: PyOpenColorIO.GradingBSplineCurve + + + .. py:method:: GradingControlPointIterator.__iter__(self: PyOpenColorIO.GradingBSplineCurve.GradingControlPointIterator) -> PyOpenColorIO.GradingBSplineCurve.GradingControlPointIterator + :module: PyOpenColorIO.GradingBSplineCurve + + + .. py:method:: GradingControlPointIterator.__len__(self: PyOpenColorIO.GradingBSplineCurve.GradingControlPointIterator) -> int + :module: PyOpenColorIO.GradingBSplineCurve + + + .. py:method:: GradingControlPointIterator.__next__(self: PyOpenColorIO.GradingBSplineCurve.GradingControlPointIterator) -> PyOpenColorIO.GradingControlPoint + :module: PyOpenColorIO.GradingBSplineCurve + + + .. py:method:: GradingControlPointIterator.__setitem__(self: PyOpenColorIO.GradingBSplineCurve.GradingControlPointIterator, arg0: int, arg1: PyOpenColorIO.GradingControlPoint) -> None + :module: PyOpenColorIO.GradingBSplineCurve + diff --git a/docs/api/python/frozen/pyopencolorio_gradingcontrolpoint.rst b/docs/api/python/frozen/pyopencolorio_gradingcontrolpoint.rst new file mode 100644 index 0000000000..5ecb2be29c --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_gradingcontrolpoint.rst @@ -0,0 +1,28 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: GradingControlPoint + :module: PyOpenColorIO + + 2D control point used by :ref:`GradingBSplineCurve`. + + + .. py:method:: GradingControlPoint.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.GradingControlPoint) -> None + + 2. __init__(self: PyOpenColorIO.GradingControlPoint, x: float = 0.0, y: float = 0.0) -> None + + + .. py:property:: GradingControlPoint.x + :module: PyOpenColorIO + + + .. py:property:: GradingControlPoint.y + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_gradingprimary.rst b/docs/api/python/frozen/pyopencolorio_gradingprimary.rst new file mode 100644 index 0000000000..0c2dc72c7a --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_gradingprimary.rst @@ -0,0 +1,82 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: GradingPrimary + :module: PyOpenColorIO + + Grading primary values. + + + .. py:attribute:: GradingPrimary.NoClampBlack + :module: PyOpenColorIO + :value: -1.7976931348623157e+308 + + + .. py:attribute:: GradingPrimary.NoClampWhite + :module: PyOpenColorIO + :value: 1.7976931348623157e+308 + + + .. py:method:: GradingPrimary.__init__(self: PyOpenColorIO.GradingPrimary, arg0: PyOpenColorIO.GradingStyle) -> None + :module: PyOpenColorIO + + + .. py:property:: GradingPrimary.brightness + :module: PyOpenColorIO + + + .. py:property:: GradingPrimary.clampBlack + :module: PyOpenColorIO + + + .. py:property:: GradingPrimary.clampWhite + :module: PyOpenColorIO + + + .. py:property:: GradingPrimary.contrast + :module: PyOpenColorIO + + + .. py:property:: GradingPrimary.exposure + :module: PyOpenColorIO + + + .. py:property:: GradingPrimary.gain + :module: PyOpenColorIO + + + .. py:property:: GradingPrimary.gamma + :module: PyOpenColorIO + + + .. py:property:: GradingPrimary.lift + :module: PyOpenColorIO + + + .. py:property:: GradingPrimary.offset + :module: PyOpenColorIO + + + .. py:property:: GradingPrimary.pivot + :module: PyOpenColorIO + + + .. py:property:: GradingPrimary.pivotBlack + :module: PyOpenColorIO + + + .. py:property:: GradingPrimary.pivotWhite + :module: PyOpenColorIO + + + .. py:property:: GradingPrimary.saturation + :module: PyOpenColorIO + + + .. py:method:: GradingPrimary.validate(self: PyOpenColorIO.GradingPrimary, arg0: PyOpenColorIO.GradingStyle) -> None + :module: PyOpenColorIO + + The valid range for each parameter varies. + diff --git a/docs/api/python/frozen/pyopencolorio_gradingprimarytransform.rst b/docs/api/python/frozen/pyopencolorio_gradingprimarytransform.rst new file mode 100644 index 0000000000..49a0aa58c6 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_gradingprimarytransform.rst @@ -0,0 +1,93 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: GradingPrimaryTransform + :module: PyOpenColorIO + + Primary color correction controls. + + This transform is for making basic color correction adjustments to an image such as brightness, contrast, or saturation. + + The controls are customized for linear, logarithmic, and video color encodings. + - Linear controls: Exposure, Contrast, Pivot, Offset, Saturation, Black Clip, White Clip. + - Log controls: Brightness, Contrast, Pivot, Log Gamma, Saturation, Black Clip, White Clip, Black Pivot White Pivot. + - Video controls : Lift, Gamma, Gain, Offset, Saturation, Black Clip, White Clip, Black Pivot White Pivot. + + The controls are dynamic, so they may be adjusted even after the :ref:`Transform` has been included in a :ref:`Processor`. + + + .. py:method:: GradingPrimaryTransform.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.GradingPrimaryTransform, values: PyOpenColorIO.GradingPrimary, style: PyOpenColorIO.GradingStyle = , dynamic: bool = False, dir: PyOpenColorIO.TransformDirection = ) -> None + + Creates an instance of :ref:`GradingPrimaryTransform`. + + 2. __init__(self: PyOpenColorIO.GradingPrimaryTransform, style: PyOpenColorIO.GradingStyle = , dynamic: bool = False, dir: PyOpenColorIO.TransformDirection = ) -> None + + Creates an instance of :ref:`GradingPrimaryTransform`. + + + .. py:method:: GradingPrimaryTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection + :module: PyOpenColorIO + + + .. py:method:: GradingPrimaryTransform.getFormatMetadata(self: PyOpenColorIO.GradingPrimaryTransform) -> PyOpenColorIO.FormatMetadata + :module: PyOpenColorIO + + + .. py:method:: GradingPrimaryTransform.getStyle(self: PyOpenColorIO.GradingPrimaryTransform) -> PyOpenColorIO.GradingStyle + :module: PyOpenColorIO + + Adjusts the behavior of the transform for log, linear, or video color space encodings. + + + .. py:method:: GradingPrimaryTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType + :module: PyOpenColorIO + + + .. py:method:: GradingPrimaryTransform.getValue(self: PyOpenColorIO.GradingPrimaryTransform) -> PyOpenColorIO.GradingPrimary + :module: PyOpenColorIO + + + .. py:method:: GradingPrimaryTransform.isDynamic(self: PyOpenColorIO.GradingPrimaryTransform) -> bool + :module: PyOpenColorIO + + Parameters can be made dynamic so the values can be changed through the CPU or GPU processor, but if there are several :ref:`GradingPrimaryTransform` only one can have dynamic parameters. + + + .. py:method:: GradingPrimaryTransform.makeDynamic(self: PyOpenColorIO.GradingPrimaryTransform) -> None + :module: PyOpenColorIO + + + .. py:method:: GradingPrimaryTransform.makeNonDynamic(self: PyOpenColorIO.GradingPrimaryTransform) -> None + :module: PyOpenColorIO + + + .. py:method:: GradingPrimaryTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None + :module: PyOpenColorIO + + Note that this only affects the evaluation and not the values stored in the object. + + + .. py:method:: GradingPrimaryTransform.setStyle(self: PyOpenColorIO.GradingPrimaryTransform, style: PyOpenColorIO.GradingStyle) -> None + :module: PyOpenColorIO + + Will reset value to style's defaults if style is not the current style. + + + .. py:method:: GradingPrimaryTransform.setValue(self: PyOpenColorIO.GradingPrimaryTransform, values: PyOpenColorIO.GradingPrimary) -> None + :module: PyOpenColorIO + + Throws if value is not valid. + + + .. py:method:: GradingPrimaryTransform.validate(self: PyOpenColorIO.Transform) -> None + :module: PyOpenColorIO + + Will throw if data is not valid. + diff --git a/docs/api/python/frozen/pyopencolorio_gradingrgbcurve.rst b/docs/api/python/frozen/pyopencolorio_gradingrgbcurve.rst new file mode 100644 index 0000000000..f6c4dd78d2 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_gradingrgbcurve.rst @@ -0,0 +1,38 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: GradingRGBCurve + :module: PyOpenColorIO + + A set of red, green, blue and master curves. It is used by RGBCurveTransform and can be used as a dynamic property (see :ref:`DynamicPropertyGradingRGBCurve`). + + + .. py:method:: GradingRGBCurve.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.GradingRGBCurve, style: PyOpenColorIO.GradingStyle) -> None + + Do not use (needed only for pybind11). + + 2. __init__(self: PyOpenColorIO.GradingRGBCurve, red: PyOpenColorIO.GradingBSplineCurve = ]>, green: PyOpenColorIO.GradingBSplineCurve = ]>, blue: PyOpenColorIO.GradingBSplineCurve = ]>, master: PyOpenColorIO.GradingBSplineCurve = ]>) -> None + + + .. py:property:: GradingRGBCurve.blue + :module: PyOpenColorIO + + + .. py:property:: GradingRGBCurve.green + :module: PyOpenColorIO + + + .. py:property:: GradingRGBCurve.master + :module: PyOpenColorIO + + + .. py:property:: GradingRGBCurve.red + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_gradingrgbcurvetransform.rst b/docs/api/python/frozen/pyopencolorio_gradingrgbcurvetransform.rst new file mode 100644 index 0000000000..73b45f2ed8 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_gradingrgbcurvetransform.rst @@ -0,0 +1,114 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: GradingRGBCurveTransform + :module: PyOpenColorIO + + RGB curve color correction controls. + + This transform allows for modifying tone reproduction via B-spline curves. + + There is an R, G, and B curve along with a Master curve (that applies to R, G, and B). Each curve is specified via the x and y coordinates of its control points. A monotonic spline is fit to the control points. The x coordinates must be non-decreasing. When the grading style is linear, the units for the control points are photographic stops relative to 0.18. + + The control points are dynamic, so they may be adjusted even after the :ref:`Transform` is included in a :ref:`Processor`. + + + .. py:method:: GradingRGBCurveTransform.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.GradingRGBCurveTransform, values: PyOpenColorIO.GradingRGBCurve, style: PyOpenColorIO.GradingStyle = , dynamic: bool = False, dir: PyOpenColorIO.TransformDirection = ) -> None + + Creates an instance of :ref:`GradingPrimaryTransform`. + + 2. __init__(self: PyOpenColorIO.GradingRGBCurveTransform, style: PyOpenColorIO.GradingStyle = , dynamic: bool = False, dir: PyOpenColorIO.TransformDirection = ) -> None + + Creates an instance of :ref:`GradingPrimaryTransform`. + + + .. py:method:: GradingRGBCurveTransform.getBypassLinToLog(self: PyOpenColorIO.GradingRGBCurveTransform) -> bool + :module: PyOpenColorIO + + The scene-linear grading style applies a lin-to-log transform to the pixel values before going through the curve. However, in some cases (e.g. drawing curves in a UI) it may be useful to bypass the lin-to-log. Default value is false. + + + .. py:method:: GradingRGBCurveTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection + :module: PyOpenColorIO + + + .. py:method:: GradingRGBCurveTransform.getFormatMetadata(self: PyOpenColorIO.GradingRGBCurveTransform) -> PyOpenColorIO.FormatMetadata + :module: PyOpenColorIO + + + .. py:method:: GradingRGBCurveTransform.getSlope(self: PyOpenColorIO.GradingRGBCurveTransform, channel: PyOpenColorIO.RGBCurveType, index: int) -> float + :module: PyOpenColorIO + + It is possible to provide a desired slope value for each control point. The number of slopes is always the same as the number of control points and so the control points must be set before setting the slopes. The slopes are primarily intended for use by config authors looking to match a specific shape with as few control points as possible, they are not intended to be exposed to a user interface for direct manipulation. When a curve is being generated for creative purposes it is better to let OCIO calculate the slopes automatically. + + + .. py:method:: GradingRGBCurveTransform.getStyle(self: PyOpenColorIO.GradingRGBCurveTransform) -> PyOpenColorIO.GradingStyle + :module: PyOpenColorIO + + Adjusts the behavior of the transform for log, linear, or video color space encodings. + + + .. py:method:: GradingRGBCurveTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType + :module: PyOpenColorIO + + + .. py:method:: GradingRGBCurveTransform.getValue(self: PyOpenColorIO.GradingRGBCurveTransform) -> PyOpenColorIO.GradingRGBCurve + :module: PyOpenColorIO + + + .. py:method:: GradingRGBCurveTransform.isDynamic(self: PyOpenColorIO.GradingRGBCurveTransform) -> bool + :module: PyOpenColorIO + + Parameters can be made dynamic so the values can be changed through the CPU or GPU processor, but if there are several :ref:`GradingRGBCurveTransform` only one can have dynamic parameters. + + + .. py:method:: GradingRGBCurveTransform.makeDynamic(self: PyOpenColorIO.GradingRGBCurveTransform) -> None + :module: PyOpenColorIO + + + .. py:method:: GradingRGBCurveTransform.makeNonDynamic(self: PyOpenColorIO.GradingRGBCurveTransform) -> None + :module: PyOpenColorIO + + + .. py:method:: GradingRGBCurveTransform.setBypassLinToLog(self: PyOpenColorIO.GradingRGBCurveTransform, bypass: bool) -> None + :module: PyOpenColorIO + + + .. py:method:: GradingRGBCurveTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None + :module: PyOpenColorIO + + Note that this only affects the evaluation and not the values stored in the object. + + + .. py:method:: GradingRGBCurveTransform.setSlope(self: PyOpenColorIO.GradingRGBCurveTransform, channel: PyOpenColorIO.RGBCurveType, index: int, slope: float) -> None + :module: PyOpenColorIO + + + .. py:method:: GradingRGBCurveTransform.setStyle(self: PyOpenColorIO.GradingRGBCurveTransform, style: PyOpenColorIO.GradingStyle) -> None + :module: PyOpenColorIO + + Will reset value to style's defaults if style is not the current style. + + + .. py:method:: GradingRGBCurveTransform.setValue(self: PyOpenColorIO.GradingRGBCurveTransform, values: PyOpenColorIO.GradingRGBCurve) -> None + :module: PyOpenColorIO + + Throws if value is not valid. + + + .. py:method:: GradingRGBCurveTransform.slopesAreDefault(self: PyOpenColorIO.GradingRGBCurveTransform, channel: PyOpenColorIO.RGBCurveType) -> bool + :module: PyOpenColorIO + + + .. py:method:: GradingRGBCurveTransform.validate(self: PyOpenColorIO.Transform) -> None + :module: PyOpenColorIO + + Will throw if data is not valid. + diff --git a/docs/api/python/frozen/pyopencolorio_gradingrgbm.rst b/docs/api/python/frozen/pyopencolorio_gradingrgbm.rst new file mode 100644 index 0000000000..c55e1da241 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_gradingrgbm.rst @@ -0,0 +1,36 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: GradingRGBM + :module: PyOpenColorIO + + Used by the grading transforms to hold the red, green, blue, and master components of a single parameter. The master component affects all three channels (RGB). + + + .. py:method:: GradingRGBM.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.GradingRGBM) -> None + + 2. __init__(self: PyOpenColorIO.GradingRGBM, red: float, green: float, blue: float, master: float) -> None + + + .. py:property:: GradingRGBM.blue + :module: PyOpenColorIO + + + .. py:property:: GradingRGBM.green + :module: PyOpenColorIO + + + .. py:property:: GradingRGBM.master + :module: PyOpenColorIO + + + .. py:property:: GradingRGBM.red + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_gradingrgbmsw.rst b/docs/api/python/frozen/pyopencolorio_gradingrgbmsw.rst new file mode 100644 index 0000000000..dfc24f90f4 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_gradingrgbmsw.rst @@ -0,0 +1,46 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: GradingRGBMSW + :module: PyOpenColorIO + + Used by the grading tone transforms to hold the red, green, blue, master, start, and width components of a single parameter. The master component affects all three channels (RGB). The start and width components control the range of tones affected. Although this struct simply uses "start" and "width" for all the range values, the actual user-facing name changes based on the parameter. + + + .. py:method:: GradingRGBMSW.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.GradingRGBMSW) -> None + + 2. __init__(self: PyOpenColorIO.GradingRGBMSW, red: float, green: float, blue: float, master: float, start: float, width: float) -> None + + 3. __init__(self: PyOpenColorIO.GradingRGBMSW, start: float, width: float) -> None + + + .. py:property:: GradingRGBMSW.blue + :module: PyOpenColorIO + + + .. py:property:: GradingRGBMSW.green + :module: PyOpenColorIO + + + .. py:property:: GradingRGBMSW.master + :module: PyOpenColorIO + + + .. py:property:: GradingRGBMSW.red + :module: PyOpenColorIO + + + .. py:property:: GradingRGBMSW.start + :module: PyOpenColorIO + + + .. py:property:: GradingRGBMSW.width + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_gradingstyle.rst b/docs/api/python/frozen/pyopencolorio_gradingstyle.rst new file mode 100644 index 0000000000..75f1ae2035 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_gradingstyle.rst @@ -0,0 +1,39 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: GradingStyle + :module: PyOpenColorIO + + Styles for grading transforms. + + Members: + + GRADING_LOG : Algorithms for Logarithmic color spaces. + + GRADING_LIN : Algorithms for Scene Linear color spaces. + + GRADING_VIDEO : Algorithms for Video color spaces. + + .. py:method:: name() -> str + :property: + + .. py:attribute:: GradingStyle.GRADING_LIN + :module: PyOpenColorIO + :value: + + + .. py:attribute:: GradingStyle.GRADING_LOG + :module: PyOpenColorIO + :value: + + + .. py:attribute:: GradingStyle.GRADING_VIDEO + :module: PyOpenColorIO + :value: + + + .. py:property:: GradingStyle.value + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_gradingstylefromstring.rst b/docs/api/python/frozen/pyopencolorio_gradingstylefromstring.rst new file mode 100644 index 0000000000..6792efad76 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_gradingstylefromstring.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: GradingStyleFromString(str: str) -> PyOpenColorIO.GradingStyle + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_gradingstyletostring.rst b/docs/api/python/frozen/pyopencolorio_gradingstyletostring.rst new file mode 100644 index 0000000000..e1ea0011d2 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_gradingstyletostring.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: GradingStyleToString(style: PyOpenColorIO.GradingStyle) -> str + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_gradingtone.rst b/docs/api/python/frozen/pyopencolorio_gradingtone.rst new file mode 100644 index 0000000000..352e1b0a5d --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_gradingtone.rst @@ -0,0 +1,44 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: GradingTone + :module: PyOpenColorIO + + Grading tone values. + + + .. py:method:: GradingTone.__init__(self: PyOpenColorIO.GradingTone, arg0: PyOpenColorIO.GradingStyle) -> None + :module: PyOpenColorIO + + + .. py:property:: GradingTone.blacks + :module: PyOpenColorIO + + + .. py:property:: GradingTone.highlights + :module: PyOpenColorIO + + + .. py:property:: GradingTone.midtones + :module: PyOpenColorIO + + + .. py:property:: GradingTone.scontrast + :module: PyOpenColorIO + + + .. py:property:: GradingTone.shadows + :module: PyOpenColorIO + + + .. py:method:: GradingTone.validate(self: PyOpenColorIO.GradingTone) -> None + :module: PyOpenColorIO + + The valid range for each parameter varies. The client is expected to enforce these bounds in the UI. + + + .. py:property:: GradingTone.whites + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_gradingtonetransform.rst b/docs/api/python/frozen/pyopencolorio_gradingtonetransform.rst new file mode 100644 index 0000000000..ae62e1cdbe --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_gradingtonetransform.rst @@ -0,0 +1,99 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: GradingToneTransform + :module: PyOpenColorIO + + Tonal color correction controls. + + This transform is for making fine adjustments to tone reproduction in specific tonal ranges. + + There are five tonal controls and each one has two parameters to control its range: + - Blacks (start, width) + - Shadows(start, pivot) + - Midtones(center, width) + - Highlights(start, pivot) + - Whites(start, width) + + The transform has three styles that adjust the response and default ranges for linear, logarithimic, and video color encodings. The defaults vary based on the style. When the style is linear, the units for start/width/etc. are photographic stops relative to 0.18. + + Each control allows R, G, B adjustments and a Master adjustment. + + There is also an S-contrast control for imparting an S-shape curve. + + The controls are dynamic, so they may be adjusted even after the :ref:`Transform` has been included in a :ref:`Processor`. + + + .. py:method:: GradingToneTransform.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.GradingToneTransform, values: PyOpenColorIO.GradingTone, style: PyOpenColorIO.GradingStyle = , dynamic: bool = False, dir: PyOpenColorIO.TransformDirection = ) -> None + + Creates an instance of :ref:`GradingToneTransform`. + + 2. __init__(self: PyOpenColorIO.GradingToneTransform, style: PyOpenColorIO.GradingStyle = , dynamic: bool = False, dir: PyOpenColorIO.TransformDirection = ) -> None + + Creates an instance of :ref:`GradingToneTransform`. + + + .. py:method:: GradingToneTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection + :module: PyOpenColorIO + + + .. py:method:: GradingToneTransform.getFormatMetadata(self: PyOpenColorIO.GradingToneTransform) -> PyOpenColorIO.FormatMetadata + :module: PyOpenColorIO + + + .. py:method:: GradingToneTransform.getStyle(self: PyOpenColorIO.GradingToneTransform) -> PyOpenColorIO.GradingStyle + :module: PyOpenColorIO + + Adjusts the behavior of the transform for log, linear, or video color space encodings. + + + .. py:method:: GradingToneTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType + :module: PyOpenColorIO + + + .. py:method:: GradingToneTransform.getValue(self: PyOpenColorIO.GradingToneTransform) -> PyOpenColorIO.GradingTone + :module: PyOpenColorIO + + + .. py:method:: GradingToneTransform.isDynamic(self: PyOpenColorIO.GradingToneTransform) -> bool + :module: PyOpenColorIO + + Parameters can be made dynamic so the values can be changed through the CPU or GPU processor, but if there are several :ref:`GradingToneTransform` only one can have dynamic parameters. + + + .. py:method:: GradingToneTransform.makeDynamic(self: PyOpenColorIO.GradingToneTransform) -> None + :module: PyOpenColorIO + + + .. py:method:: GradingToneTransform.makeNonDynamic(self: PyOpenColorIO.GradingToneTransform) -> None + :module: PyOpenColorIO + + + .. py:method:: GradingToneTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None + :module: PyOpenColorIO + + Note that this only affects the evaluation and not the values stored in the object. + + + .. py:method:: GradingToneTransform.setStyle(self: PyOpenColorIO.GradingToneTransform, style: PyOpenColorIO.GradingStyle) -> None + :module: PyOpenColorIO + + Will reset value to style's defaults if style is not the current style. + + + .. py:method:: GradingToneTransform.setValue(self: PyOpenColorIO.GradingToneTransform, values: PyOpenColorIO.GradingTone) -> None + :module: PyOpenColorIO + + + .. py:method:: GradingToneTransform.validate(self: PyOpenColorIO.Transform) -> None + :module: PyOpenColorIO + + Will throw if data is not valid. + diff --git a/docs/api/python/frozen/pyopencolorio_grouptransform.rst b/docs/api/python/frozen/pyopencolorio_grouptransform.rst new file mode 100644 index 0000000000..630ac4a122 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_grouptransform.rst @@ -0,0 +1,137 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: GroupTransform + :module: PyOpenColorIO + + + .. py:method:: GroupTransform.GetWriteFormats() -> PyOpenColorIO.GroupTransform.WriteFormatIterator + :module: PyOpenColorIO + :staticmethod: + + + .. py:method:: GroupTransform.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.GroupTransform) -> None + + 2. __init__(self: PyOpenColorIO.GroupTransform, transforms: List[PyOpenColorIO.Transform] = [], direction: PyOpenColorIO.TransformDirection = ) -> None + + + .. py:method:: GroupTransform.appendTransform(self: PyOpenColorIO.GroupTransform, transform: PyOpenColorIO.Transform) -> None + :module: PyOpenColorIO + + Adds a transform to the end of the group. + + + .. py:method:: GroupTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection + :module: PyOpenColorIO + + + .. py:method:: GroupTransform.getFormatMetadata(self: PyOpenColorIO.GroupTransform) -> PyOpenColorIO.FormatMetadata + :module: PyOpenColorIO + + + .. py:method:: GroupTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType + :module: PyOpenColorIO + + + .. py:method:: GroupTransform.prependTransform(self: PyOpenColorIO.GroupTransform, transform: PyOpenColorIO.Transform) -> None + :module: PyOpenColorIO + + Add a transform at the beginning of the group. + + + .. py:method:: GroupTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None + :module: PyOpenColorIO + + Note that this only affects the evaluation and not the values stored in the object. + + + .. py:method:: GroupTransform.validate(self: PyOpenColorIO.Transform) -> None + :module: PyOpenColorIO + + Will throw if data is not valid. + + + .. py:method:: GroupTransform.write(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. write(self: PyOpenColorIO.GroupTransform, formatName: str, fileName: str, config: PyOpenColorIO.Config = None) -> None + + Write the transforms comprising the group to the stream. + + Writing (as opposed to Baking) is a lossless process. An exception is thrown if the processor cannot be losslessly written to the specified file format. Transforms such as :ref:`FileTransform` or :ref:`ColorSpaceTransform` are resolved into write-able simple transforms using the config and context. Supported formats include CTF, CLF, and CDL. All available formats can be listed with the following: .. code-block:: cpp + + // What are the allowed writing output formats? + std::ostringstream formats; + formats << "Formats to write to: "; + for (int i = 0; i < :ref:`GroupTransform::GetNumWriteFormats`(); ++i) + { + if (i != 0) formats << ", "; + formats << :ref:`GroupTransform::GetFormatNameByIndex`(i); + formats << " (." << GroupTransform::GetFormatExtensionByIndex(i) << ")"; + } + + 2. write(self: PyOpenColorIO.GroupTransform, formatName: str, config: PyOpenColorIO.Config = None) -> str + + Write the transforms comprising the group to the stream. + + Writing (as opposed to Baking) is a lossless process. An exception is thrown if the processor cannot be losslessly written to the specified file format. Transforms such as :ref:`FileTransform` or :ref:`ColorSpaceTransform` are resolved into write-able simple transforms using the config and context. Supported formats include CTF, CLF, and CDL. All available formats can be listed with the following: .. code-block:: cpp + + // What are the allowed writing output formats? + std::ostringstream formats; + formats << "Formats to write to: "; + for (int i = 0; i < :ref:`GroupTransform::GetNumWriteFormats`(); ++i) + { + if (i != 0) formats << ", "; + formats << :ref:`GroupTransform::GetFormatNameByIndex`(i); + formats << " (." << GroupTransform::GetFormatExtensionByIndex(i) << ")"; + } + + +.. py:class:: WriteFormatIterator + :module: PyOpenColorIO.GroupTransform + + + .. py:method:: WriteFormatIterator.__getitem__(self: PyOpenColorIO.GroupTransform.WriteFormatIterator, arg0: int) -> tuple + :module: PyOpenColorIO.GroupTransform + + + .. py:method:: WriteFormatIterator.__iter__(self: PyOpenColorIO.GroupTransform.WriteFormatIterator) -> PyOpenColorIO.GroupTransform.WriteFormatIterator + :module: PyOpenColorIO.GroupTransform + + + .. py:method:: WriteFormatIterator.__len__(self: PyOpenColorIO.GroupTransform.WriteFormatIterator) -> int + :module: PyOpenColorIO.GroupTransform + + + .. py:method:: WriteFormatIterator.__next__(self: PyOpenColorIO.GroupTransform.WriteFormatIterator) -> tuple + :module: PyOpenColorIO.GroupTransform + + +.. py:class:: TransformIterator + :module: PyOpenColorIO.GroupTransform + + + .. py:method:: TransformIterator.__getitem__(self: PyOpenColorIO.GroupTransform.TransformIterator, arg0: int) -> PyOpenColorIO.Transform + :module: PyOpenColorIO.GroupTransform + + + .. py:method:: TransformIterator.__iter__(self: PyOpenColorIO.GroupTransform.TransformIterator) -> PyOpenColorIO.GroupTransform.TransformIterator + :module: PyOpenColorIO.GroupTransform + + + .. py:method:: TransformIterator.__len__(self: PyOpenColorIO.GroupTransform.TransformIterator) -> int + :module: PyOpenColorIO.GroupTransform + + + .. py:method:: TransformIterator.__next__(self: PyOpenColorIO.GroupTransform.TransformIterator) -> PyOpenColorIO.Transform + :module: PyOpenColorIO.GroupTransform + diff --git a/docs/api/python/frozen/pyopencolorio_imagedesc.rst b/docs/api/python/frozen/pyopencolorio_imagedesc.rst new file mode 100644 index 0000000000..f651298153 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_imagedesc.rst @@ -0,0 +1,56 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: ImageDesc + :module: PyOpenColorIO + + This is a light-weight wrapper around an image, that provides a context for pixel access. This does NOT claim ownership of the pixels or copy image data. + + + .. py:method:: ImageDesc.__init__(self: PyOpenColorIO.ImageDesc) -> None + :module: PyOpenColorIO + + + .. py:method:: ImageDesc.getBitDepth(self: PyOpenColorIO.ImageDesc) -> PyOpenColorIO.BitDepth + :module: PyOpenColorIO + + Get the bit-depth. + + + .. py:method:: ImageDesc.getHeight(self: PyOpenColorIO.ImageDesc) -> int + :module: PyOpenColorIO + + Get the height to process (where y position starts at 0 and ends at height-1). + + + .. py:method:: ImageDesc.getWidth(self: PyOpenColorIO.ImageDesc) -> int + :module: PyOpenColorIO + + Get the width to process (where x position starts at 0 and ends at width-1). + + + .. py:method:: ImageDesc.getXStrideBytes(self: PyOpenColorIO.ImageDesc) -> int + :module: PyOpenColorIO + + Get the step in bytes to find the same color channel of the next pixel. + + + .. py:method:: ImageDesc.getYStrideBytes(self: PyOpenColorIO.ImageDesc) -> int + :module: PyOpenColorIO + + Get the step in bytes to find the same color channel of the pixel at the same position in the next line. + + + .. py:method:: ImageDesc.isFloat(self: PyOpenColorIO.ImageDesc) -> bool + :module: PyOpenColorIO + + Is the image buffer 32-bit float? + + + .. py:method:: ImageDesc.isRGBAPacked(self: PyOpenColorIO.ImageDesc) -> bool + :module: PyOpenColorIO + + Is the image buffer in packed mode with the 4 color channels? ("Packed" here means that XStrideBytes is 4x the bytes per channel, so it is more specific than simply any :ref:`PackedImageDesc`.) + diff --git a/docs/api/python/frozen/pyopencolorio_interpolation.rst b/docs/api/python/frozen/pyopencolorio_interpolation.rst new file mode 100644 index 0000000000..91be18698f --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_interpolation.rst @@ -0,0 +1,77 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: Interpolation + :module: PyOpenColorIO + + Specify the interpolation type to use If the specified interpolation type is not supported in the requested context (for example, using tetrahedral interpolationon 1D LUTs) an exception will be thrown. + + INTERP_DEFAULT will choose the default interpolation type for the requested context: + + 1D LUT INTERP_DEFAULT: LINEAR 3D LUT INTERP_DEFAULT: LINEAR + + INTERP_BEST will choose the best interpolation type for the requested context: + + 1D LUT INTERP_BEST: LINEAR 3D LUT INTERP_BEST: TETRAHEDRAL + + Note: INTERP_BEST and INTERP_DEFAULT are subject to change in minor releases, so if you care about locking off on a specific interpolation type, we'd recommend directly specifying it. + + Members: + + INTERP_UNKNOWN : + + INTERP_NEAREST : nearest neighbor + + INTERP_LINEAR : linear interpolation (trilinear for Lut3D) + + INTERP_TETRAHEDRAL : tetrahedral interpolation (Lut3D only) + + INTERP_CUBIC : cubic interpolation (not supported) + + INTERP_DEFAULT : the default interpolation type + + INTERP_BEST : the 'best' suitable interpolation type + + .. py:method:: name() -> str + :property: + + .. py:attribute:: Interpolation.INTERP_BEST + :module: PyOpenColorIO + :value: + + + .. py:attribute:: Interpolation.INTERP_CUBIC + :module: PyOpenColorIO + :value: + + + .. py:attribute:: Interpolation.INTERP_DEFAULT + :module: PyOpenColorIO + :value: + + + .. py:attribute:: Interpolation.INTERP_LINEAR + :module: PyOpenColorIO + :value: + + + .. py:attribute:: Interpolation.INTERP_NEAREST + :module: PyOpenColorIO + :value: + + + .. py:attribute:: Interpolation.INTERP_TETRAHEDRAL + :module: PyOpenColorIO + :value: + + + .. py:attribute:: Interpolation.INTERP_UNKNOWN + :module: PyOpenColorIO + :value: + + + .. py:property:: Interpolation.value + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_interpolationfromstring.rst b/docs/api/python/frozen/pyopencolorio_interpolationfromstring.rst new file mode 100644 index 0000000000..1fb73dc038 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_interpolationfromstring.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: InterpolationFromString(str: str) -> PyOpenColorIO.Interpolation + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_interpolationtostring.rst b/docs/api/python/frozen/pyopencolorio_interpolationtostring.rst new file mode 100644 index 0000000000..280e5fcb4b --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_interpolationtostring.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: InterpolationToString(interpolation: PyOpenColorIO.Interpolation) -> str + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_isenvvariablepresent.rst b/docs/api/python/frozen/pyopencolorio_isenvvariablepresent.rst new file mode 100644 index 0000000000..2dbae9e715 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_isenvvariablepresent.rst @@ -0,0 +1,10 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: IsEnvVariablePresent(name: str) -> bool + :module: PyOpenColorIO + + cpp:function:: + diff --git a/docs/api/python/frozen/pyopencolorio_legacyviewingpipeline.rst b/docs/api/python/frozen/pyopencolorio_legacyviewingpipeline.rst index e9252d94f1..9b9d9e839a 100644 --- a/docs/api/python/frozen/pyopencolorio_legacyviewingpipeline.rst +++ b/docs/api/python/frozen/pyopencolorio_legacyviewingpipeline.rst @@ -5,7 +5,6 @@ .. py:class:: LegacyViewingPipeline :module: PyOpenColorIO - :canonical: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline Whereas the :ref:`DisplayViewTransform` simply applies a specific view from an OCIO display, the :ref:`LegacyViewingPipeline` provides an example of a complete viewing pipeline of the sort that could be used to implement a viewport in a typical application. It therefore adds, around the :ref:`DisplayViewTransform`, various optional color correction steps and RGBA channel view swizzling. The direction of the DisplayViewTranform is used as the direction of the pipeline. Note: The :ref:`LegacyViewingPipeline` class provides the same functionality as the OCIO v1 DisplayTransform. @@ -29,63 +28,63 @@ - Apply displayCC. Note that looks are applied even if the display transform involves data color spaces. - .. py:method:: LegacyViewingPipeline.__init__(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline) -> None + .. py:method:: LegacyViewingPipeline.__init__(self: PyOpenColorIO.LegacyViewingPipeline) -> None :module: PyOpenColorIO - .. py:method:: LegacyViewingPipeline.getChannelView(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline) -> PyOpenColorIO.PyOpenColorIO.Transform + .. py:method:: LegacyViewingPipeline.getChannelView(self: PyOpenColorIO.LegacyViewingPipeline) -> PyOpenColorIO.Transform :module: PyOpenColorIO - .. py:method:: LegacyViewingPipeline.getColorTimingCC(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline) -> PyOpenColorIO.PyOpenColorIO.Transform + .. py:method:: LegacyViewingPipeline.getColorTimingCC(self: PyOpenColorIO.LegacyViewingPipeline) -> PyOpenColorIO.Transform :module: PyOpenColorIO - .. py:method:: LegacyViewingPipeline.getDisplayCC(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline) -> PyOpenColorIO.PyOpenColorIO.Transform + .. py:method:: LegacyViewingPipeline.getDisplayCC(self: PyOpenColorIO.LegacyViewingPipeline) -> PyOpenColorIO.Transform :module: PyOpenColorIO - .. py:method:: LegacyViewingPipeline.getDisplayViewTransform(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline) -> PyOpenColorIO.PyOpenColorIO.DisplayViewTransform + .. py:method:: LegacyViewingPipeline.getDisplayViewTransform(self: PyOpenColorIO.LegacyViewingPipeline) -> PyOpenColorIO.DisplayViewTransform :module: PyOpenColorIO - .. py:method:: LegacyViewingPipeline.getLinearCC(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline) -> PyOpenColorIO.PyOpenColorIO.Transform + .. py:method:: LegacyViewingPipeline.getLinearCC(self: PyOpenColorIO.LegacyViewingPipeline) -> PyOpenColorIO.Transform :module: PyOpenColorIO - .. py:method:: LegacyViewingPipeline.getLooksOverride(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline) -> str + .. py:method:: LegacyViewingPipeline.getLooksOverride(self: PyOpenColorIO.LegacyViewingPipeline) -> str :module: PyOpenColorIO - .. py:method:: LegacyViewingPipeline.getLooksOverrideEnabled(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline) -> bool + .. py:method:: LegacyViewingPipeline.getLooksOverrideEnabled(self: PyOpenColorIO.LegacyViewingPipeline) -> bool :module: PyOpenColorIO - .. py:method:: LegacyViewingPipeline.getProcessor(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline, config: PyOpenColorIO.PyOpenColorIO.Config, context: PyOpenColorIO.PyOpenColorIO.Context = None) -> PyOpenColorIO.PyOpenColorIO.Processor + .. py:method:: LegacyViewingPipeline.getProcessor(self: PyOpenColorIO.LegacyViewingPipeline, config: PyOpenColorIO.Config, context: PyOpenColorIO.Context = None) -> PyOpenColorIO.Processor :module: PyOpenColorIO - .. py:method:: LegacyViewingPipeline.setChannelView(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline, arg0: PyOpenColorIO.PyOpenColorIO.Transform) -> None + .. py:method:: LegacyViewingPipeline.setChannelView(self: PyOpenColorIO.LegacyViewingPipeline, arg0: PyOpenColorIO.Transform) -> None :module: PyOpenColorIO - .. py:method:: LegacyViewingPipeline.setColorTimingCC(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline, arg0: PyOpenColorIO.PyOpenColorIO.Transform) -> None + .. py:method:: LegacyViewingPipeline.setColorTimingCC(self: PyOpenColorIO.LegacyViewingPipeline, arg0: PyOpenColorIO.Transform) -> None :module: PyOpenColorIO - .. py:method:: LegacyViewingPipeline.setDisplayCC(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline, arg0: PyOpenColorIO.PyOpenColorIO.Transform) -> None + .. py:method:: LegacyViewingPipeline.setDisplayCC(self: PyOpenColorIO.LegacyViewingPipeline, arg0: PyOpenColorIO.Transform) -> None :module: PyOpenColorIO - .. py:method:: LegacyViewingPipeline.setDisplayViewTransform(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline, arg0: PyOpenColorIO.PyOpenColorIO.DisplayViewTransform) -> None + .. py:method:: LegacyViewingPipeline.setDisplayViewTransform(self: PyOpenColorIO.LegacyViewingPipeline, arg0: PyOpenColorIO.DisplayViewTransform) -> None :module: PyOpenColorIO - .. py:method:: LegacyViewingPipeline.setLinearCC(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline, arg0: PyOpenColorIO.PyOpenColorIO.Transform) -> None + .. py:method:: LegacyViewingPipeline.setLinearCC(self: PyOpenColorIO.LegacyViewingPipeline, arg0: PyOpenColorIO.Transform) -> None :module: PyOpenColorIO - .. py:method:: LegacyViewingPipeline.setLooksOverride(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline, looks: str) -> None + .. py:method:: LegacyViewingPipeline.setLooksOverride(self: PyOpenColorIO.LegacyViewingPipeline, looks: str) -> None :module: PyOpenColorIO A user can optionally override the looks that are, by default, used with the expected display / view combination. A common use case for this functionality is in an image viewing app, where per-shot looks are supported. If for some reason a per-shot look is not defined for the current :ref:`Context`, the :ref:`Config::getProcessor` fcn will not succeed by default. Thus, with this mechanism the viewing app could override to looks = "", and this will allow image display to continue (though hopefully) the interface would reflect this fallback option. @@ -93,7 +92,7 @@ Looks is a potentially comma (or colon) delimited list of lookNames, where +/- prefixes are optionally allowed to denote forward/inverse look specification (and forward is assumed in the absence of either). - .. py:method:: LegacyViewingPipeline.setLooksOverrideEnabled(self: PyOpenColorIO.PyOpenColorIO.LegacyViewingPipeline, arg0: bool) -> None + .. py:method:: LegacyViewingPipeline.setLooksOverrideEnabled(self: PyOpenColorIO.LegacyViewingPipeline, arg0: bool) -> None :module: PyOpenColorIO Specify whether the lookOverride should be used, or not. This is a separate flag, as it's often useful to override "looks" to an empty string. diff --git a/docs/api/python/frozen/pyopencolorio_logaffinetransform.rst b/docs/api/python/frozen/pyopencolorio_logaffinetransform.rst new file mode 100644 index 0000000000..63026fa27e --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_logaffinetransform.rst @@ -0,0 +1,95 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: LogAffineTransform + :module: PyOpenColorIO + + Applies a logarithm with an affine transform before and after. Represents the Cineon lin-to-log type transforms:: + + logSideSlope * log( linSideSlope * color + linSideOffset, base) + logSideOffset + + - Default values are: 1. * log( 1. * color + 0., 2.) + 0. + - The alpha channel is not affected. + + + .. py:method:: LogAffineTransform.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.LogAffineTransform) -> None + + 2. __init__(self: PyOpenColorIO.LogAffineTransform, logSideSlope: List[float[3]] = [1.0, 1.0, 1.0], logSideOffset: List[float[3]] = [0.0, 0.0, 0.0], linSideSlope: List[float[3]] = [1.0, 1.0, 1.0], linSideOffset: List[float[3]] = [0.0, 0.0, 0.0], direction: PyOpenColorIO.TransformDirection = ) -> None + + + .. py:method:: LogAffineTransform.equals(self: PyOpenColorIO.LogAffineTransform, other: PyOpenColorIO.LogAffineTransform) -> bool + :module: PyOpenColorIO + + Checks if this exactly equals other. + + + .. py:method:: LogAffineTransform.getBase(self: PyOpenColorIO.LogAffineTransform) -> float + :module: PyOpenColorIO + + + .. py:method:: LogAffineTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection + :module: PyOpenColorIO + + + .. py:method:: LogAffineTransform.getFormatMetadata(self: PyOpenColorIO.LogAffineTransform) -> PyOpenColorIO.FormatMetadata + :module: PyOpenColorIO + + + .. py:method:: LogAffineTransform.getLinSideOffsetValue(self: PyOpenColorIO.LogAffineTransform) -> List[float[3]] + :module: PyOpenColorIO + + + .. py:method:: LogAffineTransform.getLinSideSlopeValue(self: PyOpenColorIO.LogAffineTransform) -> List[float[3]] + :module: PyOpenColorIO + + + .. py:method:: LogAffineTransform.getLogSideOffsetValue(self: PyOpenColorIO.LogAffineTransform) -> List[float[3]] + :module: PyOpenColorIO + + + .. py:method:: LogAffineTransform.getLogSideSlopeValue(self: PyOpenColorIO.LogAffineTransform) -> List[float[3]] + :module: PyOpenColorIO + + + .. py:method:: LogAffineTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType + :module: PyOpenColorIO + + + .. py:method:: LogAffineTransform.setBase(self: PyOpenColorIO.LogAffineTransform, base: float) -> None + :module: PyOpenColorIO + + + .. py:method:: LogAffineTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None + :module: PyOpenColorIO + + Note that this only affects the evaluation and not the values stored in the object. + + + .. py:method:: LogAffineTransform.setLinSideOffsetValue(self: PyOpenColorIO.LogAffineTransform, values: List[float[3]]) -> None + :module: PyOpenColorIO + + + .. py:method:: LogAffineTransform.setLinSideSlopeValue(self: PyOpenColorIO.LogAffineTransform, values: List[float[3]]) -> None + :module: PyOpenColorIO + + + .. py:method:: LogAffineTransform.setLogSideOffsetValue(self: PyOpenColorIO.LogAffineTransform, values: List[float[3]]) -> None + :module: PyOpenColorIO + + + .. py:method:: LogAffineTransform.setLogSideSlopeValue(self: PyOpenColorIO.LogAffineTransform, values: List[float[3]]) -> None + :module: PyOpenColorIO + + + .. py:method:: LogAffineTransform.validate(self: PyOpenColorIO.Transform) -> None + :module: PyOpenColorIO + + Will throw if data is not valid. + diff --git a/docs/api/python/frozen/pyopencolorio_logcameratransform.rst b/docs/api/python/frozen/pyopencolorio_logcameratransform.rst new file mode 100644 index 0000000000..24743f53cd --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_logcameratransform.rst @@ -0,0 +1,125 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: LogCameraTransform + :module: PyOpenColorIO + + Same as :ref:`LogAffineTransform` but with the addition of a linear segment near black. This formula is used for many camera logs (e.g., LogC) as well as ACEScct. + + - The linSideBreak specifies the point on the linear axis where the log and linear segments meet. It must be set (there is no default). + + - The linearSlope specifies the slope of the linear segment of the forward (linToLog) transform. By default it is set equal to the slope of the log curve at the break point. + + + .. py:method:: LogCameraTransform.__init__(self: PyOpenColorIO.LogCameraTransform, linSideBreak: List[float[3]], base: float = 2.0, logSideSlope: List[float[3]] = [1.0, 1.0, 1.0], logSideOffset: List[float[3]] = [0.0, 0.0, 0.0], linSideSlope: List[float[3]] = [1.0, 1.0, 1.0], linSideOffset: List[float[3]] = [0.0, 0.0, 0.0], linearSlope: List[float] = [], direction: PyOpenColorIO.TransformDirection = ) -> None + :module: PyOpenColorIO + + LinSideBreak must be set for the transform to be valid (there is no default). + + + .. py:method:: LogCameraTransform.equals(self: PyOpenColorIO.LogCameraTransform, other: PyOpenColorIO.LogCameraTransform) -> bool + :module: PyOpenColorIO + + Checks if this exactly equals other. + + + .. py:method:: LogCameraTransform.getBase(self: PyOpenColorIO.LogCameraTransform) -> float + :module: PyOpenColorIO + + + .. py:method:: LogCameraTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection + :module: PyOpenColorIO + + + .. py:method:: LogCameraTransform.getFormatMetadata(self: PyOpenColorIO.LogCameraTransform) -> PyOpenColorIO.FormatMetadata + :module: PyOpenColorIO + + + .. py:method:: LogCameraTransform.getLinSideBreakValue(self: PyOpenColorIO.LogCameraTransform) -> List[float[3]] + :module: PyOpenColorIO + + + .. py:method:: LogCameraTransform.getLinSideOffsetValue(self: PyOpenColorIO.LogCameraTransform) -> List[float[3]] + :module: PyOpenColorIO + + + .. py:method:: LogCameraTransform.getLinSideSlopeValue(self: PyOpenColorIO.LogCameraTransform) -> List[float[3]] + :module: PyOpenColorIO + + + .. py:method:: LogCameraTransform.getLinearSlopeValue(self: PyOpenColorIO.LogCameraTransform) -> List[float[3]] + :module: PyOpenColorIO + + Return LinearSlope or 3 qnan values if not defined. + + + .. py:method:: LogCameraTransform.getLogSideOffsetValue(self: PyOpenColorIO.LogCameraTransform) -> List[float[3]] + :module: PyOpenColorIO + + + .. py:method:: LogCameraTransform.getLogSideSlopeValue(self: PyOpenColorIO.LogCameraTransform) -> List[float[3]] + :module: PyOpenColorIO + + Get/Set values for the R, G, B components. + + + .. py:method:: LogCameraTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType + :module: PyOpenColorIO + + + .. py:method:: LogCameraTransform.isLinearSlopeValueSet(self: PyOpenColorIO.LogCameraTransform) -> bool + :module: PyOpenColorIO + + + .. py:method:: LogCameraTransform.setBase(self: PyOpenColorIO.LogCameraTransform, base: float) -> None + :module: PyOpenColorIO + + + .. py:method:: LogCameraTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None + :module: PyOpenColorIO + + Note that this only affects the evaluation and not the values stored in the object. + + + .. py:method:: LogCameraTransform.setLinSideBreakValue(self: PyOpenColorIO.LogCameraTransform, values: List[float[3]]) -> None + :module: PyOpenColorIO + + + .. py:method:: LogCameraTransform.setLinSideOffsetValue(self: PyOpenColorIO.LogCameraTransform, values: List[float[3]]) -> None + :module: PyOpenColorIO + + + .. py:method:: LogCameraTransform.setLinSideSlopeValue(self: PyOpenColorIO.LogCameraTransform, values: List[float[3]]) -> None + :module: PyOpenColorIO + + + .. py:method:: LogCameraTransform.setLinearSlopeValue(self: PyOpenColorIO.LogCameraTransform, values: List[float[3]]) -> None + :module: PyOpenColorIO + + Set LinearSlope value. + + .. note:: + You must call setLinSideBreakValue before calling this. + + + .. py:method:: LogCameraTransform.setLogSideOffsetValue(self: PyOpenColorIO.LogCameraTransform, values: List[float[3]]) -> None + :module: PyOpenColorIO + + + .. py:method:: LogCameraTransform.setLogSideSlopeValue(self: PyOpenColorIO.LogCameraTransform, values: List[float[3]]) -> None + :module: PyOpenColorIO + + + .. py:method:: LogCameraTransform.unsetLinearSlopeValue(self: PyOpenColorIO.LogCameraTransform) -> None + :module: PyOpenColorIO + + Remove LinearSlope values so that default values are used. + + + .. py:method:: LogCameraTransform.validate(self: PyOpenColorIO.Transform) -> None + :module: PyOpenColorIO + + Will throw if data is not valid. + diff --git a/docs/api/python/frozen/pyopencolorio_logginglevel.rst b/docs/api/python/frozen/pyopencolorio_logginglevel.rst new file mode 100644 index 0000000000..30c141c032 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_logginglevel.rst @@ -0,0 +1,51 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: LoggingLevel + :module: PyOpenColorIO + + Members: + + LOGGING_LEVEL_NONE : + + LOGGING_LEVEL_WARNING : + + LOGGING_LEVEL_INFO : + + LOGGING_LEVEL_DEBUG : + + LOGGING_LEVEL_UNKNOWN : + + .. py:method:: name() -> str + :property: + + .. py:attribute:: LoggingLevel.LOGGING_LEVEL_DEBUG + :module: PyOpenColorIO + :value: + + + .. py:attribute:: LoggingLevel.LOGGING_LEVEL_INFO + :module: PyOpenColorIO + :value: + + + .. py:attribute:: LoggingLevel.LOGGING_LEVEL_NONE + :module: PyOpenColorIO + :value: + + + .. py:attribute:: LoggingLevel.LOGGING_LEVEL_UNKNOWN + :module: PyOpenColorIO + :value: + + + .. py:attribute:: LoggingLevel.LOGGING_LEVEL_WARNING + :module: PyOpenColorIO + :value: + + + .. py:property:: LoggingLevel.value + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_logginglevelfromstring.rst b/docs/api/python/frozen/pyopencolorio_logginglevelfromstring.rst new file mode 100644 index 0000000000..fce29b2821 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_logginglevelfromstring.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: LoggingLevelFromString(str: str) -> PyOpenColorIO.LoggingLevel + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_loggingleveltostring.rst b/docs/api/python/frozen/pyopencolorio_loggingleveltostring.rst new file mode 100644 index 0000000000..99200cc451 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_loggingleveltostring.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: LoggingLevelToString(level: PyOpenColorIO.LoggingLevel) -> str + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_logmessage.rst b/docs/api/python/frozen/pyopencolorio_logmessage.rst new file mode 100644 index 0000000000..88f54b8cfd --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_logmessage.rst @@ -0,0 +1,10 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: LogMessage(level: PyOpenColorIO.LoggingLevel, message: str) -> None + :module: PyOpenColorIO + + Log a message using the library logging function. + diff --git a/docs/api/python/frozen/pyopencolorio_logtransform.rst b/docs/api/python/frozen/pyopencolorio_logtransform.rst new file mode 100644 index 0000000000..37450ca799 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_logtransform.rst @@ -0,0 +1,62 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: LogTransform + :module: PyOpenColorIO + + Represents log transform: log(color, base) + + - The input will be clamped for negative numbers. + - Default base is 2.0. + - The alpha channel is not affected. + + + .. py:method:: LogTransform.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.LogTransform) -> None + + 2. __init__(self: PyOpenColorIO.LogTransform, base: float = 2.0, direction: PyOpenColorIO.TransformDirection = ) -> None + + + .. py:method:: LogTransform.equals(self: PyOpenColorIO.LogTransform, other: PyOpenColorIO.LogTransform) -> bool + :module: PyOpenColorIO + + Checks if this exactly equals other. + + + .. py:method:: LogTransform.getBase(self: PyOpenColorIO.LogTransform) -> float + :module: PyOpenColorIO + + + .. py:method:: LogTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection + :module: PyOpenColorIO + + + .. py:method:: LogTransform.getFormatMetadata(self: PyOpenColorIO.LogTransform) -> PyOpenColorIO.FormatMetadata + :module: PyOpenColorIO + + + .. py:method:: LogTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType + :module: PyOpenColorIO + + + .. py:method:: LogTransform.setBase(self: PyOpenColorIO.LogTransform, base: float) -> None + :module: PyOpenColorIO + + + .. py:method:: LogTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None + :module: PyOpenColorIO + + Note that this only affects the evaluation and not the values stored in the object. + + + .. py:method:: LogTransform.validate(self: PyOpenColorIO.Transform) -> None + :module: PyOpenColorIO + + Will throw if data is not valid. + diff --git a/docs/api/python/frozen/pyopencolorio_look.rst b/docs/api/python/frozen/pyopencolorio_look.rst new file mode 100644 index 0000000000..395cc8e268 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_look.rst @@ -0,0 +1,64 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: Look + :module: PyOpenColorIO + + The *:ref:`Look`* is an 'artistic' image modification, in a specified image state. The processSpace defines the :ref:`ColorSpace` the image is required to be in, for the math to apply correctly. + + + .. py:method:: Look.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.Look) -> None + + 2. __init__(self: PyOpenColorIO.Look, name: str = '', processSpace: str = '', transform: PyOpenColorIO.Transform = None, inverseTransform: PyOpenColorIO.Transform = None, description: str = '') -> None + + + .. py:method:: Look.getDescription(self: PyOpenColorIO.Look) -> str + :module: PyOpenColorIO + + + .. py:method:: Look.getInverseTransform(self: PyOpenColorIO.Look) -> PyOpenColorIO.Transform + :module: PyOpenColorIO + + + .. py:method:: Look.getName(self: PyOpenColorIO.Look) -> str + :module: PyOpenColorIO + + + .. py:method:: Look.getProcessSpace(self: PyOpenColorIO.Look) -> str + :module: PyOpenColorIO + + + .. py:method:: Look.getTransform(self: PyOpenColorIO.Look) -> PyOpenColorIO.Transform + :module: PyOpenColorIO + + + .. py:method:: Look.setDescription(self: PyOpenColorIO.Look, description: str) -> None + :module: PyOpenColorIO + + + .. py:method:: Look.setInverseTransform(self: PyOpenColorIO.Look, transform: PyOpenColorIO.Transform) -> None + :module: PyOpenColorIO + + Setting a transform to a non-null call makes it allowed. + + + .. py:method:: Look.setName(self: PyOpenColorIO.Look, name: str) -> None + :module: PyOpenColorIO + + + .. py:method:: Look.setProcessSpace(self: PyOpenColorIO.Look, processSpace: str) -> None + :module: PyOpenColorIO + + + .. py:method:: Look.setTransform(self: PyOpenColorIO.Look, transform: PyOpenColorIO.Transform) -> None + :module: PyOpenColorIO + + Setting a transform to a non-null call makes it allowed. + diff --git a/docs/api/python/frozen/pyopencolorio_looktransform.rst b/docs/api/python/frozen/pyopencolorio_looktransform.rst new file mode 100644 index 0000000000..7d7347b09c --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_looktransform.rst @@ -0,0 +1,72 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: LookTransform + :module: PyOpenColorIO + + + .. py:method:: LookTransform.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.LookTransform) -> None + + 2. __init__(self: PyOpenColorIO.LookTransform, src: str, dst: str, looks: str = '', skipColorSpaceConversion: bool = False, direction: PyOpenColorIO.TransformDirection = ) -> None + + + .. py:method:: LookTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection + :module: PyOpenColorIO + + + .. py:method:: LookTransform.getDst(self: PyOpenColorIO.LookTransform) -> str + :module: PyOpenColorIO + + + .. py:method:: LookTransform.getLooks(self: PyOpenColorIO.LookTransform) -> str + :module: PyOpenColorIO + + + .. py:method:: LookTransform.getSkipColorSpaceConversion(self: PyOpenColorIO.LookTransform) -> bool + :module: PyOpenColorIO + + + .. py:method:: LookTransform.getSrc(self: PyOpenColorIO.LookTransform) -> str + :module: PyOpenColorIO + + + .. py:method:: LookTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType + :module: PyOpenColorIO + + + .. py:method:: LookTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None + :module: PyOpenColorIO + + Note that this only affects the evaluation and not the values stored in the object. + + + .. py:method:: LookTransform.setDst(self: PyOpenColorIO.LookTransform, dst: str) -> None + :module: PyOpenColorIO + + + .. py:method:: LookTransform.setLooks(self: PyOpenColorIO.LookTransform, looks: str) -> None + :module: PyOpenColorIO + + Specify looks to apply. Looks is a potentially comma (or colon) delimited list of look names, Where +/- prefixes are optionally allowed to denote forward/inverse look specification. (And forward is assumed in the absence of either) + + + .. py:method:: LookTransform.setSkipColorSpaceConversion(self: PyOpenColorIO.LookTransform, skipColorSpaceConversion: bool) -> None + :module: PyOpenColorIO + + + .. py:method:: LookTransform.setSrc(self: PyOpenColorIO.LookTransform, src: str) -> None + :module: PyOpenColorIO + + + .. py:method:: LookTransform.validate(self: PyOpenColorIO.Transform) -> None + :module: PyOpenColorIO + + Will throw if data is not valid. + diff --git a/docs/api/python/frozen/pyopencolorio_lut1dhueadjust.rst b/docs/api/python/frozen/pyopencolorio_lut1dhueadjust.rst new file mode 100644 index 0000000000..05cdece8c9 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_lut1dhueadjust.rst @@ -0,0 +1,39 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: Lut1DHueAdjust + :module: PyOpenColorIO + + Used by :cpp:class`:ref:`Lut1DTransform`` to control optional hue restoration algorithm. + + Members: + + HUE_NONE : No adjustment. + + HUE_DW3 : Algorithm used in ACES Output Transforms through v0.7. + + HUE_WYPN : Weighted Yellow Power Norm -- NOT IMPLEMENTED YET. + + .. py:method:: name() -> str + :property: + + .. py:attribute:: Lut1DHueAdjust.HUE_DW3 + :module: PyOpenColorIO + :value: + + + .. py:attribute:: Lut1DHueAdjust.HUE_NONE + :module: PyOpenColorIO + :value: + + + .. py:attribute:: Lut1DHueAdjust.HUE_WYPN + :module: PyOpenColorIO + :value: + + + .. py:property:: Lut1DHueAdjust.value + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_lut1dtransform.rst b/docs/api/python/frozen/pyopencolorio_lut1dtransform.rst new file mode 100644 index 0000000000..d30e448b88 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_lut1dtransform.rst @@ -0,0 +1,140 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: Lut1DTransform + :module: PyOpenColorIO + + Represents a 1D-LUT transform. + + + .. py:method:: Lut1DTransform.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.Lut1DTransform) -> None + + Create an identity 1D-LUT of length two. + + 2. __init__(self: PyOpenColorIO.Lut1DTransform, length: int, inputHalfDomain: bool) -> None + + Create an identity 1D-LUT with specific length and half-domain setting. Will throw for lengths longer than 1024x1024. + + 3. __init__(self: PyOpenColorIO.Lut1DTransform, length: int = 2, inputHalfDomain: bool = False, outputRawHalfs: bool = False, fileOutputBitDepth: PyOpenColorIO.BitDepth = , hueAdjust: PyOpenColorIO.Lut1DHueAdjust = , interpolation: PyOpenColorIO.Interpolation = , direction: PyOpenColorIO.TransformDirection = ) -> None + + Create an identity 1D-LUT with specific length and half-domain setting. Will throw for lengths longer than 1024x1024. + + + .. py:method:: Lut1DTransform.equals(self: PyOpenColorIO.Lut1DTransform, other: PyOpenColorIO.Lut1DTransform) -> bool + :module: PyOpenColorIO + + Checks if this exactly equals other. + + + .. py:method:: Lut1DTransform.getData(self: PyOpenColorIO.Lut1DTransform) -> numpy.ndarray + :module: PyOpenColorIO + + + .. py:method:: Lut1DTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection + :module: PyOpenColorIO + + + .. py:method:: Lut1DTransform.getFileOutputBitDepth(self: PyOpenColorIO.Lut1DTransform) -> PyOpenColorIO.BitDepth + :module: PyOpenColorIO + + + .. py:method:: Lut1DTransform.getFormatMetadata(self: PyOpenColorIO.Lut1DTransform) -> PyOpenColorIO.FormatMetadata + :module: PyOpenColorIO + + + .. py:method:: Lut1DTransform.getHueAdjust(self: PyOpenColorIO.Lut1DTransform) -> PyOpenColorIO.Lut1DHueAdjust + :module: PyOpenColorIO + + + .. py:method:: Lut1DTransform.getInputHalfDomain(self: PyOpenColorIO.Lut1DTransform) -> bool + :module: PyOpenColorIO + + + .. py:method:: Lut1DTransform.getInterpolation(self: PyOpenColorIO.Lut1DTransform) -> PyOpenColorIO.Interpolation + :module: PyOpenColorIO + + + .. py:method:: Lut1DTransform.getLength(self: PyOpenColorIO.Lut1DTransform) -> int + :module: PyOpenColorIO + + + .. py:method:: Lut1DTransform.getOutputRawHalfs(self: PyOpenColorIO.Lut1DTransform) -> bool + :module: PyOpenColorIO + + + .. py:method:: Lut1DTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType + :module: PyOpenColorIO + + + .. py:method:: Lut1DTransform.getValue(self: PyOpenColorIO.Lut1DTransform, index: int) -> tuple + :module: PyOpenColorIO + + + .. py:method:: Lut1DTransform.setData(self: PyOpenColorIO.Lut1DTransform, data: buffer) -> None + :module: PyOpenColorIO + + + .. py:method:: Lut1DTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None + :module: PyOpenColorIO + + Note that this only affects the evaluation and not the values stored in the object. + + + .. py:method:: Lut1DTransform.setFileOutputBitDepth(self: PyOpenColorIO.Lut1DTransform, bitDepth: PyOpenColorIO.BitDepth) -> None + :module: PyOpenColorIO + + Get the bit-depth associated with the LUT values read from a file or set the bit-depth of values to be written to a file (for file formats such as CLF that support multiple bit-depths). However, note that the values stored in the object are always normalized. + + + .. py:method:: Lut1DTransform.setHueAdjust(self: PyOpenColorIO.Lut1DTransform, hueAdjust: PyOpenColorIO.Lut1DHueAdjust) -> None + :module: PyOpenColorIO + + The 1D-LUT transform optionally supports a hue adjustment feature that was used in some versions of ACES. This adjusts the hue of the result to approximately match the input. + + + .. py:method:: Lut1DTransform.setInputHalfDomain(self: PyOpenColorIO.Lut1DTransform, isHalfDomain: bool) -> None + :module: PyOpenColorIO + + In a half-domain LUT, the contents of the LUT specify the desired value of the function for each half-float value. Therefore, the length of the LUT must be 65536 entries or else :ref:`validate()` will throw. + + + .. py:method:: Lut1DTransform.setInterpolation(self: PyOpenColorIO.Lut1DTransform, interpolation: PyOpenColorIO.Interpolation) -> None + :module: PyOpenColorIO + + + .. py:method:: Lut1DTransform.setLength(self: PyOpenColorIO.Lut1DTransform, length: int) -> None + :module: PyOpenColorIO + + Changing the length will reset the LUT to identity. Will throw for lengths longer than 1024x1024. + + + .. py:method:: Lut1DTransform.setOutputRawHalfs(self: PyOpenColorIO.Lut1DTransform, isRawHalfs: bool) -> None + :module: PyOpenColorIO + + Set OutputRawHalfs to true if you want to output the LUT contents as 16-bit floating point values expressed as unsigned 16-bit integers representing the equivalent bit pattern. For example, the value 1.0 would be written as the integer 15360 because it has the same bit-pattern. Note that this implies the values will be quantized to a 16-bit float. Note that this setting only controls the output formatting (where supported) and not the values for getValue/setValue. The only file formats that currently support this are CLF and CTF. + + + .. py:method:: Lut1DTransform.setValue(self: PyOpenColorIO.Lut1DTransform, index: int, r: float, g: float, b: float) -> None + :module: PyOpenColorIO + + Set the values of a LUT1D. Will throw if the index is outside of the range from 0 to (length-1). + + The LUT values are always for the "forward" LUT, regardless of how the transform direction is set. + + These values are normalized relative to what may be stored in any given LUT files. For example in a CLF file using a "10i" output depth, a value of 1023 in the file is normalized to 1.0. The values here are unclamped and may extend outside [0,1]. + + LUTs in various file formats may only provide values for one channel where R, G, B are the same. Even in that case, you should provide three equal values to the setter. + + + .. py:method:: Lut1DTransform.validate(self: PyOpenColorIO.Transform) -> None + :module: PyOpenColorIO + + Will throw if data is not valid. + diff --git a/docs/api/python/frozen/pyopencolorio_lut3dtransform.rst b/docs/api/python/frozen/pyopencolorio_lut3dtransform.rst new file mode 100644 index 0000000000..c0deb63b1e --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_lut3dtransform.rst @@ -0,0 +1,108 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: Lut3DTransform + :module: PyOpenColorIO + + Represents a 3D-LUT transform. + + + .. py:method:: Lut3DTransform.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.Lut3DTransform) -> None + + Create an identity 3D-LUT of size 2x2x2. + + 2. __init__(self: PyOpenColorIO.Lut3DTransform, gridSize: int) -> None + + Create an identity 3D-LUT with specific grid size. Will throw for grid size larger than 129. + + 3. __init__(self: PyOpenColorIO.Lut3DTransform, gridSize: int = 2, fileOutputBitDepth: PyOpenColorIO.BitDepth = , interpolation: PyOpenColorIO.Interpolation = , direction: PyOpenColorIO.TransformDirection = ) -> None + + Create an identity 3D-LUT with specific grid size. Will throw for grid size larger than 129. + + + .. py:method:: Lut3DTransform.equals(self: PyOpenColorIO.Lut3DTransform, other: PyOpenColorIO.Lut3DTransform) -> bool + :module: PyOpenColorIO + + Checks if this exactly equals other. + + + .. py:method:: Lut3DTransform.getData(self: PyOpenColorIO.Lut3DTransform) -> numpy.ndarray + :module: PyOpenColorIO + + + .. py:method:: Lut3DTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection + :module: PyOpenColorIO + + + .. py:method:: Lut3DTransform.getFileOutputBitDepth(self: PyOpenColorIO.Lut3DTransform) -> PyOpenColorIO.BitDepth + :module: PyOpenColorIO + + + .. py:method:: Lut3DTransform.getFormatMetadata(self: PyOpenColorIO.Lut3DTransform) -> PyOpenColorIO.FormatMetadata + :module: PyOpenColorIO + + + .. py:method:: Lut3DTransform.getGridSize(self: PyOpenColorIO.Lut3DTransform) -> int + :module: PyOpenColorIO + + + .. py:method:: Lut3DTransform.getInterpolation(self: PyOpenColorIO.Lut3DTransform) -> PyOpenColorIO.Interpolation + :module: PyOpenColorIO + + + .. py:method:: Lut3DTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType + :module: PyOpenColorIO + + + .. py:method:: Lut3DTransform.getValue(self: PyOpenColorIO.Lut3DTransform, indexR: int, indexG: int, indexB: int) -> tuple + :module: PyOpenColorIO + + + .. py:method:: Lut3DTransform.setData(self: PyOpenColorIO.Lut3DTransform, data: buffer) -> None + :module: PyOpenColorIO + + + .. py:method:: Lut3DTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None + :module: PyOpenColorIO + + Note that this only affects the evaluation and not the values stored in the object. + + + .. py:method:: Lut3DTransform.setFileOutputBitDepth(self: PyOpenColorIO.Lut3DTransform, bitDepth: PyOpenColorIO.BitDepth) -> None + :module: PyOpenColorIO + + Get the bit-depth associated with the LUT values read from a file or set the bit-depth of values to be written to a file (for file formats such as CLF that support multiple bit-depths). However, note that the values stored in the object are always normalized. + + + .. py:method:: Lut3DTransform.setGridSize(self: PyOpenColorIO.Lut3DTransform, gridSize: int) -> None + :module: PyOpenColorIO + + Changing the grid size will reset the LUT to identity. Will throw for grid sizes larger than 129. + + + .. py:method:: Lut3DTransform.setInterpolation(self: PyOpenColorIO.Lut3DTransform, interpolation: PyOpenColorIO.Interpolation) -> None + :module: PyOpenColorIO + + + .. py:method:: Lut3DTransform.setValue(self: PyOpenColorIO.Lut3DTransform, indexR: int, indexG: int, indexB: int, r: float, g: float, b: float) -> None + :module: PyOpenColorIO + + Set the values of a 3D-LUT. Will throw if an index is outside of the range from 0 to (gridSize-1). + + The LUT values are always for the "forward" LUT, regardless of how the transform direction is set. + + These values are normalized relative to what may be stored in any given LUT files. For example in a CLF file using a "10i" output depth, a value of 1023 in the file is normalized to 1.0. The values here are unclamped and may extend outside [0,1]. + + + .. py:method:: Lut3DTransform.validate(self: PyOpenColorIO.Transform) -> None + :module: PyOpenColorIO + + Will throw if data is not valid. + diff --git a/docs/api/python/frozen/pyopencolorio_matrixtransform.rst b/docs/api/python/frozen/pyopencolorio_matrixtransform.rst new file mode 100644 index 0000000000..804069f7b9 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_matrixtransform.rst @@ -0,0 +1,131 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: MatrixTransform + :module: PyOpenColorIO + + Represents an MX+B Matrix transform. + + .. note:: + For singular matrices, an inverse direction will throw an exception during finalization. + + + .. py:method:: MatrixTransform.Fit(oldMin: List[float[4]] = [0.0, 0.0, 0.0, 0.0], oldMax: List[float[4]] = [1.0, 1.0, 1.0, 1.0], newMin: List[float[4]] = [0.0, 0.0, 0.0, 0.0], newMax: List[float[4]] = [1.0, 1.0, 1.0, 1.0]) -> PyOpenColorIO.MatrixTransform + :module: PyOpenColorIO + :staticmethod: + + **Convenience functions** + + Build the matrix and offset corresponding to higher-level concepts. + + .. note:: + These can throw an exception if for any component `oldmin == oldmax. (divide by 0)` + + + .. py:method:: MatrixTransform.Identity() -> PyOpenColorIO.MatrixTransform + :module: PyOpenColorIO + :staticmethod: + + + .. py:method:: MatrixTransform.Sat(sat: float, lumaCoef: List[float[3]]) -> PyOpenColorIO.MatrixTransform + :module: PyOpenColorIO + :staticmethod: + + + .. py:method:: MatrixTransform.Scale(scale: List[float[4]]) -> PyOpenColorIO.MatrixTransform + :module: PyOpenColorIO + :staticmethod: + + + .. py:method:: MatrixTransform.View(channelHot: List[int[4]], lumaCoef: List[float[3]]) -> PyOpenColorIO.MatrixTransform + :module: PyOpenColorIO + :staticmethod: + + + .. py:method:: MatrixTransform.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.MatrixTransform) -> None + + 2. __init__(self: PyOpenColorIO.MatrixTransform, matrix: List[float[16]] = [1.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 1.0], offset: List[float[4]] = [0.0, 0.0, 0.0, 0.0], direction: PyOpenColorIO.TransformDirection = ) -> None + + + .. py:method:: MatrixTransform.equals(self: PyOpenColorIO.MatrixTransform, other: PyOpenColorIO.MatrixTransform) -> bool + :module: PyOpenColorIO + + Checks if this exactly equals other. + + + .. py:method:: MatrixTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection + :module: PyOpenColorIO + + + .. py:method:: MatrixTransform.getFileInputBitDepth(self: PyOpenColorIO.MatrixTransform) -> PyOpenColorIO.BitDepth + :module: PyOpenColorIO + + Get the bit-depths associated with the matrix values read from a file or set the bit-depths of values to be written to a file (for file formats such as CLF that support multiple bit-depths). + + In a format such as CLF, the matrix values are scaled to take pixels at the specified inBitDepth to pixels at the specified outBitDepth. This complicates the interpretation of the matrix values and so this object always holds normalized values and scaling is done on the way from or to file formats such as CLF. + + + .. py:method:: MatrixTransform.getFileOutputBitDepth(self: PyOpenColorIO.MatrixTransform) -> PyOpenColorIO.BitDepth + :module: PyOpenColorIO + + + .. py:method:: MatrixTransform.getFormatMetadata(self: PyOpenColorIO.MatrixTransform) -> PyOpenColorIO.FormatMetadata + :module: PyOpenColorIO + + + .. py:method:: MatrixTransform.getMatrix(self: PyOpenColorIO.MatrixTransform) -> List[float[16]] + :module: PyOpenColorIO + + + .. py:method:: MatrixTransform.getOffset(self: PyOpenColorIO.MatrixTransform) -> List[float[4]] + :module: PyOpenColorIO + + + .. py:method:: MatrixTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType + :module: PyOpenColorIO + + + .. py:method:: MatrixTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None + :module: PyOpenColorIO + + Note that this only affects the evaluation and not the values stored in the object. + + + .. py:method:: MatrixTransform.setFileInputBitDepth(self: PyOpenColorIO.MatrixTransform, bitDepth: PyOpenColorIO.BitDepth) -> None + :module: PyOpenColorIO + + + .. py:method:: MatrixTransform.setFileOutputBitDepth(self: PyOpenColorIO.MatrixTransform, bitDepth: PyOpenColorIO.BitDepth) -> None + :module: PyOpenColorIO + + + .. py:method:: MatrixTransform.setMatrix(self: PyOpenColorIO.MatrixTransform, matrix: List[float[16]]) -> None + :module: PyOpenColorIO + + Get or set the values of a Matrix. Expects 16 values, where the first four are the coefficients to generate the R output channel from R, G, B, A input channels. + + The Matrix values are always for the "forward" Matrix, regardless of how the transform direction is set. + + These values are normalized relative to what may be stored in file formats such as CLF. For example in a CLF file using a "32f" input depth and "10i" output depth, a value of 1023 in the file is normalized to 1.0. The values here are unclamped and may extend outside [0,1]. + + + .. py:method:: MatrixTransform.setOffset(self: PyOpenColorIO.MatrixTransform, offset: List[float[4]]) -> None + :module: PyOpenColorIO + + Get or set the R, G, B, A offsets to be applied after the matrix. + + These values are normalized relative to what may be stored in file formats such as CLF. For example, in a CLF file using a "10i" output depth, a value of 1023 in the file is normalized to 1.0. The values here are unclamped and may extend outside [0,1]. + + + .. py:method:: MatrixTransform.validate(self: PyOpenColorIO.Transform) -> None + :module: PyOpenColorIO + + Will throw if data is not valid. + diff --git a/docs/api/python/frozen/pyopencolorio_mixingcolorspacemanager.rst b/docs/api/python/frozen/pyopencolorio_mixingcolorspacemanager.rst index 8f7fe7ca98..c867dae900 100644 --- a/docs/api/python/frozen/pyopencolorio_mixingcolorspacemanager.rst +++ b/docs/api/python/frozen/pyopencolorio_mixingcolorspacemanager.rst @@ -5,32 +5,31 @@ .. py:class:: MixingColorSpaceManager :module: PyOpenColorIO - :canonical: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager Used to mix (or pick/choose) colors. - .. py:method:: MixingColorSpaceManager.__init__(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager, config: PyOpenColorIO.PyOpenColorIO.Config) -> None + .. py:method:: MixingColorSpaceManager.__init__(self: PyOpenColorIO.MixingColorSpaceManager, config: PyOpenColorIO.Config) -> None :module: PyOpenColorIO - .. py:method:: MixingColorSpaceManager.getMixingEncodings(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager) -> PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager.MixingEncodingIterator + .. py:method:: MixingColorSpaceManager.getMixingEncodings(self: PyOpenColorIO.MixingColorSpaceManager) -> PyOpenColorIO.MixingColorSpaceManager.MixingEncodingIterator :module: PyOpenColorIO - .. py:method:: MixingColorSpaceManager.getMixingSpaces(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager) -> PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator + .. py:method:: MixingColorSpaceManager.getMixingSpaces(self: PyOpenColorIO.MixingColorSpaceManager) -> PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator :module: PyOpenColorIO - .. py:method:: MixingColorSpaceManager.getProcessor(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager, workingSpaceName: str, displayName: str, viewName: str, direction: PyOpenColorIO.PyOpenColorIO.TransformDirection = ) -> PyOpenColorIO.PyOpenColorIO.Processor + .. py:method:: MixingColorSpaceManager.getProcessor(self: PyOpenColorIO.MixingColorSpaceManager, workingSpaceName: str, displayName: str, viewName: str, direction: PyOpenColorIO.TransformDirection = ) -> PyOpenColorIO.Processor :module: PyOpenColorIO - .. py:method:: MixingColorSpaceManager.getSelectedMixingEncodingIdx(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager) -> int + .. py:method:: MixingColorSpaceManager.getSelectedMixingEncodingIdx(self: PyOpenColorIO.MixingColorSpaceManager) -> int :module: PyOpenColorIO - .. py:method:: MixingColorSpaceManager.getSelectedMixingSpaceIdx(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager) -> int + .. py:method:: MixingColorSpaceManager.getSelectedMixingSpaceIdx(self: PyOpenColorIO.MixingColorSpaceManager) -> int :module: PyOpenColorIO @@ -39,75 +38,73 @@ Overloaded function. - 1. getSlider(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager) -> PyOpenColorIO.PyOpenColorIO.MixingSlider + 1. getSlider(self: PyOpenColorIO.MixingColorSpaceManager) -> PyOpenColorIO.MixingSlider - 2. getSlider(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager, sliderMixingMinEdge: float, sliderMixingMaxEdge: float) -> PyOpenColorIO.PyOpenColorIO.MixingSlider + 2. getSlider(self: PyOpenColorIO.MixingColorSpaceManager, sliderMixingMinEdge: float, sliderMixingMaxEdge: float) -> PyOpenColorIO.MixingSlider - .. py:method:: MixingColorSpaceManager.isPerceptuallyUniform(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager) -> bool + .. py:method:: MixingColorSpaceManager.isPerceptuallyUniform(self: PyOpenColorIO.MixingColorSpaceManager) -> bool :module: PyOpenColorIO - .. py:method:: MixingColorSpaceManager.refresh(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager, config: PyOpenColorIO.PyOpenColorIO.Config) -> None + .. py:method:: MixingColorSpaceManager.refresh(self: PyOpenColorIO.MixingColorSpaceManager, config: PyOpenColorIO.Config) -> None :module: PyOpenColorIO Refresh the instance (i.e. needed following a configuration change for example). - .. py:method:: MixingColorSpaceManager.setSelectedMixingEncoding(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager, mixingEncoding: str) -> None + .. py:method:: MixingColorSpaceManager.setSelectedMixingEncoding(self: PyOpenColorIO.MixingColorSpaceManager, mixingEncoding: str) -> None :module: PyOpenColorIO - .. py:method:: MixingColorSpaceManager.setSelectedMixingEncodingIdx(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager, arg0: int) -> None + .. py:method:: MixingColorSpaceManager.setSelectedMixingEncodingIdx(self: PyOpenColorIO.MixingColorSpaceManager, arg0: int) -> None :module: PyOpenColorIO - .. py:method:: MixingColorSpaceManager.setSelectedMixingSpace(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager, mixingSpace: str) -> None + .. py:method:: MixingColorSpaceManager.setSelectedMixingSpace(self: PyOpenColorIO.MixingColorSpaceManager, mixingSpace: str) -> None :module: PyOpenColorIO - .. py:method:: MixingColorSpaceManager.setSelectedMixingSpaceIdx(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager, arg0: int) -> None + .. py:method:: MixingColorSpaceManager.setSelectedMixingSpaceIdx(self: PyOpenColorIO.MixingColorSpaceManager, arg0: int) -> None :module: PyOpenColorIO .. py:class:: MixingSpaceIterator :module: PyOpenColorIO.MixingColorSpaceManager - :canonical: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator - .. py:method:: MixingSpaceIterator.__getitem__(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator, arg0: int) -> str + .. py:method:: MixingSpaceIterator.__getitem__(self: PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator, arg0: int) -> str :module: PyOpenColorIO.MixingColorSpaceManager - .. py:method:: MixingSpaceIterator.__iter__(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator) -> PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator + .. py:method:: MixingSpaceIterator.__iter__(self: PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator) -> PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator :module: PyOpenColorIO.MixingColorSpaceManager - .. py:method:: MixingSpaceIterator.__len__(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator) -> int + .. py:method:: MixingSpaceIterator.__len__(self: PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator) -> int :module: PyOpenColorIO.MixingColorSpaceManager - .. py:method:: MixingSpaceIterator.__next__(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator) -> str + .. py:method:: MixingSpaceIterator.__next__(self: PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator) -> str :module: PyOpenColorIO.MixingColorSpaceManager .. py:class:: MixingEncodingIterator :module: PyOpenColorIO.MixingColorSpaceManager - :canonical: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager.MixingEncodingIterator - .. py:method:: MixingEncodingIterator.__getitem__(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager.MixingEncodingIterator, arg0: int) -> str + .. py:method:: MixingEncodingIterator.__getitem__(self: PyOpenColorIO.MixingColorSpaceManager.MixingEncodingIterator, arg0: int) -> str :module: PyOpenColorIO.MixingColorSpaceManager - .. py:method:: MixingEncodingIterator.__iter__(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager.MixingEncodingIterator) -> PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager.MixingEncodingIterator + .. py:method:: MixingEncodingIterator.__iter__(self: PyOpenColorIO.MixingColorSpaceManager.MixingEncodingIterator) -> PyOpenColorIO.MixingColorSpaceManager.MixingEncodingIterator :module: PyOpenColorIO.MixingColorSpaceManager - .. py:method:: MixingEncodingIterator.__len__(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager.MixingEncodingIterator) -> int + .. py:method:: MixingEncodingIterator.__len__(self: PyOpenColorIO.MixingColorSpaceManager.MixingEncodingIterator) -> int :module: PyOpenColorIO.MixingColorSpaceManager - .. py:method:: MixingEncodingIterator.__next__(self: PyOpenColorIO.PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator) -> str + .. py:method:: MixingEncodingIterator.__next__(self: PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator) -> str :module: PyOpenColorIO.MixingColorSpaceManager diff --git a/docs/api/python/frozen/pyopencolorio_mixingslider.rst b/docs/api/python/frozen/pyopencolorio_mixingslider.rst index e9537518ea..4c7c09cc8c 100644 --- a/docs/api/python/frozen/pyopencolorio_mixingslider.rst +++ b/docs/api/python/frozen/pyopencolorio_mixingslider.rst @@ -5,7 +5,6 @@ .. py:class:: MixingSlider :module: PyOpenColorIO - :canonical: PyOpenColorIO.PyOpenColorIO.MixingSlider The :ref:`MixingSlider` and :ref:`MixingColorSpaceManager` classes are to help applications implement correct color pickers. The term "color mixing" is used here to describe what is done in a typical application "color picker" user interface. @@ -22,37 +21,37 @@ :module: PyOpenColorIO - .. py:method:: MixingSlider.getSliderMaxEdge(self: PyOpenColorIO.PyOpenColorIO.MixingSlider) -> float + .. py:method:: MixingSlider.getSliderMaxEdge(self: PyOpenColorIO.MixingSlider) -> float :module: PyOpenColorIO Maximum edge of a UI slider for conversion to mixing space. - .. py:method:: MixingSlider.getSliderMinEdge(self: PyOpenColorIO.PyOpenColorIO.MixingSlider) -> float + .. py:method:: MixingSlider.getSliderMinEdge(self: PyOpenColorIO.MixingSlider) -> float :module: PyOpenColorIO Minimum edge of a UI slider for conversion to mixing space. - .. py:method:: MixingSlider.mixingToSlider(self: PyOpenColorIO.PyOpenColorIO.MixingSlider, mixingUnits: float) -> float + .. py:method:: MixingSlider.mixingToSlider(self: PyOpenColorIO.MixingSlider, mixingUnits: float) -> float :module: PyOpenColorIO Convert from mixing space units to distance along the slider. - .. py:method:: MixingSlider.setSliderMaxEdge(self: PyOpenColorIO.PyOpenColorIO.MixingSlider, arg0: float) -> None + .. py:method:: MixingSlider.setSliderMaxEdge(self: PyOpenColorIO.MixingSlider, arg0: float) -> None :module: PyOpenColorIO Set the maximum edge of a UI slider for conversion to mixing space. - .. py:method:: MixingSlider.setSliderMinEdge(self: PyOpenColorIO.PyOpenColorIO.MixingSlider, arg0: float) -> None + .. py:method:: MixingSlider.setSliderMinEdge(self: PyOpenColorIO.MixingSlider, arg0: float) -> None :module: PyOpenColorIO Set the minimum edge of a UI slider for conversion to mixing space. - .. py:method:: MixingSlider.sliderToMixing(self: PyOpenColorIO.PyOpenColorIO.MixingSlider, sliderUnits: float) -> float + .. py:method:: MixingSlider.sliderToMixing(self: PyOpenColorIO.MixingSlider, sliderUnits: float) -> float :module: PyOpenColorIO Convert from units in distance along the slider to mixing space units. diff --git a/docs/api/python/frozen/pyopencolorio_namedtransform.rst b/docs/api/python/frozen/pyopencolorio_namedtransform.rst new file mode 100644 index 0000000000..3a0a7630e5 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_namedtransform.rst @@ -0,0 +1,158 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: NamedTransform + :module: PyOpenColorIO + + :ref:`NamedTransform`. + + A :ref:`NamedTransform` provides a way for config authors to include a set of color transforms that are independent of the color space being processed. For example a "utility + curve" transform where there is no need to convert to or from a reference space. + + + .. py:method:: NamedTransform.GetTransform(transform: PyOpenColorIO.NamedTransform, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Transform + :module: PyOpenColorIO + :staticmethod: + + Get the requested transform, creating the transform from the inverse direction if the transform for the requested direction is missing. + + + .. py:class:: NamedTransform.NamedTransformAliasIterator + :module: PyOpenColorIO + + + .. py:method:: NamedTransform.NamedTransformAliasIterator.__init__(*args, **kwargs) + :module: PyOpenColorIO + + + .. py:method:: NamedTransform.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.NamedTransform) -> None + + 2. __init__(self: PyOpenColorIO.NamedTransform, name: str = '', aliases: List[str] = [], family: str = '', description: str = '', forwardTransform: PyOpenColorIO.Transform = None, inverseTransform: PyOpenColorIO.Transform = None, categories: List[str] = []) -> None + + + .. py:method:: NamedTransform.addAlias(self: PyOpenColorIO.NamedTransform, alias: str) -> None + :module: PyOpenColorIO + + Nothing is done if alias is NULL or empty, if it is already there, or if it is already the named transform name. + + + .. py:method:: NamedTransform.addCategory(self: PyOpenColorIO.NamedTransform, category: str) -> None + :module: PyOpenColorIO + + .. see:: + :ref:`ColorSpace::addCategory` + + + .. py:method:: NamedTransform.clearAliases(self: PyOpenColorIO.NamedTransform) -> None + :module: PyOpenColorIO + + + .. py:method:: NamedTransform.clearCategories(self: PyOpenColorIO.NamedTransform) -> None + :module: PyOpenColorIO + + .. see:: + :ref:`ColorSpace::clearCategories` + + + .. py:method:: NamedTransform.getAliases(self: PyOpenColorIO.NamedTransform) -> PyOpenColorIO.NamedTransform.NamedTransformAliasIterator + :module: PyOpenColorIO + + + .. py:method:: NamedTransform.getCategories(self: PyOpenColorIO.NamedTransform) -> PyOpenColorIO.NamedTransform.NamedTransformCategoryIterator + :module: PyOpenColorIO + + + .. py:method:: NamedTransform.getDescription(self: PyOpenColorIO.NamedTransform) -> str + :module: PyOpenColorIO + + + .. py:method:: NamedTransform.getEncoding(self: PyOpenColorIO.NamedTransform) -> str + :module: PyOpenColorIO + + A :ref:`NamedTransform` is not a color space and does not have an encoding in the same sense. However, it may be useful to associate a color space encoding that the transform is intended to be used with, for organizational purposes. + + + .. py:method:: NamedTransform.getFamily(self: PyOpenColorIO.NamedTransform) -> str + :module: PyOpenColorIO + + .. see:: + :ref:`ColorSpace::getFamily` + + + .. py:method:: NamedTransform.getName(self: PyOpenColorIO.NamedTransform) -> str + :module: PyOpenColorIO + + + .. py:method:: NamedTransform.getTransform(self: PyOpenColorIO.NamedTransform, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Transform + :module: PyOpenColorIO + + + .. py:method:: NamedTransform.hasCategory(self: PyOpenColorIO.NamedTransform, category: str) -> bool + :module: PyOpenColorIO + + .. see:: + :ref:`ColorSpace::hasCategory` + + + .. py:method:: NamedTransform.removeAlias(self: PyOpenColorIO.NamedTransform, alias: str) -> None + :module: PyOpenColorIO + + Does nothing if alias is not present. + + + .. py:method:: NamedTransform.removeCategory(self: PyOpenColorIO.NamedTransform, category: str) -> None + :module: PyOpenColorIO + + .. see:: + :ref:`ColorSpace::removeCategory` + + + .. py:method:: NamedTransform.setDescription(self: PyOpenColorIO.NamedTransform, description: str) -> None + :module: PyOpenColorIO + + + .. py:method:: NamedTransform.setEncoding(self: PyOpenColorIO.NamedTransform, encoding: str) -> None + :module: PyOpenColorIO + + + .. py:method:: NamedTransform.setFamily(self: PyOpenColorIO.NamedTransform, family: str) -> None + :module: PyOpenColorIO + + .. see:: + :ref:`ColorSpace::setFamily` + + + .. py:method:: NamedTransform.setName(self: PyOpenColorIO.NamedTransform, name: str) -> None + :module: PyOpenColorIO + + + .. py:method:: NamedTransform.setTransform(self: PyOpenColorIO.NamedTransform, transform: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None + :module: PyOpenColorIO + + +.. py:class:: NamedTransformCategoryIterator + :module: PyOpenColorIO.NamedTransform + + + .. py:method:: NamedTransformCategoryIterator.__getitem__(self: PyOpenColorIO.NamedTransform.NamedTransformCategoryIterator, arg0: int) -> str + :module: PyOpenColorIO.NamedTransform + + + .. py:method:: NamedTransformCategoryIterator.__iter__(self: PyOpenColorIO.NamedTransform.NamedTransformCategoryIterator) -> PyOpenColorIO.NamedTransform.NamedTransformCategoryIterator + :module: PyOpenColorIO.NamedTransform + + + .. py:method:: NamedTransformCategoryIterator.__len__(self: PyOpenColorIO.NamedTransform.NamedTransformCategoryIterator) -> int + :module: PyOpenColorIO.NamedTransform + + + .. py:method:: NamedTransformCategoryIterator.__next__(self: PyOpenColorIO.NamedTransform.NamedTransformCategoryIterator) -> str + :module: PyOpenColorIO.NamedTransform + diff --git a/docs/api/python/frozen/pyopencolorio_namedtransformvisibility.rst b/docs/api/python/frozen/pyopencolorio_namedtransformvisibility.rst new file mode 100644 index 0000000000..81b25b1286 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_namedtransformvisibility.rst @@ -0,0 +1,37 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: NamedTransformVisibility + :module: PyOpenColorIO + + Members: + + NAMEDTRANSFORM_ACTIVE : + + NAMEDTRANSFORM_INACTIVE : + + NAMEDTRANSFORM_ALL : + + .. py:method:: name() -> str + :property: + + .. py:attribute:: NamedTransformVisibility.NAMEDTRANSFORM_ACTIVE + :module: PyOpenColorIO + :value: + + + .. py:attribute:: NamedTransformVisibility.NAMEDTRANSFORM_ALL + :module: PyOpenColorIO + :value: + + + .. py:attribute:: NamedTransformVisibility.NAMEDTRANSFORM_INACTIVE + :module: PyOpenColorIO + :value: + + + .. py:property:: NamedTransformVisibility.value + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_negativestyle.rst b/docs/api/python/frozen/pyopencolorio_negativestyle.rst new file mode 100644 index 0000000000..13d8c4d8fa --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_negativestyle.rst @@ -0,0 +1,46 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: NegativeStyle + :module: PyOpenColorIO + + Negative values handling style for :ref:`ExponentTransform` and :ref:`ExponentWithLinearTransform` transform algorithms. + + Members: + + NEGATIVE_CLAMP : Clamp negative values. + + NEGATIVE_MIRROR : Positive curve is rotated 180 degrees around the origin to handle negatives. + + NEGATIVE_PASS_THRU : Negative values are passed through unchanged. + + NEGATIVE_LINEAR : Linearly extrapolate the curve for negative values. + + .. py:method:: name() -> str + :property: + + .. py:attribute:: NegativeStyle.NEGATIVE_CLAMP + :module: PyOpenColorIO + :value: + + + .. py:attribute:: NegativeStyle.NEGATIVE_LINEAR + :module: PyOpenColorIO + :value: + + + .. py:attribute:: NegativeStyle.NEGATIVE_MIRROR + :module: PyOpenColorIO + :value: + + + .. py:attribute:: NegativeStyle.NEGATIVE_PASS_THRU + :module: PyOpenColorIO + :value: + + + .. py:property:: NegativeStyle.value + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_negativestylefromstring.rst b/docs/api/python/frozen/pyopencolorio_negativestylefromstring.rst new file mode 100644 index 0000000000..8645b46573 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_negativestylefromstring.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: NegativeStyleFromString(str: str) -> PyOpenColorIO.NegativeStyle + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_negativestyletostring.rst b/docs/api/python/frozen/pyopencolorio_negativestyletostring.rst new file mode 100644 index 0000000000..0d01441e25 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_negativestyletostring.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: NegativeStyleToString(style: PyOpenColorIO.NegativeStyle) -> str + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_optimizationflags.rst b/docs/api/python/frozen/pyopencolorio_optimizationflags.rst new file mode 100644 index 0000000000..3d7d680f38 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_optimizationflags.rst @@ -0,0 +1,214 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: OptimizationFlags + :module: PyOpenColorIO + + Provides control over how the ops in a :ref:`Processor` are combined in order to improve performance. + + Members: + + OPTIMIZATION_NONE : Do not optimize. + + OPTIMIZATION_IDENTITY : Replace identity ops (other than gamma). + + OPTIMIZATION_IDENTITY_GAMMA : Replace identity gamma ops. + + OPTIMIZATION_PAIR_IDENTITY_CDL : Replace a pair of ops where one is the inverse of the other. + + OPTIMIZATION_PAIR_IDENTITY_EXPOSURE_CONTRAST : + + OPTIMIZATION_PAIR_IDENTITY_FIXED_FUNCTION : + + OPTIMIZATION_PAIR_IDENTITY_GAMMA : + + OPTIMIZATION_PAIR_IDENTITY_LUT1D : + + OPTIMIZATION_PAIR_IDENTITY_LUT3D : + + OPTIMIZATION_PAIR_IDENTITY_LOG : + + OPTIMIZATION_PAIR_IDENTITY_GRADING : + + OPTIMIZATION_COMP_EXPONENT : Compose a pair of ops into a single op. + + OPTIMIZATION_COMP_GAMMA : + + OPTIMIZATION_COMP_MATRIX : + + OPTIMIZATION_COMP_LUT1D : + + OPTIMIZATION_COMP_LUT3D : + + OPTIMIZATION_COMP_RANGE : + + OPTIMIZATION_COMP_SEPARABLE_PREFIX : For integer and half bit-depths only, replace separable ops (i.e. no channel crosstalk ops) by a single 1D LUT of input bit-depth domain. + + OPTIMIZATION_LUT_INV_FAST : Implement inverse Lut1D and Lut3D evaluations using a a forward LUT (faster but less accurate). Note that GPU evals always do FAST. + + OPTIMIZATION_FAST_LOG_EXP_POW : + + OPTIMIZATION_SIMPLIFY_OPS : + + OPTIMIZATION_NO_DYNAMIC_PROPERTIES : Turn off dynamic control of any ops that offer adjustment of parameter values after finalization (e.g. ExposureContrast). + + OPTIMIZATION_ALL : Apply all possible optimizations. + + OPTIMIZATION_LOSSLESS : + + OPTIMIZATION_VERY_GOOD : + + OPTIMIZATION_GOOD : + + OPTIMIZATION_DRAFT : For quite lossy optimizations. + + OPTIMIZATION_DEFAULT : + + .. py:method:: name() -> str + :property: + + .. py:attribute:: OptimizationFlags.OPTIMIZATION_ALL + :module: PyOpenColorIO + :value: + + + .. py:attribute:: OptimizationFlags.OPTIMIZATION_COMP_EXPONENT + :module: PyOpenColorIO + :value: + + + .. py:attribute:: OptimizationFlags.OPTIMIZATION_COMP_GAMMA + :module: PyOpenColorIO + :value: + + + .. py:attribute:: OptimizationFlags.OPTIMIZATION_COMP_LUT1D + :module: PyOpenColorIO + :value: + + + .. py:attribute:: OptimizationFlags.OPTIMIZATION_COMP_LUT3D + :module: PyOpenColorIO + :value: + + + .. py:attribute:: OptimizationFlags.OPTIMIZATION_COMP_MATRIX + :module: PyOpenColorIO + :value: + + + .. py:attribute:: OptimizationFlags.OPTIMIZATION_COMP_RANGE + :module: PyOpenColorIO + :value: + + + .. py:attribute:: OptimizationFlags.OPTIMIZATION_COMP_SEPARABLE_PREFIX + :module: PyOpenColorIO + :value: + + + .. py:attribute:: OptimizationFlags.OPTIMIZATION_DEFAULT + :module: PyOpenColorIO + :value: + + + .. py:attribute:: OptimizationFlags.OPTIMIZATION_DRAFT + :module: PyOpenColorIO + :value: + + + .. py:attribute:: OptimizationFlags.OPTIMIZATION_FAST_LOG_EXP_POW + :module: PyOpenColorIO + :value: + + + .. py:attribute:: OptimizationFlags.OPTIMIZATION_GOOD + :module: PyOpenColorIO + :value: + + + .. py:attribute:: OptimizationFlags.OPTIMIZATION_IDENTITY + :module: PyOpenColorIO + :value: + + + .. py:attribute:: OptimizationFlags.OPTIMIZATION_IDENTITY_GAMMA + :module: PyOpenColorIO + :value: + + + .. py:attribute:: OptimizationFlags.OPTIMIZATION_LOSSLESS + :module: PyOpenColorIO + :value: + + + .. py:attribute:: OptimizationFlags.OPTIMIZATION_LUT_INV_FAST + :module: PyOpenColorIO + :value: + + + .. py:attribute:: OptimizationFlags.OPTIMIZATION_NONE + :module: PyOpenColorIO + :value: + + + .. py:attribute:: OptimizationFlags.OPTIMIZATION_NO_DYNAMIC_PROPERTIES + :module: PyOpenColorIO + :value: + + + .. py:attribute:: OptimizationFlags.OPTIMIZATION_PAIR_IDENTITY_CDL + :module: PyOpenColorIO + :value: + + + .. py:attribute:: OptimizationFlags.OPTIMIZATION_PAIR_IDENTITY_EXPOSURE_CONTRAST + :module: PyOpenColorIO + :value: + + + .. py:attribute:: OptimizationFlags.OPTIMIZATION_PAIR_IDENTITY_FIXED_FUNCTION + :module: PyOpenColorIO + :value: + + + .. py:attribute:: OptimizationFlags.OPTIMIZATION_PAIR_IDENTITY_GAMMA + :module: PyOpenColorIO + :value: + + + .. py:attribute:: OptimizationFlags.OPTIMIZATION_PAIR_IDENTITY_GRADING + :module: PyOpenColorIO + :value: + + + .. py:attribute:: OptimizationFlags.OPTIMIZATION_PAIR_IDENTITY_LOG + :module: PyOpenColorIO + :value: + + + .. py:attribute:: OptimizationFlags.OPTIMIZATION_PAIR_IDENTITY_LUT1D + :module: PyOpenColorIO + :value: + + + .. py:attribute:: OptimizationFlags.OPTIMIZATION_PAIR_IDENTITY_LUT3D + :module: PyOpenColorIO + :value: + + + .. py:attribute:: OptimizationFlags.OPTIMIZATION_SIMPLIFY_OPS + :module: PyOpenColorIO + :value: + + + .. py:attribute:: OptimizationFlags.OPTIMIZATION_VERY_GOOD + :module: PyOpenColorIO + :value: + + + .. py:property:: OptimizationFlags.value + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_packedimagedesc.rst b/docs/api/python/frozen/pyopencolorio_packedimagedesc.rst new file mode 100644 index 0000000000..ffade9c4b4 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_packedimagedesc.rst @@ -0,0 +1,95 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: PackedImageDesc + :module: PyOpenColorIO + + All the constructors expect a pointer to packed image data (such as rgbrgbrgb or rgbargbargba) starting at the first color channel of the first pixel to process (which does not need to be the first pixel of the image). The number of channels must be greater than or equal to 3. If a 4th channel is specified, it is assumed to be alpha information. Channels > 4 will be ignored. + + .. note:: + The methods assume the :ref:`CPUProcessor` bit-depth type for the data pointer. + + + .. py:method:: PackedImageDesc.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.PackedImageDesc, data: buffer, width: int, height: int, numChannels: int) -> None + + .. note:: + numChannels must be 3 (RGB) or 4 (RGBA). + + 2. __init__(self: PyOpenColorIO.PackedImageDesc, data: buffer, width: int, height: int, numChannels: int, bitDepth: PyOpenColorIO.BitDepth, chanStrideBytes: int, xStrideBytes: int, yStrideBytes: int) -> None + + .. note:: + numChannels must be 3 (RGB) or 4 (RGBA). + + 3. __init__(self: PyOpenColorIO.PackedImageDesc, data: buffer, width: int, height: int, chanOrder: PyOpenColorIO.ChannelOrdering) -> None + + 4. __init__(self: PyOpenColorIO.PackedImageDesc, data: buffer, width: int, height: int, chanOrder: PyOpenColorIO.ChannelOrdering, bitDepth: PyOpenColorIO.BitDepth, chanStrideBytes: int, xStrideBytes: int, yStrideBytes: int) -> None + + + .. py:method:: PackedImageDesc.getBitDepth(self: PyOpenColorIO.ImageDesc) -> PyOpenColorIO.BitDepth + :module: PyOpenColorIO + + Get the bit-depth. + + + .. py:method:: PackedImageDesc.getChanStrideBytes(self: PyOpenColorIO.PackedImageDesc) -> int + :module: PyOpenColorIO + + + .. py:method:: PackedImageDesc.getChannelOrder(self: PyOpenColorIO.PackedImageDesc) -> PyOpenColorIO.ChannelOrdering + :module: PyOpenColorIO + + Get the channel ordering of all the pixels. + + + .. py:method:: PackedImageDesc.getData(self: PyOpenColorIO.PackedImageDesc) -> numpy.ndarray + :module: PyOpenColorIO + + Get a pointer to the first color channel of the first pixel. + + + .. py:method:: PackedImageDesc.getHeight(self: PyOpenColorIO.ImageDesc) -> int + :module: PyOpenColorIO + + Get the height to process (where y position starts at 0 and ends at height-1). + + + .. py:method:: PackedImageDesc.getNumChannels(self: PyOpenColorIO.PackedImageDesc) -> int + :module: PyOpenColorIO + + + .. py:method:: PackedImageDesc.getWidth(self: PyOpenColorIO.ImageDesc) -> int + :module: PyOpenColorIO + + Get the width to process (where x position starts at 0 and ends at width-1). + + + .. py:method:: PackedImageDesc.getXStrideBytes(self: PyOpenColorIO.ImageDesc) -> int + :module: PyOpenColorIO + + Get the step in bytes to find the same color channel of the next pixel. + + + .. py:method:: PackedImageDesc.getYStrideBytes(self: PyOpenColorIO.ImageDesc) -> int + :module: PyOpenColorIO + + Get the step in bytes to find the same color channel of the pixel at the same position in the next line. + + + .. py:method:: PackedImageDesc.isFloat(self: PyOpenColorIO.ImageDesc) -> bool + :module: PyOpenColorIO + + Is the image buffer 32-bit float? + + + .. py:method:: PackedImageDesc.isRGBAPacked(self: PyOpenColorIO.ImageDesc) -> bool + :module: PyOpenColorIO + + Is the image buffer in packed mode with the 4 color channels? ("Packed" here means that XStrideBytes is 4x the bytes per channel, so it is more specific than simply any :ref:`PackedImageDesc`.) + diff --git a/docs/api/python/frozen/pyopencolorio_planarimagedesc.rst b/docs/api/python/frozen/pyopencolorio_planarimagedesc.rst new file mode 100644 index 0000000000..e5cbb3c27f --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_planarimagedesc.rst @@ -0,0 +1,95 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: PlanarImageDesc + :module: PyOpenColorIO + + All the constructors expect pointers to the specified image planes (i.e. rrrr gggg bbbb) starting at the first color channel of the first pixel to process (which need not be the first pixel of the image). Pass NULL for aData if no alpha exists (r/g/bData must not be NULL). + + .. note:: + The methods assume the :ref:`CPUProcessor` bit-depth type for the R/G/B/A data pointers. + + + .. py:method:: PlanarImageDesc.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.PlanarImageDesc, rData: buffer, gData: buffer, bData: buffer, width: int, height: int) -> None + + 2. __init__(self: PyOpenColorIO.PlanarImageDesc, rData: buffer, gData: buffer, bData: buffer, aData: buffer, width: int, height: int) -> None + + Note that although :ref:`PlanarImageDesc` is powerful enough to also describe all :ref:`PackedImageDesc` scenarios, it is recommended to use a :ref:`PackedImageDesc` where possible since that allows for additional optimizations. + + 3. __init__(self: PyOpenColorIO.PlanarImageDesc, rData: buffer, gData: buffer, bData: buffer, width: int, height: int, bitDepth: PyOpenColorIO.BitDepth, xStrideBytes: int, yStrideBytes: int) -> None + + 4. __init__(self: PyOpenColorIO.PlanarImageDesc, rData: buffer, gData: buffer, bData: buffer, aData: buffer, width: int, height: int, bitDepth: PyOpenColorIO.BitDepth, xStrideBytes: int, yStrideBytes: int) -> None + + + .. py:method:: PlanarImageDesc.getAData(self: PyOpenColorIO.PlanarImageDesc) -> numpy.ndarray + :module: PyOpenColorIO + + Get a pointer to the alpha channel of the first pixel or null as alpha channel is optional. + + + .. py:method:: PlanarImageDesc.getBData(self: PyOpenColorIO.PlanarImageDesc) -> numpy.ndarray + :module: PyOpenColorIO + + Get a pointer to the blue channel of the first pixel. + + + .. py:method:: PlanarImageDesc.getBitDepth(self: PyOpenColorIO.ImageDesc) -> PyOpenColorIO.BitDepth + :module: PyOpenColorIO + + Get the bit-depth. + + + .. py:method:: PlanarImageDesc.getGData(self: PyOpenColorIO.PlanarImageDesc) -> numpy.ndarray + :module: PyOpenColorIO + + Get a pointer to the green channel of the first pixel. + + + .. py:method:: PlanarImageDesc.getHeight(self: PyOpenColorIO.ImageDesc) -> int + :module: PyOpenColorIO + + Get the height to process (where y position starts at 0 and ends at height-1). + + + .. py:method:: PlanarImageDesc.getRData(self: PyOpenColorIO.PlanarImageDesc) -> numpy.ndarray + :module: PyOpenColorIO + + Get a pointer to the red channel of the first pixel. + + + .. py:method:: PlanarImageDesc.getWidth(self: PyOpenColorIO.ImageDesc) -> int + :module: PyOpenColorIO + + Get the width to process (where x position starts at 0 and ends at width-1). + + + .. py:method:: PlanarImageDesc.getXStrideBytes(self: PyOpenColorIO.ImageDesc) -> int + :module: PyOpenColorIO + + Get the step in bytes to find the same color channel of the next pixel. + + + .. py:method:: PlanarImageDesc.getYStrideBytes(self: PyOpenColorIO.ImageDesc) -> int + :module: PyOpenColorIO + + Get the step in bytes to find the same color channel of the pixel at the same position in the next line. + + + .. py:method:: PlanarImageDesc.isFloat(self: PyOpenColorIO.ImageDesc) -> bool + :module: PyOpenColorIO + + Is the image buffer 32-bit float? + + + .. py:method:: PlanarImageDesc.isRGBAPacked(self: PyOpenColorIO.ImageDesc) -> bool + :module: PyOpenColorIO + + Is the image buffer in packed mode with the 4 color channels? ("Packed" here means that XStrideBytes is 4x the bytes per channel, so it is more specific than simply any :ref:`PackedImageDesc`.) + diff --git a/docs/api/python/frozen/pyopencolorio_processor.rst b/docs/api/python/frozen/pyopencolorio_processor.rst index c83510b0c4..360f8c82a9 100644 --- a/docs/api/python/frozen/pyopencolorio_processor.rst +++ b/docs/api/python/frozen/pyopencolorio_processor.rst @@ -5,7 +5,6 @@ .. py:class:: Processor :module: PyOpenColorIO - :canonical: PyOpenColorIO.PyOpenColorIO.Processor The *:ref:`Processor`* represents a specific color transformation which is the result of :ref:`Config::getProcessor`. @@ -14,19 +13,17 @@ :module: PyOpenColorIO - .. py:method:: Processor.createGroupTransform(self: PyOpenColorIO.PyOpenColorIO.Processor) -> PyOpenColorIO.PyOpenColorIO.GroupTransform + .. py:method:: Processor.createGroupTransform(self: PyOpenColorIO.Processor) -> PyOpenColorIO.GroupTransform :module: PyOpenColorIO Return a :ref:`GroupTransform` that contains a copy of the transforms that comprise the processor. (Changes to it will not modify the original processor.) Note that the :ref:`GroupTransform::write` method may be used to serialize a :ref:`Processor`. Serializing to CTF format is a useful technique for debugging :ref:`Processor` contents. - .. py:method:: Processor.getCacheID(self: PyOpenColorIO.PyOpenColorIO.Processor) -> str + .. py:method:: Processor.getCacheID(self: PyOpenColorIO.Processor) -> str :module: PyOpenColorIO - Returns a hash string generated by hashing the cachedIDs of the (unoptimized) list of ops contained in the :ref:`Processor`. (This forms part of the key used by the config's processor cache.) - - .. py:method:: Processor.getDefaultCPUProcessor(self: PyOpenColorIO.PyOpenColorIO.Processor) -> PyOpenColorIO.PyOpenColorIO.CPUProcessor + .. py:method:: Processor.getDefaultCPUProcessor(self: PyOpenColorIO.Processor) -> PyOpenColorIO.CPUProcessor :module: PyOpenColorIO Get an optimized :ref:`CPUProcessor` instance. @@ -51,13 +48,13 @@ cpuProcessor->apply(img); - .. py:method:: Processor.getDefaultGPUProcessor(self: PyOpenColorIO.PyOpenColorIO.Processor) -> PyOpenColorIO.PyOpenColorIO.GPUProcessor + .. py:method:: Processor.getDefaultGPUProcessor(self: PyOpenColorIO.Processor) -> PyOpenColorIO.GPUProcessor :module: PyOpenColorIO Get an optimized :ref:`GPUProcessor` instance. - .. py:method:: Processor.getDynamicProperty(self: PyOpenColorIO.PyOpenColorIO.Processor, type: PyOpenColorIO.PyOpenColorIO.DynamicPropertyType) -> PyOpenColorIO.PyOpenColorIO.DynamicProperty + .. py:method:: Processor.getDynamicProperty(self: PyOpenColorIO.Processor, type: PyOpenColorIO.DynamicPropertyType) -> PyOpenColorIO.DynamicProperty :module: PyOpenColorIO The returned pointer may be used to set the default value of any dynamic properties of the requested type. Throws if the requested property is not found. Note that if the processor contains several ops that support the requested property, only one can be dynamic and only this one will be controlled. @@ -66,7 +63,7 @@ The dynamic properties are a convenient way to change on-the-fly values without generating again and again a CPU or GPU processor instance. Color transformations can contain dynamic properties from a :ref:`ExposureContrastTransform` for example. So, :ref:`Processor`, :ref:`CPUProcessor` and :ref:`GpuShaderCreator` all have ways to manage dynamic properties. However, the transform dynamic properties are decoupled between the types of processor instances so that the same :ref:`Processor` can generate several independent CPU and/or GPU processor instances i.e. changing the value of the exposure dynamic property from a CPU processor instance does not affect the corresponding GPU processor instance. :ref:`Processor` creation will log a warning if there are more than one property of a given type. There may be more than one property of a given type, but only one will respond to parameter updates, the others will use their original parameter values. - .. py:method:: Processor.getFormatMetadata(self: PyOpenColorIO.PyOpenColorIO.Processor) -> PyOpenColorIO.PyOpenColorIO.FormatMetadata + .. py:method:: Processor.getFormatMetadata(self: PyOpenColorIO.Processor) -> PyOpenColorIO.FormatMetadata :module: PyOpenColorIO Get a :ref:`FormatMetadata` containing the top level metadata for the processor. For a processor from a CLF file, this corresponds to the ProcessList metadata. @@ -77,12 +74,12 @@ Overloaded function. - 1. getOptimizedCPUProcessor(self: PyOpenColorIO.PyOpenColorIO.Processor, oFlags: PyOpenColorIO.PyOpenColorIO.OptimizationFlags) -> PyOpenColorIO.PyOpenColorIO.CPUProcessor + 1. getOptimizedCPUProcessor(self: PyOpenColorIO.Processor, oFlags: PyOpenColorIO.OptimizationFlags) -> PyOpenColorIO.CPUProcessor - 2. getOptimizedCPUProcessor(self: PyOpenColorIO.PyOpenColorIO.Processor, inBitDepth: PyOpenColorIO.PyOpenColorIO.BitDepth, outBitDepth: PyOpenColorIO.PyOpenColorIO.BitDepth, oFlags: PyOpenColorIO.PyOpenColorIO.OptimizationFlags) -> PyOpenColorIO.PyOpenColorIO.CPUProcessor + 2. getOptimizedCPUProcessor(self: PyOpenColorIO.Processor, inBitDepth: PyOpenColorIO.BitDepth, outBitDepth: PyOpenColorIO.BitDepth, oFlags: PyOpenColorIO.OptimizationFlags) -> PyOpenColorIO.CPUProcessor - .. py:method:: Processor.getOptimizedGPUProcessor(self: PyOpenColorIO.PyOpenColorIO.Processor, oFlags: PyOpenColorIO.PyOpenColorIO.OptimizationFlags) -> PyOpenColorIO.PyOpenColorIO.GPUProcessor + .. py:method:: Processor.getOptimizedGPUProcessor(self: PyOpenColorIO.Processor, oFlags: PyOpenColorIO.OptimizationFlags) -> PyOpenColorIO.GPUProcessor :module: PyOpenColorIO @@ -91,64 +88,63 @@ Overloaded function. - 1. getOptimizedProcessor(self: PyOpenColorIO.PyOpenColorIO.Processor, oFlags: PyOpenColorIO.PyOpenColorIO.OptimizationFlags) -> PyOpenColorIO.PyOpenColorIO.Processor + 1. getOptimizedProcessor(self: PyOpenColorIO.Processor, oFlags: PyOpenColorIO.OptimizationFlags) -> PyOpenColorIO.Processor Run the optimizer on a :ref:`Processor` to create a new :ref:`Processor`. It is usually not necessary to call this since getting a :ref:`CPUProcessor` or :ref:`GPUProcessor` will also optimize. However if you need both, calling this method first makes getting a CPU and GPU :ref:`Processor` faster since the optimization is effectively only done once. - 2. getOptimizedProcessor(self: PyOpenColorIO.PyOpenColorIO.Processor, inBitDepth: PyOpenColorIO.PyOpenColorIO.BitDepth, outBitDepth: PyOpenColorIO.PyOpenColorIO.BitDepth, oFlags: PyOpenColorIO.PyOpenColorIO.OptimizationFlags) -> PyOpenColorIO.PyOpenColorIO.Processor + 2. getOptimizedProcessor(self: PyOpenColorIO.Processor, inBitDepth: PyOpenColorIO.BitDepth, outBitDepth: PyOpenColorIO.BitDepth, oFlags: PyOpenColorIO.OptimizationFlags) -> PyOpenColorIO.Processor Run the optimizer on a :ref:`Processor` to create a new :ref:`Processor`. It is usually not necessary to call this since getting a :ref:`CPUProcessor` or :ref:`GPUProcessor` will also optimize. However if you need both, calling this method first makes getting a CPU and GPU :ref:`Processor` faster since the optimization is effectively only done once. - .. py:method:: Processor.getProcessorMetadata(self: PyOpenColorIO.PyOpenColorIO.Processor) -> PyOpenColorIO.PyOpenColorIO.ProcessorMetadata + .. py:method:: Processor.getProcessorMetadata(self: PyOpenColorIO.Processor) -> PyOpenColorIO.ProcessorMetadata :module: PyOpenColorIO The :ref:`ProcessorMetadata` contains technical information such as the number of files and looks used in the processor. - .. py:method:: Processor.getTransformFormatMetadata(self: PyOpenColorIO.PyOpenColorIO.Processor) -> PyOpenColorIO.PyOpenColorIO.Processor.TransformFormatMetadataIterator + .. py:method:: Processor.getTransformFormatMetadata(self: PyOpenColorIO.Processor) -> PyOpenColorIO.Processor.TransformFormatMetadataIterator :module: PyOpenColorIO - .. py:method:: Processor.hasChannelCrosstalk(self: PyOpenColorIO.PyOpenColorIO.Processor) -> bool + .. py:method:: Processor.hasChannelCrosstalk(self: PyOpenColorIO.Processor) -> bool :module: PyOpenColorIO True if the image transformation is non-separable. For example, if a change in red may also cause a change in green or blue. - .. py:method:: Processor.hasDynamicProperty(self: PyOpenColorIO.PyOpenColorIO.Processor, type: PyOpenColorIO.PyOpenColorIO.DynamicPropertyType) -> bool + .. py:method:: Processor.hasDynamicProperty(self: PyOpenColorIO.Processor, type: PyOpenColorIO.DynamicPropertyType) -> bool :module: PyOpenColorIO True if at least one dynamic property of that type exists. - .. py:method:: Processor.isDynamic(self: PyOpenColorIO.PyOpenColorIO.Processor) -> bool + .. py:method:: Processor.isDynamic(self: PyOpenColorIO.Processor) -> bool :module: PyOpenColorIO True if at least one dynamic property of any type exists and is dynamic. - .. py:method:: Processor.isNoOp(self: PyOpenColorIO.PyOpenColorIO.Processor) -> bool + .. py:method:: Processor.isNoOp(self: PyOpenColorIO.Processor) -> bool :module: PyOpenColorIO .. py:class:: TransformFormatMetadataIterator :module: PyOpenColorIO.Processor - :canonical: PyOpenColorIO.PyOpenColorIO.Processor.TransformFormatMetadataIterator - .. py:method:: TransformFormatMetadataIterator.__getitem__(self: PyOpenColorIO.PyOpenColorIO.Processor.TransformFormatMetadataIterator, arg0: int) -> PyOpenColorIO.PyOpenColorIO.FormatMetadata + .. py:method:: TransformFormatMetadataIterator.__getitem__(self: PyOpenColorIO.Processor.TransformFormatMetadataIterator, arg0: int) -> PyOpenColorIO.FormatMetadata :module: PyOpenColorIO.Processor - .. py:method:: TransformFormatMetadataIterator.__iter__(self: PyOpenColorIO.PyOpenColorIO.Processor.TransformFormatMetadataIterator) -> PyOpenColorIO.PyOpenColorIO.Processor.TransformFormatMetadataIterator + .. py:method:: TransformFormatMetadataIterator.__iter__(self: PyOpenColorIO.Processor.TransformFormatMetadataIterator) -> PyOpenColorIO.Processor.TransformFormatMetadataIterator :module: PyOpenColorIO.Processor - .. py:method:: TransformFormatMetadataIterator.__len__(self: PyOpenColorIO.PyOpenColorIO.Processor.TransformFormatMetadataIterator) -> int + .. py:method:: TransformFormatMetadataIterator.__len__(self: PyOpenColorIO.Processor.TransformFormatMetadataIterator) -> int :module: PyOpenColorIO.Processor - .. py:method:: TransformFormatMetadataIterator.__next__(self: PyOpenColorIO.PyOpenColorIO.Processor.TransformFormatMetadataIterator) -> PyOpenColorIO.PyOpenColorIO.FormatMetadata + .. py:method:: TransformFormatMetadataIterator.__next__(self: PyOpenColorIO.Processor.TransformFormatMetadataIterator) -> PyOpenColorIO.FormatMetadata :module: PyOpenColorIO.Processor diff --git a/docs/api/python/frozen/pyopencolorio_processorcacheflags.rst b/docs/api/python/frozen/pyopencolorio_processorcacheflags.rst new file mode 100644 index 0000000000..dc4d67b116 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_processorcacheflags.rst @@ -0,0 +1,46 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: ProcessorCacheFlags + :module: PyOpenColorIO + + cpp:type:: Enum to control the behavior of the internal caches e.g. the processor cache in + + Members: + + PROCESSOR_CACHE_OFF : + + PROCESSOR_CACHE_ENABLED : + + PROCESSOR_CACHE_SHARE_DYN_PROPERTIES : + + PROCESSOR_CACHE_DEFAULT : + + .. py:method:: name() -> str + :property: + + .. py:attribute:: ProcessorCacheFlags.PROCESSOR_CACHE_DEFAULT + :module: PyOpenColorIO + :value: + + + .. py:attribute:: ProcessorCacheFlags.PROCESSOR_CACHE_ENABLED + :module: PyOpenColorIO + :value: + + + .. py:attribute:: ProcessorCacheFlags.PROCESSOR_CACHE_OFF + :module: PyOpenColorIO + :value: + + + .. py:attribute:: ProcessorCacheFlags.PROCESSOR_CACHE_SHARE_DYN_PROPERTIES + :module: PyOpenColorIO + :value: + + + .. py:property:: ProcessorCacheFlags.value + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_processormetadata.rst b/docs/api/python/frozen/pyopencolorio_processormetadata.rst index 970118bb19..dc59890c9a 100644 --- a/docs/api/python/frozen/pyopencolorio_processormetadata.rst +++ b/docs/api/python/frozen/pyopencolorio_processormetadata.rst @@ -5,69 +5,66 @@ .. py:class:: ProcessorMetadata :module: PyOpenColorIO - :canonical: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata This class contains meta information about the process that generated this processor. The results of these functions do not impact the pixel processing. - .. py:method:: ProcessorMetadata.__init__(self: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata) -> None + .. py:method:: ProcessorMetadata.__init__(self: PyOpenColorIO.ProcessorMetadata) -> None :module: PyOpenColorIO - .. py:method:: ProcessorMetadata.addFile(self: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata, fileName: str) -> None + .. py:method:: ProcessorMetadata.addFile(self: PyOpenColorIO.ProcessorMetadata, fileName: str) -> None :module: PyOpenColorIO - .. py:method:: ProcessorMetadata.addLook(self: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata, look: str) -> None + .. py:method:: ProcessorMetadata.addLook(self: PyOpenColorIO.ProcessorMetadata, look: str) -> None :module: PyOpenColorIO - .. py:method:: ProcessorMetadata.getFiles(self: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata) -> PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.FileIterator + .. py:method:: ProcessorMetadata.getFiles(self: PyOpenColorIO.ProcessorMetadata) -> PyOpenColorIO.ProcessorMetadata.FileIterator :module: PyOpenColorIO - .. py:method:: ProcessorMetadata.getLooks(self: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata) -> PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.LookIterator + .. py:method:: ProcessorMetadata.getLooks(self: PyOpenColorIO.ProcessorMetadata) -> PyOpenColorIO.ProcessorMetadata.LookIterator :module: PyOpenColorIO .. py:class:: FileIterator :module: PyOpenColorIO.ProcessorMetadata - :canonical: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.FileIterator - .. py:method:: FileIterator.__getitem__(self: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.FileIterator, arg0: int) -> str + .. py:method:: FileIterator.__getitem__(self: PyOpenColorIO.ProcessorMetadata.FileIterator, arg0: int) -> str :module: PyOpenColorIO.ProcessorMetadata - .. py:method:: FileIterator.__iter__(self: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.FileIterator) -> PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.FileIterator + .. py:method:: FileIterator.__iter__(self: PyOpenColorIO.ProcessorMetadata.FileIterator) -> PyOpenColorIO.ProcessorMetadata.FileIterator :module: PyOpenColorIO.ProcessorMetadata - .. py:method:: FileIterator.__len__(self: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.FileIterator) -> int + .. py:method:: FileIterator.__len__(self: PyOpenColorIO.ProcessorMetadata.FileIterator) -> int :module: PyOpenColorIO.ProcessorMetadata - .. py:method:: FileIterator.__next__(self: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.FileIterator) -> str + .. py:method:: FileIterator.__next__(self: PyOpenColorIO.ProcessorMetadata.FileIterator) -> str :module: PyOpenColorIO.ProcessorMetadata .. py:class:: LookIterator :module: PyOpenColorIO.ProcessorMetadata - :canonical: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.LookIterator - .. py:method:: LookIterator.__getitem__(self: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.LookIterator, arg0: int) -> str + .. py:method:: LookIterator.__getitem__(self: PyOpenColorIO.ProcessorMetadata.LookIterator, arg0: int) -> str :module: PyOpenColorIO.ProcessorMetadata - .. py:method:: LookIterator.__iter__(self: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.LookIterator) -> PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.LookIterator + .. py:method:: LookIterator.__iter__(self: PyOpenColorIO.ProcessorMetadata.LookIterator) -> PyOpenColorIO.ProcessorMetadata.LookIterator :module: PyOpenColorIO.ProcessorMetadata - .. py:method:: LookIterator.__len__(self: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.LookIterator) -> int + .. py:method:: LookIterator.__len__(self: PyOpenColorIO.ProcessorMetadata.LookIterator) -> int :module: PyOpenColorIO.ProcessorMetadata - .. py:method:: LookIterator.__next__(self: PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.LookIterator) -> str + .. py:method:: LookIterator.__next__(self: PyOpenColorIO.ProcessorMetadata.LookIterator) -> str :module: PyOpenColorIO.ProcessorMetadata diff --git a/docs/api/python/frozen/pyopencolorio_rangestyle.rst b/docs/api/python/frozen/pyopencolorio_rangestyle.rst new file mode 100644 index 0000000000..23184f2d29 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_rangestyle.rst @@ -0,0 +1,32 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: RangeStyle + :module: PyOpenColorIO + + A :ref:`RangeTransform` may be set to clamp the values, or not. + + Members: + + RANGE_NO_CLAMP : + + RANGE_CLAMP : + + .. py:method:: name() -> str + :property: + + .. py:attribute:: RangeStyle.RANGE_CLAMP + :module: PyOpenColorIO + :value: + + + .. py:attribute:: RangeStyle.RANGE_NO_CLAMP + :module: PyOpenColorIO + :value: + + + .. py:property:: RangeStyle.value + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_rangestylefromstring.rst b/docs/api/python/frozen/pyopencolorio_rangestylefromstring.rst new file mode 100644 index 0000000000..32f1cc770c --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_rangestylefromstring.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: RangeStyleFromString(str: str) -> PyOpenColorIO.RangeStyle + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_rangestyletostring.rst b/docs/api/python/frozen/pyopencolorio_rangestyletostring.rst new file mode 100644 index 0000000000..788c31679e --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_rangestyletostring.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: RangeStyleToString(style: PyOpenColorIO.RangeStyle) -> str + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_rangetransform.rst b/docs/api/python/frozen/pyopencolorio_rangetransform.rst new file mode 100644 index 0000000000..97e51e6be6 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_rangetransform.rst @@ -0,0 +1,195 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: RangeTransform + :module: PyOpenColorIO + + Represents a range transform + + The Range is used to apply an affine transform (scale & offset) and clamps values to min/max bounds on all color components except the alpha. The scale and offset values are computed from the input and output bounds. + + Refer to section 7.2.4 in specification S-2014-006 "A Common File Format + for Look-Up Tables" from the Academy of Motion Picture Arts and Sciences and the American Society of Cinematographers. + + .. note:: + The "noClamp" style described in the specification S-2014-006 becomes a MatrixOp at the processor level. + + .. note:: + Changing the transform direction does not modify the in/out values -- they are always specified with respect to the "forward" direction. + + + .. py:method:: RangeTransform.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.RangeTransform) -> None + + Creates an instance of :ref:`RangeTransform`. + + 2. __init__(self: PyOpenColorIO.RangeTransform, minInValue: float = nan, maxInValue: float = nan, minOutValue: float = nan, maxOutValue: float = nan, direction: PyOpenColorIO.TransformDirection = ) -> None + + Creates an instance of :ref:`RangeTransform`. + + + .. py:method:: RangeTransform.equals(self: PyOpenColorIO.RangeTransform, other: PyOpenColorIO.RangeTransform) -> bool + :module: PyOpenColorIO + + Checks if this equals other. + + + .. py:method:: RangeTransform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection + :module: PyOpenColorIO + + + .. py:method:: RangeTransform.getFileInputBitDepth(self: PyOpenColorIO.RangeTransform) -> PyOpenColorIO.BitDepth + :module: PyOpenColorIO + + **File bit-depth** + + In a format such as CLF, the range values are scaled to take pixels at the specified inBitDepth to pixels at the specified outBitDepth. This complicates the interpretation of the range values and so this object always holds normalized values and scaling is done on the way from or to file formats such as CLF. Get the bit-depths associated with the range values read from a file or set the bit-depths of values to be written to a file (for file formats such as CLF that support multiple bit-depths). + + + .. py:method:: RangeTransform.getFileOutputBitDepth(self: PyOpenColorIO.RangeTransform) -> PyOpenColorIO.BitDepth + :module: PyOpenColorIO + + + .. py:method:: RangeTransform.getFormatMetadata(self: PyOpenColorIO.RangeTransform) -> PyOpenColorIO.FormatMetadata + :module: PyOpenColorIO + + + .. py:method:: RangeTransform.getMaxInValue(self: PyOpenColorIO.RangeTransform) -> float + :module: PyOpenColorIO + + Get the maximum value for the input. + + + .. py:method:: RangeTransform.getMaxOutValue(self: PyOpenColorIO.RangeTransform) -> float + :module: PyOpenColorIO + + Get the maximum value for the output. + + + .. py:method:: RangeTransform.getMinInValue(self: PyOpenColorIO.RangeTransform) -> float + :module: PyOpenColorIO + + Get the minimum value for the input. + + **Range values** + + These values are normalized relative to what may be stored in file formats such as CLF. For example in a CLF file using a "10i" input depth, a MaxInValue of 1023 in the file is normalized to 1.0. Likewise, for an output depth of "12i", a MaxOutValue of 4095 in the file is normalized to 1.0. The values here are unclamped and may extend outside [0,1]. + + + .. py:method:: RangeTransform.getMinOutValue(self: PyOpenColorIO.RangeTransform) -> float + :module: PyOpenColorIO + + Get the minimum value for the output. + + + .. py:method:: RangeTransform.getStyle(self: PyOpenColorIO.RangeTransform) -> PyOpenColorIO.RangeStyle + :module: PyOpenColorIO + + + .. py:method:: RangeTransform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType + :module: PyOpenColorIO + + + .. py:method:: RangeTransform.hasMaxInValue(self: PyOpenColorIO.RangeTransform) -> bool + :module: PyOpenColorIO + + Is the maximum value for the input set? + + + .. py:method:: RangeTransform.hasMaxOutValue(self: PyOpenColorIO.RangeTransform) -> bool + :module: PyOpenColorIO + + Is the maximum value for the output set? + + + .. py:method:: RangeTransform.hasMinInValue(self: PyOpenColorIO.RangeTransform) -> bool + :module: PyOpenColorIO + + Is the minimum value for the input set? + + + .. py:method:: RangeTransform.hasMinOutValue(self: PyOpenColorIO.RangeTransform) -> bool + :module: PyOpenColorIO + + Is the minimum value for the output set? + + + .. py:method:: RangeTransform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None + :module: PyOpenColorIO + + Note that this only affects the evaluation and not the values stored in the object. + + + .. py:method:: RangeTransform.setFileInputBitDepth(self: PyOpenColorIO.RangeTransform, bitDepth: PyOpenColorIO.BitDepth) -> None + :module: PyOpenColorIO + + + .. py:method:: RangeTransform.setFileOutputBitDepth(self: PyOpenColorIO.RangeTransform, bitDepth: PyOpenColorIO.BitDepth) -> None + :module: PyOpenColorIO + + + .. py:method:: RangeTransform.setMaxInValue(self: PyOpenColorIO.RangeTransform, value: float) -> None + :module: PyOpenColorIO + + Set the maximum value for the input. + + + .. py:method:: RangeTransform.setMaxOutValue(self: PyOpenColorIO.RangeTransform, value: float) -> None + :module: PyOpenColorIO + + Set the maximum value for the output. + + + .. py:method:: RangeTransform.setMinInValue(self: PyOpenColorIO.RangeTransform, value: float) -> None + :module: PyOpenColorIO + + Set the minimum value for the input. + + + .. py:method:: RangeTransform.setMinOutValue(self: PyOpenColorIO.RangeTransform, value: float) -> None + :module: PyOpenColorIO + + Set the minimum value for the output. + + + .. py:method:: RangeTransform.setStyle(self: PyOpenColorIO.RangeTransform, style: PyOpenColorIO.RangeStyle) -> None + :module: PyOpenColorIO + + Set the Range style to clamp or not input values. + + + .. py:method:: RangeTransform.unsetMaxInValue(self: PyOpenColorIO.RangeTransform) -> None + :module: PyOpenColorIO + + Unset the maximum value for the input. + + + .. py:method:: RangeTransform.unsetMaxOutValue(self: PyOpenColorIO.RangeTransform) -> None + :module: PyOpenColorIO + + Unset the maximum value for the output. + + + .. py:method:: RangeTransform.unsetMinInValue(self: PyOpenColorIO.RangeTransform) -> None + :module: PyOpenColorIO + + Unset the minimum value for the input. + + + .. py:method:: RangeTransform.unsetMinOutValue(self: PyOpenColorIO.RangeTransform) -> None + :module: PyOpenColorIO + + Unset the minimum value for the output. + + + .. py:method:: RangeTransform.validate(self: PyOpenColorIO.Transform) -> None + :module: PyOpenColorIO + + Will throw if data is not valid. + diff --git a/docs/api/python/frozen/pyopencolorio_referencespacetype.rst b/docs/api/python/frozen/pyopencolorio_referencespacetype.rst new file mode 100644 index 0000000000..993f0178a0 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_referencespacetype.rst @@ -0,0 +1,32 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: ReferenceSpaceType + :module: PyOpenColorIO + + OCIO does not mandate the image state of the main reference space and it is not required to be scene-referred. This enum is used in connection with the display color space and view transform features which do assume that the main reference space is scene-referred and the display reference space is display-referred. If a config used a non-scene-referred reference space, presumably it would not use either display color spaces or view transforms, so this enum becomes irrelevant. + + Members: + + REFERENCE_SPACE_SCENE : the main scene reference space + + REFERENCE_SPACE_DISPLAY : the reference space for display color spaces + + .. py:method:: name() -> str + :property: + + .. py:attribute:: ReferenceSpaceType.REFERENCE_SPACE_DISPLAY + :module: PyOpenColorIO + :value: + + + .. py:attribute:: ReferenceSpaceType.REFERENCE_SPACE_SCENE + :module: PyOpenColorIO + :value: + + + .. py:property:: ReferenceSpaceType.value + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_resetcomputehashfunction.rst b/docs/api/python/frozen/pyopencolorio_resetcomputehashfunction.rst new file mode 100644 index 0000000000..88e0b1858a --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_resetcomputehashfunction.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: ResetComputeHashFunction() -> None + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_resettodefaultloggingfunction.rst b/docs/api/python/frozen/pyopencolorio_resettodefaultloggingfunction.rst new file mode 100644 index 0000000000..45b190b45c --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_resettodefaultloggingfunction.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: ResetToDefaultLoggingFunction() -> None + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_rgbcurvetype.rst b/docs/api/python/frozen/pyopencolorio_rgbcurvetype.rst new file mode 100644 index 0000000000..ff74b91aaf --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_rgbcurvetype.rst @@ -0,0 +1,53 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: RGBCurveType + :module: PyOpenColorIO + + Types for :ref:`GradingRGBCurve`. + + Members: + + RGB_RED : + + RGB_GREEN : + + RGB_BLUE : + + RGB_MASTER : + + RGB_NUM_CURVES : + + .. py:method:: name() -> str + :property: + + .. py:attribute:: RGBCurveType.RGB_BLUE + :module: PyOpenColorIO + :value: + + + .. py:attribute:: RGBCurveType.RGB_GREEN + :module: PyOpenColorIO + :value: + + + .. py:attribute:: RGBCurveType.RGB_MASTER + :module: PyOpenColorIO + :value: + + + .. py:attribute:: RGBCurveType.RGB_NUM_CURVES + :module: PyOpenColorIO + :value: + + + .. py:attribute:: RGBCurveType.RGB_RED + :module: PyOpenColorIO + :value: + + + .. py:property:: RGBCurveType.value + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_searchreferencespacetype.rst b/docs/api/python/frozen/pyopencolorio_searchreferencespacetype.rst new file mode 100644 index 0000000000..8dc9e306e6 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_searchreferencespacetype.rst @@ -0,0 +1,37 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: SearchReferenceSpaceType + :module: PyOpenColorIO + + Members: + + SEARCH_REFERENCE_SPACE_SCENE : + + SEARCH_REFERENCE_SPACE_DISPLAY : + + SEARCH_REFERENCE_SPACE_ALL : + + .. py:method:: name() -> str + :property: + + .. py:attribute:: SearchReferenceSpaceType.SEARCH_REFERENCE_SPACE_ALL + :module: PyOpenColorIO + :value: + + + .. py:attribute:: SearchReferenceSpaceType.SEARCH_REFERENCE_SPACE_DISPLAY + :module: PyOpenColorIO + :value: + + + .. py:attribute:: SearchReferenceSpaceType.SEARCH_REFERENCE_SPACE_SCENE + :module: PyOpenColorIO + :value: + + + .. py:property:: SearchReferenceSpaceType.value + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_setcomputehashfunction.rst b/docs/api/python/frozen/pyopencolorio_setcomputehashfunction.rst new file mode 100644 index 0000000000..1af5bde567 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_setcomputehashfunction.rst @@ -0,0 +1,14 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: SetComputeHashFunction(hashFunction: Callable[[str], str]) -> None + :module: PyOpenColorIO + + Set the Compute Hash Function to use; otherwise, use the default. + + This is not used when using CreateFromFile with an OCIOZ archive or CreateFromConfigIOProxy. + + :param ComputeHashFunction: + diff --git a/docs/api/python/frozen/pyopencolorio_setenvvariable.rst b/docs/api/python/frozen/pyopencolorio_setenvvariable.rst new file mode 100644 index 0000000000..76a5c57521 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_setenvvariable.rst @@ -0,0 +1,11 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: SetEnvVariable(name: str, value: str) -> None + :module: PyOpenColorIO + + .. warning:: + This method is not thread safe. + diff --git a/docs/api/python/frozen/pyopencolorio_setloggingfunction.rst b/docs/api/python/frozen/pyopencolorio_setloggingfunction.rst new file mode 100644 index 0000000000..c6b8ce5127 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_setloggingfunction.rst @@ -0,0 +1,13 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: SetLoggingFunction(logFunction: Callable[[str], None]) -> None + :module: PyOpenColorIO + + Set the logging function to use; otherwise, use the default (i.e. std::cerr). + + .. note:: + The logging mechanism is thread-safe. + diff --git a/docs/api/python/frozen/pyopencolorio_setlogginglevel.rst b/docs/api/python/frozen/pyopencolorio_setlogginglevel.rst new file mode 100644 index 0000000000..3d6d930274 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_setlogginglevel.rst @@ -0,0 +1,10 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: SetLoggingLevel(level: PyOpenColorIO.LoggingLevel) -> None + :module: PyOpenColorIO + + Set the global logging level. + diff --git a/docs/api/python/frozen/pyopencolorio_systemmonitors.rst b/docs/api/python/frozen/pyopencolorio_systemmonitors.rst new file mode 100644 index 0000000000..27ab9b95de --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_systemmonitors.rst @@ -0,0 +1,38 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: SystemMonitors + :module: PyOpenColorIO + + Provides access to the ICC monitor profile provided by the operating system for each active display. + + + .. py:method:: SystemMonitors.__init__(self: PyOpenColorIO.SystemMonitors) -> None + :module: PyOpenColorIO + + + .. py:method:: SystemMonitors.getMonitors(self: PyOpenColorIO.SystemMonitors) -> PyOpenColorIO.SystemMonitors.MonitorIterator + :module: PyOpenColorIO + + +.. py:class:: MonitorIterator + :module: PyOpenColorIO.SystemMonitors + + + .. py:method:: MonitorIterator.__getitem__(self: PyOpenColorIO.SystemMonitors.MonitorIterator, arg0: int) -> tuple + :module: PyOpenColorIO.SystemMonitors + + + .. py:method:: MonitorIterator.__iter__(self: PyOpenColorIO.SystemMonitors.MonitorIterator) -> PyOpenColorIO.SystemMonitors.MonitorIterator + :module: PyOpenColorIO.SystemMonitors + + + .. py:method:: MonitorIterator.__len__(self: PyOpenColorIO.SystemMonitors.MonitorIterator) -> int + :module: PyOpenColorIO.SystemMonitors + + + .. py:method:: MonitorIterator.__next__(self: PyOpenColorIO.SystemMonitors.MonitorIterator) -> tuple + :module: PyOpenColorIO.SystemMonitors + diff --git a/docs/api/python/frozen/pyopencolorio_transform.rst b/docs/api/python/frozen/pyopencolorio_transform.rst new file mode 100644 index 0000000000..322ae9e988 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_transform.rst @@ -0,0 +1,34 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: Transform + :module: PyOpenColorIO + + Base class for all the transform classes. + + + .. py:method:: Transform.__init__(*args, **kwargs) + :module: PyOpenColorIO + + + .. py:method:: Transform.getDirection(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformDirection + :module: PyOpenColorIO + + + .. py:method:: Transform.getTransformType(self: PyOpenColorIO.Transform) -> PyOpenColorIO.TransformType + :module: PyOpenColorIO + + + .. py:method:: Transform.setDirection(self: PyOpenColorIO.Transform, direction: PyOpenColorIO.TransformDirection) -> None + :module: PyOpenColorIO + + Note that this only affects the evaluation and not the values stored in the object. + + + .. py:method:: Transform.validate(self: PyOpenColorIO.Transform) -> None + :module: PyOpenColorIO + + Will throw if data is not valid. + diff --git a/docs/api/python/frozen/pyopencolorio_transformdirection.rst b/docs/api/python/frozen/pyopencolorio_transformdirection.rst new file mode 100644 index 0000000000..5623ecc4d7 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_transformdirection.rst @@ -0,0 +1,30 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: TransformDirection + :module: PyOpenColorIO + + Members: + + TRANSFORM_DIR_FORWARD : + + TRANSFORM_DIR_INVERSE : + + .. py:method:: name() -> str + :property: + + .. py:attribute:: TransformDirection.TRANSFORM_DIR_FORWARD + :module: PyOpenColorIO + :value: + + + .. py:attribute:: TransformDirection.TRANSFORM_DIR_INVERSE + :module: PyOpenColorIO + :value: + + + .. py:property:: TransformDirection.value + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_transformdirectionfromstring.rst b/docs/api/python/frozen/pyopencolorio_transformdirectionfromstring.rst new file mode 100644 index 0000000000..57aa8d5a21 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_transformdirectionfromstring.rst @@ -0,0 +1,10 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: TransformDirectionFromString(str: str) -> PyOpenColorIO.TransformDirection + :module: PyOpenColorIO + + Will throw if string is not recognized. + diff --git a/docs/api/python/frozen/pyopencolorio_transformdirectiontostring.rst b/docs/api/python/frozen/pyopencolorio_transformdirectiontostring.rst new file mode 100644 index 0000000000..9664daeb2d --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_transformdirectiontostring.rst @@ -0,0 +1,8 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: TransformDirectionToString(direction: PyOpenColorIO.TransformDirection) -> str + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_transformtype.rst b/docs/api/python/frozen/pyopencolorio_transformtype.rst new file mode 100644 index 0000000000..3f2c455fc7 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_transformtype.rst @@ -0,0 +1,170 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: TransformType + :module: PyOpenColorIO + + Members: + + TRANSFORM_TYPE_ALLOCATION : + + TRANSFORM_TYPE_BUILTIN : + + TRANSFORM_TYPE_CDL : + + TRANSFORM_TYPE_COLORSPACE : + + TRANSFORM_TYPE_DISPLAY_VIEW : + + TRANSFORM_TYPE_EXPONENT : + + TRANSFORM_TYPE_EXPONENT_WITH_LINEAR : + + TRANSFORM_TYPE_EXPOSURE_CONTRAST : + + TRANSFORM_TYPE_FILE : + + TRANSFORM_TYPE_FIXED_FUNCTION : + + TRANSFORM_TYPE_GRADING_PRIMARY : + + TRANSFORM_TYPE_GRADING_RGB_CURVE : + + TRANSFORM_TYPE_GRADING_TONE : + + TRANSFORM_TYPE_GROUP : + + TRANSFORM_TYPE_LOG_AFFINE : + + TRANSFORM_TYPE_LOG_CAMERA : + + TRANSFORM_TYPE_LOG : + + TRANSFORM_TYPE_LOOK : + + TRANSFORM_TYPE_LUT1D : + + TRANSFORM_TYPE_LUT3D : + + TRANSFORM_TYPE_MATRIX : + + TRANSFORM_TYPE_RANGE : + + .. py:method:: name() -> str + :property: + + .. py:attribute:: TransformType.TRANSFORM_TYPE_ALLOCATION + :module: PyOpenColorIO + :value: + + + .. py:attribute:: TransformType.TRANSFORM_TYPE_BUILTIN + :module: PyOpenColorIO + :value: + + + .. py:attribute:: TransformType.TRANSFORM_TYPE_CDL + :module: PyOpenColorIO + :value: + + + .. py:attribute:: TransformType.TRANSFORM_TYPE_COLORSPACE + :module: PyOpenColorIO + :value: + + + .. py:attribute:: TransformType.TRANSFORM_TYPE_DISPLAY_VIEW + :module: PyOpenColorIO + :value: + + + .. py:attribute:: TransformType.TRANSFORM_TYPE_EXPONENT + :module: PyOpenColorIO + :value: + + + .. py:attribute:: TransformType.TRANSFORM_TYPE_EXPONENT_WITH_LINEAR + :module: PyOpenColorIO + :value: + + + .. py:attribute:: TransformType.TRANSFORM_TYPE_EXPOSURE_CONTRAST + :module: PyOpenColorIO + :value: + + + .. py:attribute:: TransformType.TRANSFORM_TYPE_FILE + :module: PyOpenColorIO + :value: + + + .. py:attribute:: TransformType.TRANSFORM_TYPE_FIXED_FUNCTION + :module: PyOpenColorIO + :value: + + + .. py:attribute:: TransformType.TRANSFORM_TYPE_GRADING_PRIMARY + :module: PyOpenColorIO + :value: + + + .. py:attribute:: TransformType.TRANSFORM_TYPE_GRADING_RGB_CURVE + :module: PyOpenColorIO + :value: + + + .. py:attribute:: TransformType.TRANSFORM_TYPE_GRADING_TONE + :module: PyOpenColorIO + :value: + + + .. py:attribute:: TransformType.TRANSFORM_TYPE_GROUP + :module: PyOpenColorIO + :value: + + + .. py:attribute:: TransformType.TRANSFORM_TYPE_LOG + :module: PyOpenColorIO + :value: + + + .. py:attribute:: TransformType.TRANSFORM_TYPE_LOG_AFFINE + :module: PyOpenColorIO + :value: + + + .. py:attribute:: TransformType.TRANSFORM_TYPE_LOG_CAMERA + :module: PyOpenColorIO + :value: + + + .. py:attribute:: TransformType.TRANSFORM_TYPE_LOOK + :module: PyOpenColorIO + :value: + + + .. py:attribute:: TransformType.TRANSFORM_TYPE_LUT1D + :module: PyOpenColorIO + :value: + + + .. py:attribute:: TransformType.TRANSFORM_TYPE_LUT3D + :module: PyOpenColorIO + :value: + + + .. py:attribute:: TransformType.TRANSFORM_TYPE_MATRIX + :module: PyOpenColorIO + :value: + + + .. py:attribute:: TransformType.TRANSFORM_TYPE_RANGE + :module: PyOpenColorIO + :value: + + + .. py:property:: TransformType.value + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_uniformdatatype.rst b/docs/api/python/frozen/pyopencolorio_uniformdatatype.rst new file mode 100644 index 0000000000..f6707c37bb --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_uniformdatatype.rst @@ -0,0 +1,60 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: UniformDataType + :module: PyOpenColorIO + + Types for uniform data. + + Members: + + UNIFORM_DOUBLE : + + UNIFORM_BOOL : + + UNIFORM_FLOAT3 : Array of 3 floats. + + UNIFORM_VECTOR_FLOAT : Vector of floats (size is set by uniform). + + UNIFORM_VECTOR_INT : Vector of int pairs (size is set by uniform). + + UNIFORM_UNKNOWN : + + .. py:method:: name() -> str + :property: + + .. py:attribute:: UniformDataType.UNIFORM_BOOL + :module: PyOpenColorIO + :value: + + + .. py:attribute:: UniformDataType.UNIFORM_DOUBLE + :module: PyOpenColorIO + :value: + + + .. py:attribute:: UniformDataType.UNIFORM_FLOAT3 + :module: PyOpenColorIO + :value: + + + .. py:attribute:: UniformDataType.UNIFORM_UNKNOWN + :module: PyOpenColorIO + :value: + + + .. py:attribute:: UniformDataType.UNIFORM_VECTOR_FLOAT + :module: PyOpenColorIO + :value: + + + .. py:attribute:: UniformDataType.UNIFORM_VECTOR_INT + :module: PyOpenColorIO + :value: + + + .. py:property:: UniformDataType.value + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_unsetenvvariable.rst b/docs/api/python/frozen/pyopencolorio_unsetenvvariable.rst new file mode 100644 index 0000000000..98fef1d15f --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_unsetenvvariable.rst @@ -0,0 +1,11 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:function:: UnsetEnvVariable(name: str) -> None + :module: PyOpenColorIO + + .. warning:: + This method is not thread safe. + diff --git a/docs/api/python/frozen/pyopencolorio_viewingrules.rst b/docs/api/python/frozen/pyopencolorio_viewingrules.rst new file mode 100644 index 0000000000..12cfc05d41 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_viewingrules.rst @@ -0,0 +1,160 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: ViewingRules + :module: PyOpenColorIO + + :ref:`ViewingRules` + + Viewing Rules allow config authors to filter the list of views an application should offer based on the color space of an image. For example, a config may define a large number of views but not all of them may be appropriate for use with all color spaces. E.g., some views may be intended for use with scene-linear color space encodings and others with video color space encodings. + + Each rule has a name key for applications to refer to the rule. Name values must be unique (using case insensitive comparison). Viewing Rules may also have the following keys: + + - colorspaces: Either a single colorspace name or a list of names. + - encodings: One or more strings to be found in the colorspace's encoding attribute. Either this attribute or colorspaces must be present, but not both. + - custom : Allows arbitrary key / value string pairs, similar to :ref:`FileRules`. + + Getters and setters are using the rule position, they will throw if the position is not valid. + + + .. py:method:: ViewingRules.__init__(self: PyOpenColorIO.ViewingRules) -> None + :module: PyOpenColorIO + + Creates :ref:`ViewingRules` for a :ref:`Config`. + + + .. py:method:: ViewingRules.addColorSpace(self: PyOpenColorIO.ViewingRules, ruleIndex: int, colorSpaceName: str) -> None + :module: PyOpenColorIO + + Add colorspace name. Will throw if: + + - RuleIndex is invalid. + - :ref:`ViewingRules::getNumEncodings` is not 0. + + + .. py:method:: ViewingRules.addEncoding(self: PyOpenColorIO.ViewingRules, ruleIndex: int, encodingName: str) -> None + :module: PyOpenColorIO + + Add encoding name. Will throw if: + + - RuleIndex is invalid. + - :ref:`ViewingRules::getNumColorSpaces` is not 0. + + + .. py:method:: ViewingRules.getColorSpaces(self: PyOpenColorIO.ViewingRules, ruleIndex: int) -> PyOpenColorIO.ViewingRules.ViewingRuleColorSpaceIterator + :module: PyOpenColorIO + + + .. py:method:: ViewingRules.getCustomKeyName(self: PyOpenColorIO.ViewingRules, ruleIndex: int, key: int) -> str + :module: PyOpenColorIO + + Get name of key. Will throw if ruleIndex or keyIndex is invalid. + + + .. py:method:: ViewingRules.getCustomKeyValue(self: PyOpenColorIO.ViewingRules, ruleIndex: int, key: int) -> str + :module: PyOpenColorIO + + Get value for the key. Will throw if ruleIndex or keyIndex is invalid. + + + .. py:method:: ViewingRules.getEncodings(self: PyOpenColorIO.ViewingRules, ruleIndex: int) -> PyOpenColorIO.ViewingRules.ViewingRuleEncodingIterator + :module: PyOpenColorIO + + + .. py:method:: ViewingRules.getIndexForRule(self: PyOpenColorIO.ViewingRules, ruleName: str) -> int + :module: PyOpenColorIO + + Get the index from the rule name. Will throw if there is no rule named ruleName. + + + .. py:method:: ViewingRules.getName(self: PyOpenColorIO.ViewingRules, ruleIndex: int) -> str + :module: PyOpenColorIO + + Get name of the rule. Will throw if ruleIndex is invalid. + + + .. py:method:: ViewingRules.getNumCustomKeys(self: PyOpenColorIO.ViewingRules, ruleIndex: int) -> int + :module: PyOpenColorIO + + Get number of key/value pairs. Will throw if ruleIndex is invalid. + + + .. py:method:: ViewingRules.getNumEntries(self: PyOpenColorIO.ViewingRules) -> int + :module: PyOpenColorIO + + + .. py:method:: ViewingRules.insertRule(self: PyOpenColorIO.ViewingRules, ruleIndex: int, name: str) -> None + :module: PyOpenColorIO + + Insert a rule at a given ruleIndex. + + Rule currently at ruleIndex will be pushed to index: ruleIndex + 1. If ruleIndex is ViewingRules::getNumEntries, a new rule will be added at the end. Will throw if: + - RuleIndex is invalid (must be less than or equal to ViewingRules::getNumEntries). + - RuleName already exists. + + + .. py:method:: ViewingRules.removeColorSpace(self: PyOpenColorIO.ViewingRules, ruleIndex: int, colorSpaceIndex: int) -> None + :module: PyOpenColorIO + + Remove colorspace. Will throw if ruleIndex or colorSpaceIndex is invalid. + + + .. py:method:: ViewingRules.removeEncoding(self: PyOpenColorIO.ViewingRules, ruleIndex: int, encodingIndex: int) -> None + :module: PyOpenColorIO + + Remove encoding. Will throw if ruleIndex or encodingIndex is invalid. + + + .. py:method:: ViewingRules.removeRule(self: PyOpenColorIO.ViewingRules, ruleIndex: int) -> None + :module: PyOpenColorIO + + Remove a rule. Throws if ruleIndex is not valid. + + + .. py:method:: ViewingRules.setCustomKey(self: PyOpenColorIO.ViewingRules, ruleIndex: int, key: str, value: str) -> None + :module: PyOpenColorIO + + Adds a key/value or replace value if key exists. Setting a NULL or an empty value will erase the key. Will throw if ruleIndex is invalid. + + +.. py:class:: ViewingRuleColorSpaceIterator + :module: PyOpenColorIO.ViewingRules + + + .. py:method:: ViewingRuleColorSpaceIterator.__getitem__(self: PyOpenColorIO.ViewingRules.ViewingRuleColorSpaceIterator, arg0: int) -> str + :module: PyOpenColorIO.ViewingRules + + + .. py:method:: ViewingRuleColorSpaceIterator.__iter__(self: PyOpenColorIO.ViewingRules.ViewingRuleColorSpaceIterator) -> PyOpenColorIO.ViewingRules.ViewingRuleColorSpaceIterator + :module: PyOpenColorIO.ViewingRules + + + .. py:method:: ViewingRuleColorSpaceIterator.__len__(self: PyOpenColorIO.ViewingRules.ViewingRuleColorSpaceIterator) -> int + :module: PyOpenColorIO.ViewingRules + + + .. py:method:: ViewingRuleColorSpaceIterator.__next__(self: PyOpenColorIO.ViewingRules.ViewingRuleColorSpaceIterator) -> str + :module: PyOpenColorIO.ViewingRules + + +.. py:class:: ViewingRuleEncodingIterator + :module: PyOpenColorIO.ViewingRules + + + .. py:method:: ViewingRuleEncodingIterator.__getitem__(self: PyOpenColorIO.ViewingRules.ViewingRuleEncodingIterator, arg0: int) -> str + :module: PyOpenColorIO.ViewingRules + + + .. py:method:: ViewingRuleEncodingIterator.__iter__(self: PyOpenColorIO.ViewingRules.ViewingRuleEncodingIterator) -> PyOpenColorIO.ViewingRules.ViewingRuleEncodingIterator + :module: PyOpenColorIO.ViewingRules + + + .. py:method:: ViewingRuleEncodingIterator.__len__(self: PyOpenColorIO.ViewingRules.ViewingRuleEncodingIterator) -> int + :module: PyOpenColorIO.ViewingRules + + + .. py:method:: ViewingRuleEncodingIterator.__next__(self: PyOpenColorIO.ViewingRules.ViewingRuleEncodingIterator) -> str + :module: PyOpenColorIO.ViewingRules + diff --git a/docs/api/python/frozen/pyopencolorio_viewtransform.rst b/docs/api/python/frozen/pyopencolorio_viewtransform.rst new file mode 100644 index 0000000000..5695594de9 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_viewtransform.rst @@ -0,0 +1,124 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: ViewTransform + :module: PyOpenColorIO + + A *:ref:`ViewTransform`* provides a conversion from the main (usually scene-referred) reference space to the display-referred reference space. This allows splitting the conversion from the main reference space to a display into two parts: the :ref:`ViewTransform` plus a display color space. + + It is also possible to provide a :ref:`ViewTransform` that converts from the display-referred reference space back to that space. This is useful in cases when a :ref:`ViewTransform` is needed when converting between displays (such as HDR to SDR). + + The ReferenceSpaceType indicates whether the :ref:`ViewTransform` converts from scene-to-display reference or display-to-display reference. + + The from_reference transform direction is the one that is used when going out towards a display. + + + .. py:method:: ViewTransform.__init__(*args, **kwargs) + :module: PyOpenColorIO + + Overloaded function. + + 1. __init__(self: PyOpenColorIO.ViewTransform, referenceSpace: PyOpenColorIO.ReferenceSpaceType) -> None + + 2. __init__(self: PyOpenColorIO.ViewTransform, referenceSpace: PyOpenColorIO.ReferenceSpaceType = , name: str = '', family: str = '', description: str = '', toReference: PyOpenColorIO.Transform = None, fromReference: PyOpenColorIO.Transform = None, categories: List[str] = []) -> None + + + .. py:method:: ViewTransform.addCategory(self: PyOpenColorIO.ViewTransform, category: str) -> None + :module: PyOpenColorIO + + .. see:: + :ref:`ColorSpace::addCategory` + + + .. py:method:: ViewTransform.clearCategories(self: PyOpenColorIO.ViewTransform) -> None + :module: PyOpenColorIO + + .. see:: + :ref:`ColorSpace::clearCategories` + + + .. py:method:: ViewTransform.getCategories(self: PyOpenColorIO.ViewTransform) -> PyOpenColorIO.ViewTransform.ViewTransformCategoryIterator + :module: PyOpenColorIO + + + .. py:method:: ViewTransform.getDescription(self: PyOpenColorIO.ViewTransform) -> str + :module: PyOpenColorIO + + + .. py:method:: ViewTransform.getFamily(self: PyOpenColorIO.ViewTransform) -> str + :module: PyOpenColorIO + + .. see:: + :ref:`ColorSpace::getFamily` + + + .. py:method:: ViewTransform.getName(self: PyOpenColorIO.ViewTransform) -> str + :module: PyOpenColorIO + + + .. py:method:: ViewTransform.getReferenceSpaceType(self: PyOpenColorIO.ViewTransform) -> PyOpenColorIO.ReferenceSpaceType + :module: PyOpenColorIO + + + .. py:method:: ViewTransform.getTransform(self: PyOpenColorIO.ViewTransform, direction: PyOpenColorIO.ViewTransformDirection) -> PyOpenColorIO.Transform + :module: PyOpenColorIO + + If a transform in the specified direction has been specified, return it. Otherwise return a null ConstTransformRcPtr + + + .. py:method:: ViewTransform.hasCategory(self: PyOpenColorIO.ViewTransform, category: str) -> bool + :module: PyOpenColorIO + + .. see:: + :ref:`ColorSpace::hasCategory` + + + .. py:method:: ViewTransform.removeCategory(self: PyOpenColorIO.ViewTransform, category: str) -> None + :module: PyOpenColorIO + + .. see:: + :ref:`ColorSpace::removeCategory` + + + .. py:method:: ViewTransform.setDescription(self: PyOpenColorIO.ViewTransform, description: str) -> None + :module: PyOpenColorIO + + + .. py:method:: ViewTransform.setFamily(self: PyOpenColorIO.ViewTransform, family: str) -> None + :module: PyOpenColorIO + + .. see:: + :ref:`ColorSpace::setFamily` + + + .. py:method:: ViewTransform.setName(self: PyOpenColorIO.ViewTransform, name: str) -> None + :module: PyOpenColorIO + + + .. py:method:: ViewTransform.setTransform(self: PyOpenColorIO.ViewTransform, transform: PyOpenColorIO.Transform, direction: PyOpenColorIO.ViewTransformDirection) -> None + :module: PyOpenColorIO + + Specify the transform for the appropriate direction. Setting the transform to null will clear it. + + +.. py:class:: ViewTransformCategoryIterator + :module: PyOpenColorIO.ViewTransform + + + .. py:method:: ViewTransformCategoryIterator.__getitem__(self: PyOpenColorIO.ViewTransform.ViewTransformCategoryIterator, arg0: int) -> str + :module: PyOpenColorIO.ViewTransform + + + .. py:method:: ViewTransformCategoryIterator.__iter__(self: PyOpenColorIO.ViewTransform.ViewTransformCategoryIterator) -> PyOpenColorIO.ViewTransform.ViewTransformCategoryIterator + :module: PyOpenColorIO.ViewTransform + + + .. py:method:: ViewTransformCategoryIterator.__len__(self: PyOpenColorIO.ViewTransform.ViewTransformCategoryIterator) -> int + :module: PyOpenColorIO.ViewTransform + + + .. py:method:: ViewTransformCategoryIterator.__next__(self: PyOpenColorIO.ViewTransform.ViewTransformCategoryIterator) -> str + :module: PyOpenColorIO.ViewTransform + diff --git a/docs/api/python/frozen/pyopencolorio_viewtransformdirection.rst b/docs/api/python/frozen/pyopencolorio_viewtransformdirection.rst new file mode 100644 index 0000000000..2745c7c858 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_viewtransformdirection.rst @@ -0,0 +1,30 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: ViewTransformDirection + :module: PyOpenColorIO + + Members: + + VIEWTRANSFORM_DIR_TO_REFERENCE : + + VIEWTRANSFORM_DIR_FROM_REFERENCE : + + .. py:method:: name() -> str + :property: + + .. py:attribute:: ViewTransformDirection.VIEWTRANSFORM_DIR_FROM_REFERENCE + :module: PyOpenColorIO + :value: + + + .. py:attribute:: ViewTransformDirection.VIEWTRANSFORM_DIR_TO_REFERENCE + :module: PyOpenColorIO + :value: + + + .. py:property:: ViewTransformDirection.value + :module: PyOpenColorIO + diff --git a/docs/api/python/frozen/pyopencolorio_viewtype.rst b/docs/api/python/frozen/pyopencolorio_viewtype.rst new file mode 100644 index 0000000000..b4ae513fa9 --- /dev/null +++ b/docs/api/python/frozen/pyopencolorio_viewtype.rst @@ -0,0 +1,30 @@ +.. + SPDX-License-Identifier: CC-BY-4.0 + Copyright Contributors to the OpenColorIO Project. + Do not edit! This file was automatically generated by share/docs/frozendoc.py. + +.. py:class:: ViewType + :module: PyOpenColorIO + + Members: + + VIEW_SHARED : + + VIEW_DISPLAY_DEFINED : + + .. py:method:: name() -> str + :property: + + .. py:attribute:: ViewType.VIEW_DISPLAY_DEFINED + :module: PyOpenColorIO + :value: + + + .. py:attribute:: ViewType.VIEW_SHARED + :module: PyOpenColorIO + :value: + + + .. py:property:: ViewType.value + :module: PyOpenColorIO +