From 05959ad120190730b069940726455cb02a187ed6 Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Mon, 30 Jun 2025 00:21:35 -0400 Subject: [PATCH 01/36] Remove frozen docs Signed-off-by: Michael Dolan --- CMakeLists.txt | 3 +- docs/api/apphelpers.rst | 44 +- docs/api/baker.rst | 9 +- docs/api/colorspace.rst | 24 +- docs/api/config.rst | 85 +- docs/api/context.rst | 17 +- docs/api/dynamicproperty.rst | 5 +- docs/api/enums.rst | 140 +- docs/api/exceptions.rst | 4 +- docs/api/formatmetadata.rst | 26 +- docs/api/global.rst | 92 +- docs/api/grading_transforms.rst | 57 +- docs/api/imagedesc.rst | 17 +- docs/api/look.rst | 5 +- docs/api/namedtransform.rst | 9 +- docs/api/processors.rst | 31 +- .../frozen/pyopencolorio_allocation.rst | 36 - .../pyopencolorio_allocationfromstring.rst | 8 - .../pyopencolorio_allocationtostring.rst | 8 - .../pyopencolorio_allocationtransform.rst | 57 - .../api/python/frozen/pyopencolorio_baker.rst | 183 -- .../python/frozen/pyopencolorio_bitdepth.rst | 80 - .../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 | 55 - ...pyopencolorio_builtintransformregistry.rst | 63 - .../python/frozen/pyopencolorio_cdlstyle.rst | 36 - .../pyopencolorio_cdlstylefromstring.rst | 8 - .../frozen/pyopencolorio_cdlstyletostring.rst | 8 - .../frozen/pyopencolorio_cdltransform.rst | 152 -- .../frozen/pyopencolorio_channelordering.rst | 52 - .../frozen/pyopencolorio_clearallcaches.rst | 15 - .../frozen/pyopencolorio_colorspace.rst | 264 --- .../pyopencolorio_colorspacedirection.rst | 29 - .../pyopencolorio_colorspacehelpers.rst | 12 - .../pyopencolorio_colorspacemenuhelper.rst | 94 - ...pyopencolorio_colorspacemenuparameters.rst | 167 -- .../frozen/pyopencolorio_colorspaceset.rst | 177 -- .../pyopencolorio_colorspacetransform.rst | 65 - .../pyopencolorio_colorspacevisibility.rst | 36 - ...opencolorio_combinetransformdirections.rst | 8 - .../python/frozen/pyopencolorio_config.rst | 1615 ----------------- .../python/frozen/pyopencolorio_context.rst | 197 -- .../frozen/pyopencolorio_cpuprocessor.rst | 195 -- .../pyopencolorio_displayviewhelpers.rst | 28 - .../pyopencolorio_displayviewtransform.rst | 89 - .../frozen/pyopencolorio_dynamicproperty.rst | 106 -- .../pyopencolorio_dynamicpropertytype.rst | 59 - .../frozen/pyopencolorio_environmentmode.rst | 38 - ...yopencolorio_environmentmodefromstring.rst | 8 - .../pyopencolorio_environmentmodetostring.rst | 8 - .../python/frozen/pyopencolorio_exception.rst | 14 - .../pyopencolorio_exceptionmissingfile.rst | 13 - .../pyopencolorio_exponenttransform.rst | 76 - ...pencolorio_exponentwithlineartransform.rst | 96 - .../pyopencolorio_exposurecontraststyle.rst | 38 - ...olorio_exposurecontraststylefromstring.rst | 8 - ...ncolorio_exposurecontraststyletostring.rst | 8 - ...yopencolorio_exposurecontrasttransform.rst | 161 -- .../python/frozen/pyopencolorio_filerules.rst | 182 -- .../frozen/pyopencolorio_filetransform.rst | 110 -- .../pyopencolorio_fixedfunctionstyle.rst | 157 -- ...encolorio_fixedfunctionstylefromstring.rst | 8 - ...opencolorio_fixedfunctionstyletostring.rst | 8 - .../pyopencolorio_fixedfunctiontransform.rst | 65 - .../frozen/pyopencolorio_formatmetadata.rst | 189 -- .../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 | 80 - .../pyopencolorio_gpulanguagefromstring.rst | 8 - .../pyopencolorio_gpulanguagetostring.rst | 8 - .../frozen/pyopencolorio_gpuprocessor.rst | 31 - .../frozen/pyopencolorio_gpushadercreator.rst | 279 --- .../frozen/pyopencolorio_gpushaderdesc.rst | 574 ------ .../pyopencolorio_gradingbsplinecurve.rst | 62 - .../pyopencolorio_gradingcontrolpoint.rst | 29 - .../frozen/pyopencolorio_gradingprimary.rst | 83 - .../pyopencolorio_gradingprimarytransform.rst | 94 - .../frozen/pyopencolorio_gradingrgbcurve.rst | 39 - ...pyopencolorio_gradingrgbcurvetransform.rst | 115 -- .../frozen/pyopencolorio_gradingrgbm.rst | 37 - .../frozen/pyopencolorio_gradingrgbmsw.rst | 47 - .../frozen/pyopencolorio_gradingstyle.rst | 38 - .../pyopencolorio_gradingstylefromstring.rst | 8 - .../pyopencolorio_gradingstyletostring.rst | 8 - .../frozen/pyopencolorio_gradingtone.rst | 45 - .../pyopencolorio_gradingtonetransform.rst | 100 - .../frozen/pyopencolorio_grouptransform.rst | 140 -- .../python/frozen/pyopencolorio_imagedesc.rst | 57 - .../frozen/pyopencolorio_interpolation.rst | 76 - .../pyopencolorio_interpolationfromstring.rst | 8 - .../pyopencolorio_interpolationtostring.rst | 8 - .../pyopencolorio_isenvvariablepresent.rst | 10 - .../pyopencolorio_legacyviewingpipeline.rst | 100 - .../pyopencolorio_logaffinetransform.rst | 96 - .../pyopencolorio_logcameratransform.rst | 126 -- .../frozen/pyopencolorio_logginglevel.rst | 50 - .../pyopencolorio_logginglevelfromstring.rst | 8 - .../pyopencolorio_loggingleveltostring.rst | 8 - .../frozen/pyopencolorio_logmessage.rst | 10 - .../frozen/pyopencolorio_logtransform.rst | 63 - docs/api/python/frozen/pyopencolorio_look.rst | 65 - .../frozen/pyopencolorio_looktransform.rst | 73 - .../frozen/pyopencolorio_lut1dhueadjust.rst | 38 - .../frozen/pyopencolorio_lut1dtransform.rst | 141 -- .../frozen/pyopencolorio_lut3dtransform.rst | 109 -- .../frozen/pyopencolorio_matrixtransform.rst | 132 -- .../pyopencolorio_mixingcolorspacemanager.rst | 113 -- .../frozen/pyopencolorio_mixingslider.rst | 59 - .../frozen/pyopencolorio_namedtransform.rst | 167 -- ...pyopencolorio_namedtransformvisibility.rst | 36 - .../frozen/pyopencolorio_negativestyle.rst | 45 - .../pyopencolorio_negativestylefromstring.rst | 8 - .../pyopencolorio_negativestyletostring.rst | 8 - .../pyopencolorio_optimizationflags.rst | 213 --- .../frozen/pyopencolorio_packedimagedesc.rst | 96 - .../frozen/pyopencolorio_planarimagedesc.rst | 96 - .../python/frozen/pyopencolorio_processor.rst | 154 -- .../pyopencolorio_processorcacheflags.rst | 45 - .../pyopencolorio_processormetadata.rst | 73 - .../frozen/pyopencolorio_rangestyle.rst | 31 - .../pyopencolorio_rangestylefromstring.rst | 8 - .../pyopencolorio_rangestyletostring.rst | 8 - .../frozen/pyopencolorio_rangetransform.rst | 196 -- .../pyopencolorio_referencespacetype.rst | 31 - ...pyopencolorio_resetcomputehashfunction.rst | 8 - ...ncolorio_resettodefaultloggingfunction.rst | 8 - .../frozen/pyopencolorio_rgbcurvetype.rst | 52 - ...pyopencolorio_searchreferencespacetype.rst | 36 - .../pyopencolorio_setcomputehashfunction.rst | 14 - .../frozen/pyopencolorio_setenvvariable.rst | 11 - .../pyopencolorio_setloggingfunction.rst | 13 - .../frozen/pyopencolorio_setlogginglevel.rst | 10 - .../frozen/pyopencolorio_systemmonitors.rst | 40 - .../python/frozen/pyopencolorio_transform.rst | 35 - .../pyopencolorio_transformdirection.rst | 29 - ...encolorio_transformdirectionfromstring.rst | 10 - ...opencolorio_transformdirectiontostring.rst | 8 - .../frozen/pyopencolorio_transformtype.rst | 169 -- .../frozen/pyopencolorio_uniformdatatype.rst | 59 - .../frozen/pyopencolorio_unsetenvvariable.rst | 11 - .../frozen/pyopencolorio_viewingrules.rst | 163 -- .../frozen/pyopencolorio_viewtransform.rst | 126 -- .../pyopencolorio_viewtransformdirection.rst | 29 - .../python/frozen/pyopencolorio_viewtype.rst | 29 - .../python/src/pyopencolorio_allocation.rst | 8 - .../pyopencolorio_allocationfromstring.rst | 5 - .../src/pyopencolorio_allocationtostring.rst | 5 - .../src/pyopencolorio_allocationtransform.rst | 9 - docs/api/python/src/pyopencolorio_baker.rst | 12 - .../api/python/src/pyopencolorio_bitdepth.rst | 8 - .../src/pyopencolorio_bitdepthfromstring.rst | 5 - .../src/pyopencolorio_bitdepthisfloat.rst | 5 - .../src/pyopencolorio_bitdepthtoint.rst | 5 - .../src/pyopencolorio_bitdepthtostring.rst | 5 - .../src/pyopencolorio_boolfromstring.rst | 5 - .../python/src/pyopencolorio_booltostring.rst | 5 - .../src/pyopencolorio_builtintransform.rst | 9 - ...pyopencolorio_builtintransformregistry.rst | 15 - .../api/python/src/pyopencolorio_cdlstyle.rst | 8 - .../src/pyopencolorio_cdlstylefromstring.rst | 5 - .../src/pyopencolorio_cdlstyletostring.rst | 5 - .../python/src/pyopencolorio_cdltransform.rst | 9 - .../src/pyopencolorio_channelordering.rst | 8 - .../src/pyopencolorio_clearallcaches.rst | 5 - .../python/src/pyopencolorio_colorspace.rst | 15 - .../src/pyopencolorio_colorspacedirection.rst | 8 - .../src/pyopencolorio_colorspacehelpers.rst | 20 - .../src/pyopencolorio_colorspaceset.rst | 15 - .../src/pyopencolorio_colorspacetransform.rst | 9 - .../pyopencolorio_colorspacevisibility.rst | 8 - ...opencolorio_combinetransformdirections.rst | 5 - docs/api/python/src/pyopencolorio_config.rst | 88 - docs/api/python/src/pyopencolorio_context.rst | 20 - .../python/src/pyopencolorio_cpuprocessor.rst | 8 - .../src/pyopencolorio_displayviewhelpers.rst | 8 - .../pyopencolorio_displayviewtransform.rst | 9 - .../src/pyopencolorio_dynamicproperty.rst | 8 - .../src/pyopencolorio_dynamicpropertytype.rst | 8 - .../src/pyopencolorio_environmentmode.rst | 8 - ...yopencolorio_environmentmodefromstring.rst | 5 - .../pyopencolorio_environmentmodetostring.rst | 5 - .../python/src/pyopencolorio_exception.rst | 5 - .../pyopencolorio_exceptionmissingfile.rst | 5 - .../src/pyopencolorio_exponenttransform.rst | 9 - ...pencolorio_exponentwithlineartransform.rst | 9 - .../pyopencolorio_exposurecontraststyle.rst | 8 - ...olorio_exposurecontraststylefromstring.rst | 5 - ...ncolorio_exposurecontraststyletostring.rst | 5 - ...yopencolorio_exposurecontrasttransform.rst | 9 - .../python/src/pyopencolorio_filerules.rst | 8 - .../src/pyopencolorio_filetransform.rst | 13 - .../src/pyopencolorio_fixedfunctionstyle.rst | 8 - ...encolorio_fixedfunctionstylefromstring.rst | 5 - ...opencolorio_fixedfunctionstyletostring.rst | 5 - .../pyopencolorio_fixedfunctiontransform.rst | 9 - .../src/pyopencolorio_formatmetadata.rst | 29 - .../src/pyopencolorio_getenvvariable.rst | 5 - ...encolorio_getinversetransformdirection.rst | 5 - .../src/pyopencolorio_getlogginglevel.rst | 5 - .../python/src/pyopencolorio_getversion.rst | 5 - .../src/pyopencolorio_getversionhex.rst | 5 - .../python/src/pyopencolorio_gpulanguage.rst | 8 - .../pyopencolorio_gpulanguagefromstring.rst | 5 - .../src/pyopencolorio_gpulanguagetostring.rst | 5 - .../python/src/pyopencolorio_gpuprocessor.rst | 8 - .../src/pyopencolorio_gpushadercreator.rst | 19 - .../src/pyopencolorio_gpushaderdesc.rst | 48 - .../src/pyopencolorio_gradingbsplinecurve.rst | 12 - .../src/pyopencolorio_gradingcontrolpoint.rst | 8 - .../src/pyopencolorio_gradingprimary.rst | 8 - .../pyopencolorio_gradingprimarytransform.rst | 9 - .../src/pyopencolorio_gradingrgbcurve.rst | 8 - ...pyopencolorio_gradingrgbcurvetransform.rst | 9 - .../python/src/pyopencolorio_gradingrgbm.rst | 8 - .../src/pyopencolorio_gradingrgbmsw.rst | 8 - .../python/src/pyopencolorio_gradingstyle.rst | 8 - .../pyopencolorio_gradingstylefromstring.rst | 5 - .../pyopencolorio_gradingstyletostring.rst | 5 - .../python/src/pyopencolorio_gradingtone.rst | 8 - .../pyopencolorio_gradingtonetransform.rst | 9 - .../src/pyopencolorio_grouptransform.rst | 16 - .../python/src/pyopencolorio_imagedesc.rst | 8 - .../src/pyopencolorio_interpolation.rst | 8 - .../pyopencolorio_interpolationfromstring.rst | 5 - .../pyopencolorio_interpolationtostring.rst | 5 - .../pyopencolorio_isenvvariablepresent.rst | 5 - .../pyopencolorio_legacyviewingpipeline.rst | 8 - .../src/pyopencolorio_logaffinetransform.rst | 9 - .../src/pyopencolorio_logcameratransform.rst | 9 - .../python/src/pyopencolorio_logginglevel.rst | 8 - .../pyopencolorio_logginglevelfromstring.rst | 5 - .../pyopencolorio_loggingleveltostring.rst | 5 - .../python/src/pyopencolorio_logmessage.rst | 5 - .../python/src/pyopencolorio_logtransform.rst | 9 - docs/api/python/src/pyopencolorio_look.rst | 8 - .../src/pyopencolorio_looktransform.rst | 9 - .../src/pyopencolorio_lut1dhueadjust.rst | 8 - .../src/pyopencolorio_lut1dtransform.rst | 9 - .../src/pyopencolorio_lut3dtransform.rst | 9 - .../src/pyopencolorio_matrixtransform.rst | 9 - .../src/pyopencolorio_mixinghelpers.rst | 20 - .../src/pyopencolorio_namedtransform.rst | 12 - ...pyopencolorio_namedtransformvisibility.rst | 8 - .../src/pyopencolorio_negativestyle.rst | 8 - .../pyopencolorio_negativestylefromstring.rst | 5 - .../pyopencolorio_negativestyletostring.rst | 5 - .../src/pyopencolorio_optimizationflags.rst | 8 - .../src/pyopencolorio_packedimagedesc.rst | 9 - .../src/pyopencolorio_planarimagedesc.rst | 9 - .../python/src/pyopencolorio_processor.rst | 12 - .../src/pyopencolorio_processorcacheflags.rst | 8 - .../src/pyopencolorio_processormetadata.rst | 15 - .../python/src/pyopencolorio_rangestyle.rst | 8 - .../pyopencolorio_rangestylefromstring.rst | 5 - .../src/pyopencolorio_rangestyletostring.rst | 5 - .../src/pyopencolorio_rangetransform.rst | 9 - .../src/pyopencolorio_referencespacetype.rst | 8 - ...pyopencolorio_resetcomputehashfunction.rst | 5 - ...ncolorio_resettodefaultloggingfunction.rst | 5 - .../python/src/pyopencolorio_rgbcurvetype.rst | 8 - ...pyopencolorio_searchreferencespacetype.rst | 8 - .../pyopencolorio_setcomputehashfunction.rst | 5 - .../src/pyopencolorio_setenvvariable.rst | 5 - .../src/pyopencolorio_setloggingfunction.rst | 5 - .../src/pyopencolorio_setlogginglevel.rst | 5 - .../src/pyopencolorio_systemmonitors.rst | 12 - .../python/src/pyopencolorio_transform.rst | 8 - .../src/pyopencolorio_transformdirection.rst | 8 - ...encolorio_transformdirectionfromstring.rst | 5 - ...opencolorio_transformdirectiontostring.rst | 5 - .../src/pyopencolorio_transformtype.rst | 8 - .../src/pyopencolorio_uniformdatatype.rst | 8 - .../src/pyopencolorio_unsetenvvariable.rst | 5 - .../python/src/pyopencolorio_viewingrules.rst | 15 - .../src/pyopencolorio_viewtransform.rst | 12 - .../pyopencolorio_viewtransformdirection.rst | 8 - .../api/python/src/pyopencolorio_viewtype.rst | 8 - docs/api/rules.rst | 17 +- docs/api/shaders.rst | 61 +- docs/api/systemmonitors.rst | 9 +- docs/api/transforms.rst | 142 +- docs/api/viewtransform.rst | 9 +- docs/conf.py | 23 +- .../contributing/documentation_guidelines.rst | 20 +- docs/quick_start/installation.rst | 1 - share/docs/frozendoc.py | 333 ---- 294 files changed, 673 insertions(+), 12153 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_colorspacehelpers.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_colorspacemenuhelper.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_colorspacemenuparameters.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_cpuprocessor.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_displayviewhelpers.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_gpuprocessor.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_legacyviewingpipeline.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_mixingcolorspacemanager.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_mixingslider.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_processor.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_processorcacheflags.rst delete mode 100644 docs/api/python/frozen/pyopencolorio_processormetadata.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 delete mode 100644 docs/api/python/src/pyopencolorio_allocation.rst delete mode 100644 docs/api/python/src/pyopencolorio_allocationfromstring.rst delete mode 100644 docs/api/python/src/pyopencolorio_allocationtostring.rst delete mode 100644 docs/api/python/src/pyopencolorio_allocationtransform.rst delete mode 100644 docs/api/python/src/pyopencolorio_baker.rst delete mode 100644 docs/api/python/src/pyopencolorio_bitdepth.rst delete mode 100644 docs/api/python/src/pyopencolorio_bitdepthfromstring.rst delete mode 100644 docs/api/python/src/pyopencolorio_bitdepthisfloat.rst delete mode 100644 docs/api/python/src/pyopencolorio_bitdepthtoint.rst delete mode 100644 docs/api/python/src/pyopencolorio_bitdepthtostring.rst delete mode 100644 docs/api/python/src/pyopencolorio_boolfromstring.rst delete mode 100644 docs/api/python/src/pyopencolorio_booltostring.rst delete mode 100644 docs/api/python/src/pyopencolorio_builtintransform.rst delete mode 100644 docs/api/python/src/pyopencolorio_builtintransformregistry.rst delete mode 100644 docs/api/python/src/pyopencolorio_cdlstyle.rst delete mode 100644 docs/api/python/src/pyopencolorio_cdlstylefromstring.rst delete mode 100644 docs/api/python/src/pyopencolorio_cdlstyletostring.rst delete mode 100644 docs/api/python/src/pyopencolorio_cdltransform.rst delete mode 100644 docs/api/python/src/pyopencolorio_channelordering.rst delete mode 100644 docs/api/python/src/pyopencolorio_clearallcaches.rst delete mode 100644 docs/api/python/src/pyopencolorio_colorspace.rst delete mode 100644 docs/api/python/src/pyopencolorio_colorspacedirection.rst delete mode 100644 docs/api/python/src/pyopencolorio_colorspacehelpers.rst delete mode 100644 docs/api/python/src/pyopencolorio_colorspaceset.rst delete mode 100644 docs/api/python/src/pyopencolorio_colorspacetransform.rst delete mode 100644 docs/api/python/src/pyopencolorio_colorspacevisibility.rst delete mode 100644 docs/api/python/src/pyopencolorio_combinetransformdirections.rst delete mode 100644 docs/api/python/src/pyopencolorio_config.rst delete mode 100644 docs/api/python/src/pyopencolorio_context.rst delete mode 100644 docs/api/python/src/pyopencolorio_cpuprocessor.rst delete mode 100644 docs/api/python/src/pyopencolorio_displayviewhelpers.rst delete mode 100644 docs/api/python/src/pyopencolorio_displayviewtransform.rst delete mode 100644 docs/api/python/src/pyopencolorio_dynamicproperty.rst delete mode 100644 docs/api/python/src/pyopencolorio_dynamicpropertytype.rst delete mode 100644 docs/api/python/src/pyopencolorio_environmentmode.rst delete mode 100644 docs/api/python/src/pyopencolorio_environmentmodefromstring.rst delete mode 100644 docs/api/python/src/pyopencolorio_environmentmodetostring.rst delete mode 100644 docs/api/python/src/pyopencolorio_exception.rst delete mode 100644 docs/api/python/src/pyopencolorio_exceptionmissingfile.rst delete mode 100644 docs/api/python/src/pyopencolorio_exponenttransform.rst delete mode 100644 docs/api/python/src/pyopencolorio_exponentwithlineartransform.rst delete mode 100644 docs/api/python/src/pyopencolorio_exposurecontraststyle.rst delete mode 100644 docs/api/python/src/pyopencolorio_exposurecontraststylefromstring.rst delete mode 100644 docs/api/python/src/pyopencolorio_exposurecontraststyletostring.rst delete mode 100644 docs/api/python/src/pyopencolorio_exposurecontrasttransform.rst delete mode 100644 docs/api/python/src/pyopencolorio_filerules.rst delete mode 100644 docs/api/python/src/pyopencolorio_filetransform.rst delete mode 100644 docs/api/python/src/pyopencolorio_fixedfunctionstyle.rst delete mode 100644 docs/api/python/src/pyopencolorio_fixedfunctionstylefromstring.rst delete mode 100644 docs/api/python/src/pyopencolorio_fixedfunctionstyletostring.rst delete mode 100644 docs/api/python/src/pyopencolorio_fixedfunctiontransform.rst delete mode 100644 docs/api/python/src/pyopencolorio_formatmetadata.rst delete mode 100644 docs/api/python/src/pyopencolorio_getenvvariable.rst delete mode 100644 docs/api/python/src/pyopencolorio_getinversetransformdirection.rst delete mode 100644 docs/api/python/src/pyopencolorio_getlogginglevel.rst delete mode 100644 docs/api/python/src/pyopencolorio_getversion.rst delete mode 100644 docs/api/python/src/pyopencolorio_getversionhex.rst delete mode 100644 docs/api/python/src/pyopencolorio_gpulanguage.rst delete mode 100644 docs/api/python/src/pyopencolorio_gpulanguagefromstring.rst delete mode 100644 docs/api/python/src/pyopencolorio_gpulanguagetostring.rst delete mode 100644 docs/api/python/src/pyopencolorio_gpuprocessor.rst delete mode 100644 docs/api/python/src/pyopencolorio_gpushadercreator.rst delete mode 100644 docs/api/python/src/pyopencolorio_gpushaderdesc.rst delete mode 100644 docs/api/python/src/pyopencolorio_gradingbsplinecurve.rst delete mode 100644 docs/api/python/src/pyopencolorio_gradingcontrolpoint.rst delete mode 100644 docs/api/python/src/pyopencolorio_gradingprimary.rst delete mode 100644 docs/api/python/src/pyopencolorio_gradingprimarytransform.rst delete mode 100644 docs/api/python/src/pyopencolorio_gradingrgbcurve.rst delete mode 100644 docs/api/python/src/pyopencolorio_gradingrgbcurvetransform.rst delete mode 100644 docs/api/python/src/pyopencolorio_gradingrgbm.rst delete mode 100644 docs/api/python/src/pyopencolorio_gradingrgbmsw.rst delete mode 100644 docs/api/python/src/pyopencolorio_gradingstyle.rst delete mode 100644 docs/api/python/src/pyopencolorio_gradingstylefromstring.rst delete mode 100644 docs/api/python/src/pyopencolorio_gradingstyletostring.rst delete mode 100644 docs/api/python/src/pyopencolorio_gradingtone.rst delete mode 100644 docs/api/python/src/pyopencolorio_gradingtonetransform.rst delete mode 100644 docs/api/python/src/pyopencolorio_grouptransform.rst delete mode 100644 docs/api/python/src/pyopencolorio_imagedesc.rst delete mode 100644 docs/api/python/src/pyopencolorio_interpolation.rst delete mode 100644 docs/api/python/src/pyopencolorio_interpolationfromstring.rst delete mode 100644 docs/api/python/src/pyopencolorio_interpolationtostring.rst delete mode 100644 docs/api/python/src/pyopencolorio_isenvvariablepresent.rst delete mode 100644 docs/api/python/src/pyopencolorio_legacyviewingpipeline.rst delete mode 100644 docs/api/python/src/pyopencolorio_logaffinetransform.rst delete mode 100644 docs/api/python/src/pyopencolorio_logcameratransform.rst delete mode 100644 docs/api/python/src/pyopencolorio_logginglevel.rst delete mode 100644 docs/api/python/src/pyopencolorio_logginglevelfromstring.rst delete mode 100644 docs/api/python/src/pyopencolorio_loggingleveltostring.rst delete mode 100644 docs/api/python/src/pyopencolorio_logmessage.rst delete mode 100644 docs/api/python/src/pyopencolorio_logtransform.rst delete mode 100644 docs/api/python/src/pyopencolorio_look.rst delete mode 100644 docs/api/python/src/pyopencolorio_looktransform.rst delete mode 100644 docs/api/python/src/pyopencolorio_lut1dhueadjust.rst delete mode 100644 docs/api/python/src/pyopencolorio_lut1dtransform.rst delete mode 100644 docs/api/python/src/pyopencolorio_lut3dtransform.rst delete mode 100644 docs/api/python/src/pyopencolorio_matrixtransform.rst delete mode 100644 docs/api/python/src/pyopencolorio_mixinghelpers.rst delete mode 100644 docs/api/python/src/pyopencolorio_namedtransform.rst delete mode 100644 docs/api/python/src/pyopencolorio_namedtransformvisibility.rst delete mode 100644 docs/api/python/src/pyopencolorio_negativestyle.rst delete mode 100644 docs/api/python/src/pyopencolorio_negativestylefromstring.rst delete mode 100644 docs/api/python/src/pyopencolorio_negativestyletostring.rst delete mode 100644 docs/api/python/src/pyopencolorio_optimizationflags.rst delete mode 100644 docs/api/python/src/pyopencolorio_packedimagedesc.rst delete mode 100644 docs/api/python/src/pyopencolorio_planarimagedesc.rst delete mode 100644 docs/api/python/src/pyopencolorio_processor.rst delete mode 100644 docs/api/python/src/pyopencolorio_processorcacheflags.rst delete mode 100644 docs/api/python/src/pyopencolorio_processormetadata.rst delete mode 100644 docs/api/python/src/pyopencolorio_rangestyle.rst delete mode 100644 docs/api/python/src/pyopencolorio_rangestylefromstring.rst delete mode 100644 docs/api/python/src/pyopencolorio_rangestyletostring.rst delete mode 100644 docs/api/python/src/pyopencolorio_rangetransform.rst delete mode 100644 docs/api/python/src/pyopencolorio_referencespacetype.rst delete mode 100644 docs/api/python/src/pyopencolorio_resetcomputehashfunction.rst delete mode 100644 docs/api/python/src/pyopencolorio_resettodefaultloggingfunction.rst delete mode 100644 docs/api/python/src/pyopencolorio_rgbcurvetype.rst delete mode 100644 docs/api/python/src/pyopencolorio_searchreferencespacetype.rst delete mode 100644 docs/api/python/src/pyopencolorio_setcomputehashfunction.rst delete mode 100644 docs/api/python/src/pyopencolorio_setenvvariable.rst delete mode 100644 docs/api/python/src/pyopencolorio_setloggingfunction.rst delete mode 100644 docs/api/python/src/pyopencolorio_setlogginglevel.rst delete mode 100644 docs/api/python/src/pyopencolorio_systemmonitors.rst delete mode 100644 docs/api/python/src/pyopencolorio_transform.rst delete mode 100644 docs/api/python/src/pyopencolorio_transformdirection.rst delete mode 100644 docs/api/python/src/pyopencolorio_transformdirectionfromstring.rst delete mode 100644 docs/api/python/src/pyopencolorio_transformdirectiontostring.rst delete mode 100644 docs/api/python/src/pyopencolorio_transformtype.rst delete mode 100644 docs/api/python/src/pyopencolorio_uniformdatatype.rst delete mode 100644 docs/api/python/src/pyopencolorio_unsetenvvariable.rst delete mode 100644 docs/api/python/src/pyopencolorio_viewingrules.rst delete mode 100644 docs/api/python/src/pyopencolorio_viewtransform.rst delete mode 100644 docs/api/python/src/pyopencolorio_viewtransformdirection.rst delete mode 100644 docs/api/python/src/pyopencolorio_viewtype.rst delete mode 100644 share/docs/frozendoc.py diff --git a/CMakeLists.txt b/CMakeLists.txt index edb74c3db0..579255ddd9 100755 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -144,8 +144,7 @@ option(OCIO_BUILD_TESTS "Specify whether to build unittests" ON) option(OCIO_BUILD_GPU_TESTS "Specify whether to build gpu unittests" ON) option(OCIO_USE_HEADLESS "Specify whether the GPU rendering is headless" OFF) -option(OCIO_BUILD_FROZEN_DOCS "Specify whether to build frozen documentation, necessary when modifying the OCIO public API" OFF) -option(OCIO_BUILD_DOCS "Specify whether to build documentation" ${OCIO_BUILD_FROZEN_DOCS}) +option(OCIO_BUILD_DOCS "Specify whether to build documentation" OFF) option(OCIO_BUILD_PYTHON "Specify whether to build python bindings" ON) set (OCIO_PYTHON_VERSION "" CACHE STRING diff --git a/docs/api/apphelpers.rst b/docs/api/apphelpers.rst index e84606de69..a31935708d 100644 --- a/docs/api/apphelpers.rst +++ b/docs/api/apphelpers.rst @@ -12,7 +12,22 @@ ColorSpaceMenuHelpers .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_colorspacehelpers.rst + .. autofunction:: PyOpenColorIO.ColorSpaceHelpers.AddColorSpace + + .. autoclass:: PyOpenColorIO.ColorSpaceMenuParameters + :members: + :undoc-members: + :special-members: __init__, __str__ + :exclude-members: AddedColorSpaceIterator + + .. autoclass:: PyOpenColorIO.ColorSpaceMenuHelper + :members: + :undoc-members: + :special-members: __init__, __str__ + :exclude-members: ColorSpaceLevelIterator + + .. autoclass:: PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator + :special-members: __getitem__, __iter__, __len__, __next__ .. group-tab:: C++ @@ -38,7 +53,10 @@ DisplayViewHelpers .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_displayviewhelpers.rst + .. autofunction:: PyOpenColorIO.DisplayViewHelpers.GetProcessor + .. autofunction:: PyOpenColorIO.DisplayViewHelpers.GetIdentityProcessor + .. autofunction:: PyOpenColorIO.DisplayViewHelpers.AddDisplayView + .. autofunction:: PyOpenColorIO.DisplayViewHelpers.RemoveDisplayView .. group-tab:: C++ @@ -53,7 +71,10 @@ LegacyViewingPipeline .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_legacyviewingpipeline.rst + .. autoclass:: PyOpenColorIO.LegacyViewingPipeline + :members: + :undoc-members: + :special-members: __init__, __str__ .. group-tab:: C++ @@ -73,7 +94,22 @@ MixingHelpers .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_mixinghelpers.rst + .. autoclass:: PyOpenColorIO.MixingSlider + :members: + :undoc-members: + :special-members: __init__, __str__ + + .. autoclass:: PyOpenColorIO.MixingColorSpaceManager + :members: + :undoc-members: + :special-members: __init__, __str__ + :exclude-members: MixingSpaceIterator, MixingEncodingIterator + + .. autoclass:: PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.MixingColorSpaceManager.MixingEncodingIterator + :special-members: __getitem__, __iter__, __len__, __next__ .. group-tab:: C++ diff --git a/docs/api/baker.rst b/docs/api/baker.rst index b896e3a8ef..617d3ad656 100644 --- a/docs/api/baker.rst +++ b/docs/api/baker.rst @@ -9,7 +9,14 @@ Baker .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_baker.rst + .. autoclass:: PyOpenColorIO.Baker + :members: + :undoc-members: + :special-members: __init__ + :exclude-members: FormatIterator + + .. autoclass:: PyOpenColorIO.Baker.FormatIterator + :special-members: __getitem__, __iter__, __len__, __next__ .. group-tab:: C++ diff --git a/docs/api/colorspace.rst b/docs/api/colorspace.rst index 38a5e63f71..7df4408b4c 100644 --- a/docs/api/colorspace.rst +++ b/docs/api/colorspace.rst @@ -9,7 +9,17 @@ ColorSpace .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_colorspace.rst + .. autoclass:: PyOpenColorIO.ColorSpace + :members: + :undoc-members: + :special-members: __init__, __str__ + :exclude-members: ColorSpaceCategoryIterator, ColorSpaceAliasIterator + + .. autoclass:: PyOpenColorIO.ColorSpace.ColorSpaceCategoryIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.ColorSpace.ColorSpaceAliasIterator + :special-members: __getitem__, __iter__, __len__, __next__ .. group-tab:: C++ @@ -29,7 +39,17 @@ ColorSpaceSet .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_colorspaceset.rst + .. autoclass:: PyOpenColorIO.ColorSpaceSet + :members: + :undoc-members: + :special-members: __init__, __eq__, __ne__, __sub__, __or__, __and__ + :exclude-members: ColorSpaceNameIterator, ColorSpaceIterator + + .. autoclass:: PyOpenColorIO.ColorSpaceSet.ColorSpaceNameIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.ColorSpaceSet.ColorSpaceIterator + :special-members: __getitem__, __iter__, __len__, __next__ .. group-tab:: C++ diff --git a/docs/api/config.rst b/docs/api/config.rst index fed8180820..395e5c5cf8 100644 --- a/docs/api/config.rst +++ b/docs/api/config.rst @@ -9,7 +9,90 @@ Config .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_config.rst + .. autoclass:: PyOpenColorIO.Config + :members: + :undoc-members: + :special-members: __init__, __str__ + :exclude-members: EnvironmentVarNameIterator, + SearchPathIterator, + ColorSpaceNameIterator, + ColorSpaceIterator, + ActiveColorSpaceNameIterator, + ActiveColorSpaceIterator, + RoleNameIterator, + RoleColorSpaceIterator, + DisplayIterator, + SharedViewIterator, + ViewIterator, + ViewForColorSpaceIterator, + LookNameIterator, + LookIterator, + ViewTransformNameIterator, + ViewTransformIterator, + NamedTransformNameIterator, + NamedTransformIterator, + ActiveNamedTransformNameIterator, + ActiveNamedTransformIterator + + .. autoclass:: PyOpenColorIO.Config.EnvironmentVarNameIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.Config.SearchPathIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.Config.ColorSpaceNameIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.Config.ColorSpaceIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.Config.ActiveColorSpaceNameIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.Config.ActiveColorSpaceIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.Config.RoleNameIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.Config.RoleColorSpaceIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.Config.DisplayIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.Config.SharedViewIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.Config.ViewIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.Config.ViewForColorSpaceIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.Config.LookNameIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.Config.LookIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.Config.ViewTransformNameIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.Config.ViewTransformIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.Config.NamedTransformNameIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.Config.NamedTransformIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.Config.ActiveNamedTransformNameIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.Config.ActiveNamedTransformIterator + :special-members: __getitem__, __iter__, __len__, __next__ .. group-tab:: C++ diff --git a/docs/api/context.rst b/docs/api/context.rst index c4f3f02212..4e2a831c5e 100644 --- a/docs/api/context.rst +++ b/docs/api/context.rst @@ -9,7 +9,22 @@ Context .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_context.rst + .. autoclass:: PyOpenColorIO.Context + :members: + :undoc-members: + :special-members: __init__, __str__ + :exclude-members: StringVarNameIterator, + StringVarIterator, + SearchPathIterator + + .. autoclass:: PyOpenColorIO.Context.StringVarNameIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.Context.StringVarIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.Context.SearchPathIterator + :special-members: __getitem__, __iter__, __len__, __next__ .. group-tab:: C++ diff --git a/docs/api/dynamicproperty.rst b/docs/api/dynamicproperty.rst index e0e4607825..59898db190 100644 --- a/docs/api/dynamicproperty.rst +++ b/docs/api/dynamicproperty.rst @@ -9,7 +9,10 @@ DynamicProperty .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_dynamicproperty.rst + .. autoclass:: PyOpenColorIO.DynamicProperty + :members: + :undoc-members: + :special-members: __init__ .. group-tab:: C++ diff --git a/docs/api/enums.rst b/docs/api/enums.rst index 153e1d7a47..11646686c2 100644 --- a/docs/api/enums.rst +++ b/docs/api/enums.rst @@ -12,7 +12,10 @@ LoggingLevel .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_logginglevel.rst + .. autoclass:: PyOpenColorIO.LoggingLevel + :members: + :undoc-members: + :exclude-members: name .. group-tab:: C++ @@ -27,7 +30,10 @@ ReferenceSpaceType .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_referencespacetype.rst + .. autoclass:: PyOpenColorIO.ReferenceSpaceType + :members: + :undoc-members: + :exclude-members: name .. group-tab:: C++ @@ -40,7 +46,10 @@ SearchReferenceSpaceType .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_searchreferencespacetype.rst + .. autoclass:: PyOpenColorIO.SearchReferenceSpaceType + :members: + :undoc-members: + :exclude-members: name .. group-tab:: C++ @@ -53,7 +62,10 @@ NamedTransformVisibility .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_namedtransformvisibility.rst + .. autoclass:: PyOpenColorIO.NamedTransformVisibility + :members: + :undoc-members: + :exclude-members: name .. group-tab:: C++ @@ -66,7 +78,10 @@ ColorSpaceVisibility .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_colorspacevisibility.rst + .. autoclass:: PyOpenColorIO.ColorSpaceVisibility + :members: + :undoc-members: + :exclude-members: name .. group-tab:: C++ @@ -79,7 +94,10 @@ ViewType .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_viewtype.rst + .. autoclass:: PyOpenColorIO.ViewType + :members: + :undoc-members: + :exclude-members: name .. group-tab:: C++ @@ -92,7 +110,10 @@ ColorSpaceDirection .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_colorspacedirection.rst + .. autoclass:: PyOpenColorIO.ColorSpaceDirection + :members: + :undoc-members: + :exclude-members: name .. group-tab:: C++ @@ -107,7 +128,10 @@ ViewTransformDirection .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_viewtransformdirection.rst + .. autoclass:: PyOpenColorIO.ViewTransformDirection + :members: + :undoc-members: + :exclude-members: name .. group-tab:: C++ @@ -122,7 +146,10 @@ TransformDirection .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_transformdirection.rst + .. autoclass:: PyOpenColorIO.TransformDirection + :members: + :undoc-members: + :exclude-members: name .. group-tab:: C++ @@ -137,7 +164,10 @@ TransformType .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_transformtype.rst + .. autoclass:: PyOpenColorIO.TransformType + :members: + :undoc-members: + :exclude-members: name .. group-tab:: C++ @@ -150,7 +180,10 @@ Interpolation .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_interpolation.rst + .. autoclass:: PyOpenColorIO.Interpolation + :members: + :undoc-members: + :exclude-members: name .. group-tab:: C++ @@ -165,7 +198,10 @@ BitDepth .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_bitdepth.rst + .. autoclass:: PyOpenColorIO.BitDepth + :members: + :undoc-members: + :exclude-members: name .. group-tab:: C++ @@ -180,7 +216,10 @@ Lut1DHueAdjust .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_lut1dhueadjust.rst + .. autoclass:: PyOpenColorIO.Lut1DHueAdjust + :members: + :undoc-members: + :exclude-members: name .. group-tab:: C++ @@ -193,7 +232,10 @@ ChannelOrdering .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_channelordering.rst + .. autoclass:: PyOpenColorIO.ChannelOrdering + :members: + :undoc-members: + :exclude-members: name .. group-tab:: C++ @@ -206,7 +248,10 @@ Allocation .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_allocation.rst + .. autoclass:: PyOpenColorIO.Allocation + :members: + :undoc-members: + :exclude-members: name .. group-tab:: C++ @@ -221,7 +266,10 @@ GpuLanguage .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_gpulanguage.rst + .. autoclass:: PyOpenColorIO.GpuLanguage + :members: + :undoc-members: + :exclude-members: name .. group-tab:: C++ @@ -236,7 +284,10 @@ EnvironmentMode .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_environmentmode.rst + .. autoclass:: PyOpenColorIO.EnvironmentMode + :members: + :undoc-members: + :exclude-members: name .. group-tab:: C++ @@ -251,7 +302,10 @@ RangeStyle .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_rangestyle.rst + .. autoclass:: PyOpenColorIO.RangeStyle + :members: + :undoc-members: + :exclude-members: name .. group-tab:: C++ @@ -266,7 +320,10 @@ FixedFunctionStyle .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_fixedfunctionstyle.rst + .. autoclass:: PyOpenColorIO.FixedFunctionStyle + :members: + :undoc-members: + :exclude-members: name .. group-tab:: C++ @@ -281,7 +338,10 @@ ExposureContrastStyle .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_exposurecontraststyle.rst + .. autoclass:: PyOpenColorIO.ExposureContrastStyle + :members: + :undoc-members: + :exclude-members: name .. group-tab:: C++ @@ -296,7 +356,10 @@ CDLStyle .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_cdlstyle.rst + .. autoclass:: PyOpenColorIO.CDLStyle + :members: + :undoc-members: + :exclude-members: name .. group-tab:: C++ @@ -311,7 +374,10 @@ NegativeStyle .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_negativestyle.rst + .. autoclass:: PyOpenColorIO.NegativeStyle + :members: + :undoc-members: + :exclude-members: name .. group-tab:: C++ @@ -326,7 +392,10 @@ GradingStyle .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_gradingstyle.rst + .. autoclass:: PyOpenColorIO.GradingStyle + :members: + :undoc-members: + :exclude-members: name .. group-tab:: C++ @@ -341,7 +410,10 @@ DynamicPropertyType .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_dynamicpropertytype.rst + .. autoclass:: PyOpenColorIO.DynamicPropertyType + :members: + :undoc-members: + :exclude-members: name .. group-tab:: C++ @@ -354,7 +426,10 @@ RGBCurveType .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_rgbcurvetype.rst + .. autoclass:: PyOpenColorIO.RGBCurveType + :members: + :undoc-members: + :exclude-members: name .. group-tab:: C++ @@ -367,7 +442,10 @@ UniformDataType .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_uniformdatatype.rst + .. autoclass:: PyOpenColorIO.UniformDataType + :members: + :undoc-members: + :exclude-members: name .. group-tab:: C++ @@ -380,7 +458,10 @@ OptimizationFlags .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_optimizationflags.rst + .. autoclass:: PyOpenColorIO.OptimizationFlags + :members: + :undoc-members: + :exclude-members: name .. group-tab:: C++ @@ -393,7 +474,10 @@ ProcessorCacheFlags .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_processorcacheflags.rst + .. autoclass:: PyOpenColorIO.ProcessorCacheFlags + :members: + :undoc-members: + :exclude-members: name .. group-tab:: C++ diff --git a/docs/api/exceptions.rst b/docs/api/exceptions.rst index ed46c1d7a0..6602cd62d2 100644 --- a/docs/api/exceptions.rst +++ b/docs/api/exceptions.rst @@ -9,9 +9,9 @@ Exceptions .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_exception.rst + .. autoexception:: PyOpenColorIO.Exception - .. include:: python/${PYDIR}/pyopencolorio_exceptionmissingfile.rst + .. autoexception:: PyOpenColorIO.ExceptionMissingFile .. group-tab:: C++ diff --git a/docs/api/formatmetadata.rst b/docs/api/formatmetadata.rst index fade1a81ca..d49edcf8f6 100644 --- a/docs/api/formatmetadata.rst +++ b/docs/api/formatmetadata.rst @@ -9,7 +9,31 @@ FormatMetadata .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_formatmetadata.rst + .. autoclass:: PyOpenColorIO.FormatMetadata + :members: + :undoc-members: + :special-members: __init__, + __iter__, + __len__, + __getitem__, + __setitem__, + __contains__ + :exclude-members: AttributeNameIterator, + AttributeIterator, + ConstChildElementIterator, + ChildElementIterator + + .. autoclass:: PyOpenColorIO.FormatMetadata.AttributeNameIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.FormatMetadata.AttributeIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.FormatMetadata.ConstChildElementIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.FormatMetadata.ChildElementIterator + :special-members: __getitem__, __iter__, __len__, __next__ .. group-tab:: C++ diff --git a/docs/api/global.rst b/docs/api/global.rst index 7fad558b4c..d592099bc8 100644 --- a/docs/api/global.rst +++ b/docs/api/global.rst @@ -12,7 +12,7 @@ Caching .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_clearallcaches.rst + .. autofunction:: PyOpenColorIO.ClearAllCaches .. group-tab:: C++ @@ -27,9 +27,9 @@ Version .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_getversion.rst + .. autofunction:: PyOpenColorIO.GetVersion - .. include:: python/${PYDIR}/pyopencolorio_getversionhex.rst + .. autofunction:: PyOpenColorIO.GetVersionHex .. group-tab:: C++ @@ -44,9 +44,9 @@ Logging .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_getlogginglevel.rst + .. autofunction:: PyOpenColorIO.GetLoggingLevel - .. include:: python/${PYDIR}/pyopencolorio_setlogginglevel.rst + .. autofunction:: PyOpenColorIO.SetLoggingLevel .. group-tab:: C++ @@ -61,11 +61,11 @@ Logging Function .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_setloggingfunction.rst + .. autofunction:: PyOpenColorIO.SetLoggingFunction - .. include:: python/${PYDIR}/pyopencolorio_resettodefaultloggingfunction.rst + .. autofunction:: PyOpenColorIO.ResetToDefaultLoggingFunction - .. include:: python/${PYDIR}/pyopencolorio_logmessage.rst + .. autofunction:: PyOpenColorIO.LogMessage .. group-tab:: C++ @@ -84,9 +84,9 @@ Compute Hash Function .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_setcomputehashfunction.rst + .. autofunction:: PyOpenColorIO.SetComputeHashFunction - .. include:: python/${PYDIR}/pyopencolorio_resetcomputehashfunction.rst + .. autofunction:: PyOpenColorIO.ResetComputeHashFunction .. group-tab:: C++ @@ -103,13 +103,13 @@ Environment Variables .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_getenvvariable.rst + .. autofunction:: PyOpenColorIO.GetEnvVariable - .. include:: python/${PYDIR}/pyopencolorio_setenvvariable.rst + .. autofunction:: PyOpenColorIO.SetEnvVariable - .. include:: python/${PYDIR}/pyopencolorio_unsetenvvariable.rst + .. autofunction:: PyOpenColorIO.UnsetEnvVariable - .. include:: python/${PYDIR}/pyopencolorio_isenvvariablepresent.rst + .. autofunction:: PyOpenColorIO.IsEnvVariablePresent .. group-tab:: C++ @@ -142,9 +142,9 @@ Bool .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_booltostring.rst + .. autofunction:: PyOpenColorIO.BoolToString - .. include:: python/${PYDIR}/pyopencolorio_boolfromstring.rst + .. autofunction:: PyOpenColorIO.BoolFromString .. group-tab:: C++ @@ -161,9 +161,9 @@ LoggingLevel .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_loggingleveltostring.rst + .. autofunction:: PyOpenColorIO.LoggingLevelToString - .. include:: python/${PYDIR}/pyopencolorio_logginglevelfromstring.rst + .. autofunction:: PyOpenColorIO.LoggingLevelFromString .. group-tab:: C++ @@ -180,13 +180,13 @@ TransformDirection .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_transformdirectiontostring.rst + .. autofunction:: PyOpenColorIO.TransformDirectionToString - .. include:: python/${PYDIR}/pyopencolorio_transformdirectionfromstring.rst + .. autofunction:: PyOpenColorIO.TransformDirectionFromString - .. include:: python/${PYDIR}/pyopencolorio_getinversetransformdirection.rst + .. autofunction:: PyOpenColorIO.GetInverseTransformDirection - .. include:: python/${PYDIR}/pyopencolorio_combinetransformdirections.rst + .. autofunction:: PyOpenColorIO.CombineTransformDirections .. group-tab:: C++ @@ -207,13 +207,13 @@ BitDepth .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_bitdepthtostring.rst + .. autofunction:: PyOpenColorIO.BitDepthToString - .. include:: python/${PYDIR}/pyopencolorio_bitdepthfromstring.rst + .. autofunction:: PyOpenColorIO.BitDepthFromString - .. include:: python/${PYDIR}/pyopencolorio_bitdepthisfloat.rst + .. autofunction:: PyOpenColorIO.BitDepthIsFloat - .. include:: python/${PYDIR}/pyopencolorio_bitdepthtoint.rst + .. autofunction:: PyOpenColorIO.BitDepthToInt .. group-tab:: C++ @@ -234,9 +234,9 @@ Allocation .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_allocationtostring.rst + .. autofunction:: PyOpenColorIO.AllocationToString - .. include:: python/${PYDIR}/pyopencolorio_allocationfromstring.rst + .. autofunction:: PyOpenColorIO.AllocationFromString .. group-tab:: C++ @@ -253,9 +253,9 @@ Interpolation .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_interpolationtostring.rst + .. autofunction:: PyOpenColorIO.InterpolationToString - .. include:: python/${PYDIR}/pyopencolorio_interpolationfromstring.rst + .. autofunction:: PyOpenColorIO.InterpolationFromString .. group-tab:: C++ @@ -272,9 +272,9 @@ GpuLanguage .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_gpulanguagetostring.rst + .. autofunction:: PyOpenColorIO.GpuLanguageToString - .. include:: python/${PYDIR}/pyopencolorio_gpulanguagefromstring.rst + .. autofunction:: PyOpenColorIO.GpuLanguageFromString .. group-tab:: C++ @@ -291,9 +291,9 @@ EnvironmentMode .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_environmentmodetostring.rst + .. autofunction:: PyOpenColorIO.EnvironmentModeToString - .. include:: python/${PYDIR}/pyopencolorio_environmentmodefromstring.rst + .. autofunction:: PyOpenColorIO.EnvironmentModeFromString .. group-tab:: C++ @@ -310,9 +310,9 @@ CDLStyle .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_cdlstyletostring.rst + .. autofunction:: PyOpenColorIO.CDLStyleToString - .. include:: python/${PYDIR}/pyopencolorio_cdlstylefromstring.rst + .. autofunction:: PyOpenColorIO.CDLStyleFromString .. group-tab:: C++ @@ -329,9 +329,9 @@ RangeStyle .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_rangestyletostring.rst + .. autofunction:: PyOpenColorIO.RangeStyleToString - .. include:: python/${PYDIR}/pyopencolorio_rangestylefromstring.rst + .. autofunction:: PyOpenColorIO.RangeStyleFromString .. group-tab:: C++ @@ -348,9 +348,9 @@ FixedFunctionStyle .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_fixedfunctionstyletostring.rst + .. autofunction:: PyOpenColorIO.FixedFunctionStyleToString - .. include:: python/${PYDIR}/pyopencolorio_fixedfunctionstylefromstring.rst + .. autofunction:: PyOpenColorIO.FixedFunctionStyleFromString .. group-tab:: C++ @@ -367,9 +367,9 @@ GradingStyle .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_gradingstyletostring.rst + .. autofunction:: PyOpenColorIO.GradingStyleToString - .. include:: python/${PYDIR}/pyopencolorio_gradingstylefromstring.rst + .. autofunction:: PyOpenColorIO.GradingStyleFromString .. group-tab:: C++ @@ -386,9 +386,9 @@ ExposureContrastStyle .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_exposurecontraststyletostring.rst + .. autofunction:: PyOpenColorIO.ExposureContrastStyleToString - .. include:: python/${PYDIR}/pyopencolorio_exposurecontraststylefromstring.rst + .. autofunction:: PyOpenColorIO.ExposureContrastStyleFromString .. group-tab:: C++ @@ -405,9 +405,9 @@ NegativeStyle .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_negativestyletostring.rst + .. autofunction:: PyOpenColorIO.NegativeStyleToString - .. include:: python/${PYDIR}/pyopencolorio_negativestylefromstring.rst + .. autofunction:: PyOpenColorIO.NegativeStyleFromString .. group-tab:: C++ diff --git a/docs/api/grading_transforms.rst b/docs/api/grading_transforms.rst index 02145d72a7..83fafe2d24 100644 --- a/docs/api/grading_transforms.rst +++ b/docs/api/grading_transforms.rst @@ -14,7 +14,11 @@ GradingPrimaryTransform .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_gradingprimarytransform.rst + .. autoclass:: PyOpenColorIO.GradingPrimaryTransform + :members: + :undoc-members: + :special-members: __init__, __str__ + :inherited-members: .. group-tab:: C++ @@ -34,7 +38,10 @@ GradingPrimary .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_gradingprimary.rst + .. autoclass:: PyOpenColorIO.GradingPrimary + :members: + :undoc-members: + :special-members: __init__, __str__ .. group-tab:: C++ @@ -51,7 +58,10 @@ GradingRGBM .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_gradingrgbm.rst + .. autoclass:: PyOpenColorIO.GradingRGBM + :members: + :undoc-members: + :special-members: __init__, __str__ .. group-tab:: C++ @@ -68,7 +78,11 @@ GradingRGBCurveTransform .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_gradingrgbcurvetransform.rst + .. autoclass:: PyOpenColorIO.GradingRGBCurveTransform + :members: + :undoc-members: + :special-members: __init__, __str__ + :inherited-members: .. group-tab:: C++ @@ -88,7 +102,10 @@ GradingRGBCurve .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_gradingrgbcurve.rst + .. autoclass:: PyOpenColorIO.GradingRGBCurve + :members: + :undoc-members: + :special-members: __init__, __str__ .. group-tab:: C++ @@ -108,7 +125,10 @@ GradingControlPoint .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_gradingcontrolpoint.rst + .. autoclass:: PyOpenColorIO.GradingControlPoint + :members: + :undoc-members: + :special-members: __init__, __str__ .. group-tab:: C++ @@ -125,7 +145,14 @@ GradingBSplineCurve .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_gradingbsplinecurve.rst + .. autoclass:: PyOpenColorIO.GradingBSplineCurve + :members: + :undoc-members: + :special-members: __init__, __str__ + :exclude-members: GradingControlPointIterator + + .. autoclass:: PyOpenColorIO.GradingBSplineCurve.GradingControlPointIterator + :special-members: __getitem__, __setitem__, __iter__, __len__, __next__ .. group-tab:: C++ @@ -145,7 +172,11 @@ GradingToneTransform .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_gradingtonetransform.rst + .. autoclass:: PyOpenColorIO.GradingToneTransform + :members: + :undoc-members: + :special-members: __init__, __str__ + :inherited-members: .. group-tab:: C++ @@ -165,7 +196,10 @@ GradingTone .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_gradingtone.rst + .. autoclass:: PyOpenColorIO.GradingTone + :members: + :undoc-members: + :special-members: __init__, __str__ .. group-tab:: C++ @@ -182,7 +216,10 @@ GradingRGBMSW .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_gradingrgbmsw.rst + .. autoclass:: PyOpenColorIO.GradingRGBMSW + :members: + :undoc-members: + :special-members: __init__, __str__ .. group-tab:: C++ diff --git a/docs/api/imagedesc.rst b/docs/api/imagedesc.rst index 107d923068..ed14e5a9f5 100644 --- a/docs/api/imagedesc.rst +++ b/docs/api/imagedesc.rst @@ -9,7 +9,10 @@ ImageDesc .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_imagedesc.rst + .. autoclass:: PyOpenColorIO.ImageDesc + :members: + :undoc-members: + :special-members: __init__ .. py:data:: AutoStride :module: PyOpenColorIO @@ -35,7 +38,11 @@ PackedImageDesc .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_packedimagedesc.rst + .. autoclass:: PyOpenColorIO.PackedImageDesc + :members: + :undoc-members: + :special-members: __init__ + :inherited-members: .. group-tab:: C++ @@ -50,7 +57,11 @@ PlanarImageDesc .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_planarimagedesc.rst + .. autoclass:: PyOpenColorIO.PlanarImageDesc + :members: + :undoc-members: + :special-members: __init__ + :inherited-members: .. group-tab:: C++ diff --git a/docs/api/look.rst b/docs/api/look.rst index db8a3bad6e..fcd9808eb6 100644 --- a/docs/api/look.rst +++ b/docs/api/look.rst @@ -9,7 +9,10 @@ Look .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_look.rst + .. autoclass:: PyOpenColorIO.Look + :members: + :undoc-members: + :special-members: __init__, __str__ .. group-tab:: C++ diff --git a/docs/api/namedtransform.rst b/docs/api/namedtransform.rst index f2fe69685f..c770a4a766 100644 --- a/docs/api/namedtransform.rst +++ b/docs/api/namedtransform.rst @@ -9,7 +9,14 @@ Named Transform .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_namedtransform.rst + .. autoclass:: PyOpenColorIO.NamedTransform + :members: + :undoc-members: + :special-members: __init__, __str__ + :exclude-members: NamedTransformCategoryIterator + + .. autoclass:: PyOpenColorIO.NamedTransform.NamedTransformCategoryIterator + :special-members: __getitem__, __iter__, __len__, __next__ .. group-tab:: C++ diff --git a/docs/api/processors.rst b/docs/api/processors.rst index 230d821af7..5b97f61009 100644 --- a/docs/api/processors.rst +++ b/docs/api/processors.rst @@ -12,7 +12,14 @@ Processor .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_processor.rst + .. autoclass:: PyOpenColorIO.Processor + :members: + :undoc-members: + :special-members: __init__ + :exclude-members: TransformFormatMetadataIterator, WriteFormatIterator + + .. autoclass:: PyOpenColorIO.Processor.TransformFormatMetadataIterator + :special-members: __getitem__, __iter__, __len__, __next__ .. group-tab:: C++ @@ -30,7 +37,10 @@ CPUProcessor .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_cpuprocessor.rst + .. autoclass:: PyOpenColorIO.CPUProcessor + :members: + :undoc-members: + :special-members: __init__ .. group-tab:: C++ @@ -48,7 +58,10 @@ GPUProcessor .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_gpuprocessor.rst + .. autoclass:: PyOpenColorIO.GPUProcessor + :members: + :undoc-members: + :special-members: __init__ .. group-tab:: C++ @@ -66,7 +79,17 @@ ProcessorMetadata .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_processormetadata.rst + .. autoclass:: PyOpenColorIO.ProcessorMetadata + :members: + :undoc-members: + :special-members: __init__ + :exclude-members: FileIterator, LookIterator + + .. autoclass:: PyOpenColorIO.ProcessorMetadata.FileIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.ProcessorMetadata.LookIterator + :special-members: __getitem__, __iter__, __len__, __next__ .. group-tab:: C++ diff --git a/docs/api/python/frozen/pyopencolorio_allocation.rst b/docs/api/python/frozen/pyopencolorio_allocation.rst deleted file mode 100644 index f7e734311f..0000000000 --- a/docs/api/python/frozen/pyopencolorio_allocation.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:: Allocation - :module: PyOpenColorIO - :canonical: PyOpenColorIO.Allocation - - Members: - - ALLOCATION_UNKNOWN : - - ALLOCATION_UNIFORM : - - ALLOCATION_LG2 : - - - .. 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 a0e378987d..0000000000 --- a/docs/api/python/frozen/pyopencolorio_allocationtransform.rst +++ /dev/null @@ -1,57 +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 - :canonical: PyOpenColorIO.AllocationTransform - - 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 fa6f1138a3..0000000000 --- a/docs/api/python/frozen/pyopencolorio_baker.rst +++ /dev/null @@ -1,183 +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 - :canonical: PyOpenColorIO.Baker - - 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(OCIO::METADATA_DESCRIPTION, "A first comment"); - metadata.addChildElement(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` or :ref:`NamedTransform` 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 - :canonical: PyOpenColorIO.Baker.FormatIterator - - 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 61d9f0a474..0000000000 --- a/docs/api/python/frozen/pyopencolorio_bitdepth.rst +++ /dev/null @@ -1,80 +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 - :canonical: PyOpenColorIO.BitDepth - - 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: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 0b6696f6ef..0000000000 --- a/docs/api/python/frozen/pyopencolorio_builtintransform.rst +++ /dev/null @@ -1,55 +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 - :canonical: PyOpenColorIO.BuiltinTransform - - 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 63b4842cf2..0000000000 --- a/docs/api/python/frozen/pyopencolorio_builtintransformregistry.rst +++ /dev/null @@ -1,63 +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 - :canonical: PyOpenColorIO.BuiltinTransformRegistry - - 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 - :canonical: PyOpenColorIO.BuiltinTransformRegistry.BuiltinStyleIterator - - - .. 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 - :canonical: PyOpenColorIO.BuiltinTransformRegistry.BuiltinIterator - - - .. 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 7c122cd574..0000000000 --- a/docs/api/python/frozen/pyopencolorio_cdlstyle.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:: CDLStyle - :module: PyOpenColorIO - :canonical: PyOpenColorIO.CDLStyle - - Members: - - CDL_ASC : ASC CDL specification v1.2. - - CDL_NO_CLAMP : CDL that does not clamp. - - CDL_TRANSFORM_DEFAULT : - - - .. 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 c106ea9f9a..0000000000 --- a/docs/api/python/frozen/pyopencolorio_cdltransform.rst +++ /dev/null @@ -1,152 +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 - :canonical: PyOpenColorIO.CDLTransform - - 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: Annotated[list[float], FixedSize(3)] = [1.0, 1.0, 1.0], offset: Annotated[list[float], FixedSize(3)] = [0.0, 0.0, 0.0], power: Annotated[list[float], FixedSize(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) -> Annotated[list[float], FixedSize(3)] - :module: PyOpenColorIO - - - .. py:method:: CDLTransform.getPower(self: PyOpenColorIO.CDLTransform) -> Annotated[list[float], FixedSize(3)] - :module: PyOpenColorIO - - - .. py:method:: CDLTransform.getSOP(self: PyOpenColorIO.CDLTransform) -> Annotated[list[float], FixedSize(9)] - :module: PyOpenColorIO - - - .. py:method:: CDLTransform.getSat(self: PyOpenColorIO.CDLTransform) -> float - :module: PyOpenColorIO - - - .. py:method:: CDLTransform.getSatLumaCoefs(self: PyOpenColorIO.CDLTransform) -> Annotated[list[float], FixedSize(3)] - :module: PyOpenColorIO - - These are hard-coded, by spec, to r709. - - - .. py:method:: CDLTransform.getSlope(self: PyOpenColorIO.CDLTransform) -> Annotated[list[float], FixedSize(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: Annotated[list[float], FixedSize(3)]) -> None - :module: PyOpenColorIO - - - .. py:method:: CDLTransform.setPower(self: PyOpenColorIO.CDLTransform, rgb: Annotated[list[float], FixedSize(3)]) -> None - :module: PyOpenColorIO - - - .. py:method:: CDLTransform.setSOP(self: PyOpenColorIO.CDLTransform, vec9: Annotated[list[float], FixedSize(9)]) -> None - :module: PyOpenColorIO - - - .. py:method:: CDLTransform.setSat(self: PyOpenColorIO.CDLTransform, sat: float) -> None - :module: PyOpenColorIO - - - .. py:method:: CDLTransform.setSlope(self: PyOpenColorIO.CDLTransform, rgb: Annotated[list[float], FixedSize(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 d21f3c4765..0000000000 --- a/docs/api/python/frozen/pyopencolorio_channelordering.rst +++ /dev/null @@ -1,52 +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 - :canonical: PyOpenColorIO.ChannelOrdering - - 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: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 d266c3e684..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:: - This method does not apply to instance-specific caches such as the :ref:`Processor` cache in a :ref:`Config` instance or the GPU and CPU :ref:`Processor` caches in a :ref:`Processor` instance. So in cases where you still have a :ref:`Config` instance after calling ClearAllCaches, you should also call the :ref:`Config`'s clearProcessorCache method. - diff --git a/docs/api/python/frozen/pyopencolorio_colorspace.rst b/docs/api/python/frozen/pyopencolorio_colorspace.rst deleted file mode 100644 index 435140040f..0000000000 --- a/docs/api/python/frozen/pyopencolorio_colorspace.rst +++ /dev/null @@ -1,264 +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 - :canonical: PyOpenColorIO.ColorSpace - - 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.hasAlias(self: PyOpenColorIO.ColorSpace, alias: str) -> bool - :module: PyOpenColorIO - - Return true if alias exists. - - - .. 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 - :canonical: PyOpenColorIO.ColorSpace.ColorSpaceCategoryIterator - - - .. 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 - :canonical: PyOpenColorIO.ColorSpace.ColorSpaceAliasIterator - - - .. 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 76cebc9bc6..0000000000 --- a/docs/api/python/frozen/pyopencolorio_colorspacedirection.rst +++ /dev/null @@ -1,29 +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 - :canonical: PyOpenColorIO.ColorSpaceDirection - - Members: - - COLORSPACE_DIR_TO_REFERENCE : - - COLORSPACE_DIR_FROM_REFERENCE : - - - .. 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 deleted file mode 100644 index 938855a665..0000000000 --- a/docs/api/python/frozen/pyopencolorio_colorspacehelpers.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:: 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. - - Note: If the config does not already use categories, we do not add them since that would make a big change to how existing color spaces show up in menus. - diff --git a/docs/api/python/frozen/pyopencolorio_colorspacemenuhelper.rst b/docs/api/python/frozen/pyopencolorio_colorspacemenuhelper.rst deleted file mode 100644 index 383d2612c6..0000000000 --- a/docs/api/python/frozen/pyopencolorio_colorspacemenuhelper.rst +++ /dev/null @@ -1,94 +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:: ColorSpaceMenuHelper - :module: PyOpenColorIO - :canonical: PyOpenColorIO.ColorSpaceMenuHelper - - Helper class to create menus for the content of a config. - - Menu can list color spaces, roles, named transforms. Each entry has a name, a UI name, a description, and a family. Family can also be accessed as hierarchy levels; levels are created by splitting the family using the 'family separator'. Hierarchy levels are meant to be used as sub-menus. - - The UI name is what is intended to be put in application menus seen by the end-user. However, please note that the UI name is not guaranteed to remain stable between releases and so if applications need to save something it should be the 'name' rather than the 'UI name'. Currently, the only difference between the 'name' and 'UI name' is for roles. - - 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 - :module: PyOpenColorIO - - - .. py:method:: ColorSpaceMenuHelper.getDescription(self: PyOpenColorIO.ColorSpaceMenuHelper, index: int) -> str - :module: PyOpenColorIO - - - .. py:method:: ColorSpaceMenuHelper.getFamily(self: PyOpenColorIO.ColorSpaceMenuHelper, index: int) -> str - :module: PyOpenColorIO - - - .. py:method:: ColorSpaceMenuHelper.getHierarchyLevels(self: PyOpenColorIO.ColorSpaceMenuHelper, index: int) -> PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator - :module: PyOpenColorIO - - - .. 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.ColorSpaceMenuHelper, name: str) -> int - :module: PyOpenColorIO - - - .. 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.ColorSpaceMenuHelper, name: str) -> str - :module: PyOpenColorIO - - Get the color space name from the UI name. - - - .. py:method:: ColorSpaceMenuHelper.getNumColorSpaces(self: PyOpenColorIO.ColorSpaceMenuHelper) -> int - :module: PyOpenColorIO - - Access to the color spaces (or roles). - - - .. 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.ColorSpaceMenuHelper, name: str) -> str - :module: PyOpenColorIO - - Get the color space UI name from the name. - - -.. py:class:: ColorSpaceLevelIterator - :module: PyOpenColorIO.ColorSpaceMenuHelper - :canonical: PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator - - - .. py:method:: ColorSpaceLevelIterator.__getitem__(self: PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator, arg0: int) -> str - :module: PyOpenColorIO.ColorSpaceMenuHelper - - - .. py:method:: ColorSpaceLevelIterator.__iter__(self: PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator) -> PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator - :module: PyOpenColorIO.ColorSpaceMenuHelper - - - .. py:method:: ColorSpaceLevelIterator.__len__(self: PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator) -> int - :module: PyOpenColorIO.ColorSpaceMenuHelper - - - .. 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 deleted file mode 100644 index e5e7065614..0000000000 --- a/docs/api/python/frozen/pyopencolorio_colorspacemenuparameters.rst +++ /dev/null @@ -1,167 +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:: ColorSpaceMenuParameters - :module: PyOpenColorIO - :canonical: PyOpenColorIO.ColorSpaceMenuParameters - - Parameters controlling which color spaces appear in menus. - - The :ref:`ColorSpaceMenuHelper` class is intended to be used by applications to get the list of items to show in color space menus. - - The :ref:`ColorSpaceMenuParameters` class is used to configure the behavior as needed for any given menu. Here is the algorithm used to produce a list of "items" (or strings) that will appear in a menu: - - 1) Use setRole to identify a role that controls a given menu. If the config has this role, then only that color space is returned. The name is set to the color space name, the UIName is presented as " ()". It may be useful for the application to then grey-out the menu or otherwise indicate to the user that the value for this menu is not user selectable since it was pre-determined by the config. If the config does not have that role, the algorithm continues to the remaining steps. - - 2) The IncludeColorSpaces, SearchReferenceSpaceType, and IncludeNamedTransforms parameters are used to identify a set of items from the config that are potential candidates for use in the menu, as follows: - - IncludeColorSpaces: Set to true to include color spaces in the menu. - - SearchReferenceSpaceType: Use this to control whether the menu should include all color spaces, only display color spaces, or only non-display color spaces. - - IncludeNamedTransforms: Set to true to include named transforms in the menu. - - 3) The set of items from step 2 is then filtered in step 3 using the following parameters: - - AppCategories: A list of strings specified by the application based on the purpose of the menu. For example, if the menu is used to select a color space for importing an image, the application might specify the 'file-io' category, whereas if it is to select a working color space, it might specify the 'working-space' category. Application developers should document what strings they are using for each menu so that config authors know what categories to use in their configs. Alternatively, an application could let advanced users customize the string to use for a given menu in the application. - - Encodings: A list of strings used to further refine the items selected from the AppCategories. For example, an application might specify 'working-space' as the category and then specify 'scene-linear' as the encoding to only use items that have both of those properties (e.g., only select scene-linear working color spaces). - - UserCategories: A list of strings specified by the end-user of the application. OCIO will check for these strings in an environment variable, or they may be passed in from the application. - - Basically the intent is for the filtering to return the intersection of the app categories, encoding, and user categories. However, some fall-backs are in place to ensure that the filtering does not remove all menu items. Here is the detailed description: - - 3a) The items from step 2 are filtered to generate a list of appItems containing only the ones that contain at least one of the AppCategories strings in their "categories" property and one of the encodings in their "encoding" property. If this list is empty, an attempt is made to generate a non-empty appItems list by only filtering by AppCategories. If that is empty, an attempt is made to only filter by Encodings. - - 3b) The items from step 2 are filtered to generate a list of userItems containing only the ones that have at least one of the UserCategories strings in their "categories" property. - - 3c) If both appItems and userItems are non-empty, a list of resultItems will be generated as the intersection of those two lists. - - 3d) If the resultItems list is empty, the appList will be expanded by only filtering by AppCategories and not encodings. The resultItems will be formed again as the intersection of the appItems and userItems. - - 3e) If the resultItems is still empty, it will be set to just the appItems from step 3a. - - 3f) If the resultItems is still empty, it will be set to just the userItems. - - 3g) If the resultItems is still empty, the items are not filtered and all items from step 2 are returned. The rationale is that if step 2 has produced any items, it is not acceptable for step 3 to remove all of them. An application usually expects to have a non-zero number of items to display in the menu. However, if step 2 produces no items (e.g. the application requests only named transforms and the config has no named transform), then no items will be returned. - - 4) If IncludeRoles is true, the items from step 3 are extended by including an item for each role. The name is set to the role name, the UIName is presented as " ()", and the family is set to "Roles". - - 5) If AddColorSpace has been used to add any additional items, these are appended to the final list. - - - .. py:method:: ColorSpaceMenuParameters.__init__(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. __init__(self: PyOpenColorIO.ColorSpaceMenuParameters, config: 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 - - - .. py:method:: ColorSpaceMenuParameters.addColorSpace(self: PyOpenColorIO.ColorSpaceMenuParameters, colorSpace: str) -> None - :module: PyOpenColorIO - - Add an additional color space (or named transform) to the menu. - - Note that an additional color space could be: - - an inactive color space, - - an active color space not having at least one of the selected categories, - - 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 - :module: PyOpenColorIO - - - .. py:method:: ColorSpaceMenuParameters.getAddedColorSpaces(self: PyOpenColorIO.ColorSpaceMenuParameters) -> PyOpenColorIO.ColorSpaceMenuParameters.AddedColorSpaceIterator - :module: PyOpenColorIO - - - .. py:method:: ColorSpaceMenuParameters.getAppCategories(self: PyOpenColorIO.ColorSpaceMenuParameters) -> str - :module: PyOpenColorIO - - - .. py:method:: ColorSpaceMenuParameters.getConfig(self: PyOpenColorIO.ColorSpaceMenuParameters) -> PyOpenColorIO.Config - :module: PyOpenColorIO - - - .. py:method:: ColorSpaceMenuParameters.getEncodings(self: PyOpenColorIO.ColorSpaceMenuParameters) -> str - :module: PyOpenColorIO - - - .. py:method:: ColorSpaceMenuParameters.getIncludeColorSpaces(self: PyOpenColorIO.ColorSpaceMenuParameters) -> bool - :module: PyOpenColorIO - - - .. py:method:: ColorSpaceMenuParameters.getIncludeNamedTransforms(self: PyOpenColorIO.ColorSpaceMenuParameters) -> bool - :module: PyOpenColorIO - - - .. py:method:: ColorSpaceMenuParameters.getIncludeRoles(self: PyOpenColorIO.ColorSpaceMenuParameters) -> bool - :module: PyOpenColorIO - - - .. py:method:: ColorSpaceMenuParameters.getRole(self: PyOpenColorIO.ColorSpaceMenuParameters) -> str - :module: PyOpenColorIO - - - .. py:method:: ColorSpaceMenuParameters.getSearchReferenceSpaceType(self: PyOpenColorIO.ColorSpaceMenuParameters) -> PyOpenColorIO.SearchReferenceSpaceType - :module: PyOpenColorIO - - Can be used to restrict the search using the :ref:`ReferenceSpaceType` of the color spaces. It has no effect on roles and named transforms. - - - .. py:method:: ColorSpaceMenuParameters.getUserCategories(self: PyOpenColorIO.ColorSpaceMenuParameters) -> str - :module: PyOpenColorIO - - - .. 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.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.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 - :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 - :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 - :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 - :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 - :module: PyOpenColorIO - - - .. 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 deleted file mode 100644 index 2b48aefb03..0000000000 --- a/docs/api/python/frozen/pyopencolorio_colorspaceset.rst +++ /dev/null @@ -1,177 +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 - :canonical: PyOpenColorIO.ColorSpaceSet - - The *:ref:`ColorSpaceSet`* is a set of color spaces (i.e. no color space duplication) which could be the result of :ref:`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:`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. - - ColorSpaceSetOperators - - .. 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.hasColorSpace(self: PyOpenColorIO.ColorSpaceSet, name: str) -> bool - :module: PyOpenColorIO - - .. note:: - Only accepts color space names (i.e. no role name) - - :param name: - - :return: true - - :return: false - - - .. 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 - :canonical: PyOpenColorIO.ColorSpaceSet.ColorSpaceNameIterator - - - .. 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 - :canonical: PyOpenColorIO.ColorSpaceSet.ColorSpaceIterator - - - .. 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 7a1f6cf1bc..0000000000 --- a/docs/api/python/frozen/pyopencolorio_colorspacetransform.rst +++ /dev/null @@ -1,65 +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 - :canonical: PyOpenColorIO.ColorSpaceTransform - - - .. 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 24b3137a44..0000000000 --- a/docs/api/python/frozen/pyopencolorio_colorspacevisibility.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:: ColorSpaceVisibility - :module: PyOpenColorIO - :canonical: PyOpenColorIO.ColorSpaceVisibility - - Members: - - COLORSPACE_ACTIVE : - - COLORSPACE_INACTIVE : - - COLORSPACE_ALL : - - - .. 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 67baba6cbb..0000000000 --- a/docs/api/python/frozen/pyopencolorio_config.rst +++ /dev/null @@ -1,1615 +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 - :canonical: PyOpenColorIO.Config - - 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 (with or without the "ocio://" URI prefix). - - Also supports the following OCIO URI format for Built-in configs: "ocio://default" - Default Built-in config. "ocio://cg-config-latest" - Latest Built-in CG config. "ocio://studio-config-latest" - Latest Built-in Studio config. "ocio://" - A specific Built-in config. - - The available configNames are: - - ACES Studio config, contains a more complete collection of color spaces and displays: "studio-config-v1.0.0_aces-v1.3_ocio-v2.1" "studio-config-v2.1.0_aces-v1.3_ocio-v2.3" "studio-config-v2.2.0_aces-v1.3_ocio-v2.4" - - ACES CG config, basic color spaces for computer graphics apps: "cg-config-v1.0.0_aces-v1.3_ocio-v2.1" "cg-config-v2.1.0_aces-v1.3_ocio-v2.3" "cg-config-v2.2.0_aces-v1.3_ocio-v2.4" - - More information 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_5dev::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:`CreateFromFile`. - - If the variable is missing or empty, returns the same result as :ref:`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. - - Supports the OCIO URI format for Built-in configs. See :ref:`CreateFromBuiltinConfig`. - - 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 - :canonical: PyOpenColorIO.Config.DisplayAllIterator - - - .. py:method:: Config.DisplayAllIterator.__init__(*args, **kwargs) - :module: PyOpenColorIO - - - .. py:method:: Config.GetProcessorFromBuiltinColorSpace(builtinColorSpaceName: str, srcConfig: PyOpenColorIO.Config, srcColorSpaceName: str) -> PyOpenColorIO.Processor - :module: PyOpenColorIO - :staticmethod: - - See description of GetProcessorToBuiltinColorSpace. - - :param builtinColorSpaceName: The name of the color space in the current default Built-in config. - :param srcConfig: The user's source config. - :param srcColorSpaceName: The name of the color space in the source config. - - - .. 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. - - Note: For all of the two-config GetProcessor functions, if either the source or destination color spaces are data spaces, the entire processor will be a no-op. - - 4. GetProcessorFromConfigs(srcContext: PyOpenColorIO.Context, srcConfig: PyOpenColorIO.Config, srcColorSpaceName: str, srcInterchangeName: str, dstContext: PyOpenColorIO.Context, dstConfig: PyOpenColorIO.Config, dstColorSpaceName: str, dstInterchangeName: str) -> PyOpenColorIO.Processor - - 5. GetProcessorFromConfigs(srcConfig: PyOpenColorIO.Config, srcColorSpaceName: str, dstConfig: PyOpenColorIO.Config, dstDisplay: str, dstView: str, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Processor - - Get a processor to convert from a color space to a display and view in two separate configs. - - 6. GetProcessorFromConfigs(srcContext: PyOpenColorIO.Context, srcConfig: PyOpenColorIO.Config, srcColorSpaceName: str, dstContext: PyOpenColorIO.Context, dstConfig: PyOpenColorIO.Config, dstView: str, dstDisplay: str, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Processor - - 7. GetProcessorFromConfigs(srcConfig: PyOpenColorIO.Config, srcColorSpaceName: str, srcInterchangeName: str, dstConfig: PyOpenColorIO.Config, dstDisplay: str, dstView: str, dstInterchangeName: str, direction: PyOpenColorIO.TransformDirection) -> 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. - - 8. GetProcessorFromConfigs(srcContext: PyOpenColorIO.Context, srcConfig: PyOpenColorIO.Config, srcColorSpaceName: str, srcInterchangeName: str, dstContext: PyOpenColorIO.Context, dstConfig: PyOpenColorIO.Config, dstDisplay: str, dstView: str, dstInterchangeName: str, direction: PyOpenColorIO.TransformDirection) -> PyOpenColorIO.Processor - - - .. py:method:: Config.GetProcessorToBuiltinColorSpace(srcConfig: PyOpenColorIO.Config, srcColorSpaceName: str, builtinColorSpaceName: str) -> PyOpenColorIO.Processor - :module: PyOpenColorIO - :staticmethod: - - Get a :ref:`Processor` to or from a known external color space. - - These methods provide a way to interface color spaces in a config with known standard external color spaces. The set of external color space are those contained in the current default Built-in config. This includes common spaces such as "Linear Rec.709 (sRGB)", "sRGB - Texture", "ACEScg", and "ACES2065-1". - - If the source config defines the necessary Interchange Role (typically "aces_interchange"), then the conversion will be well-defined and equivalent to calling GetProcessorFromConfigs with the source config and the Built-in config. - - However, if the Interchange Roles are not present, heuristics will be used to try and identify a common color space in the source config that may be used to allow the conversion to proceed. If the heuristics fail to find a suitable space, an exception is thrown. The heuristics may evolve, so the results returned by this function for a given source config and color space may change in future releases of the library. However, the Interchange Roles are required in config versions 2.2 and higher, so it is hoped that the need for the heuristics will decrease over time. - - :param srcConfig: The user's source config. - :param srcColorSpaceName: The name of the color space in the source config. - :param builtinColorSpaceName: The name of the color space in the current default Built-in config. - - :exception :ref:`Exception`: if either the src or builtin interchange space cannot be identified. - - - .. py:method:: Config.IdentifyBuiltinColorSpace(srcConfig: PyOpenColorIO.Config, builtinConfig: PyOpenColorIO.Config, builtinColorSpaceName: str) -> str - :module: PyOpenColorIO - :staticmethod: - - Find the name of the color space in the source config that is the same as a color space in the default built-in config. For example, setting the builtinColorSpaceName to "sRGB - Texture" (a color space name from that config), would return the name for the corresponding sRGB texture space in the current config (or empty if it was not found). Note that this method relies on heuristics which may evolve over time and which may not work on all configs. - - The method only looks at active color spaces. If the interchange roles are missing and heuristics are used, only scene-referred color spaces are searched. - - :param srcConfig: The config to search for the desired color space. - :param builtinConfig: The built-in config to use. See :ref:`CreateFromBuiltinConfig`. - :param builtinColorSpaceName: Color space name in the built-in default config. - - :return: Matching color space name from the source config. Empty if not found. - - :exception :ref:`Exception`: if an interchange space cannot be found or the equivalent space cannot be found. - - - .. py:method:: Config.IdentifyInterchangeSpace(srcConfig: PyOpenColorIO.Config, srcColorSpaceName: str, builtinConfig: PyOpenColorIO.Config, builtinColorSpaceName: str) -> tuple[str, str] - :module: PyOpenColorIO - :staticmethod: - - Identify the two names of a common color space that exists in both the given config and the provided built-in config that may be used for converting color spaces between the two configs. If both configs have the interchange role set, than the color spaces set to that role will be returned. Otherwise, heuristics will be used to try and identify a known color space in the source config. These are the same heuristics that are used for other methods such as identifyBuiltinColorSpace and GetProcessorTo/FromBuiltinColorSpace. - - Using this method in connection with GetProcessorFromConfigs is more efficient if you need to call GetProcessorTo/FromBuiltinColorSpace multiple times since it is only necessary to run the heuristics once (to identify the interchange spaces). - - The srcColorSpaceName and builtinColorSpace name are used to decide which interchange role to use (scene- or display-referred). However, they are not used if the interchange roles are not present and the heuristics are used. It is actually only the :ref:`ReferenceSpaceType` of the color spaces that are used, so it is not necessary to call this function multiple times if all the spaces are of the same type. (These are the same arguments that would also be set if you were instead calling GetProcessorTo/FromBuiltinColorSpace.) - - :param srcInterchangeName: Color space name from the source config. - :param builtinInterchangeName: Corresponding color space name from the built-in config. - :param srcConfig: The config to search for the desired color space. - :param srcColorSpaceName: Color space name in the given config to convert to/from. - :param builtinConfig: The built-in config to use. See :ref:`CreateFromBuiltinConfig`. - :param builtinColorSpaceName: Color space name in the default built-in config. - - :exception :ref:`Exception`: if either the srcInterchange or builtinInterchange cannot be identified. - - - .. py:class:: Config.ViewForViewTypeIterator - :module: PyOpenColorIO - :canonical: PyOpenColorIO.Config.ViewForViewTypeIterator - - - .. py:method:: Config.ViewForViewTypeIterator.__init__(*args, **kwargs) - :module: PyOpenColorIO - - - .. py:method:: Config.ViewsAreEqual(first: PyOpenColorIO.Config, second: PyOpenColorIO.Config, dispName: str, viewName: str) -> bool - :module: PyOpenColorIO - :staticmethod: - - Compare views in a pair of configs. - - Will return false if either of the views does not exist. This will return true even if the view is display-defined in one config and a reference to a shared view in the other config (both within the same display), as long as the contents match. The description text (if any) is ignored, since it is not a functional difference. - - Note that the comparison is only on the strings contained in the view definition, the function does not attempt to compare that the color spaces or view transforms being referenced are identical (only that they have the same name). - - - .. py:class:: Config.VirtualViewIterator - :module: PyOpenColorIO - :canonical: PyOpenColorIO.Config.VirtualViewIterator - - - .. py:method:: Config.VirtualViewIterator.__init__(*args, **kwargs) - :module: PyOpenColorIO - - - .. py:method:: Config.VirtualViewsAreEqual(first: PyOpenColorIO.Config, second: PyOpenColorIO.Config, viewName: str) -> bool - :module: PyOpenColorIO - :staticmethod: - - Compare virtual views in a pair of configs. - - Will return false if either of the virtual views does not exist. This will return true even if the virtual view is display-defined in one config and a reference to a shared virtual view in the other config, as long as the contents match. - - The description text (if any) is ignored, since it is not a functional difference. - - Note that the comparison is only on the strings contained in the view definition, the function does not attempt to compare that the color spaces or view transforms being referenced are identical (only that they have the same name). - - - .. 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:`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. - - - .. 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.clearProcessorCache(self: PyOpenColorIO.Config) -> 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.clearSearchPaths(self: PyOpenColorIO.Config) -> None - :module: PyOpenColorIO - - - .. py:method:: Config.clearSharedViews(self: PyOpenColorIO.Config) -> None - :module: PyOpenColorIO - - Clear all shared views. This will throw if any displays are still using the shared views. - - - .. 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.displayHasView(self: PyOpenColorIO.Config, display: str, view: str) -> bool - :module: PyOpenColorIO - - Determine if a display and view exist. - - This returns false if either the display or view doesn't exist. It works regardless of whether the display or view are active, and it works regardless of whether the view is display-defined or if the display has this as a shared view. It will only check config-level shared views if dispName is null. It will not check config level shared views if dispName is not null. - - - .. 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:`getNumColorSpaces` and :ref:`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.getConfigIOProxy(self: PyOpenColorIO.Config) -> OpenColorIO_v2_5dev::ConfigIOProxy - :module: PyOpenColorIO - - - .. 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) -> Annotated[list[float], FixedSize(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.getRoleColorSpace(self: PyOpenColorIO.Config, roleName: str) -> str - :module: PyOpenColorIO - - Get the role color space at index. - - Return empty string if index is out of range. - - - .. 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.hasVirtualView(self: PyOpenColorIO.Config, view: str) -> bool - :module: PyOpenColorIO - - Determine if a virtual view exists. - - Methods related to the Virtual Display. - - ... (See descriptions for the non-virtual methods above.) - - The virtual display is the way to incorporate the ICC monitor profile for a user's display into OCIO. The views that are defined for the virtual display are the views that are used to create a new display for an ICC profile. They serve as a kind of template that lets OCIO know how to build the new display. - - Typically the views will define a View :ref:`Transform` and set the colorSpaceName to "" so that it will use the display color space with the same name as the display, in this case corresponding to the ICC profile. - - This returns false if the virtual view doesn't exist. It works regardless of whether the virtual view is active, and it works regardless of whether the virtual view is display-defined or if the display has this as a shared virtual view. - - - .. 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.isInactiveColorSpace(self: PyOpenColorIO.Config, colorspace: str) -> bool - :module: PyOpenColorIO - - Return true if the color space name is present in the inactive_colorspaces list. - - - .. py:method:: Config.isStrictParsingEnabled(self: PyOpenColorIO.Config) -> bool - :module: PyOpenColorIO - - - .. py:method:: Config.loadEnvironment(self: PyOpenColorIO.Config) -> None - :module: PyOpenColorIO - - Initialize the environment/context variables in the :ref:`Config`'s :ref:`Context`. - - - .. 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.setConfigIOProxy(self: PyOpenColorIO.Config, ciop: OpenColorIO_v2_5dev::ConfigIOProxy) -> None - :module: PyOpenColorIO - - Set the :ref:`ConfigIOProxy` object used to provision the config and LUTs from somewhere other than the file system. (This is set on the config's embedded :ref:`Context` object.) - - - .. py:method:: Config.setDefaultLumaCoefs(self: PyOpenColorIO.Config, rgb: Annotated[list[float], FixedSize(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 - - The :ref:`EnvironmentMode` controls the behavior of loadEnvironment. - - - ENV_ENVIRONMENT_LOAD_PREDEFINED - Only update vars already added to the :ref:`Context`. - - ENV_ENVIRONMENT_LOAD_ALL - Load all env. vars into the :ref:`Context`. - - .. note:: - Loading ALL the env. vars may reduce performance and reduce cache efficiency. - - Client programs generally will not use these methods because the:ref:`EnvironmentMode` is set automatically when a :ref:`Config` is loaded. If the :ref:`Config` has an "environment" section, the mode is set to LOAD_PREDEFINED, and otherwise set to LOAD_ALL. - - - .. 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 - - Methods related to Roles. - - A role allows a config author to indicate that a given color space should be used for a particular purpose. - - Role names may be passed to most functions that accept color space names, such as getColorSpace. So for example, you may find the name of the color space assigned to the scene_linear role by getting the color space object for "scene_linear" and then calling getName on the color space object. .. 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, use ':' 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:method:: Config.viewIsShared(self: PyOpenColorIO.Config, display: str, view: str) -> bool - :module: PyOpenColorIO - - Check if a view within a given display is referencing one of the config's shared views. - - Methods related to displays and views. - - 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:`validate` will throw if the config does not contain the matching display color space. - - - .. py:method:: Config.virtualViewIsShared(self: PyOpenColorIO.Config, view: str) -> bool - :module: PyOpenColorIO - - Check if a given virtual view is referencing one of the config's shared views. - - -.. py:class:: EnvironmentVarNameIterator - :module: PyOpenColorIO.Config - :canonical: PyOpenColorIO.Config.EnvironmentVarNameIterator - - - .. 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 - :canonical: PyOpenColorIO.Config.SearchPathIterator - - - .. 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 - :canonical: PyOpenColorIO.Config.ColorSpaceNameIterator - - - .. 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 - :canonical: PyOpenColorIO.Config.ColorSpaceIterator - - - .. 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 - :canonical: PyOpenColorIO.Config.ActiveColorSpaceNameIterator - - - .. 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 - :canonical: PyOpenColorIO.Config.ActiveColorSpaceIterator - - - .. 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 - :canonical: PyOpenColorIO.Config.RoleNameIterator - - - .. 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 - :canonical: PyOpenColorIO.Config.RoleColorSpaceIterator - - - .. 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 - :canonical: PyOpenColorIO.Config.DisplayIterator - - - .. 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 - :canonical: PyOpenColorIO.Config.SharedViewIterator - - - .. 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 - :canonical: PyOpenColorIO.Config.ViewIterator - - - .. 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 - :canonical: PyOpenColorIO.Config.ViewForColorSpaceIterator - - - .. 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 - :canonical: PyOpenColorIO.Config.LookNameIterator - - - .. 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 - :canonical: PyOpenColorIO.Config.LookIterator - - - .. 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 - :canonical: PyOpenColorIO.Config.ViewTransformNameIterator - - - .. 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 - :canonical: PyOpenColorIO.Config.ViewTransformIterator - - - .. 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 - :canonical: PyOpenColorIO.Config.NamedTransformNameIterator - - - .. 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 - :canonical: PyOpenColorIO.Config.NamedTransformIterator - - - .. 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 - :canonical: PyOpenColorIO.Config.ActiveNamedTransformNameIterator - - - .. 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 - :canonical: PyOpenColorIO.Config.ActiveNamedTransformIterator - - - .. 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 1f21f84586..0000000000 --- a/docs/api/python/frozen/pyopencolorio_context.rst +++ /dev/null @@ -1,197 +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 - :canonical: PyOpenColorIO.Context - - :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:`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 `ColorSpaceTransform` to define the source and the destination color space names, - - the `FileTransform` to define the source file name (e.g. a LUT file name), - - the search_path, - - the cccid of the `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 string vars with the current environment, based on the :ref:`EnvironmentMode` setting. - - - .. 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 - - See :ref:`setEnvironmentMode`. - - - .. 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 - :canonical: PyOpenColorIO.Context.StringVarNameIterator - - - .. 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 - :canonical: PyOpenColorIO.Context.StringVarIterator - - - .. 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 - :canonical: PyOpenColorIO.Context.SearchPathIterator - - - .. 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 deleted file mode 100644 index 73087a67e1..0000000000 --- a/docs/api/python/frozen/pyopencolorio_cpuprocessor.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:: CPUProcessor - :module: PyOpenColorIO - :canonical: PyOpenColorIO.CPUProcessor - - - .. py:method:: CPUProcessor.__init__(*args, **kwargs) - :module: PyOpenColorIO - - - .. py:method:: CPUProcessor.apply(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. apply(self: PyOpenColorIO.CPUProcessor, imgDesc: PyOpenColorIO.ImageDesc) -> None - - - Apply to an image with any kind of channel ordering while respecting - the input and output bit-depths. Image values are modified in place. - - .. note:: - The GIL is released during processing, freeing up Python to execute - other threads concurrently. - - .. note:: - For large images, ``applyRGB`` or ``applyRGBA`` are preferred for - processing a NumPy array. The Python ``ImageDesc`` implementation - requires copying all values (once) in order to own the underlying - pointer. The dedicated packed ``apply*`` methods utilize - ``ImageDesc`` on the C++ side so avoid the copy. - - - - 2. apply(self: PyOpenColorIO.CPUProcessor, srcImgDesc: PyOpenColorIO.ImageDesc, dstImgDesc: PyOpenColorIO.ImageDesc) -> None - - - Apply to an image with any kind of channel ordering while respecting - the input and output bit-depths. Modified srcImgDesc image values are - written to the dstImgDesc image, leaving srcImgDesc unchanged. - - .. note:: - The GIL is released during processing, freeing up Python to execute - other threads concurrently. - - .. note:: - For large images, ``applyRGB`` or ``applyRGBA`` are preferred for - processing a NumPy array. The Python ``ImageDesc`` implementation - requires copying all values (once) in order to own the underlying - pointer. The dedicated packed ``apply*`` methods utilize - ``ImageDesc`` on the C++ side so avoid the copy. - - - .. py:method:: CPUProcessor.applyRGB(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. applyRGB(self: PyOpenColorIO.CPUProcessor, data: Buffer) -> None - - - Apply to a packed RGB array adhering to the Python buffer protocol. - This will typically be a NumPy array. Input and output bit-depths are - respected but must match. Any array size or shape is supported as long - as the flattened array size is divisible by 3. Array values are - modified in place. - - .. note:: - This differs from the C++ implementation which only applies to a - single pixel. This method uses a ``PackedImageDesc`` under the - hood to apply to an entire image at once. The GIL is released - during processing, freeing up Python to execute other threads - concurrently. - - - - 2. applyRGB(self: PyOpenColorIO.CPUProcessor, data: list[float]) -> list[float] - - - Apply to a packed RGB list of float values. Any size is supported as - long as the list length is divisible by 3. A new list with processed - float values is returned, leaving the input list unchanged. - - .. note:: - This differs from the C++ implementation which only applies to a - single pixel. This method uses a ``PackedImageDesc`` under the - hood to apply to an entire image at once. The GIL is released - during processing, freeing up Python to execute other threads - concurrently. - - .. note:: - For large images, a NumPy array should be preferred over a list. - List values are copied on input and output, where an array is - modified in place. - - - .. py:method:: CPUProcessor.applyRGBA(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. applyRGBA(self: PyOpenColorIO.CPUProcessor, data: Buffer) -> None - - - Apply to a packed RGBA array adhering to the Python buffer protocol. - This will typically be a NumPy array. Input and output bit-depths are - respected but must match. Any array size or shape is supported as long - as the flattened array size is divisible by 4. Array values are - modified in place. - - .. note:: - This differs from the C++ implementation which only applies to a - single pixel. This method uses a ``PackedImageDesc`` under the - hood to apply to an entire image at once. The GIL is released - during processing, freeing up Python to execute other threads - concurrently. - - - - 2. applyRGBA(self: PyOpenColorIO.CPUProcessor, data: list[float]) -> list[float] - - - Apply to a packed RGBA list of float values. Any size is supported as - long as the list length is divisible by 4. A new list with processed - float values is returned, leaving the input list unchanged. - - .. note:: - This differs from the C++ implementation which only applies to a - single pixel. This method uses a ``PackedImageDesc`` under the - hood to apply to an entire image at once. The GIL is released - during processing, freeing up Python to execute other threads - concurrently. - - .. note:: - For large images, a NumPy array should be preferred over a list. - List values are copied on input and output, where an array is - modified in place. - - - .. py:method:: CPUProcessor.getCacheID(self: PyOpenColorIO.CPUProcessor) -> str - :module: PyOpenColorIO - - - .. 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. - - .. note:: - 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 - :module: PyOpenColorIO - - Bit-depth of the input pixel buffer. - - - .. py:method:: CPUProcessor.getOutputBitDepth(self: PyOpenColorIO.CPUProcessor) -> PyOpenColorIO.BitDepth - :module: PyOpenColorIO - - Bit-depth of the output pixel buffer. - - - .. py:method:: CPUProcessor.hasChannelCrosstalk(self: PyOpenColorIO.CPUProcessor) -> bool - :module: PyOpenColorIO - - - .. py:method:: CPUProcessor.hasDynamicProperty(self: PyOpenColorIO.CPUProcessor, type: PyOpenColorIO.DynamicPropertyType) -> bool - :module: PyOpenColorIO - - True if at least one dynamic property of that type exists. - - - .. py:method:: CPUProcessor.isDynamic(self: 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.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 - :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 deleted file mode 100644 index c99237493c..0000000000 --- a/docs/api/python/frozen/pyopencolorio_displayviewhelpers.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: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.Config) -> 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 - :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 - :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 40ec3c7e3e..0000000000 --- a/docs/api/python/frozen/pyopencolorio_displayviewtransform.rst +++ /dev/null @@ -1,89 +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 - :canonical: PyOpenColorIO.DisplayViewTransform - - - .. 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 28dbe5cea1..0000000000 --- a/docs/api/python/frozen/pyopencolorio_dynamicproperty.rst +++ /dev/null @@ -1,106 +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 - :canonical: PyOpenColorIO.DynamicProperty - - 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; - primaryProp->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 78e68a82e6..0000000000 --- a/docs/api/python/frozen/pyopencolorio_dynamicpropertytype.rst +++ /dev/null @@ -1,59 +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 - :canonical: PyOpenColorIO.DynamicPropertyType - - 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: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 6fd645ca9e..0000000000 --- a/docs/api/python/frozen/pyopencolorio_environmentmode.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:: EnvironmentMode - :module: PyOpenColorIO - :canonical: PyOpenColorIO.EnvironmentMode - - Controls which environment variables are loaded into a :ref:`Context` object. - - Members: - - ENV_ENVIRONMENT_UNKNOWN : - - ENV_ENVIRONMENT_LOAD_PREDEFINED : Only load vars in the config's environment section. - - ENV_ENVIRONMENT_LOAD_ALL : Load all env. vars (note: may reduce performance) - - - .. 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 2742a59388..0000000000 --- a/docs/api/python/frozen/pyopencolorio_exception.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:exception:: Exception - :module: PyOpenColorIO - :canonical: PyOpenColorIO.Exception - - 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 aaa1abcba5..0000000000 --- a/docs/api/python/frozen/pyopencolorio_exceptionmissingfile.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:: ExceptionMissingFile - :module: PyOpenColorIO - :canonical: PyOpenColorIO.ExceptionMissingFile - - 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 8f33143135..0000000000 --- a/docs/api/python/frozen/pyopencolorio_exponenttransform.rst +++ /dev/null @@ -1,76 +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 - :canonical: PyOpenColorIO.ExponentTransform - - 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: Annotated[list[float], FixedSize(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) -> Annotated[list[float], FixedSize(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: Annotated[list[float], FixedSize(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 99a6dfa28e..0000000000 --- a/docs/api/python/frozen/pyopencolorio_exponentwithlineartransform.rst +++ /dev/null @@ -1,96 +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 - :canonical: PyOpenColorIO.ExponentWithLinearTransform - - 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: Annotated[list[float], FixedSize(4)] = [1.0, 1.0, 1.0, 1.0], offset: Annotated[list[float], FixedSize(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) -> Annotated[list[float], FixedSize(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) -> Annotated[list[float], FixedSize(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: Annotated[list[float], FixedSize(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: Annotated[list[float], FixedSize(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 ed66539129..0000000000 --- a/docs/api/python/frozen/pyopencolorio_exposurecontraststyle.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:: ExposureContrastStyle - :module: PyOpenColorIO - :canonical: PyOpenColorIO.ExposureContrastStyle - - 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: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 2d5a90dc45..0000000000 --- a/docs/api/python/frozen/pyopencolorio_exposurecontrasttransform.rst +++ /dev/null @@ -1,161 +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 - :canonical: PyOpenColorIO.ExposureContrastTransform - - 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 b6fad4f5a2..0000000000 --- a/docs/api/python/frozen/pyopencolorio_filerules.rst +++ /dev/null @@ -1,182 +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 - :canonical: PyOpenColorIO.FileRules - - 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:`setDefaultRuleColorSpace` ). - - "ColorSpaceNamePathSearch" is also a reserved name (see :ref:`insertPathSearchRule` ). - - Will throw if pattern, extension or regex is a null or empty string. - - Will throw if ruleIndex is not less than :ref:`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:`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 eb07de2b09..0000000000 --- a/docs/api/python/frozen/pyopencolorio_filetransform.rst +++ /dev/null @@ -1,110 +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 - :canonical: PyOpenColorIO.FileTransform - - - .. py:method:: FileTransform.IsFormatExtensionSupported(extension: str) -> bool - :module: PyOpenColorIO - :staticmethod: - - Returns true if the extension corresponds to a format supported by :ref:`FileTransform`. The argument is case-insensitive, and a leading dot, if present, is ignored. Note that :ref:`FileTransform` will attempt all format readers on a given file until it is successful, even files that contain an unsupported extension or no extension. However, this function is useful for applications that want to know which files are likely to be LUT files, based on their extension. - - - .. 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 - :canonical: PyOpenColorIO.FileTransform.FormatIterator - - - .. 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 35fa20f1a4..0000000000 --- a/docs/api/python/frozen/pyopencolorio_fixedfunctionstyle.rst +++ /dev/null @@ -1,157 +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 - :canonical: PyOpenColorIO.FixedFunctionStyle - - 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) - - FIXED_FUNCTION_LIN_TO_PQ : SMPTE ST-2084 OETF, scaled with 100 nits at 1.0 (neg vals mirrored) - - FIXED_FUNCTION_LIN_TO_GAMMA_LOG : Parametrized gamma and log segments with mirroring. - - FIXED_FUNCTION_LIN_TO_DOUBLE_LOG : Two parameterized LogAffineTransforms with a middle linear segment. - - FIXED_FUNCTION_ACES_OUTPUT_TRANSFORM_20 : ACES 2.0 Display Rendering -- EXPERIMENTAL. - - FIXED_FUNCTION_ACES_RGB_TO_JMH_20 : ACES 2.0 RGB to JMh -- EXPERIMENTAL. - - FIXED_FUNCTION_ACES_TONESCALE_COMPRESS_20 : ACES 2.0 Tonescale and chroma compression -- EXPERIMENTAL. - - FIXED_FUNCTION_ACES_GAMUT_COMPRESS_20 : ACES 2.0 Gamut compression -- EXPERIMENTAL. - - - .. 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_COMPRESS_20 - :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_OUTPUT_TRANSFORM_20 - :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_ACES_RGB_TO_JMH_20 - :module: PyOpenColorIO - :value: - - - .. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_ACES_TONESCALE_COMPRESS_20 - :module: PyOpenColorIO - :value: - - - .. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_LIN_TO_DOUBLE_LOG - :module: PyOpenColorIO - :value: - - - .. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_LIN_TO_GAMMA_LOG - :module: PyOpenColorIO - :value: - - - .. py:attribute:: FixedFunctionStyle.FIXED_FUNCTION_LIN_TO_PQ - :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 8a2a4590be..0000000000 --- a/docs/api/python/frozen/pyopencolorio_fixedfunctiontransform.rst +++ /dev/null @@ -1,65 +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 - :canonical: PyOpenColorIO.FixedFunctionTransform - - 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 1f8b5924f9..0000000000 --- a/docs/api/python/frozen/pyopencolorio_formatmetadata.rst +++ /dev/null @@ -1,189 +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 - :canonical: PyOpenColorIO.FormatMetadata - - 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 - :canonical: PyOpenColorIO.FormatMetadata.AttributeNameIterator - - - .. 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 - :canonical: PyOpenColorIO.FormatMetadata.AttributeIterator - - - .. 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 - :canonical: PyOpenColorIO.FormatMetadata.ConstChildElementIterator - - - .. 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 - :canonical: PyOpenColorIO.FormatMetadata.ChildElementIterator - - - .. 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 d69209913e..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gpulanguage.rst +++ /dev/null @@ -1,80 +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 - :canonical: PyOpenColorIO.GpuLanguage - - 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 : - - GPU_LANGUAGE_MSL_2_0 : Metal Shading Language. - - LANGUAGE_OSL_1 : Open Shading Language. - - - .. 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:attribute:: GpuLanguage.LANGUAGE_OSL_1 - :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 deleted file mode 100644 index 5531d6fc5d..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gpuprocessor.rst +++ /dev/null @@ -1,31 +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:: GPUProcessor - :module: PyOpenColorIO - :canonical: PyOpenColorIO.GPUProcessor - - - .. py:method:: GPUProcessor.__init__(*args, **kwargs) - :module: PyOpenColorIO - - - .. 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.GPUProcessor) -> str - :module: PyOpenColorIO - - - .. py:method:: GPUProcessor.hasChannelCrosstalk(self: PyOpenColorIO.GPUProcessor) -> bool - :module: PyOpenColorIO - - - .. 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 deleted file mode 100644 index 3f29b6148e..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gpushadercreator.rst +++ /dev/null @@ -1,279 +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 - :canonical: PyOpenColorIO.GpuShaderCreator - - 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 - :canonical: PyOpenColorIO.GpuShaderCreator.TextureType - - Members: - - TEXTURE_RED_CHANNEL - - TEXTURE_RGB_CHANNEL - - - .. 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 - :canonical: PyOpenColorIO.GpuShaderCreator.DynamicPropertyIterator - - - .. 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 fe580614ee..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gpushaderdesc.rst +++ /dev/null @@ -1,574 +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 - :canonical: PyOpenColorIO.GpuShaderDesc - - 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: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 - :canonical: PyOpenColorIO.GpuShaderDesc.UniformData - - - .. 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) -> Annotated[list[float], FixedSize(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 - :canonical: PyOpenColorIO.GpuShaderDesc.Texture - - - .. 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 - :canonical: PyOpenColorIO.GpuShaderDesc.Texture3D - - - .. 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 - :canonical: PyOpenColorIO.GpuShaderDesc.UniformIterator - - - .. 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 - :canonical: PyOpenColorIO.GpuShaderDesc.TextureIterator - - - .. 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 - :canonical: PyOpenColorIO.GpuShaderDesc.Texture3DIterator - - - .. 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 49aca0d418..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gradingbsplinecurve.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:: GradingBSplineCurve - :module: PyOpenColorIO - :canonical: PyOpenColorIO.GradingBSplineCurve - - 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 - :canonical: PyOpenColorIO.GradingBSplineCurve.GradingControlPointIterator - - - .. 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 797ea19891..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gradingcontrolpoint.rst +++ /dev/null @@ -1,29 +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 - :canonical: PyOpenColorIO.GradingControlPoint - - 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 221337d499..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gradingprimary.rst +++ /dev/null @@ -1,83 +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 - :canonical: PyOpenColorIO.GradingPrimary - - 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 4813d8e8b0..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gradingprimarytransform.rst +++ /dev/null @@ -1,94 +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 - :canonical: PyOpenColorIO.GradingPrimaryTransform - - 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 9300a7fbe2..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gradingrgbcurve.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:: GradingRGBCurve - :module: PyOpenColorIO - :canonical: PyOpenColorIO.GradingRGBCurve - - 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 a19b2f648b..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gradingrgbcurvetransform.rst +++ /dev/null @@ -1,115 +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 - :canonical: PyOpenColorIO.GradingRGBCurveTransform - - 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 3c0b35233f..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gradingrgbm.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:: GradingRGBM - :module: PyOpenColorIO - :canonical: PyOpenColorIO.GradingRGBM - - 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 7759afd29b..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gradingrgbmsw.rst +++ /dev/null @@ -1,47 +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 - :canonical: PyOpenColorIO.GradingRGBMSW - - 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 16ba5dee8b..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gradingstyle.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:: GradingStyle - :module: PyOpenColorIO - :canonical: PyOpenColorIO.GradingStyle - - 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: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 0215d620ea..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gradingtone.rst +++ /dev/null @@ -1,45 +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 - :canonical: PyOpenColorIO.GradingTone - - 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 df03ce743a..0000000000 --- a/docs/api/python/frozen/pyopencolorio_gradingtonetransform.rst +++ /dev/null @@ -1,100 +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 - :canonical: PyOpenColorIO.GradingToneTransform - - 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 5586f14d8a..0000000000 --- a/docs/api/python/frozen/pyopencolorio_grouptransform.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:: GroupTransform - :module: PyOpenColorIO - :canonical: PyOpenColorIO.GroupTransform - - - .. 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 - :canonical: PyOpenColorIO.GroupTransform.WriteFormatIterator - - - .. 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 - :canonical: PyOpenColorIO.GroupTransform.TransformIterator - - - .. 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 f545ad40da..0000000000 --- a/docs/api/python/frozen/pyopencolorio_imagedesc.rst +++ /dev/null @@ -1,57 +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 - :canonical: PyOpenColorIO.ImageDesc - - 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 5dcd9a7204..0000000000 --- a/docs/api/python/frozen/pyopencolorio_interpolation.rst +++ /dev/null @@ -1,76 +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 - :canonical: PyOpenColorIO.Interpolation - - 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: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 deleted file mode 100644 index 320fbbbd43..0000000000 --- a/docs/api/python/frozen/pyopencolorio_legacyviewingpipeline.rst +++ /dev/null @@ -1,100 +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:: LegacyViewingPipeline - :module: PyOpenColorIO - :canonical: 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. - - Legacy viewing pipeline: - - Start in display transform input color space. - - If linearCC is provided: - - Go to scene_linear colorspace. - - Apply linearCC transform. - - - If colorTimingCC is provided: - - Go to color_timing colorspace. - - Apply colorTimingCC transform. - - - Apply looks (from display transform or from looks override). - - Go to first look color space. - - Apply first look transform. - - Iterate for all looks. - - - Apply channelView transform. - - Apply display transform (without looks). - - Apply displayCC. Note that looks are applied even if the display transform involves data color spaces. - - - .. py:method:: LegacyViewingPipeline.__init__(self: PyOpenColorIO.LegacyViewingPipeline) -> None - :module: PyOpenColorIO - - - .. py:method:: LegacyViewingPipeline.getChannelView(self: PyOpenColorIO.LegacyViewingPipeline) -> PyOpenColorIO.Transform - :module: PyOpenColorIO - - - .. py:method:: LegacyViewingPipeline.getColorTimingCC(self: PyOpenColorIO.LegacyViewingPipeline) -> PyOpenColorIO.Transform - :module: PyOpenColorIO - - - .. py:method:: LegacyViewingPipeline.getDisplayCC(self: PyOpenColorIO.LegacyViewingPipeline) -> PyOpenColorIO.Transform - :module: PyOpenColorIO - - - .. py:method:: LegacyViewingPipeline.getDisplayViewTransform(self: PyOpenColorIO.LegacyViewingPipeline) -> PyOpenColorIO.DisplayViewTransform - :module: PyOpenColorIO - - - .. py:method:: LegacyViewingPipeline.getLinearCC(self: PyOpenColorIO.LegacyViewingPipeline) -> PyOpenColorIO.Transform - :module: PyOpenColorIO - - - .. py:method:: LegacyViewingPipeline.getLooksOverride(self: PyOpenColorIO.LegacyViewingPipeline) -> str - :module: PyOpenColorIO - - - .. py:method:: LegacyViewingPipeline.getLooksOverrideEnabled(self: PyOpenColorIO.LegacyViewingPipeline) -> bool - :module: PyOpenColorIO - - - .. py:method:: LegacyViewingPipeline.getProcessor(self: PyOpenColorIO.LegacyViewingPipeline, config: PyOpenColorIO.Config, context: PyOpenColorIO.Context = None) -> PyOpenColorIO.Processor - :module: PyOpenColorIO - - - .. py:method:: LegacyViewingPipeline.setChannelView(self: PyOpenColorIO.LegacyViewingPipeline, arg0: PyOpenColorIO.Transform) -> None - :module: PyOpenColorIO - - - .. py:method:: LegacyViewingPipeline.setColorTimingCC(self: PyOpenColorIO.LegacyViewingPipeline, arg0: PyOpenColorIO.Transform) -> None - :module: PyOpenColorIO - - - .. py:method:: LegacyViewingPipeline.setDisplayCC(self: PyOpenColorIO.LegacyViewingPipeline, arg0: PyOpenColorIO.Transform) -> None - :module: PyOpenColorIO - - - .. py:method:: LegacyViewingPipeline.setDisplayViewTransform(self: PyOpenColorIO.LegacyViewingPipeline, arg0: PyOpenColorIO.DisplayViewTransform) -> None - :module: PyOpenColorIO - - - .. py:method:: LegacyViewingPipeline.setLinearCC(self: PyOpenColorIO.LegacyViewingPipeline, arg0: PyOpenColorIO.Transform) -> None - :module: PyOpenColorIO - - - .. 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. - - 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 - :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 fa9ef95891..0000000000 --- a/docs/api/python/frozen/pyopencolorio_logaffinetransform.rst +++ /dev/null @@ -1,96 +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 - :canonical: PyOpenColorIO.LogAffineTransform - - 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: Annotated[list[float], FixedSize(3)] = [1.0, 1.0, 1.0], logSideOffset: Annotated[list[float], FixedSize(3)] = [0.0, 0.0, 0.0], linSideSlope: Annotated[list[float], FixedSize(3)] = [1.0, 1.0, 1.0], linSideOffset: Annotated[list[float], FixedSize(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) -> Annotated[list[float], FixedSize(3)] - :module: PyOpenColorIO - - - .. py:method:: LogAffineTransform.getLinSideSlopeValue(self: PyOpenColorIO.LogAffineTransform) -> Annotated[list[float], FixedSize(3)] - :module: PyOpenColorIO - - - .. py:method:: LogAffineTransform.getLogSideOffsetValue(self: PyOpenColorIO.LogAffineTransform) -> Annotated[list[float], FixedSize(3)] - :module: PyOpenColorIO - - - .. py:method:: LogAffineTransform.getLogSideSlopeValue(self: PyOpenColorIO.LogAffineTransform) -> Annotated[list[float], FixedSize(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: Annotated[list[float], FixedSize(3)]) -> None - :module: PyOpenColorIO - - - .. py:method:: LogAffineTransform.setLinSideSlopeValue(self: PyOpenColorIO.LogAffineTransform, values: Annotated[list[float], FixedSize(3)]) -> None - :module: PyOpenColorIO - - - .. py:method:: LogAffineTransform.setLogSideOffsetValue(self: PyOpenColorIO.LogAffineTransform, values: Annotated[list[float], FixedSize(3)]) -> None - :module: PyOpenColorIO - - - .. py:method:: LogAffineTransform.setLogSideSlopeValue(self: PyOpenColorIO.LogAffineTransform, values: Annotated[list[float], FixedSize(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 a47be00c61..0000000000 --- a/docs/api/python/frozen/pyopencolorio_logcameratransform.rst +++ /dev/null @@ -1,126 +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 - :canonical: PyOpenColorIO.LogCameraTransform - - 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: Annotated[list[float], FixedSize(3)], base: float = 2.0, logSideSlope: Annotated[list[float], FixedSize(3)] = [1.0, 1.0, 1.0], logSideOffset: Annotated[list[float], FixedSize(3)] = [0.0, 0.0, 0.0], linSideSlope: Annotated[list[float], FixedSize(3)] = [1.0, 1.0, 1.0], linSideOffset: Annotated[list[float], FixedSize(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) -> Annotated[list[float], FixedSize(3)] - :module: PyOpenColorIO - - - .. py:method:: LogCameraTransform.getLinSideOffsetValue(self: PyOpenColorIO.LogCameraTransform) -> Annotated[list[float], FixedSize(3)] - :module: PyOpenColorIO - - - .. py:method:: LogCameraTransform.getLinSideSlopeValue(self: PyOpenColorIO.LogCameraTransform) -> Annotated[list[float], FixedSize(3)] - :module: PyOpenColorIO - - - .. py:method:: LogCameraTransform.getLinearSlopeValue(self: PyOpenColorIO.LogCameraTransform) -> Annotated[list[float], FixedSize(3)] - :module: PyOpenColorIO - - Return LinearSlope or 3 qnan values if not defined. - - - .. py:method:: LogCameraTransform.getLogSideOffsetValue(self: PyOpenColorIO.LogCameraTransform) -> Annotated[list[float], FixedSize(3)] - :module: PyOpenColorIO - - - .. py:method:: LogCameraTransform.getLogSideSlopeValue(self: PyOpenColorIO.LogCameraTransform) -> Annotated[list[float], FixedSize(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: Annotated[list[float], FixedSize(3)]) -> None - :module: PyOpenColorIO - - - .. py:method:: LogCameraTransform.setLinSideOffsetValue(self: PyOpenColorIO.LogCameraTransform, values: Annotated[list[float], FixedSize(3)]) -> None - :module: PyOpenColorIO - - - .. py:method:: LogCameraTransform.setLinSideSlopeValue(self: PyOpenColorIO.LogCameraTransform, values: Annotated[list[float], FixedSize(3)]) -> None - :module: PyOpenColorIO - - - .. py:method:: LogCameraTransform.setLinearSlopeValue(self: PyOpenColorIO.LogCameraTransform, values: Annotated[list[float], FixedSize(3)]) -> None - :module: PyOpenColorIO - - Set LinearSlope value. - - .. note:: - You must call setLinSideBreakValue before calling this. - - - .. py:method:: LogCameraTransform.setLogSideOffsetValue(self: PyOpenColorIO.LogCameraTransform, values: Annotated[list[float], FixedSize(3)]) -> None - :module: PyOpenColorIO - - - .. py:method:: LogCameraTransform.setLogSideSlopeValue(self: PyOpenColorIO.LogCameraTransform, values: Annotated[list[float], FixedSize(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 b77e79fd52..0000000000 --- a/docs/api/python/frozen/pyopencolorio_logginglevel.rst +++ /dev/null @@ -1,50 +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 - :canonical: PyOpenColorIO.LoggingLevel - - Members: - - LOGGING_LEVEL_NONE : - - LOGGING_LEVEL_WARNING : - - LOGGING_LEVEL_INFO : - - LOGGING_LEVEL_DEBUG : - - LOGGING_LEVEL_UNKNOWN : - - - .. 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 c8e32116b3..0000000000 --- a/docs/api/python/frozen/pyopencolorio_logtransform.rst +++ /dev/null @@ -1,63 +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 - :canonical: PyOpenColorIO.LogTransform - - 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 cbfa7eee3f..0000000000 --- a/docs/api/python/frozen/pyopencolorio_look.rst +++ /dev/null @@ -1,65 +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 - :canonical: PyOpenColorIO.Look - - 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 959454d8c3..0000000000 --- a/docs/api/python/frozen/pyopencolorio_looktransform.rst +++ /dev/null @@ -1,73 +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 - :canonical: PyOpenColorIO.LookTransform - - - .. 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 faeb40549b..0000000000 --- a/docs/api/python/frozen/pyopencolorio_lut1dhueadjust.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:: Lut1DHueAdjust - :module: PyOpenColorIO - :canonical: PyOpenColorIO.Lut1DHueAdjust - - 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: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 2eeb3ef1ca..0000000000 --- a/docs/api/python/frozen/pyopencolorio_lut1dtransform.rst +++ /dev/null @@ -1,141 +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 - :canonical: PyOpenColorIO.Lut1DTransform - - 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 20360714b8..0000000000 --- a/docs/api/python/frozen/pyopencolorio_lut3dtransform.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:: Lut3DTransform - :module: PyOpenColorIO - :canonical: PyOpenColorIO.Lut3DTransform - - 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 e23459e6bf..0000000000 --- a/docs/api/python/frozen/pyopencolorio_matrixtransform.rst +++ /dev/null @@ -1,132 +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 - :canonical: PyOpenColorIO.MatrixTransform - - Represents an MX+B Matrix transform. - - .. note:: - For singular matrices, an inverse direction will throw an exception during finalization. - - - .. py:method:: MatrixTransform.Fit(oldMin: Annotated[list[float], FixedSize(4)] = [0.0, 0.0, 0.0, 0.0], oldMax: Annotated[list[float], FixedSize(4)] = [1.0, 1.0, 1.0, 1.0], newMin: Annotated[list[float], FixedSize(4)] = [0.0, 0.0, 0.0, 0.0], newMax: Annotated[list[float], FixedSize(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: Annotated[list[float], FixedSize(3)]) -> PyOpenColorIO.MatrixTransform - :module: PyOpenColorIO - :staticmethod: - - - .. py:method:: MatrixTransform.Scale(scale: Annotated[list[float], FixedSize(4)]) -> PyOpenColorIO.MatrixTransform - :module: PyOpenColorIO - :staticmethod: - - - .. py:method:: MatrixTransform.View(channelHot: Annotated[list[int], FixedSize(4)], lumaCoef: Annotated[list[float], FixedSize(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: Annotated[list[float], FixedSize(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: Annotated[list[float], FixedSize(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) -> Annotated[list[float], FixedSize(16)] - :module: PyOpenColorIO - - - .. py:method:: MatrixTransform.getOffset(self: PyOpenColorIO.MatrixTransform) -> Annotated[list[float], FixedSize(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: Annotated[list[float], FixedSize(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: Annotated[list[float], FixedSize(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 deleted file mode 100644 index 955d893330..0000000000 --- a/docs/api/python/frozen/pyopencolorio_mixingcolorspacemanager.rst +++ /dev/null @@ -1,113 +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:: MixingColorSpaceManager - :module: PyOpenColorIO - :canonical: PyOpenColorIO.MixingColorSpaceManager - - Used to mix (or pick/choose) colors. - - - .. py:method:: MixingColorSpaceManager.__init__(self: PyOpenColorIO.MixingColorSpaceManager, config: PyOpenColorIO.Config) -> None - :module: PyOpenColorIO - - - .. py:method:: MixingColorSpaceManager.getMixingEncodings(self: PyOpenColorIO.MixingColorSpaceManager) -> PyOpenColorIO.MixingColorSpaceManager.MixingEncodingIterator - :module: PyOpenColorIO - - - .. py:method:: MixingColorSpaceManager.getMixingSpaces(self: PyOpenColorIO.MixingColorSpaceManager) -> PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator - :module: PyOpenColorIO - - - .. 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.MixingColorSpaceManager) -> int - :module: PyOpenColorIO - - - .. py:method:: MixingColorSpaceManager.getSelectedMixingSpaceIdx(self: PyOpenColorIO.MixingColorSpaceManager) -> int - :module: PyOpenColorIO - - - .. py:method:: MixingColorSpaceManager.getSlider(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. getSlider(self: PyOpenColorIO.MixingColorSpaceManager) -> PyOpenColorIO.MixingSlider - - 2. getSlider(self: PyOpenColorIO.MixingColorSpaceManager, sliderMixingMinEdge: float, sliderMixingMaxEdge: float) -> PyOpenColorIO.MixingSlider - - - .. py:method:: MixingColorSpaceManager.isPerceptuallyUniform(self: PyOpenColorIO.MixingColorSpaceManager) -> bool - :module: PyOpenColorIO - - - .. 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.MixingColorSpaceManager, mixingEncoding: str) -> None - :module: PyOpenColorIO - - - .. py:method:: MixingColorSpaceManager.setSelectedMixingEncodingIdx(self: PyOpenColorIO.MixingColorSpaceManager, arg0: int) -> None - :module: PyOpenColorIO - - - .. py:method:: MixingColorSpaceManager.setSelectedMixingSpace(self: PyOpenColorIO.MixingColorSpaceManager, mixingSpace: str) -> None - :module: PyOpenColorIO - - - .. py:method:: MixingColorSpaceManager.setSelectedMixingSpaceIdx(self: PyOpenColorIO.MixingColorSpaceManager, arg0: int) -> None - :module: PyOpenColorIO - - -.. py:class:: MixingSpaceIterator - :module: PyOpenColorIO.MixingColorSpaceManager - :canonical: PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator - - - .. py:method:: MixingSpaceIterator.__getitem__(self: PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator, arg0: int) -> str - :module: PyOpenColorIO.MixingColorSpaceManager - - - .. py:method:: MixingSpaceIterator.__iter__(self: PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator) -> PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator - :module: PyOpenColorIO.MixingColorSpaceManager - - - .. py:method:: MixingSpaceIterator.__len__(self: PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator) -> int - :module: PyOpenColorIO.MixingColorSpaceManager - - - .. py:method:: MixingSpaceIterator.__next__(self: PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator) -> str - :module: PyOpenColorIO.MixingColorSpaceManager - - -.. py:class:: MixingEncodingIterator - :module: PyOpenColorIO.MixingColorSpaceManager - :canonical: PyOpenColorIO.MixingColorSpaceManager.MixingEncodingIterator - - - .. py:method:: MixingEncodingIterator.__getitem__(self: PyOpenColorIO.MixingColorSpaceManager.MixingEncodingIterator, arg0: int) -> str - :module: PyOpenColorIO.MixingColorSpaceManager - - - .. py:method:: MixingEncodingIterator.__iter__(self: PyOpenColorIO.MixingColorSpaceManager.MixingEncodingIterator) -> PyOpenColorIO.MixingColorSpaceManager.MixingEncodingIterator - :module: PyOpenColorIO.MixingColorSpaceManager - - - .. py:method:: MixingEncodingIterator.__len__(self: PyOpenColorIO.MixingColorSpaceManager.MixingEncodingIterator) -> int - :module: PyOpenColorIO.MixingColorSpaceManager - - - .. 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 deleted file mode 100644 index c8f7e9972f..0000000000 --- a/docs/api/python/frozen/pyopencolorio_mixingslider.rst +++ /dev/null @@ -1,59 +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:: MixingSlider - :module: PyOpenColorIO - :canonical: 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. - - A user may want to mix colors in different color spaces. The two most common mixing space options are a scene-linear working space or the display space. - - Since scene-linear color spaces are not perceptually uniform, it is necessary to compensate UI widgets such as sliders. For example, it is nice if mid-gray falls near the center of mixing controls rather than way over near the black end. This may be done by using a mapping from linear into an approximately perceptually uniform space. - - Also note that a color picking/mixing UI may want to present a given color space in several different encodings. The most common two encodings for color mixing are RGB and HSV. - - Note that these helpers anticipate that a user may want to mix colors using values that extend outside the typical [0,1] domain. - - - .. py:method:: MixingSlider.__init__(*args, **kwargs) - :module: PyOpenColorIO - - - .. 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.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 - :module: PyOpenColorIO - - Convert from mixing space units to distance along the slider. - - - .. 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.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 - :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 1c7a028c85..0000000000 --- a/docs/api/python/frozen/pyopencolorio_namedtransform.rst +++ /dev/null @@ -1,167 +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 - :canonical: PyOpenColorIO.NamedTransform - - :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: - - Will create the transform from the inverse direction if the transform for requested direction is missing. - - - .. py:class:: NamedTransform.NamedTransformAliasIterator - :module: PyOpenColorIO - :canonical: PyOpenColorIO.NamedTransform.NamedTransformAliasIterator - - - .. 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.hasAlias(self: PyOpenColorIO.NamedTransform, alias: str) -> bool - :module: PyOpenColorIO - - Return true if alias exists. - - - .. 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 - :canonical: PyOpenColorIO.NamedTransform.NamedTransformCategoryIterator - - - .. 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 e3e59d0878..0000000000 --- a/docs/api/python/frozen/pyopencolorio_namedtransformvisibility.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:: NamedTransformVisibility - :module: PyOpenColorIO - :canonical: PyOpenColorIO.NamedTransformVisibility - - Members: - - NAMEDTRANSFORM_ACTIVE : - - NAMEDTRANSFORM_INACTIVE : - - NAMEDTRANSFORM_ALL : - - - .. 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 8de87200b6..0000000000 --- a/docs/api/python/frozen/pyopencolorio_negativestyle.rst +++ /dev/null @@ -1,45 +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 - :canonical: PyOpenColorIO.NegativeStyle - - 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: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 5ebc30142e..0000000000 --- a/docs/api/python/frozen/pyopencolorio_optimizationflags.rst +++ /dev/null @@ -1,213 +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 - :canonical: PyOpenColorIO.OptimizationFlags - - 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: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 78d82c5263..0000000000 --- a/docs/api/python/frozen/pyopencolorio_packedimagedesc.rst +++ /dev/null @@ -1,96 +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 - :canonical: PyOpenColorIO.PackedImageDesc - - 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 1da5165290..0000000000 --- a/docs/api/python/frozen/pyopencolorio_planarimagedesc.rst +++ /dev/null @@ -1,96 +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 - :canonical: PyOpenColorIO.PlanarImageDesc - - 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 deleted file mode 100644 index 0759e6d46c..0000000000 --- a/docs/api/python/frozen/pyopencolorio_processor.rst +++ /dev/null @@ -1,154 +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:: Processor - :module: PyOpenColorIO - :canonical: PyOpenColorIO.Processor - - The *:ref:`Processor`* represents a specific color transformation which is the result of :ref:`getProcessor`. - - - .. py:method:: Processor.__init__(*args, **kwargs) - :module: PyOpenColorIO - - - .. 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.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 - :module: PyOpenColorIO - - Get an optimized :ref:`CPUProcessor` instance. - - .. note:: - This may provide higher fidelity than anticipated due to internal optimizations. For example, if the inputColorSpace and the outputColorSpace are members of the same equalitygroup, no conversion will be applied, even though strictly speaking quantization should be added. - - .. note:: - The typical use case to apply color processing to an image is: - - .. code-block:: cpp - - OCIO::ConstConfigRcPtr config = OCIO::GetCurrentConfig(); - - OCIO::ConstProcessorRcPtr processor - = config->getProcessor(colorSpace1, colorSpace2); - - OCIO::ConstCPUProcessorRcPtr cpuProcessor - = processor->getDefaultCPUProcessor(); - - OCIO::PackedImageDesc img(imgDataPtr, imgWidth, imgHeight, imgChannels); - cpuProcessor->apply(img); - - - .. py:method:: Processor.getDefaultGPUProcessor(self: PyOpenColorIO.Processor) -> PyOpenColorIO.GPUProcessor - :module: PyOpenColorIO - - Get an optimized :ref:`GPUProcessor` instance. - - - .. 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. - - .. note:: - 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 - :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. - - - .. py:method:: Processor.getOptimizedCPUProcessor(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 1. getOptimizedCPUProcessor(self: PyOpenColorIO.Processor, oFlags: PyOpenColorIO.OptimizationFlags) -> PyOpenColorIO.CPUProcessor - - 2. getOptimizedCPUProcessor(self: PyOpenColorIO.Processor, inBitDepth: PyOpenColorIO.BitDepth, outBitDepth: PyOpenColorIO.BitDepth, oFlags: PyOpenColorIO.OptimizationFlags) -> PyOpenColorIO.CPUProcessor - - - .. py:method:: Processor.getOptimizedGPUProcessor(self: PyOpenColorIO.Processor, oFlags: PyOpenColorIO.OptimizationFlags) -> PyOpenColorIO.GPUProcessor - :module: PyOpenColorIO - - - .. py:method:: Processor.getOptimizedProcessor(*args, **kwargs) - :module: PyOpenColorIO - - Overloaded function. - - 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.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.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.Processor) -> PyOpenColorIO.Processor.TransformFormatMetadataIterator - :module: PyOpenColorIO - - - .. 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.Processor, type: PyOpenColorIO.DynamicPropertyType) -> bool - :module: PyOpenColorIO - - True if at least one dynamic property of that type exists. - - - .. 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.Processor) -> bool - :module: PyOpenColorIO - - -.. py:class:: TransformFormatMetadataIterator - :module: PyOpenColorIO.Processor - :canonical: PyOpenColorIO.Processor.TransformFormatMetadataIterator - - - .. py:method:: TransformFormatMetadataIterator.__getitem__(self: PyOpenColorIO.Processor.TransformFormatMetadataIterator, arg0: int) -> PyOpenColorIO.FormatMetadata - :module: PyOpenColorIO.Processor - - - .. py:method:: TransformFormatMetadataIterator.__iter__(self: PyOpenColorIO.Processor.TransformFormatMetadataIterator) -> PyOpenColorIO.Processor.TransformFormatMetadataIterator - :module: PyOpenColorIO.Processor - - - .. py:method:: TransformFormatMetadataIterator.__len__(self: PyOpenColorIO.Processor.TransformFormatMetadataIterator) -> int - :module: PyOpenColorIO.Processor - - - .. 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 deleted file mode 100644 index aac00d58f7..0000000000 --- a/docs/api/python/frozen/pyopencolorio_processorcacheflags.rst +++ /dev/null @@ -1,45 +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 - :canonical: PyOpenColorIO.ProcessorCacheFlags - - 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: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 deleted file mode 100644 index efa9eff793..0000000000 --- a/docs/api/python/frozen/pyopencolorio_processormetadata.rst +++ /dev/null @@ -1,73 +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:: ProcessorMetadata - :module: PyOpenColorIO - :canonical: 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 - :module: PyOpenColorIO - - - .. py:method:: ProcessorMetadata.addFile(self: PyOpenColorIO.ProcessorMetadata, fileName: str) -> None - :module: PyOpenColorIO - - - .. py:method:: ProcessorMetadata.addLook(self: PyOpenColorIO.ProcessorMetadata, look: str) -> None - :module: PyOpenColorIO - - - .. py:method:: ProcessorMetadata.getFiles(self: PyOpenColorIO.ProcessorMetadata) -> PyOpenColorIO.ProcessorMetadata.FileIterator - :module: PyOpenColorIO - - - .. py:method:: ProcessorMetadata.getLooks(self: PyOpenColorIO.ProcessorMetadata) -> PyOpenColorIO.ProcessorMetadata.LookIterator - :module: PyOpenColorIO - - -.. py:class:: FileIterator - :module: PyOpenColorIO.ProcessorMetadata - :canonical: PyOpenColorIO.ProcessorMetadata.FileIterator - - - .. py:method:: FileIterator.__getitem__(self: PyOpenColorIO.ProcessorMetadata.FileIterator, arg0: int) -> str - :module: PyOpenColorIO.ProcessorMetadata - - - .. py:method:: FileIterator.__iter__(self: PyOpenColorIO.ProcessorMetadata.FileIterator) -> PyOpenColorIO.ProcessorMetadata.FileIterator - :module: PyOpenColorIO.ProcessorMetadata - - - .. py:method:: FileIterator.__len__(self: PyOpenColorIO.ProcessorMetadata.FileIterator) -> int - :module: PyOpenColorIO.ProcessorMetadata - - - .. py:method:: FileIterator.__next__(self: PyOpenColorIO.ProcessorMetadata.FileIterator) -> str - :module: PyOpenColorIO.ProcessorMetadata - - -.. py:class:: LookIterator - :module: PyOpenColorIO.ProcessorMetadata - :canonical: PyOpenColorIO.ProcessorMetadata.LookIterator - - - .. py:method:: LookIterator.__getitem__(self: PyOpenColorIO.ProcessorMetadata.LookIterator, arg0: int) -> str - :module: PyOpenColorIO.ProcessorMetadata - - - .. py:method:: LookIterator.__iter__(self: PyOpenColorIO.ProcessorMetadata.LookIterator) -> PyOpenColorIO.ProcessorMetadata.LookIterator - :module: PyOpenColorIO.ProcessorMetadata - - - .. py:method:: LookIterator.__len__(self: PyOpenColorIO.ProcessorMetadata.LookIterator) -> int - :module: PyOpenColorIO.ProcessorMetadata - - - .. 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 deleted file mode 100644 index 7607a5b484..0000000000 --- a/docs/api/python/frozen/pyopencolorio_rangestyle.rst +++ /dev/null @@ -1,31 +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 - :canonical: PyOpenColorIO.RangeStyle - - A :ref:`RangeTransform` may be set to clamp the values, or not. - - Members: - - RANGE_NO_CLAMP : - - RANGE_CLAMP : - - - .. 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 78c1a030e0..0000000000 --- a/docs/api/python/frozen/pyopencolorio_rangetransform.rst +++ /dev/null @@ -1,196 +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 - :canonical: PyOpenColorIO.RangeTransform - - 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 ebf0325f23..0000000000 --- a/docs/api/python/frozen/pyopencolorio_referencespacetype.rst +++ /dev/null @@ -1,31 +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 - :canonical: PyOpenColorIO.ReferenceSpaceType - - 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: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 4d625c38b5..0000000000 --- a/docs/api/python/frozen/pyopencolorio_rgbcurvetype.rst +++ /dev/null @@ -1,52 +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 - :canonical: PyOpenColorIO.RGBCurveType - - Types for :ref:`GradingRGBCurve`. - - Members: - - RGB_RED : - - RGB_GREEN : - - RGB_BLUE : - - RGB_MASTER : - - RGB_NUM_CURVES : - - - .. 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 d47de645b3..0000000000 --- a/docs/api/python/frozen/pyopencolorio_searchreferencespacetype.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:: SearchReferenceSpaceType - :module: PyOpenColorIO - :canonical: PyOpenColorIO.SearchReferenceSpaceType - - Members: - - SEARCH_REFERENCE_SPACE_SCENE : - - SEARCH_REFERENCE_SPACE_DISPLAY : - - SEARCH_REFERENCE_SPACE_ALL : - - - .. 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 e8b133e8cb..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 :ref:`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 edb1a87808..0000000000 --- a/docs/api/python/frozen/pyopencolorio_systemmonitors.rst +++ /dev/null @@ -1,40 +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 - :canonical: PyOpenColorIO.SystemMonitors - - 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 - :canonical: PyOpenColorIO.SystemMonitors.MonitorIterator - - - .. 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 2f3b828124..0000000000 --- a/docs/api/python/frozen/pyopencolorio_transform.rst +++ /dev/null @@ -1,35 +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 - :canonical: PyOpenColorIO.Transform - - 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 94a3cc6b9c..0000000000 --- a/docs/api/python/frozen/pyopencolorio_transformdirection.rst +++ /dev/null @@ -1,29 +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 - :canonical: PyOpenColorIO.TransformDirection - - Members: - - TRANSFORM_DIR_FORWARD : - - TRANSFORM_DIR_INVERSE : - - - .. 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 7a7f72446d..0000000000 --- a/docs/api/python/frozen/pyopencolorio_transformtype.rst +++ /dev/null @@ -1,169 +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 - :canonical: PyOpenColorIO.TransformType - - 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: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 f74215ffb8..0000000000 --- a/docs/api/python/frozen/pyopencolorio_uniformdatatype.rst +++ /dev/null @@ -1,59 +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 - :canonical: PyOpenColorIO.UniformDataType - - 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: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 945519ecee..0000000000 --- a/docs/api/python/frozen/pyopencolorio_viewingrules.rst +++ /dev/null @@ -1,163 +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 - :canonical: PyOpenColorIO.ViewingRules - - :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:`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:`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 - :canonical: PyOpenColorIO.ViewingRules.ViewingRuleColorSpaceIterator - - - .. 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 - :canonical: PyOpenColorIO.ViewingRules.ViewingRuleEncodingIterator - - - .. 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 372f973907..0000000000 --- a/docs/api/python/frozen/pyopencolorio_viewtransform.rst +++ /dev/null @@ -1,126 +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 - :canonical: PyOpenColorIO.ViewTransform - - 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 :ref:`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 - :canonical: PyOpenColorIO.ViewTransform.ViewTransformCategoryIterator - - - .. 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 4f08f370b6..0000000000 --- a/docs/api/python/frozen/pyopencolorio_viewtransformdirection.rst +++ /dev/null @@ -1,29 +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 - :canonical: PyOpenColorIO.ViewTransformDirection - - Members: - - VIEWTRANSFORM_DIR_TO_REFERENCE : - - VIEWTRANSFORM_DIR_FROM_REFERENCE : - - - .. 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 4bb71556a9..0000000000 --- a/docs/api/python/frozen/pyopencolorio_viewtype.rst +++ /dev/null @@ -1,29 +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 - :canonical: PyOpenColorIO.ViewType - - Members: - - VIEW_SHARED : - - VIEW_DISPLAY_DEFINED : - - - .. 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/api/python/src/pyopencolorio_allocation.rst b/docs/api/python/src/pyopencolorio_allocation.rst deleted file mode 100644 index 0f35a4a026..0000000000 --- a/docs/api/python/src/pyopencolorio_allocation.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.Allocation - :members: - :undoc-members: - :exclude-members: name diff --git a/docs/api/python/src/pyopencolorio_allocationfromstring.rst b/docs/api/python/src/pyopencolorio_allocationfromstring.rst deleted file mode 100644 index 60df82ec7e..0000000000 --- a/docs/api/python/src/pyopencolorio_allocationfromstring.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.AllocationFromString diff --git a/docs/api/python/src/pyopencolorio_allocationtostring.rst b/docs/api/python/src/pyopencolorio_allocationtostring.rst deleted file mode 100644 index 6efafeb215..0000000000 --- a/docs/api/python/src/pyopencolorio_allocationtostring.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.AllocationToString diff --git a/docs/api/python/src/pyopencolorio_allocationtransform.rst b/docs/api/python/src/pyopencolorio_allocationtransform.rst deleted file mode 100644 index 6e1f22b632..0000000000 --- a/docs/api/python/src/pyopencolorio_allocationtransform.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.AllocationTransform - :members: - :undoc-members: - :special-members: __init__, __str__ - :inherited-members: diff --git a/docs/api/python/src/pyopencolorio_baker.rst b/docs/api/python/src/pyopencolorio_baker.rst deleted file mode 100644 index 63ce0b8076..0000000000 --- a/docs/api/python/src/pyopencolorio_baker.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.Baker - :members: - :undoc-members: - :special-members: __init__ - :exclude-members: FormatIterator - -.. autoclass:: PyOpenColorIO.Baker.FormatIterator - :special-members: __getitem__, __iter__, __len__, __next__ diff --git a/docs/api/python/src/pyopencolorio_bitdepth.rst b/docs/api/python/src/pyopencolorio_bitdepth.rst deleted file mode 100644 index 3ab0537319..0000000000 --- a/docs/api/python/src/pyopencolorio_bitdepth.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.BitDepth - :members: - :undoc-members: - :exclude-members: name diff --git a/docs/api/python/src/pyopencolorio_bitdepthfromstring.rst b/docs/api/python/src/pyopencolorio_bitdepthfromstring.rst deleted file mode 100644 index 7d5c67a28d..0000000000 --- a/docs/api/python/src/pyopencolorio_bitdepthfromstring.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.BitDepthFromString diff --git a/docs/api/python/src/pyopencolorio_bitdepthisfloat.rst b/docs/api/python/src/pyopencolorio_bitdepthisfloat.rst deleted file mode 100644 index 4ca2f29bc6..0000000000 --- a/docs/api/python/src/pyopencolorio_bitdepthisfloat.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.BitDepthIsFloat diff --git a/docs/api/python/src/pyopencolorio_bitdepthtoint.rst b/docs/api/python/src/pyopencolorio_bitdepthtoint.rst deleted file mode 100644 index 554825c309..0000000000 --- a/docs/api/python/src/pyopencolorio_bitdepthtoint.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.BitDepthToInt diff --git a/docs/api/python/src/pyopencolorio_bitdepthtostring.rst b/docs/api/python/src/pyopencolorio_bitdepthtostring.rst deleted file mode 100644 index 87dfd8b274..0000000000 --- a/docs/api/python/src/pyopencolorio_bitdepthtostring.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.BitDepthToString diff --git a/docs/api/python/src/pyopencolorio_boolfromstring.rst b/docs/api/python/src/pyopencolorio_boolfromstring.rst deleted file mode 100644 index 4bf130c433..0000000000 --- a/docs/api/python/src/pyopencolorio_boolfromstring.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.BoolFromString diff --git a/docs/api/python/src/pyopencolorio_booltostring.rst b/docs/api/python/src/pyopencolorio_booltostring.rst deleted file mode 100644 index 4eefbba656..0000000000 --- a/docs/api/python/src/pyopencolorio_booltostring.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.BoolToString diff --git a/docs/api/python/src/pyopencolorio_builtintransform.rst b/docs/api/python/src/pyopencolorio_builtintransform.rst deleted file mode 100644 index a59124d893..0000000000 --- a/docs/api/python/src/pyopencolorio_builtintransform.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.BuiltinTransform - :members: - :undoc-members: - :special-members: __init__, __str__ - :inherited-members: diff --git a/docs/api/python/src/pyopencolorio_builtintransformregistry.rst b/docs/api/python/src/pyopencolorio_builtintransformregistry.rst deleted file mode 100644 index cdff317343..0000000000 --- a/docs/api/python/src/pyopencolorio_builtintransformregistry.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.BuiltinTransformRegistry - :members: - :undoc-members: - :special-members: __init__ - :exclude-members: BuiltinStyleIterator, BuiltinIterator - -.. autoclass:: PyOpenColorIO.BuiltinTransformRegistry.BuiltinStyleIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.BuiltinTransformRegistry.BuiltinIterator - :special-members: __getitem__, __iter__, __len__, __next__ diff --git a/docs/api/python/src/pyopencolorio_cdlstyle.rst b/docs/api/python/src/pyopencolorio_cdlstyle.rst deleted file mode 100644 index 8934a6589f..0000000000 --- a/docs/api/python/src/pyopencolorio_cdlstyle.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.CDLStyle - :members: - :undoc-members: - :exclude-members: name diff --git a/docs/api/python/src/pyopencolorio_cdlstylefromstring.rst b/docs/api/python/src/pyopencolorio_cdlstylefromstring.rst deleted file mode 100644 index 0904d34c61..0000000000 --- a/docs/api/python/src/pyopencolorio_cdlstylefromstring.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.CDLStyleFromString diff --git a/docs/api/python/src/pyopencolorio_cdlstyletostring.rst b/docs/api/python/src/pyopencolorio_cdlstyletostring.rst deleted file mode 100644 index fe855ce7e1..0000000000 --- a/docs/api/python/src/pyopencolorio_cdlstyletostring.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.CDLStyleToString diff --git a/docs/api/python/src/pyopencolorio_cdltransform.rst b/docs/api/python/src/pyopencolorio_cdltransform.rst deleted file mode 100644 index 2785552904..0000000000 --- a/docs/api/python/src/pyopencolorio_cdltransform.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.CDLTransform - :members: - :undoc-members: - :special-members: __init__, __str__ - :inherited-members: diff --git a/docs/api/python/src/pyopencolorio_channelordering.rst b/docs/api/python/src/pyopencolorio_channelordering.rst deleted file mode 100644 index 4dd8ee42f3..0000000000 --- a/docs/api/python/src/pyopencolorio_channelordering.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.ChannelOrdering - :members: - :undoc-members: - :exclude-members: name diff --git a/docs/api/python/src/pyopencolorio_clearallcaches.rst b/docs/api/python/src/pyopencolorio_clearallcaches.rst deleted file mode 100644 index a388f8763a..0000000000 --- a/docs/api/python/src/pyopencolorio_clearallcaches.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.ClearAllCaches diff --git a/docs/api/python/src/pyopencolorio_colorspace.rst b/docs/api/python/src/pyopencolorio_colorspace.rst deleted file mode 100644 index a8a79e3125..0000000000 --- a/docs/api/python/src/pyopencolorio_colorspace.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.ColorSpace - :members: - :undoc-members: - :special-members: __init__, __str__ - :exclude-members: ColorSpaceCategoryIterator, ColorSpaceAliasIterator - -.. autoclass:: PyOpenColorIO.ColorSpace.ColorSpaceCategoryIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.ColorSpace.ColorSpaceAliasIterator - :special-members: __getitem__, __iter__, __len__, __next__ diff --git a/docs/api/python/src/pyopencolorio_colorspacedirection.rst b/docs/api/python/src/pyopencolorio_colorspacedirection.rst deleted file mode 100644 index ab0b4382e0..0000000000 --- a/docs/api/python/src/pyopencolorio_colorspacedirection.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.ColorSpaceDirection - :members: - :undoc-members: - :exclude-members: name diff --git a/docs/api/python/src/pyopencolorio_colorspacehelpers.rst b/docs/api/python/src/pyopencolorio_colorspacehelpers.rst deleted file mode 100644 index 9592616eb4..0000000000 --- a/docs/api/python/src/pyopencolorio_colorspacehelpers.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.ColorSpaceHelpers.AddColorSpace - -.. autoclass:: PyOpenColorIO.ColorSpaceMenuParameters - :members: - :undoc-members: - :special-members: __init__, __str__ - :exclude-members: AddedColorSpaceIterator - -.. autoclass:: PyOpenColorIO.ColorSpaceMenuHelper - :members: - :undoc-members: - :special-members: __init__, __str__ - :exclude-members: ColorSpaceLevelIterator - -.. autoclass:: PyOpenColorIO.ColorSpaceMenuHelper.ColorSpaceLevelIterator - :special-members: __getitem__, __iter__, __len__, __next__ diff --git a/docs/api/python/src/pyopencolorio_colorspaceset.rst b/docs/api/python/src/pyopencolorio_colorspaceset.rst deleted file mode 100644 index 9a2dfb0462..0000000000 --- a/docs/api/python/src/pyopencolorio_colorspaceset.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.ColorSpaceSet - :members: - :undoc-members: - :special-members: __init__, __eq__, __ne__, __sub__, __or__, __and__ - :exclude-members: ColorSpaceNameIterator, ColorSpaceIterator - -.. autoclass:: PyOpenColorIO.ColorSpaceSet.ColorSpaceNameIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.ColorSpaceSet.ColorSpaceIterator - :special-members: __getitem__, __iter__, __len__, __next__ diff --git a/docs/api/python/src/pyopencolorio_colorspacetransform.rst b/docs/api/python/src/pyopencolorio_colorspacetransform.rst deleted file mode 100644 index 009d958287..0000000000 --- a/docs/api/python/src/pyopencolorio_colorspacetransform.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.ColorSpaceTransform - :members: - :undoc-members: - :special-members: __init__, __str__ - :inherited-members: diff --git a/docs/api/python/src/pyopencolorio_colorspacevisibility.rst b/docs/api/python/src/pyopencolorio_colorspacevisibility.rst deleted file mode 100644 index 97ed60fde0..0000000000 --- a/docs/api/python/src/pyopencolorio_colorspacevisibility.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.ColorSpaceVisibility - :members: - :undoc-members: - :exclude-members: name diff --git a/docs/api/python/src/pyopencolorio_combinetransformdirections.rst b/docs/api/python/src/pyopencolorio_combinetransformdirections.rst deleted file mode 100644 index 1e1e385d89..0000000000 --- a/docs/api/python/src/pyopencolorio_combinetransformdirections.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.CombineTransformDirections diff --git a/docs/api/python/src/pyopencolorio_config.rst b/docs/api/python/src/pyopencolorio_config.rst deleted file mode 100644 index f176f2c1a0..0000000000 --- a/docs/api/python/src/pyopencolorio_config.rst +++ /dev/null @@ -1,88 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.Config - :members: - :undoc-members: - :special-members: __init__, __str__ - :exclude-members: EnvironmentVarNameIterator, - SearchPathIterator, - ColorSpaceNameIterator, - ColorSpaceIterator, - ActiveColorSpaceNameIterator, - ActiveColorSpaceIterator, - RoleNameIterator, - RoleColorSpaceIterator, - DisplayIterator, - SharedViewIterator, - ViewIterator, - ViewForColorSpaceIterator, - LookNameIterator, - LookIterator, - ViewTransformNameIterator, - ViewTransformIterator, - NamedTransformNameIterator, - NamedTransformIterator, - ActiveNamedTransformNameIterator, - ActiveNamedTransformIterator - -.. autoclass:: PyOpenColorIO.Config.EnvironmentVarNameIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.Config.SearchPathIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.Config.ColorSpaceNameIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.Config.ColorSpaceIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.Config.ActiveColorSpaceNameIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.Config.ActiveColorSpaceIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.Config.RoleNameIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.Config.RoleColorSpaceIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.Config.DisplayIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.Config.SharedViewIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.Config.ViewIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.Config.ViewForColorSpaceIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.Config.LookNameIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.Config.LookIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.Config.ViewTransformNameIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.Config.ViewTransformIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.Config.NamedTransformNameIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.Config.NamedTransformIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.Config.ActiveNamedTransformNameIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.Config.ActiveNamedTransformIterator - :special-members: __getitem__, __iter__, __len__, __next__ diff --git a/docs/api/python/src/pyopencolorio_context.rst b/docs/api/python/src/pyopencolorio_context.rst deleted file mode 100644 index 8e7539dc04..0000000000 --- a/docs/api/python/src/pyopencolorio_context.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.Context - :members: - :undoc-members: - :special-members: __init__, __str__ - :exclude-members: StringVarNameIterator, - StringVarIterator, - SearchPathIterator - -.. autoclass:: PyOpenColorIO.Context.StringVarNameIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.Context.StringVarIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.Context.SearchPathIterator - :special-members: __getitem__, __iter__, __len__, __next__ diff --git a/docs/api/python/src/pyopencolorio_cpuprocessor.rst b/docs/api/python/src/pyopencolorio_cpuprocessor.rst deleted file mode 100644 index 3cc0ca0b7b..0000000000 --- a/docs/api/python/src/pyopencolorio_cpuprocessor.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.CPUProcessor - :members: - :undoc-members: - :special-members: __init__ diff --git a/docs/api/python/src/pyopencolorio_displayviewhelpers.rst b/docs/api/python/src/pyopencolorio_displayviewhelpers.rst deleted file mode 100644 index 878906074e..0000000000 --- a/docs/api/python/src/pyopencolorio_displayviewhelpers.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.DisplayViewHelpers.GetProcessor -.. autofunction:: PyOpenColorIO.DisplayViewHelpers.GetIdentityProcessor -.. autofunction:: PyOpenColorIO.DisplayViewHelpers.AddDisplayView -.. autofunction:: PyOpenColorIO.DisplayViewHelpers.RemoveDisplayView diff --git a/docs/api/python/src/pyopencolorio_displayviewtransform.rst b/docs/api/python/src/pyopencolorio_displayviewtransform.rst deleted file mode 100644 index cd3f766b5b..0000000000 --- a/docs/api/python/src/pyopencolorio_displayviewtransform.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.DisplayViewTransform - :members: - :undoc-members: - :special-members: __init__, __str__ - :inherited-members: diff --git a/docs/api/python/src/pyopencolorio_dynamicproperty.rst b/docs/api/python/src/pyopencolorio_dynamicproperty.rst deleted file mode 100644 index 5bde833d19..0000000000 --- a/docs/api/python/src/pyopencolorio_dynamicproperty.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.DynamicProperty - :members: - :undoc-members: - :special-members: __init__ diff --git a/docs/api/python/src/pyopencolorio_dynamicpropertytype.rst b/docs/api/python/src/pyopencolorio_dynamicpropertytype.rst deleted file mode 100644 index 2432762bb5..0000000000 --- a/docs/api/python/src/pyopencolorio_dynamicpropertytype.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.DynamicPropertyType - :members: - :undoc-members: - :exclude-members: name diff --git a/docs/api/python/src/pyopencolorio_environmentmode.rst b/docs/api/python/src/pyopencolorio_environmentmode.rst deleted file mode 100644 index b8334b2e7e..0000000000 --- a/docs/api/python/src/pyopencolorio_environmentmode.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.EnvironmentMode - :members: - :undoc-members: - :exclude-members: name diff --git a/docs/api/python/src/pyopencolorio_environmentmodefromstring.rst b/docs/api/python/src/pyopencolorio_environmentmodefromstring.rst deleted file mode 100644 index cfab189d62..0000000000 --- a/docs/api/python/src/pyopencolorio_environmentmodefromstring.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.EnvironmentModeFromString diff --git a/docs/api/python/src/pyopencolorio_environmentmodetostring.rst b/docs/api/python/src/pyopencolorio_environmentmodetostring.rst deleted file mode 100644 index 0b2f649b34..0000000000 --- a/docs/api/python/src/pyopencolorio_environmentmodetostring.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.EnvironmentModeToString diff --git a/docs/api/python/src/pyopencolorio_exception.rst b/docs/api/python/src/pyopencolorio_exception.rst deleted file mode 100644 index de517d4bee..0000000000 --- a/docs/api/python/src/pyopencolorio_exception.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoexception:: PyOpenColorIO.Exception diff --git a/docs/api/python/src/pyopencolorio_exceptionmissingfile.rst b/docs/api/python/src/pyopencolorio_exceptionmissingfile.rst deleted file mode 100644 index baf432110f..0000000000 --- a/docs/api/python/src/pyopencolorio_exceptionmissingfile.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoexception:: PyOpenColorIO.ExceptionMissingFile diff --git a/docs/api/python/src/pyopencolorio_exponenttransform.rst b/docs/api/python/src/pyopencolorio_exponenttransform.rst deleted file mode 100644 index aa9d3c8f39..0000000000 --- a/docs/api/python/src/pyopencolorio_exponenttransform.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.ExponentTransform - :members: - :undoc-members: - :special-members: __init__, __str__ - :inherited-members: diff --git a/docs/api/python/src/pyopencolorio_exponentwithlineartransform.rst b/docs/api/python/src/pyopencolorio_exponentwithlineartransform.rst deleted file mode 100644 index 0766d40480..0000000000 --- a/docs/api/python/src/pyopencolorio_exponentwithlineartransform.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.ExponentWithLinearTransform - :members: - :undoc-members: - :special-members: __init__, __str__ - :inherited-members: diff --git a/docs/api/python/src/pyopencolorio_exposurecontraststyle.rst b/docs/api/python/src/pyopencolorio_exposurecontraststyle.rst deleted file mode 100644 index f597d91e3a..0000000000 --- a/docs/api/python/src/pyopencolorio_exposurecontraststyle.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.ExposureContrastStyle - :members: - :undoc-members: - :exclude-members: name diff --git a/docs/api/python/src/pyopencolorio_exposurecontraststylefromstring.rst b/docs/api/python/src/pyopencolorio_exposurecontraststylefromstring.rst deleted file mode 100644 index 2a480ea1e7..0000000000 --- a/docs/api/python/src/pyopencolorio_exposurecontraststylefromstring.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.ExposureContrastStyleFromString diff --git a/docs/api/python/src/pyopencolorio_exposurecontraststyletostring.rst b/docs/api/python/src/pyopencolorio_exposurecontraststyletostring.rst deleted file mode 100644 index 137895a154..0000000000 --- a/docs/api/python/src/pyopencolorio_exposurecontraststyletostring.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.ExposureContrastStyleToString diff --git a/docs/api/python/src/pyopencolorio_exposurecontrasttransform.rst b/docs/api/python/src/pyopencolorio_exposurecontrasttransform.rst deleted file mode 100644 index 12378f9df3..0000000000 --- a/docs/api/python/src/pyopencolorio_exposurecontrasttransform.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.ExposureContrastTransform - :members: - :undoc-members: - :special-members: __init__, __str__ - :inherited-members: diff --git a/docs/api/python/src/pyopencolorio_filerules.rst b/docs/api/python/src/pyopencolorio_filerules.rst deleted file mode 100644 index 1c5bccf93e..0000000000 --- a/docs/api/python/src/pyopencolorio_filerules.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.FileRules - :members: - :undoc-members: - :special-members: __init__ diff --git a/docs/api/python/src/pyopencolorio_filetransform.rst b/docs/api/python/src/pyopencolorio_filetransform.rst deleted file mode 100644 index 54192a82ff..0000000000 --- a/docs/api/python/src/pyopencolorio_filetransform.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.FileTransform - :members: - :undoc-members: - :special-members: __init__, __str__ - :inherited-members: - :exclude-members: FormatIterator - -.. autoclass:: PyOpenColorIO.FileTransform.FormatIterator - :special-members: __getitem__, __iter__, __len__, __next__ diff --git a/docs/api/python/src/pyopencolorio_fixedfunctionstyle.rst b/docs/api/python/src/pyopencolorio_fixedfunctionstyle.rst deleted file mode 100644 index ca371c665d..0000000000 --- a/docs/api/python/src/pyopencolorio_fixedfunctionstyle.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.FixedFunctionStyle - :members: - :undoc-members: - :exclude-members: name diff --git a/docs/api/python/src/pyopencolorio_fixedfunctionstylefromstring.rst b/docs/api/python/src/pyopencolorio_fixedfunctionstylefromstring.rst deleted file mode 100644 index ae79415a76..0000000000 --- a/docs/api/python/src/pyopencolorio_fixedfunctionstylefromstring.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.FixedFunctionStyleFromString diff --git a/docs/api/python/src/pyopencolorio_fixedfunctionstyletostring.rst b/docs/api/python/src/pyopencolorio_fixedfunctionstyletostring.rst deleted file mode 100644 index 93ccdb4357..0000000000 --- a/docs/api/python/src/pyopencolorio_fixedfunctionstyletostring.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.FixedFunctionStyleToString diff --git a/docs/api/python/src/pyopencolorio_fixedfunctiontransform.rst b/docs/api/python/src/pyopencolorio_fixedfunctiontransform.rst deleted file mode 100644 index f2968b4ff4..0000000000 --- a/docs/api/python/src/pyopencolorio_fixedfunctiontransform.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.FixedFunctionTransform - :members: - :undoc-members: - :special-members: __init__, __str__ - :inherited-members: diff --git a/docs/api/python/src/pyopencolorio_formatmetadata.rst b/docs/api/python/src/pyopencolorio_formatmetadata.rst deleted file mode 100644 index 12fbb71590..0000000000 --- a/docs/api/python/src/pyopencolorio_formatmetadata.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.FormatMetadata - :members: - :undoc-members: - :special-members: __init__, - __iter__, - __len__, - __getitem__, - __setitem__, - __contains__ - :exclude-members: AttributeNameIterator, - AttributeIterator, - ConstChildElementIterator, - ChildElementIterator - -.. autoclass:: PyOpenColorIO.FormatMetadata.AttributeNameIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.FormatMetadata.AttributeIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.FormatMetadata.ConstChildElementIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.FormatMetadata.ChildElementIterator - :special-members: __getitem__, __iter__, __len__, __next__ diff --git a/docs/api/python/src/pyopencolorio_getenvvariable.rst b/docs/api/python/src/pyopencolorio_getenvvariable.rst deleted file mode 100644 index b65b71a356..0000000000 --- a/docs/api/python/src/pyopencolorio_getenvvariable.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.GetEnvVariable diff --git a/docs/api/python/src/pyopencolorio_getinversetransformdirection.rst b/docs/api/python/src/pyopencolorio_getinversetransformdirection.rst deleted file mode 100644 index cfdddc36f4..0000000000 --- a/docs/api/python/src/pyopencolorio_getinversetransformdirection.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.GetInverseTransformDirection diff --git a/docs/api/python/src/pyopencolorio_getlogginglevel.rst b/docs/api/python/src/pyopencolorio_getlogginglevel.rst deleted file mode 100644 index b84ed64e21..0000000000 --- a/docs/api/python/src/pyopencolorio_getlogginglevel.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.GetLoggingLevel diff --git a/docs/api/python/src/pyopencolorio_getversion.rst b/docs/api/python/src/pyopencolorio_getversion.rst deleted file mode 100644 index ffd9d126db..0000000000 --- a/docs/api/python/src/pyopencolorio_getversion.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.GetVersion diff --git a/docs/api/python/src/pyopencolorio_getversionhex.rst b/docs/api/python/src/pyopencolorio_getversionhex.rst deleted file mode 100644 index 6dba0ac03a..0000000000 --- a/docs/api/python/src/pyopencolorio_getversionhex.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.GetVersionHex diff --git a/docs/api/python/src/pyopencolorio_gpulanguage.rst b/docs/api/python/src/pyopencolorio_gpulanguage.rst deleted file mode 100644 index 1c24e811f3..0000000000 --- a/docs/api/python/src/pyopencolorio_gpulanguage.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.GpuLanguage - :members: - :undoc-members: - :exclude-members: name diff --git a/docs/api/python/src/pyopencolorio_gpulanguagefromstring.rst b/docs/api/python/src/pyopencolorio_gpulanguagefromstring.rst deleted file mode 100644 index 10dac89964..0000000000 --- a/docs/api/python/src/pyopencolorio_gpulanguagefromstring.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.GpuLanguageFromString diff --git a/docs/api/python/src/pyopencolorio_gpulanguagetostring.rst b/docs/api/python/src/pyopencolorio_gpulanguagetostring.rst deleted file mode 100644 index f920963155..0000000000 --- a/docs/api/python/src/pyopencolorio_gpulanguagetostring.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.GpuLanguageToString diff --git a/docs/api/python/src/pyopencolorio_gpuprocessor.rst b/docs/api/python/src/pyopencolorio_gpuprocessor.rst deleted file mode 100644 index d47f05e0d0..0000000000 --- a/docs/api/python/src/pyopencolorio_gpuprocessor.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.GPUProcessor - :members: - :undoc-members: - :special-members: __init__ diff --git a/docs/api/python/src/pyopencolorio_gpushadercreator.rst b/docs/api/python/src/pyopencolorio_gpushadercreator.rst deleted file mode 100644 index 03d42a5b28..0000000000 --- a/docs/api/python/src/pyopencolorio_gpushadercreator.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.GpuShaderCreator - :members: - :undoc-members: - :exclude-members: TextureType, - TEXTURE_RED_CHANNEL, - TEXTURE_RGB_CHANNEL, - DynamicPropertyIterator - -.. autoclass:: PyOpenColorIO.GpuShaderCreator.TextureType - :members: - :undoc-members: - :exclude-members: name - -.. autoclass:: PyOpenColorIO.GpuShaderCreator.DynamicPropertyIterator - :special-members: __getitem__, __iter__, __len__, __next__ diff --git a/docs/api/python/src/pyopencolorio_gpushaderdesc.rst b/docs/api/python/src/pyopencolorio_gpushaderdesc.rst deleted file mode 100644 index 29c760e8ee..0000000000 --- a/docs/api/python/src/pyopencolorio_gpushaderdesc.rst +++ /dev/null @@ -1,48 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.GpuShaderDesc - :members: - :undoc-members: - :special-members: __init__ - :exclude-members: TextureType, - TEXTURE_RED_CHANNEL, - TEXTURE_RGB_CHANNEL, - UniformData, - Texture, - Texture3D, - UniformIterator, - TextureIterator, - Texture3DIterator, - DynamicPropertyIterator - :inherited-members: - -.. autoclass:: PyOpenColorIO.GpuShaderDesc.TextureType - :members: - :undoc-members: - :exclude-members: name - -.. autoclass:: PyOpenColorIO.GpuShaderDesc.UniformData - :members: - :undoc-members: - -.. autoclass:: PyOpenColorIO.GpuShaderDesc.Texture - :members: - :undoc-members: - -.. autoclass:: PyOpenColorIO.GpuShaderDesc.Texture3D - :members: - :undoc-members: - -.. autoclass:: PyOpenColorIO.GpuShaderDesc.UniformIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.GpuShaderDesc.TextureIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.GpuShaderDesc.Texture3DIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.GpuShaderDesc.DynamicPropertyIterator - :special-members: __getitem__, __iter__, __len__, __next__ diff --git a/docs/api/python/src/pyopencolorio_gradingbsplinecurve.rst b/docs/api/python/src/pyopencolorio_gradingbsplinecurve.rst deleted file mode 100644 index 61764457ce..0000000000 --- a/docs/api/python/src/pyopencolorio_gradingbsplinecurve.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.GradingBSplineCurve - :members: - :undoc-members: - :special-members: __init__, __str__ - :exclude-members: GradingControlPointIterator - -.. autoclass:: PyOpenColorIO.GradingBSplineCurve.GradingControlPointIterator - :special-members: __getitem__, __setitem__, __iter__, __len__, __next__ diff --git a/docs/api/python/src/pyopencolorio_gradingcontrolpoint.rst b/docs/api/python/src/pyopencolorio_gradingcontrolpoint.rst deleted file mode 100644 index a8014170e5..0000000000 --- a/docs/api/python/src/pyopencolorio_gradingcontrolpoint.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.GradingControlPoint - :members: - :undoc-members: - :special-members: __init__, __str__ diff --git a/docs/api/python/src/pyopencolorio_gradingprimary.rst b/docs/api/python/src/pyopencolorio_gradingprimary.rst deleted file mode 100644 index 51df3fbe0e..0000000000 --- a/docs/api/python/src/pyopencolorio_gradingprimary.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.GradingPrimary - :members: - :undoc-members: - :special-members: __init__, __str__ diff --git a/docs/api/python/src/pyopencolorio_gradingprimarytransform.rst b/docs/api/python/src/pyopencolorio_gradingprimarytransform.rst deleted file mode 100644 index 14f222eebc..0000000000 --- a/docs/api/python/src/pyopencolorio_gradingprimarytransform.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.GradingPrimaryTransform - :members: - :undoc-members: - :special-members: __init__, __str__ - :inherited-members: diff --git a/docs/api/python/src/pyopencolorio_gradingrgbcurve.rst b/docs/api/python/src/pyopencolorio_gradingrgbcurve.rst deleted file mode 100644 index af9c9d3fe8..0000000000 --- a/docs/api/python/src/pyopencolorio_gradingrgbcurve.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.GradingRGBCurve - :members: - :undoc-members: - :special-members: __init__, __str__ diff --git a/docs/api/python/src/pyopencolorio_gradingrgbcurvetransform.rst b/docs/api/python/src/pyopencolorio_gradingrgbcurvetransform.rst deleted file mode 100644 index 79e8d34202..0000000000 --- a/docs/api/python/src/pyopencolorio_gradingrgbcurvetransform.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.GradingRGBCurveTransform - :members: - :undoc-members: - :special-members: __init__, __str__ - :inherited-members: diff --git a/docs/api/python/src/pyopencolorio_gradingrgbm.rst b/docs/api/python/src/pyopencolorio_gradingrgbm.rst deleted file mode 100644 index d658f46683..0000000000 --- a/docs/api/python/src/pyopencolorio_gradingrgbm.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.GradingRGBM - :members: - :undoc-members: - :special-members: __init__, __str__ diff --git a/docs/api/python/src/pyopencolorio_gradingrgbmsw.rst b/docs/api/python/src/pyopencolorio_gradingrgbmsw.rst deleted file mode 100644 index 4f3b796ed5..0000000000 --- a/docs/api/python/src/pyopencolorio_gradingrgbmsw.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.GradingRGBMSW - :members: - :undoc-members: - :special-members: __init__, __str__ diff --git a/docs/api/python/src/pyopencolorio_gradingstyle.rst b/docs/api/python/src/pyopencolorio_gradingstyle.rst deleted file mode 100644 index 08cd5cc50d..0000000000 --- a/docs/api/python/src/pyopencolorio_gradingstyle.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.GradingStyle - :members: - :undoc-members: - :exclude-members: name diff --git a/docs/api/python/src/pyopencolorio_gradingstylefromstring.rst b/docs/api/python/src/pyopencolorio_gradingstylefromstring.rst deleted file mode 100644 index 52e861e567..0000000000 --- a/docs/api/python/src/pyopencolorio_gradingstylefromstring.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.GradingStyleFromString diff --git a/docs/api/python/src/pyopencolorio_gradingstyletostring.rst b/docs/api/python/src/pyopencolorio_gradingstyletostring.rst deleted file mode 100644 index 906239e795..0000000000 --- a/docs/api/python/src/pyopencolorio_gradingstyletostring.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.GradingStyleToString diff --git a/docs/api/python/src/pyopencolorio_gradingtone.rst b/docs/api/python/src/pyopencolorio_gradingtone.rst deleted file mode 100644 index c28d0406a8..0000000000 --- a/docs/api/python/src/pyopencolorio_gradingtone.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.GradingTone - :members: - :undoc-members: - :special-members: __init__, __str__ diff --git a/docs/api/python/src/pyopencolorio_gradingtonetransform.rst b/docs/api/python/src/pyopencolorio_gradingtonetransform.rst deleted file mode 100644 index 5d6726ad69..0000000000 --- a/docs/api/python/src/pyopencolorio_gradingtonetransform.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.GradingToneTransform - :members: - :undoc-members: - :special-members: __init__, __str__ - :inherited-members: diff --git a/docs/api/python/src/pyopencolorio_grouptransform.rst b/docs/api/python/src/pyopencolorio_grouptransform.rst deleted file mode 100644 index f53a474086..0000000000 --- a/docs/api/python/src/pyopencolorio_grouptransform.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.GroupTransform - :members: - :undoc-members: - :special-members: __init__, __str__ - :inherited-members: - :exclude-members: TransformIterator, WriteFormatIterator - -.. autoclass:: PyOpenColorIO.GroupTransform.WriteFormatIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.GroupTransform.TransformIterator - :special-members: __getitem__, __iter__, __len__, __next__ diff --git a/docs/api/python/src/pyopencolorio_imagedesc.rst b/docs/api/python/src/pyopencolorio_imagedesc.rst deleted file mode 100644 index 8ba40a0b9d..0000000000 --- a/docs/api/python/src/pyopencolorio_imagedesc.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.ImageDesc - :members: - :undoc-members: - :special-members: __init__ diff --git a/docs/api/python/src/pyopencolorio_interpolation.rst b/docs/api/python/src/pyopencolorio_interpolation.rst deleted file mode 100644 index 2a68d36078..0000000000 --- a/docs/api/python/src/pyopencolorio_interpolation.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.Interpolation - :members: - :undoc-members: - :exclude-members: name diff --git a/docs/api/python/src/pyopencolorio_interpolationfromstring.rst b/docs/api/python/src/pyopencolorio_interpolationfromstring.rst deleted file mode 100644 index 74d740d0f2..0000000000 --- a/docs/api/python/src/pyopencolorio_interpolationfromstring.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.InterpolationFromString diff --git a/docs/api/python/src/pyopencolorio_interpolationtostring.rst b/docs/api/python/src/pyopencolorio_interpolationtostring.rst deleted file mode 100644 index 1165a974cd..0000000000 --- a/docs/api/python/src/pyopencolorio_interpolationtostring.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.InterpolationToString diff --git a/docs/api/python/src/pyopencolorio_isenvvariablepresent.rst b/docs/api/python/src/pyopencolorio_isenvvariablepresent.rst deleted file mode 100644 index 0a908908a8..0000000000 --- a/docs/api/python/src/pyopencolorio_isenvvariablepresent.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.IsEnvVariablePresent diff --git a/docs/api/python/src/pyopencolorio_legacyviewingpipeline.rst b/docs/api/python/src/pyopencolorio_legacyviewingpipeline.rst deleted file mode 100644 index 49d2b80c43..0000000000 --- a/docs/api/python/src/pyopencolorio_legacyviewingpipeline.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.LegacyViewingPipeline - :members: - :undoc-members: - :special-members: __init__, __str__ diff --git a/docs/api/python/src/pyopencolorio_logaffinetransform.rst b/docs/api/python/src/pyopencolorio_logaffinetransform.rst deleted file mode 100644 index cf3c344fae..0000000000 --- a/docs/api/python/src/pyopencolorio_logaffinetransform.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.LogAffineTransform - :members: - :undoc-members: - :special-members: __init__, __str__ - :inherited-members: diff --git a/docs/api/python/src/pyopencolorio_logcameratransform.rst b/docs/api/python/src/pyopencolorio_logcameratransform.rst deleted file mode 100644 index 286c9b0fb9..0000000000 --- a/docs/api/python/src/pyopencolorio_logcameratransform.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.LogCameraTransform - :members: - :undoc-members: - :special-members: __init__, __str__ - :inherited-members: diff --git a/docs/api/python/src/pyopencolorio_logginglevel.rst b/docs/api/python/src/pyopencolorio_logginglevel.rst deleted file mode 100644 index 6e8e790956..0000000000 --- a/docs/api/python/src/pyopencolorio_logginglevel.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.LoggingLevel - :members: - :undoc-members: - :exclude-members: name diff --git a/docs/api/python/src/pyopencolorio_logginglevelfromstring.rst b/docs/api/python/src/pyopencolorio_logginglevelfromstring.rst deleted file mode 100644 index d2d5c5d031..0000000000 --- a/docs/api/python/src/pyopencolorio_logginglevelfromstring.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.LoggingLevelFromString diff --git a/docs/api/python/src/pyopencolorio_loggingleveltostring.rst b/docs/api/python/src/pyopencolorio_loggingleveltostring.rst deleted file mode 100644 index 13ecf0f6f9..0000000000 --- a/docs/api/python/src/pyopencolorio_loggingleveltostring.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.LoggingLevelToString diff --git a/docs/api/python/src/pyopencolorio_logmessage.rst b/docs/api/python/src/pyopencolorio_logmessage.rst deleted file mode 100644 index de5a6f4386..0000000000 --- a/docs/api/python/src/pyopencolorio_logmessage.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.LogMessage diff --git a/docs/api/python/src/pyopencolorio_logtransform.rst b/docs/api/python/src/pyopencolorio_logtransform.rst deleted file mode 100644 index 9940358678..0000000000 --- a/docs/api/python/src/pyopencolorio_logtransform.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.LogTransform - :members: - :undoc-members: - :special-members: __init__, __str__ - :inherited-members: diff --git a/docs/api/python/src/pyopencolorio_look.rst b/docs/api/python/src/pyopencolorio_look.rst deleted file mode 100644 index 604bf2e2fd..0000000000 --- a/docs/api/python/src/pyopencolorio_look.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.Look - :members: - :undoc-members: - :special-members: __init__, __str__ diff --git a/docs/api/python/src/pyopencolorio_looktransform.rst b/docs/api/python/src/pyopencolorio_looktransform.rst deleted file mode 100644 index ca68d01c3c..0000000000 --- a/docs/api/python/src/pyopencolorio_looktransform.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.LookTransform - :members: - :undoc-members: - :special-members: __init__, __str__ - :inherited-members: diff --git a/docs/api/python/src/pyopencolorio_lut1dhueadjust.rst b/docs/api/python/src/pyopencolorio_lut1dhueadjust.rst deleted file mode 100644 index 9929751a09..0000000000 --- a/docs/api/python/src/pyopencolorio_lut1dhueadjust.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.Lut1DHueAdjust - :members: - :undoc-members: - :exclude-members: name diff --git a/docs/api/python/src/pyopencolorio_lut1dtransform.rst b/docs/api/python/src/pyopencolorio_lut1dtransform.rst deleted file mode 100644 index 9810b84aa9..0000000000 --- a/docs/api/python/src/pyopencolorio_lut1dtransform.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.Lut1DTransform - :members: - :undoc-members: - :special-members: __init__, __str__ - :inherited-members: diff --git a/docs/api/python/src/pyopencolorio_lut3dtransform.rst b/docs/api/python/src/pyopencolorio_lut3dtransform.rst deleted file mode 100644 index 4829c75a4f..0000000000 --- a/docs/api/python/src/pyopencolorio_lut3dtransform.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.Lut3DTransform - :members: - :undoc-members: - :special-members: __init__, __str__ - :inherited-members: diff --git a/docs/api/python/src/pyopencolorio_matrixtransform.rst b/docs/api/python/src/pyopencolorio_matrixtransform.rst deleted file mode 100644 index 39c0b78ad1..0000000000 --- a/docs/api/python/src/pyopencolorio_matrixtransform.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.MatrixTransform - :members: - :undoc-members: - :special-members: __init__, __str__ - :inherited-members: diff --git a/docs/api/python/src/pyopencolorio_mixinghelpers.rst b/docs/api/python/src/pyopencolorio_mixinghelpers.rst deleted file mode 100644 index 9d51f4cf7c..0000000000 --- a/docs/api/python/src/pyopencolorio_mixinghelpers.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.MixingSlider - :members: - :undoc-members: - :special-members: __init__, __str__ - -.. autoclass:: PyOpenColorIO.MixingColorSpaceManager - :members: - :undoc-members: - :special-members: __init__, __str__ - :exclude-members: MixingSpaceIterator, MixingEncodingIterator - -.. autoclass:: PyOpenColorIO.MixingColorSpaceManager.MixingSpaceIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.MixingColorSpaceManager.MixingEncodingIterator - :special-members: __getitem__, __iter__, __len__, __next__ diff --git a/docs/api/python/src/pyopencolorio_namedtransform.rst b/docs/api/python/src/pyopencolorio_namedtransform.rst deleted file mode 100644 index b7eaaf1ddd..0000000000 --- a/docs/api/python/src/pyopencolorio_namedtransform.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.NamedTransform - :members: - :undoc-members: - :special-members: __init__, __str__ - :exclude-members: NamedTransformCategoryIterator - -.. autoclass:: PyOpenColorIO.NamedTransform.NamedTransformCategoryIterator - :special-members: __getitem__, __iter__, __len__, __next__ diff --git a/docs/api/python/src/pyopencolorio_namedtransformvisibility.rst b/docs/api/python/src/pyopencolorio_namedtransformvisibility.rst deleted file mode 100644 index 6306f37cfa..0000000000 --- a/docs/api/python/src/pyopencolorio_namedtransformvisibility.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.NamedTransformVisibility - :members: - :undoc-members: - :exclude-members: name diff --git a/docs/api/python/src/pyopencolorio_negativestyle.rst b/docs/api/python/src/pyopencolorio_negativestyle.rst deleted file mode 100644 index 535a6e6dec..0000000000 --- a/docs/api/python/src/pyopencolorio_negativestyle.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.NegativeStyle - :members: - :undoc-members: - :exclude-members: name diff --git a/docs/api/python/src/pyopencolorio_negativestylefromstring.rst b/docs/api/python/src/pyopencolorio_negativestylefromstring.rst deleted file mode 100644 index 774077d9a3..0000000000 --- a/docs/api/python/src/pyopencolorio_negativestylefromstring.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.NegativeStyleFromString diff --git a/docs/api/python/src/pyopencolorio_negativestyletostring.rst b/docs/api/python/src/pyopencolorio_negativestyletostring.rst deleted file mode 100644 index 068106f0cc..0000000000 --- a/docs/api/python/src/pyopencolorio_negativestyletostring.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.NegativeStyleToString diff --git a/docs/api/python/src/pyopencolorio_optimizationflags.rst b/docs/api/python/src/pyopencolorio_optimizationflags.rst deleted file mode 100644 index 60298f52b9..0000000000 --- a/docs/api/python/src/pyopencolorio_optimizationflags.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.OptimizationFlags - :members: - :undoc-members: - :exclude-members: name diff --git a/docs/api/python/src/pyopencolorio_packedimagedesc.rst b/docs/api/python/src/pyopencolorio_packedimagedesc.rst deleted file mode 100644 index a051cf9b09..0000000000 --- a/docs/api/python/src/pyopencolorio_packedimagedesc.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.PackedImageDesc - :members: - :undoc-members: - :special-members: __init__ - :inherited-members: diff --git a/docs/api/python/src/pyopencolorio_planarimagedesc.rst b/docs/api/python/src/pyopencolorio_planarimagedesc.rst deleted file mode 100644 index d1f699ca2a..0000000000 --- a/docs/api/python/src/pyopencolorio_planarimagedesc.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.PlanarImageDesc - :members: - :undoc-members: - :special-members: __init__ - :inherited-members: diff --git a/docs/api/python/src/pyopencolorio_processor.rst b/docs/api/python/src/pyopencolorio_processor.rst deleted file mode 100644 index 23ebf26a22..0000000000 --- a/docs/api/python/src/pyopencolorio_processor.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.Processor - :members: - :undoc-members: - :special-members: __init__ - :exclude-members: TransformFormatMetadataIterator, WriteFormatIterator - -.. autoclass:: PyOpenColorIO.Processor.TransformFormatMetadataIterator - :special-members: __getitem__, __iter__, __len__, __next__ diff --git a/docs/api/python/src/pyopencolorio_processorcacheflags.rst b/docs/api/python/src/pyopencolorio_processorcacheflags.rst deleted file mode 100644 index 4d86c5871e..0000000000 --- a/docs/api/python/src/pyopencolorio_processorcacheflags.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.ProcessorCacheFlags - :members: - :undoc-members: - :exclude-members: name diff --git a/docs/api/python/src/pyopencolorio_processormetadata.rst b/docs/api/python/src/pyopencolorio_processormetadata.rst deleted file mode 100644 index e7e566daab..0000000000 --- a/docs/api/python/src/pyopencolorio_processormetadata.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.ProcessorMetadata - :members: - :undoc-members: - :special-members: __init__ - :exclude-members: FileIterator, LookIterator - -.. autoclass:: PyOpenColorIO.ProcessorMetadata.FileIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.ProcessorMetadata.LookIterator - :special-members: __getitem__, __iter__, __len__, __next__ diff --git a/docs/api/python/src/pyopencolorio_rangestyle.rst b/docs/api/python/src/pyopencolorio_rangestyle.rst deleted file mode 100644 index f45bfd2cee..0000000000 --- a/docs/api/python/src/pyopencolorio_rangestyle.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.RangeStyle - :members: - :undoc-members: - :exclude-members: name diff --git a/docs/api/python/src/pyopencolorio_rangestylefromstring.rst b/docs/api/python/src/pyopencolorio_rangestylefromstring.rst deleted file mode 100644 index 18b5aa1124..0000000000 --- a/docs/api/python/src/pyopencolorio_rangestylefromstring.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.RangeStyleFromString diff --git a/docs/api/python/src/pyopencolorio_rangestyletostring.rst b/docs/api/python/src/pyopencolorio_rangestyletostring.rst deleted file mode 100644 index 5934cb14ef..0000000000 --- a/docs/api/python/src/pyopencolorio_rangestyletostring.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.RangeStyleToString diff --git a/docs/api/python/src/pyopencolorio_rangetransform.rst b/docs/api/python/src/pyopencolorio_rangetransform.rst deleted file mode 100644 index 04bd42141a..0000000000 --- a/docs/api/python/src/pyopencolorio_rangetransform.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.RangeTransform - :members: - :undoc-members: - :special-members: __init__, __str__ - :inherited-members: diff --git a/docs/api/python/src/pyopencolorio_referencespacetype.rst b/docs/api/python/src/pyopencolorio_referencespacetype.rst deleted file mode 100644 index f03e49c46c..0000000000 --- a/docs/api/python/src/pyopencolorio_referencespacetype.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.ReferenceSpaceType - :members: - :undoc-members: - :exclude-members: name diff --git a/docs/api/python/src/pyopencolorio_resetcomputehashfunction.rst b/docs/api/python/src/pyopencolorio_resetcomputehashfunction.rst deleted file mode 100644 index a402c90730..0000000000 --- a/docs/api/python/src/pyopencolorio_resetcomputehashfunction.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.ResetComputeHashFunction diff --git a/docs/api/python/src/pyopencolorio_resettodefaultloggingfunction.rst b/docs/api/python/src/pyopencolorio_resettodefaultloggingfunction.rst deleted file mode 100644 index 375c237f09..0000000000 --- a/docs/api/python/src/pyopencolorio_resettodefaultloggingfunction.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.ResetToDefaultLoggingFunction diff --git a/docs/api/python/src/pyopencolorio_rgbcurvetype.rst b/docs/api/python/src/pyopencolorio_rgbcurvetype.rst deleted file mode 100644 index d1c6e3ddbe..0000000000 --- a/docs/api/python/src/pyopencolorio_rgbcurvetype.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.RGBCurveType - :members: - :undoc-members: - :exclude-members: name diff --git a/docs/api/python/src/pyopencolorio_searchreferencespacetype.rst b/docs/api/python/src/pyopencolorio_searchreferencespacetype.rst deleted file mode 100644 index 9f394d33fe..0000000000 --- a/docs/api/python/src/pyopencolorio_searchreferencespacetype.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.SearchReferenceSpaceType - :members: - :undoc-members: - :exclude-members: name diff --git a/docs/api/python/src/pyopencolorio_setcomputehashfunction.rst b/docs/api/python/src/pyopencolorio_setcomputehashfunction.rst deleted file mode 100644 index 0420723654..0000000000 --- a/docs/api/python/src/pyopencolorio_setcomputehashfunction.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.SetComputeHashFunction diff --git a/docs/api/python/src/pyopencolorio_setenvvariable.rst b/docs/api/python/src/pyopencolorio_setenvvariable.rst deleted file mode 100644 index ae882e60d4..0000000000 --- a/docs/api/python/src/pyopencolorio_setenvvariable.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.SetEnvVariable diff --git a/docs/api/python/src/pyopencolorio_setloggingfunction.rst b/docs/api/python/src/pyopencolorio_setloggingfunction.rst deleted file mode 100644 index 3574b75475..0000000000 --- a/docs/api/python/src/pyopencolorio_setloggingfunction.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.SetLoggingFunction diff --git a/docs/api/python/src/pyopencolorio_setlogginglevel.rst b/docs/api/python/src/pyopencolorio_setlogginglevel.rst deleted file mode 100644 index 2f37fa0121..0000000000 --- a/docs/api/python/src/pyopencolorio_setlogginglevel.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.SetLoggingLevel diff --git a/docs/api/python/src/pyopencolorio_systemmonitors.rst b/docs/api/python/src/pyopencolorio_systemmonitors.rst deleted file mode 100644 index 5656aef69f..0000000000 --- a/docs/api/python/src/pyopencolorio_systemmonitors.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.SystemMonitors - :members: - :undoc-members: - :special-members: __init__ - :exclude-members: MonitorIterator - -.. autoclass:: PyOpenColorIO.SystemMonitors.MonitorIterator - :special-members: __getitem__, __iter__, __len__, __next__ diff --git a/docs/api/python/src/pyopencolorio_transform.rst b/docs/api/python/src/pyopencolorio_transform.rst deleted file mode 100644 index 7c0713539f..0000000000 --- a/docs/api/python/src/pyopencolorio_transform.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.Transform - :members: - :undoc-members: - :special-members: __init__, __str__ diff --git a/docs/api/python/src/pyopencolorio_transformdirection.rst b/docs/api/python/src/pyopencolorio_transformdirection.rst deleted file mode 100644 index 1a7af2b7b4..0000000000 --- a/docs/api/python/src/pyopencolorio_transformdirection.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.TransformDirection - :members: - :undoc-members: - :exclude-members: name diff --git a/docs/api/python/src/pyopencolorio_transformdirectionfromstring.rst b/docs/api/python/src/pyopencolorio_transformdirectionfromstring.rst deleted file mode 100644 index 13b1a18884..0000000000 --- a/docs/api/python/src/pyopencolorio_transformdirectionfromstring.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.TransformDirectionFromString diff --git a/docs/api/python/src/pyopencolorio_transformdirectiontostring.rst b/docs/api/python/src/pyopencolorio_transformdirectiontostring.rst deleted file mode 100644 index 575f87dfde..0000000000 --- a/docs/api/python/src/pyopencolorio_transformdirectiontostring.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.TransformDirectionToString diff --git a/docs/api/python/src/pyopencolorio_transformtype.rst b/docs/api/python/src/pyopencolorio_transformtype.rst deleted file mode 100644 index febb3d59aa..0000000000 --- a/docs/api/python/src/pyopencolorio_transformtype.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.TransformType - :members: - :undoc-members: - :exclude-members: name diff --git a/docs/api/python/src/pyopencolorio_uniformdatatype.rst b/docs/api/python/src/pyopencolorio_uniformdatatype.rst deleted file mode 100644 index a86a0a1603..0000000000 --- a/docs/api/python/src/pyopencolorio_uniformdatatype.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.UniformDataType - :members: - :undoc-members: - :exclude-members: name diff --git a/docs/api/python/src/pyopencolorio_unsetenvvariable.rst b/docs/api/python/src/pyopencolorio_unsetenvvariable.rst deleted file mode 100644 index bd8b61bba1..0000000000 --- a/docs/api/python/src/pyopencolorio_unsetenvvariable.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autofunction:: PyOpenColorIO.UnsetEnvVariable diff --git a/docs/api/python/src/pyopencolorio_viewingrules.rst b/docs/api/python/src/pyopencolorio_viewingrules.rst deleted file mode 100644 index e34bc23ced..0000000000 --- a/docs/api/python/src/pyopencolorio_viewingrules.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.ViewingRules - :members: - :undoc-members: - :special-members: __init__ - :exclude-members: ViewingRuleColorSpaceIterator, ViewingRuleEncodingIterator - -.. autoclass:: PyOpenColorIO.ViewingRules.ViewingRuleColorSpaceIterator - :special-members: __getitem__, __iter__, __len__, __next__ - -.. autoclass:: PyOpenColorIO.ViewingRules.ViewingRuleEncodingIterator - :special-members: __getitem__, __iter__, __len__, __next__ diff --git a/docs/api/python/src/pyopencolorio_viewtransform.rst b/docs/api/python/src/pyopencolorio_viewtransform.rst deleted file mode 100644 index 7bfc1190f8..0000000000 --- a/docs/api/python/src/pyopencolorio_viewtransform.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.ViewTransform - :members: - :undoc-members: - :special-members: __init__, __str__ - :exclude-members: ViewTransformCategoryIterator - -.. autoclass:: PyOpenColorIO.ViewTransform.ViewTransformCategoryIterator - :special-members: __getitem__, __iter__, __len__, __next__ diff --git a/docs/api/python/src/pyopencolorio_viewtransformdirection.rst b/docs/api/python/src/pyopencolorio_viewtransformdirection.rst deleted file mode 100644 index ab50155bc3..0000000000 --- a/docs/api/python/src/pyopencolorio_viewtransformdirection.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.ViewTransformDirection - :members: - :undoc-members: - :exclude-members: name diff --git a/docs/api/python/src/pyopencolorio_viewtype.rst b/docs/api/python/src/pyopencolorio_viewtype.rst deleted file mode 100644 index 00d2862123..0000000000 --- a/docs/api/python/src/pyopencolorio_viewtype.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - SPDX-License-Identifier: CC-BY-4.0 - Copyright Contributors to the OpenColorIO Project. - -.. autoclass:: PyOpenColorIO.ViewType - :members: - :undoc-members: - :exclude-members: name diff --git a/docs/api/rules.rst b/docs/api/rules.rst index 8e9b7b8439..2689a8e72e 100644 --- a/docs/api/rules.rst +++ b/docs/api/rules.rst @@ -12,7 +12,10 @@ FileRules .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_filerules.rst + .. autoclass:: PyOpenColorIO.FileRules + :members: + :undoc-members: + :special-members: __init__ .. group-tab:: C++ @@ -32,7 +35,17 @@ ViewingRules .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_viewingrules.rst + .. autoclass:: PyOpenColorIO.ViewingRules + :members: + :undoc-members: + :special-members: __init__ + :exclude-members: ViewingRuleColorSpaceIterator, ViewingRuleEncodingIterator + + .. autoclass:: PyOpenColorIO.ViewingRules.ViewingRuleColorSpaceIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.ViewingRules.ViewingRuleEncodingIterator + :special-members: __getitem__, __iter__, __len__, __next__ .. group-tab:: C++ diff --git a/docs/api/shaders.rst b/docs/api/shaders.rst index 5f3f665ba4..7718fd3a28 100644 --- a/docs/api/shaders.rst +++ b/docs/api/shaders.rst @@ -12,7 +12,21 @@ GpuShaderCreator .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_gpushadercreator.rst + .. autoclass:: PyOpenColorIO.GpuShaderCreator + :members: + :undoc-members: + :exclude-members: TextureType, + TEXTURE_RED_CHANNEL, + TEXTURE_RGB_CHANNEL, + DynamicPropertyIterator + + .. autoclass:: PyOpenColorIO.GpuShaderCreator.TextureType + :members: + :undoc-members: + :exclude-members: name + + .. autoclass:: PyOpenColorIO.GpuShaderCreator.DynamicPropertyIterator + :special-members: __getitem__, __iter__, __len__, __next__ .. group-tab:: C++ @@ -30,7 +44,50 @@ GpuShaderDesc .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_gpushaderdesc.rst + .. autoclass:: PyOpenColorIO.GpuShaderDesc + :members: + :undoc-members: + :special-members: __init__ + :exclude-members: TextureType, + TEXTURE_RED_CHANNEL, + TEXTURE_RGB_CHANNEL, + UniformData, + Texture, + Texture3D, + UniformIterator, + TextureIterator, + Texture3DIterator, + DynamicPropertyIterator + :inherited-members: + + .. autoclass:: PyOpenColorIO.GpuShaderDesc.TextureType + :members: + :undoc-members: + :exclude-members: name + + .. autoclass:: PyOpenColorIO.GpuShaderDesc.UniformData + :members: + :undoc-members: + + .. autoclass:: PyOpenColorIO.GpuShaderDesc.Texture + :members: + :undoc-members: + + .. autoclass:: PyOpenColorIO.GpuShaderDesc.Texture3D + :members: + :undoc-members: + + .. autoclass:: PyOpenColorIO.GpuShaderDesc.UniformIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.GpuShaderDesc.TextureIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.GpuShaderDesc.Texture3DIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.GpuShaderDesc.DynamicPropertyIterator + :special-members: __getitem__, __iter__, __len__, __next__ .. group-tab:: C++ diff --git a/docs/api/systemmonitors.rst b/docs/api/systemmonitors.rst index 0a9475dbee..89bc727bba 100644 --- a/docs/api/systemmonitors.rst +++ b/docs/api/systemmonitors.rst @@ -9,7 +9,14 @@ SystemMonitors .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_systemmonitors.rst + .. autoclass:: PyOpenColorIO.SystemMonitors + :members: + :undoc-members: + :special-members: __init__ + :exclude-members: MonitorIterator + + .. autoclass:: PyOpenColorIO.SystemMonitors.MonitorIterator + :special-members: __getitem__, __iter__, __len__, __next__ .. group-tab:: C++ diff --git a/docs/api/transforms.rst b/docs/api/transforms.rst index ea433f6922..c034c6386a 100644 --- a/docs/api/transforms.rst +++ b/docs/api/transforms.rst @@ -14,7 +14,10 @@ Transform .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_transform.rst + .. autoclass:: PyOpenColorIO.Transform + :members: + :undoc-members: + :special-members: __init__, __str__ .. group-tab:: C++ @@ -34,7 +37,11 @@ AllocationTransform .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_allocationtransform.rst + .. autoclass:: PyOpenColorIO.AllocationTransform + :members: + :undoc-members: + :special-members: __init__, __str__ + :inherited-members: .. group-tab:: C++ @@ -54,7 +61,11 @@ BuiltinTransform .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_builtintransform.rst + .. autoclass:: PyOpenColorIO.BuiltinTransform + :members: + :undoc-members: + :special-members: __init__, __str__ + :inherited-members: .. group-tab:: C++ @@ -74,7 +85,17 @@ BuiltinTransformRegistry .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_builtintransformregistry.rst + .. autoclass:: PyOpenColorIO.BuiltinTransformRegistry + :members: + :undoc-members: + :special-members: __init__ + :exclude-members: BuiltinStyleIterator, BuiltinIterator + + .. autoclass:: PyOpenColorIO.BuiltinTransformRegistry.BuiltinStyleIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.BuiltinTransformRegistry.BuiltinIterator + :special-members: __getitem__, __iter__, __len__, __next__ .. group-tab:: C++ @@ -92,7 +113,11 @@ CDLTransform .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_cdltransform.rst + .. autoclass:: PyOpenColorIO.CDLTransform + :members: + :undoc-members: + :special-members: __init__, __str__ + :inherited-members: .. group-tab:: C++ @@ -112,7 +137,11 @@ ColorSpaceTransform .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_colorspacetransform.rst + .. autoclass:: PyOpenColorIO.ColorSpaceTransform + :members: + :undoc-members: + :special-members: __init__, __str__ + :inherited-members: .. group-tab:: C++ @@ -132,7 +161,11 @@ DisplayViewTransform .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_displayviewtransform.rst + .. autoclass:: PyOpenColorIO.DisplayViewTransform + :members: + :undoc-members: + :special-members: __init__, __str__ + :inherited-members: .. group-tab:: C++ @@ -152,7 +185,11 @@ ExponentTransform .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_exponenttransform.rst + .. autoclass:: PyOpenColorIO.ExponentTransform + :members: + :undoc-members: + :special-members: __init__, __str__ + :inherited-members: .. group-tab:: C++ @@ -172,7 +209,11 @@ ExponentWithLinearTransform .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_exponentwithlineartransform.rst + .. autoclass:: PyOpenColorIO.ExponentWithLinearTransform + :members: + :undoc-members: + :special-members: __init__, __str__ + :inherited-members: .. group-tab:: C++ @@ -192,7 +233,11 @@ ExposureContrastTransform .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_exposurecontrasttransform.rst + .. autoclass:: PyOpenColorIO.ExposureContrastTransform + :members: + :undoc-members: + :special-members: __init__, __str__ + :inherited-members: .. group-tab:: C++ @@ -212,7 +257,15 @@ FileTransform .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_filetransform.rst + .. autoclass:: PyOpenColorIO.FileTransform + :members: + :undoc-members: + :special-members: __init__, __str__ + :inherited-members: + :exclude-members: FormatIterator + + .. autoclass:: PyOpenColorIO.FileTransform.FormatIterator + :special-members: __getitem__, __iter__, __len__, __next__ .. group-tab:: C++ @@ -232,7 +285,11 @@ FixedFunctionTransform .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_fixedfunctiontransform.rst + .. autoclass:: PyOpenColorIO.FixedFunctionTransform + :members: + :undoc-members: + :special-members: __init__, __str__ + :inherited-members: .. group-tab:: C++ @@ -252,7 +309,18 @@ GroupTransform .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_grouptransform.rst + .. autoclass:: PyOpenColorIO.GroupTransform + :members: + :undoc-members: + :special-members: __init__, __str__ + :inherited-members: + :exclude-members: TransformIterator, WriteFormatIterator + + .. autoclass:: PyOpenColorIO.GroupTransform.WriteFormatIterator + :special-members: __getitem__, __iter__, __len__, __next__ + + .. autoclass:: PyOpenColorIO.GroupTransform.TransformIterator + :special-members: __getitem__, __iter__, __len__, __next__ .. group-tab:: C++ @@ -272,7 +340,11 @@ LogAffineTransform .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_logaffinetransform.rst + .. autoclass:: PyOpenColorIO.LogAffineTransform + :members: + :undoc-members: + :special-members: __init__, __str__ + :inherited-members: .. group-tab:: C++ @@ -292,7 +364,11 @@ LogCameraTransform .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_logcameratransform.rst + .. autoclass:: PyOpenColorIO.LogCameraTransform + :members: + :undoc-members: + :special-members: __init__, __str__ + :inherited-members: .. group-tab:: C++ @@ -312,7 +388,11 @@ LogTransform .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_logtransform.rst + .. autoclass:: PyOpenColorIO.LogTransform + :members: + :undoc-members: + :special-members: __init__, __str__ + :inherited-members: .. group-tab:: C++ @@ -332,7 +412,11 @@ LookTransform .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_looktransform.rst + .. autoclass:: PyOpenColorIO.LookTransform + :members: + :undoc-members: + :special-members: __init__, __str__ + :inherited-members: .. group-tab:: C++ @@ -352,7 +436,11 @@ Lut1DTransform .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_lut1dtransform.rst + .. autoclass:: PyOpenColorIO.Lut1DTransform + :members: + :undoc-members: + :special-members: __init__, __str__ + :inherited-members: .. group-tab:: C++ @@ -372,7 +460,11 @@ Lut3DTransform .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_lut3dtransform.rst + .. autoclass:: PyOpenColorIO.Lut3DTransform + :members: + :undoc-members: + :special-members: __init__, __str__ + :inherited-members: .. group-tab:: C++ @@ -392,7 +484,11 @@ MatrixTransform .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_matrixtransform.rst + .. autoclass:: PyOpenColorIO.MatrixTransform + :members: + :undoc-members: + :special-members: __init__, __str__ + :inherited-members: .. group-tab:: C++ @@ -412,7 +508,11 @@ RangeTransform .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_rangetransform.rst + .. autoclass:: PyOpenColorIO.RangeTransform + :members: + :undoc-members: + :special-members: __init__, __str__ + :inherited-members: .. group-tab:: C++ diff --git a/docs/api/viewtransform.rst b/docs/api/viewtransform.rst index 67489c07db..38397bef6f 100644 --- a/docs/api/viewtransform.rst +++ b/docs/api/viewtransform.rst @@ -9,7 +9,14 @@ ViewTransform .. group-tab:: Python - .. include:: python/${PYDIR}/pyopencolorio_viewtransform.rst + .. autoclass:: PyOpenColorIO.ViewTransform + :members: + :undoc-members: + :special-members: __init__, __str__ + :exclude-members: ViewTransformCategoryIterator + + .. autoclass:: PyOpenColorIO.ViewTransform.ViewTransformCategoryIterator + :special-members: __getitem__, __iter__, __len__, __next__ .. group-tab:: C++ diff --git a/docs/conf.py b/docs/conf.py index 3609e413b7..3b8d977a76 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -6,10 +6,8 @@ # http://sphinx.pocoo.org/config.html import os -import shutil import subprocess import sys -import re HERE = os.path.dirname(os.path.realpath(__file__)) @@ -17,15 +15,8 @@ # -- Build options ------------------------------------------------------------ -# OCIO API has been modified. Update frozen API docs in source tree. -# Dependent on CMake build (so not RTD). -BUILD_FROZEN = "@OCIO_BUILD_FROZEN_DOCS@" == "ON" - # 'READTHEDOCS' env var set by Read the Docs RTD_BUILD = os.environ.get("READTHEDOCS") == "True" -# 'CI' env var set by GitHub Actions. Only test frozen docs on Linux, since -# that's what RTD will use. -CI_BUILD = os.environ.get("CI") == "true" and sys.platform in ("linux", "linux2") # -- Add local Sphinx extensions ---------------------------------------------- @@ -38,7 +29,6 @@ import expandvars import prettymethods -import frozendoc # -- General configuration ---------------------------------------------------- @@ -76,7 +66,6 @@ "breathe", "expandvars", "prettymethods", - "frozendoc", ] source_suffix = { @@ -85,7 +74,7 @@ ".txt": "markdown", } -master_doc = "index" +root_doc = "index" exclude_patterns = [ "INSTALL.md", "README*", @@ -107,15 +96,6 @@ # -- Extension Configuration -------------------------------------------------- -# frozendoc -frozendoc_build = BUILD_FROZEN - -# When enabled, frozendoc_build is also enabled to build and compare new frozen -# RST with frozen RST present in the source tree. This is only necessary in a -# CI job, where we want to confirm the contributor has built frozen RST along -# with any public API or documentation changes. -frozendoc_compare = CI_BUILD - # breathe breathe_projects = {project: "_doxygen/xml"} breathe_default_project = project @@ -129,7 +109,6 @@ # expandvars expandvars_define = { - "PYDIR": "frozen" if RTD_BUILD else "src", "OCIO_NAMESPACE": ocio_namespace, } diff --git a/docs/guides/contributing/documentation_guidelines.rst b/docs/guides/contributing/documentation_guidelines.rst index 8f3004754e..bccb462719 100644 --- a/docs/guides/contributing/documentation_guidelines.rst +++ b/docs/guides/contributing/documentation_guidelines.rst @@ -81,25 +81,7 @@ Tip: 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:: - - $ 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 -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); 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 +The conf.py 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, and will also facilitate a CMake configure_file-like process (via Python) to handle substitutions in headers and docs source files that CMake would usually handle, but can't diff --git a/docs/quick_start/installation.rst b/docs/quick_start/installation.rst index 8b8e275d53..03da2f9e9f 100644 --- a/docs/quick_start/installation.rst +++ b/docs/quick_start/installation.rst @@ -289,7 +289,6 @@ Here are the most common OCIO-specific CMake options (the default values are sho - ``-DOCIO_USE_HEADLESS=OFF`` (Set to ON to do headless GPU rendering) - ``-DOCIO_WARNING_AS_ERROR=ON`` (Set to OFF to turn off warnings as errors) - ``-DOCIO_BUILD_DOCS=OFF`` (Set to ON to build the documentation) -- ``-DOCIO_BUILD_FROZEN_DOCS=OFF`` (Set to ON to update the Python documentation) Note that OCIO will turn off any specific SIMD CPU performance optimizations if they are not supported by the build target architecture. The default for ``OCIO_USE_SSE2``, ``OCIO_USE_AVX``, ``OCIO_USE_AVX2`` and diff --git a/share/docs/frozendoc.py b/share/docs/frozendoc.py deleted file mode 100644 index d3d9e06566..0000000000 --- a/share/docs/frozendoc.py +++ /dev/null @@ -1,333 +0,0 @@ -# SPDX-License-Identifier: BSD-3-Clause -# Copyright Contributors to the OpenColorIO Project. -# -# ----------------------------------------------------------------------------- -# -# This Sphinx extension emits "frozen" autodoc generated RST for use in an -# environment where the dependent Python package is unavailable (e.g. Python -# bindings which must be compiled, but can't due to a build environment like -# readthedocs.org). It also facilitates comparison between versions of generated -# RST to determine when re-freezing is needed to keep up with upstream changes -# which affect autodoc output. -# -# The add_line monkeypatch contained in this module is derived from two Stack -# Overflow answers, which point out an entry point in autodoc for capturing -# generated RST: -# -# Answer: https://stackoverflow.com/a/2712413 -# Author: Michal Čihař (https://stackoverflow.com/users/225718/michal-%c4%8ciha%c5%99) -# License: CC BY-SA 4.0 (https://creativecommons.org/licenses/by-sa/4.0/) -# -# Answer: https://stackoverflow.com/a/31648880 -# Author: srepmub (https://stackoverflow.com/users/1368566/srepmub) -# License: CC BY-SA 3.0 (https://creativecommons.org/licenses/by-sa/3.0/) -# -# This module extends the sphinx.ext.autodoc.Documenter.add_line method defined -# in this source file: -# https://github.com/sphinx-doc/sphinx/blob/3.x/sphinx/ext/autodoc/__init__.py -# -# Sphinx is released under the BSD license. The full license contents are -# below: -# -# ----------------------------------------------------------------------------- -# -# Copyright (c) 2007-2020 by the Sphinx team (see AUTHORS file). -# All rights reserved. -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions are -# met: -# -# * Redistributions of source code must retain the above copyright -# notice, this list of conditions and the following disclaimer. -# -# * Redistributions in binary form must reproduce the above copyright -# notice, this list of conditions and the following disclaimer in the -# documentation and/or other materials provided with the distribution. -# -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -# -# ----------------------------------------------------------------------------- - -import difflib -import filecmp -import logging -import os -import shutil - -import sphinx.ext.autodoc -from sphinx.errors import ExtensionError - - -logging.basicConfig( - level=logging.INFO, - format="[%(levelname)s] %(name)s: %(message)s", -) -logger = logging.getLogger(__name__) - -MODULE = os.path.realpath(__file__) -HERE = os.path.dirname(MODULE) -ROOT = os.path.abspath(os.path.join(HERE, os.pardir, os.pardir)) -MODULE_RELPATH = MODULE[len(ROOT)+1:].replace("\\", "/") -DOCS_DIR = os.path.join(ROOT, "docs") -PYTHON_FROZEN_DIR = os.path.join(DOCS_DIR, "api", "python", "frozen") -PYTHON_BACKUP_DIR = os.path.join(DOCS_DIR, "api", "python", "backup") - - -class RSTRouter(object): - """ - Manages state for multiple incrementally generated RST files. - """ - _init_dest_dir = set() - _init_rst_file = set() - _current_fullname = None - _current_rst_file = None - - @classmethod - def init_dest_dir(cls, dest_dir): - """ - Re-initialize RST destination dir once per session. - """ - if dest_dir not in cls._init_dest_dir: - if os.path.exists(dest_dir): - shutil.rmtree(dest_dir) - os.makedirs(dest_dir) - cls._init_dest_dir.add(dest_dir) - - @classmethod - def init_rst_file(cls, dest_dir, fullname, after_token, header): - """ - Return an RST file object for capturing RST lines. - """ - cls.init_dest_dir(dest_dir) - - if fullname != cls._current_fullname: - if cls._current_rst_file: - cls._current_rst_file.close() - - # Given a Python signature, remove all tokens beyond - # after_token + 1: - # fullname: "a.b.c.d" - # after_token: "b" - # rst_path: "dest_dir/a.b.c.rst" - name_tokens = fullname.split(".") - after_index = name_tokens.index(after_token) - basename = "_".join(name_tokens[:after_index+2]).lower() - rst_path = os.path.join(PYTHON_FROZEN_DIR, basename + ".rst") - - mode = "w" - if rst_path in cls._init_rst_file: - mode = "a" - - cls._current_rst_file = open(rst_path, mode, encoding="utf-8") - cls._current_fullname = fullname - - # Start each new RST file with the given header - if mode == "w": - cls._current_rst_file.write(header) - cls._init_rst_file.add(rst_path) - - return cls._current_rst_file - - -def add_line(self, line, source, *lineno): - # PyOpenColorIO (pybind11) extension module is now a submodule of the - # PyOpenColorIO top level package. This enables easier inclusion of side - # content like the command line apps but results in duplicated module - # paths appearing in the type hints. - # As a simple workaround we manually remove this duplication here. - line = line.replace("PyOpenColorIO.PyOpenColorIO.", "PyOpenColorIO.") - - if line.strip(): # not a blank line - line_out = self.indent + line - else: - line_out = "" - - rst_file = RSTRouter.init_rst_file( - PYTHON_FROZEN_DIR, - self.fullname, - "PyOpenColorIO", - "..\n" - " SPDX-License-Identifier: CC-BY-4.0\n" - " Copyright Contributors to the OpenColorIO Project.\n" - " Do not edit! This file was automatically generated by " - "{module}.\n".format(module=MODULE_RELPATH) - ) - - rst_file.write(line_out + "\n") - # The last rst file won't be explicitly closed, so write to file now - rst_file.flush() - - self.directive.result.append(line_out, source, *lineno) - - -def patch(): - """ - Apply monkeypatch to autodoc. - """ - sphinx.ext.autodoc.Documenter.add_line = add_line - - -def backup_frozen(app): - """ - Duplicate existing frozen RST files for comparison with newly - frozen RST in ``compare_frozen()`` after docs are built. - """ - if app.config.frozendoc_build or app.config.frozendoc_compare: - # Apply monkeypatch, enabling frozen RST generation - patch() - - if not app.config.frozendoc_compare: - return - - logger.info("Backing up frozen RST: {src} -> {dst}".format( - src=PYTHON_FROZEN_DIR, - dst=PYTHON_BACKUP_DIR - )) - - if os.path.exists(PYTHON_FROZEN_DIR) and os.listdir(PYTHON_FROZEN_DIR): - if os.path.exists(PYTHON_BACKUP_DIR): - shutil.rmtree(PYTHON_BACKUP_DIR) - shutil.move(PYTHON_FROZEN_DIR, PYTHON_BACKUP_DIR) - else: - raise ExtensionError( - "No frozen RST found! Build OpenColorIO with CMake option " - "'-DOCIO_BUILD_FROZEN_DOCS=ON' to generate required frozen " - "documentation source files in: {dir}".format(dir=PYTHON_FROZEN_DIR) - ) - - logger.info("Backup complete.") - - -def compare_frozen(app, exception): - """ - Compare backed up frozen RST files from ``backup_frozen()`` with - newly frozen RST. If they don't match within accepted tolerances, - raise an exception to fail the current CI job. This implies that - the OCIO API changed without building with CMake option - ``-DOCIO_BUILD_FROZEN_DOCS=ON``; needed to update frozen RST in the - source tree. - """ - # Raise Sphinx exceptions for debugging - if exception: - raise ExtensionError(str(exception)) - - if not app.config.frozendoc_compare: - return - - logger.info("Comparing frozen RST: {src} <-> {dst}\n".format( - src=PYTHON_FROZEN_DIR, - dst=PYTHON_BACKUP_DIR - )) - - frozen_files = set(os.listdir(PYTHON_FROZEN_DIR)) - backup_files = set(os.listdir(PYTHON_BACKUP_DIR)) - - # Find any files which are different, or only present in one of the two - # directories. - match, mismatch, errors = filecmp.cmpfiles( - PYTHON_FROZEN_DIR, - PYTHON_BACKUP_DIR, - list(frozen_files | backup_files), - shallow=False - ) - - # Different OSs or compilers may result in slightly different signatures - # or types. Test each mismatched file for the ratio of how different - # their contents are. If they have a difference ratio at or above 0.6 (the - # recommended ratio to determine close matches), assume the differences are - # ok. This is certainly not a water tight assumption, but deemed (at the - # moment) preferrable to failing on every mior difference. Keep track of - # these ignored differences and report them for transparency in CI logs. - ignored = [] - - for i in reversed(range(len(mismatch))): - filename = mismatch[i] - logger.info("Difference found in: {}".format(filename)) - - frozen_path = os.path.join(PYTHON_FROZEN_DIR, filename) - with open(frozen_path, "r") as frozen_file: - frozen_data = frozen_file.read() - - backup_path = os.path.join(PYTHON_BACKUP_DIR, filename) - with open(backup_path, "r") as backup_file: - backup_data = backup_file.read() - - for line in difflib.unified_diff( - frozen_data.splitlines(), - backup_data.splitlines(), - fromfile=frozen_path, - tofile=backup_path - ): - logger.info(line) - - # Based on difflib's caution of argument order playing a role in the - # results of ratio(), check the ratio in both directions and use the - # better of the two as our heuristic. - match_ab = difflib.SequenceMatcher(None, frozen_data, backup_data) - match_ba = difflib.SequenceMatcher(None, backup_data, frozen_data) - max_ratio = max(match_ab.ratio(), match_ba.ratio()) - - if max_ratio >= 0.6: - ignored.append(mismatch.pop(i)) - logger.info( - "Difference ratio {} is within error tolerances\n".format( - max_ratio - ) - ) - else: - logger.error( - "Difference ratio {} exceeds error tolerances\n".format( - max_ratio - ) - ) - - if os.path.exists(PYTHON_BACKUP_DIR): - shutil.rmtree(PYTHON_BACKUP_DIR) - - if mismatch or errors: - raise ExtensionError( - "Frozen RST is out of date! Build OpenColorIO with CMake option " - "'-DOCIO_BUILD_FROZEN_DOCS=ON' to update required frozen " - "documentation source files in: {dir}\n\n" - " Changed files: {changed}\n\n" - " Added files: {added}\n\n" - " Removed files: {removed}\n\n" - "See log for changed file differences.\n".format( - dir=PYTHON_FROZEN_DIR, - changed=", ".join(mismatch), - added=", ".join(f for f in errors if f in frozen_files), - removed=", ".join(f for f in errors if f in backup_files), - ) - ) - - # Report ignored differences - if ignored: - logger.warning( - "Some differences were found and ignored when comparing frozen " - "RST to current documentation source in: {dir}\n\n" - " Changed files: {changed}\n\n" - "See log for changed file differences.\n".format( - dir=PYTHON_FROZEN_DIR, - changed=", ".join(ignored), - ) - ) - - logger.info("Frozen RST matches within error tolerances.") - - -def setup(app): - app.add_config_value("frozendoc_build", False, "env") - app.add_config_value("frozendoc_compare", False, "env") - app.connect("builder-inited", backup_frozen) - app.connect("build-finished", compare_frozen) From 4f513231db39135f601076e2bee45a16913cfeed Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Tue, 1 Jul 2025 17:01:44 -0400 Subject: [PATCH 02/36] Make opencolorio RTD requirement Signed-off-by: Michael Dolan --- docs/CMakeLists.txt | 2 +- docs/requirements.txt | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index c3fd38e839..31dd8c5db5 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -45,7 +45,7 @@ if(${Python_VERSION_MAJOR} GREATER_EQUAL 3) # Breathe # https://pypi.org/project/breathe/ find_python_package(breathe REQUIRED) - + ########################################################################### ### Setup PYTHONPATH ### diff --git a/docs/requirements.txt b/docs/requirements.txt index 334e782153..ada699e8cc 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -12,3 +12,4 @@ sphinx-press-theme sphinx-tabs breathe setuptools<68.0.0 +opencolorio From 6fa92c9f918e31e01eb60c93070ad067f060a760 Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Tue, 1 Jul 2025 21:27:13 -0400 Subject: [PATCH 03/36] Only install from PyPi on RTD_BUILD Signed-off-by: Michael Dolan --- docs/conf.py | 12 ++++++++++++ docs/requirements.txt | 1 - 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 3b8d977a76..a2cbc1ae7f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -192,3 +192,15 @@ # Generate Doxygen XML subprocess.run(["doxygen", "Doxyfile"], check=True) + +# -- Install PyOpenColorIO ---------------------------------------------------- + +# When building docs for Read the Docs, we won't have a local PyOpenColorIO +# build to run autodoc for, so we instead install the specific version needed +# from PyPi. + +if RTD_BUILD: + subprocess.run( + [sys.executable, "-m", "pip", "install", f"opencolorio=={version}"], + check=True + ) diff --git a/docs/requirements.txt b/docs/requirements.txt index ada699e8cc..334e782153 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -12,4 +12,3 @@ sphinx-press-theme sphinx-tabs breathe setuptools<68.0.0 -opencolorio From 0e610781e2bc083aafd418ca032c121a6a651b0a Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Wed, 2 Jul 2025 15:32:32 -0400 Subject: [PATCH 04/36] Trigger PR RTD build Signed-off-by: Michael Dolan --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index a2cbc1ae7f..91e50aa779 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -82,7 +82,7 @@ "build", "*-prefix", "api/python", - "site" + "site", ] rst_prolog = """ From aa3b1633aad3a170577cce21f75bd8c9b6a05272 Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Wed, 2 Jul 2025 15:57:51 -0400 Subject: [PATCH 05/36] Restructure pip command Signed-off-by: Michael Dolan --- docs/conf.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 91e50aa779..36bddb180a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -201,6 +201,9 @@ if RTD_BUILD: subprocess.run( - [sys.executable, "-m", "pip", "install", f"opencolorio=={version}"], + [ + "python", "-m", "pip", "install", "--no-cache-dir", + f"opencolorio=={version}" + ], check=True ) From bbd6ab2538abbffdde599153d53d73806bee556c Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Wed, 2 Jul 2025 16:10:17 -0400 Subject: [PATCH 06/36] Fallback to latest PyPi version Signed-off-by: Michael Dolan --- docs/conf.py | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 36bddb180a..fae2e330e3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -196,14 +196,13 @@ # -- Install PyOpenColorIO ---------------------------------------------------- # When building docs for Read the Docs, we won't have a local PyOpenColorIO -# build to run autodoc for, so we instead install the specific version needed -# from PyPi. +# build to run autodoc for, so we try to install the specific version needed +# from PyPi. If that version is not yet available (pre-release), fallback to +# installing the latest version. if RTD_BUILD: - subprocess.run( - [ - "python", "-m", "pip", "install", "--no-cache-dir", - f"opencolorio=={version}" - ], - check=True - ) + pip_cmd = ["python", "-m", "pip", "install", "--no-cache-dir"] + try: + subprocess.run(pip_cmd + [f"opencolorio=={version}"], check=True) + except subprocess.CalledProcessError: + subprocess.run(pip_cmd + ["--upgrade", "opencolorio"], check=True) From 919ad7d71b7e64d45563a76e73a09145f144ba02 Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Wed, 2 Jul 2025 23:42:26 -0400 Subject: [PATCH 07/36] Increase sphinx verbosity for debugging Signed-off-by: Michael Dolan --- .readthedocs.yml | 2 +- docs/conf.py | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 1164cbf61f..26c5cb2915 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -9,7 +9,7 @@ version: 2 build: os: ubuntu-20.04 tools: - python: "3.9" + python: "3.11" sphinx: configuration: docs/conf.py diff --git a/docs/conf.py b/docs/conf.py index fae2e330e3..744d352bba 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -206,3 +206,6 @@ subprocess.run(pip_cmd + [f"opencolorio=={version}"], check=True) except subprocess.CalledProcessError: subprocess.run(pip_cmd + ["--upgrade", "opencolorio"], check=True) + +def setup(app): + app.verbosity = 2 From fdd97cb27dffc2f19e2c9134dd20f9e7f183424c Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Thu, 3 Jul 2025 16:55:09 -0400 Subject: [PATCH 08/36] Update sphinx verbosity Signed-off-by: Michael Dolan --- docs/conf.py | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 744d352bba..fae2e330e3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -206,6 +206,3 @@ subprocess.run(pip_cmd + [f"opencolorio=={version}"], check=True) except subprocess.CalledProcessError: subprocess.run(pip_cmd + ["--upgrade", "opencolorio"], check=True) - -def setup(app): - app.verbosity = 2 From 81555a22cf0d5e2726a8d4bc50843a43793f0ac9 Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Thu, 3 Jul 2025 19:53:12 -0400 Subject: [PATCH 09/36] Try another verbosity adjustment Signed-off-by: Michael Dolan --- .readthedocs.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.readthedocs.yml b/.readthedocs.yml index 26c5cb2915..99ebbdcb34 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -10,6 +10,10 @@ build: os: ubuntu-20.04 tools: python: "3.11" + jobs: + build: + html: + - python -m sphinx -T -b -vvv html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html sphinx: configuration: docs/conf.py From 4508fac5e654c5e4ec309e4d4901722b9d570598 Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Thu, 3 Jul 2025 20:19:48 -0400 Subject: [PATCH 10/36] Fix sphinx build command Signed-off-by: Michael Dolan --- .readthedocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 99ebbdcb34..ac508e2c78 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -13,7 +13,7 @@ build: jobs: build: html: - - python -m sphinx -T -b -vvv html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html + - python -m sphinx -vvv -T -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html sphinx: configuration: docs/conf.py From b3bfbecde548e8c670692be2e0c558a71f7b1b1d Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Thu, 3 Jul 2025 20:35:22 -0400 Subject: [PATCH 11/36] Adjusting relative path Signed-off-by: Michael Dolan --- .readthedocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index ac508e2c78..af3593074b 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -13,7 +13,7 @@ build: jobs: build: html: - - python -m sphinx -vvv -T -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html + - python -m sphinx -vvv -T -b html -d docs/_build/doctrees -D language=en docs $READTHEDOCS_OUTPUT/html sphinx: configuration: docs/conf.py From 6ecd6a525d62a9c8f8d36d4daa1bcd51fe5c4b20 Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Thu, 3 Jul 2025 21:06:14 -0400 Subject: [PATCH 12/36] Trying alt build structure Signed-off-by: Michael Dolan --- docs/api/processors.rst | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/api/processors.rst b/docs/api/processors.rst index 5b97f61009..5605945645 100644 --- a/docs/api/processors.rst +++ b/docs/api/processors.rst @@ -13,10 +13,6 @@ Processor .. group-tab:: Python .. autoclass:: PyOpenColorIO.Processor - :members: - :undoc-members: - :special-members: __init__ - :exclude-members: TransformFormatMetadataIterator, WriteFormatIterator .. autoclass:: PyOpenColorIO.Processor.TransformFormatMetadataIterator :special-members: __getitem__, __iter__, __len__, __next__ From 93f3c4edaf039af290f5f766494bfec7c454549d Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Thu, 3 Jul 2025 21:09:24 -0400 Subject: [PATCH 13/36] Another alt build structure Signed-off-by: Michael Dolan --- docs/api/processors.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/api/processors.rst b/docs/api/processors.rst index 5605945645..f71cb8b8e4 100644 --- a/docs/api/processors.rst +++ b/docs/api/processors.rst @@ -13,6 +13,7 @@ Processor .. group-tab:: Python .. autoclass:: PyOpenColorIO.Processor + :members: .. autoclass:: PyOpenColorIO.Processor.TransformFormatMetadataIterator :special-members: __getitem__, __iter__, __len__, __next__ From fd68a1f8e68795394d55de1d412bb48fcc80d77a Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Thu, 3 Jul 2025 21:25:05 -0400 Subject: [PATCH 14/36] Try pre-install of OCIO Signed-off-by: Michael Dolan --- .readthedocs.yml | 2 +- docs/api/processors.rst | 3 +++ docs/conf.py | 12 ++++++------ docs/requirements.txt | 1 + 4 files changed, 11 insertions(+), 7 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index af3593074b..5067cadfd8 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -13,7 +13,7 @@ build: jobs: build: html: - - python -m sphinx -vvv -T -b html -d docs/_build/doctrees -D language=en docs $READTHEDOCS_OUTPUT/html + - python -m sphinx -vv -T -b html -d docs/_build/doctrees -D language=en docs $READTHEDOCS_OUTPUT/html sphinx: configuration: docs/conf.py diff --git a/docs/api/processors.rst b/docs/api/processors.rst index f71cb8b8e4..5b97f61009 100644 --- a/docs/api/processors.rst +++ b/docs/api/processors.rst @@ -14,6 +14,9 @@ Processor .. autoclass:: PyOpenColorIO.Processor :members: + :undoc-members: + :special-members: __init__ + :exclude-members: TransformFormatMetadataIterator, WriteFormatIterator .. autoclass:: PyOpenColorIO.Processor.TransformFormatMetadataIterator :special-members: __getitem__, __iter__, __len__, __next__ diff --git a/docs/conf.py b/docs/conf.py index fae2e330e3..00aa059d4e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -200,9 +200,9 @@ # from PyPi. If that version is not yet available (pre-release), fallback to # installing the latest version. -if RTD_BUILD: - pip_cmd = ["python", "-m", "pip", "install", "--no-cache-dir"] - try: - subprocess.run(pip_cmd + [f"opencolorio=={version}"], check=True) - except subprocess.CalledProcessError: - subprocess.run(pip_cmd + ["--upgrade", "opencolorio"], check=True) +# if RTD_BUILD: +# pip_cmd = ["python", "-m", "pip", "install", "--no-cache-dir"] +# try: +# subprocess.run(pip_cmd + [f"opencolorio=={version}"], check=True) +# except subprocess.CalledProcessError: +# subprocess.run(pip_cmd + ["--upgrade", "opencolorio"], check=True) diff --git a/docs/requirements.txt b/docs/requirements.txt index 334e782153..ada699e8cc 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -12,3 +12,4 @@ sphinx-press-theme sphinx-tabs breathe setuptools<68.0.0 +opencolorio From bc433231397f511b0d353bfc215f1b0d3e301494 Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Thu, 3 Jul 2025 21:57:07 -0400 Subject: [PATCH 15/36] Testing platform build Signed-off-by: Michael Dolan --- .readthedocs.yml | 4 ---- docs/conf.py | 21 +++++++++++++++------ docs/requirements.txt | 1 - 3 files changed, 15 insertions(+), 11 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 5067cadfd8..26c5cb2915 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -10,10 +10,6 @@ build: os: ubuntu-20.04 tools: python: "3.11" - jobs: - build: - html: - - python -m sphinx -vv -T -b html -d docs/_build/doctrees -D language=en docs $READTHEDOCS_OUTPUT/html sphinx: configuration: docs/conf.py diff --git a/docs/conf.py b/docs/conf.py index 00aa059d4e..dd271ab72e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -67,6 +67,7 @@ "expandvars", "prettymethods", ] +autodoc_inherit_docstrings = False source_suffix = { ".rst": "restructuredtext", @@ -200,9 +201,17 @@ # from PyPi. If that version is not yet available (pre-release), fallback to # installing the latest version. -# if RTD_BUILD: -# pip_cmd = ["python", "-m", "pip", "install", "--no-cache-dir"] -# try: -# subprocess.run(pip_cmd + [f"opencolorio=={version}"], check=True) -# except subprocess.CalledProcessError: -# subprocess.run(pip_cmd + ["--upgrade", "opencolorio"], check=True) +if RTD_BUILD: + pip_cmd = ["python", "-m", "pip", "install", "--no-cache-dir"] + try: + subprocess.run(pip_cmd + [f"opencolorio=={version}"], check=True) + except subprocess.CalledProcessError: + subprocess.run(pip_cmd + ["--upgrade", "opencolorio"], check=True) + +import PyOpenColorIO as ocio +print("Processor") +print(ocio.Processor.__doc__) +print("Processor.createGroupTransform") +print(ocio.Processor.createGroupTransform.__doc__) +print("CPUProcessor.apply") +print(ocio.CPUProcessor.apply.__doc__) diff --git a/docs/requirements.txt b/docs/requirements.txt index ada699e8cc..334e782153 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -12,4 +12,3 @@ sphinx-press-theme sphinx-tabs breathe setuptools<68.0.0 -opencolorio From 3891c9887b7840b99b5ef2bb8d26c59129806a6d Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Thu, 3 Jul 2025 22:11:42 -0400 Subject: [PATCH 16/36] Revert conf.py __doc__ test Signed-off-by: Michael Dolan --- docs/conf.py | 8 -------- 1 file changed, 8 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index dd271ab72e..13c20ad9d1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -207,11 +207,3 @@ subprocess.run(pip_cmd + [f"opencolorio=={version}"], check=True) except subprocess.CalledProcessError: subprocess.run(pip_cmd + ["--upgrade", "opencolorio"], check=True) - -import PyOpenColorIO as ocio -print("Processor") -print(ocio.Processor.__doc__) -print("Processor.createGroupTransform") -print(ocio.Processor.createGroupTransform.__doc__) -print("CPUProcessor.apply") -print(ocio.CPUProcessor.apply.__doc__) From 83a45b00b90b7393ad849c491f1384d18317fe79 Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Thu, 3 Jul 2025 23:09:16 -0400 Subject: [PATCH 17/36] Update CI to use windows-2022, and linux builds to use apt Signed-off-by: Michael Dolan --- .github/workflows/analysis_workflow.yml | 4 ++-- .github/workflows/ci_workflow.yml | 12 ++++++------ .github/workflows/dependencies_latest.yml | 4 ++-- .github/workflows/platform_latest.yml | 2 +- pyproject.toml | 2 +- share/ci/scripts/linux/yum/install_docs_env.sh | 8 +------- 6 files changed, 13 insertions(+), 19 deletions(-) diff --git a/.github/workflows/analysis_workflow.yml b/.github/workflows/analysis_workflow.yml index 7a7bfbbbeb..818175ef8e 100644 --- a/.github/workflows/analysis_workflow.yml +++ b/.github/workflows/analysis_workflow.yml @@ -47,9 +47,9 @@ jobs: - name: Install sonar-scanner and build-wrapper uses: sonarsource/sonarcloud-github-c-cpp@v2 - name: Install docs env - run: share/ci/scripts/linux/yum/install_docs_env.sh + run: share/ci/scripts/linux/apt/install_docs_env.sh - name: Install tests env - run: share/ci/scripts/linux/yum/install_tests_env.sh + run: share/ci/scripts/linux/apt/install_tests_env.sh - name: Create build directories run: | mkdir _install diff --git a/.github/workflows/ci_workflow.yml b/.github/workflows/ci_workflow.yml index 07db553ea4..0e4af8ac13 100644 --- a/.github/workflows/ci_workflow.yml +++ b/.github/workflows/ci_workflow.yml @@ -154,10 +154,10 @@ jobs: - name: Checkout uses: actions/checkout@v4 - name: Install docs env - run: share/ci/scripts/linux/yum/install_docs_env.sh + run: share/ci/scripts/linux/apt/install_docs_env.sh if: matrix.build-docs == 'ON' - name: Install tests env - run: share/ci/scripts/linux/yum/install_tests_env.sh + run: share/ci/scripts/linux/apt/install_tests_env.sh - name: Create build directories run: | mkdir _install @@ -366,10 +366,10 @@ jobs: - name: Checkout uses: actions/checkout@v3 - name: Install docs env - run: share/ci/scripts/linux/yum/install_docs_env.sh + run: share/ci/scripts/linux/apt/install_docs_env.sh if: matrix.build-docs == 'ON' - name: Install tests env - run: share/ci/scripts/linux/yum/install_tests_env.sh + run: share/ci/scripts/linux/apt/install_tests_env.sh - name: Create build directories run: | mkdir _install @@ -736,7 +736,7 @@ jobs: # Debug build testing with Python bindings and docs enabled. windows: - name: 'Windows 2019 + name: 'Windows 2022 = 10.13 diff --git a/share/ci/scripts/linux/yum/install_docs_env.sh b/share/ci/scripts/linux/yum/install_docs_env.sh index df66ae6fd9..6460204155 100755 --- a/share/ci/scripts/linux/yum/install_docs_env.sh +++ b/share/ci/scripts/linux/yum/install_docs_env.sh @@ -6,11 +6,5 @@ set -ex HERE=$(dirname $0) -# The yum install doxygen command started failing during CI since mirrorlist.centos.org -# was turned off. However, it seems that Doxygen is already installed on the containers -# used for CI, so this command is not currently necessary there. You will need to -# uncomment this line if you want to build the documentation on Linux but don't have -# doxygen already installed. -# bash $HERE/install_doxygen.sh latest - +bash $HERE/install_doxygen.sh latest pip install -r $HERE/../../../../../docs/requirements.txt From c6c680e8057d834de32757486608e333be6afaaf Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Fri, 4 Jul 2025 00:02:28 -0400 Subject: [PATCH 18/36] Handle dnf/yum/apt for different workflows Signed-off-by: Michael Dolan --- .github/workflows/analysis_workflow.yml | 4 ++-- .github/workflows/ci_workflow.yml | 8 ++++---- .github/workflows/dependencies_latest.yml | 4 ++-- .github/workflows/platform_latest.yml | 2 +- share/ci/scripts/linux/yum/install_doxygen.sh | 11 +++++++++-- 5 files changed, 18 insertions(+), 11 deletions(-) diff --git a/.github/workflows/analysis_workflow.yml b/.github/workflows/analysis_workflow.yml index 818175ef8e..7a7bfbbbeb 100644 --- a/.github/workflows/analysis_workflow.yml +++ b/.github/workflows/analysis_workflow.yml @@ -47,9 +47,9 @@ jobs: - name: Install sonar-scanner and build-wrapper uses: sonarsource/sonarcloud-github-c-cpp@v2 - name: Install docs env - run: share/ci/scripts/linux/apt/install_docs_env.sh + run: share/ci/scripts/linux/yum/install_docs_env.sh - name: Install tests env - run: share/ci/scripts/linux/apt/install_tests_env.sh + run: share/ci/scripts/linux/yum/install_tests_env.sh - name: Create build directories run: | mkdir _install diff --git a/.github/workflows/ci_workflow.yml b/.github/workflows/ci_workflow.yml index 0e4af8ac13..4d81c63f1c 100644 --- a/.github/workflows/ci_workflow.yml +++ b/.github/workflows/ci_workflow.yml @@ -154,10 +154,10 @@ jobs: - name: Checkout uses: actions/checkout@v4 - name: Install docs env - run: share/ci/scripts/linux/apt/install_docs_env.sh + run: share/ci/scripts/linux/yum/install_docs_env.sh if: matrix.build-docs == 'ON' - name: Install tests env - run: share/ci/scripts/linux/apt/install_tests_env.sh + run: share/ci/scripts/linux/yum/install_tests_env.sh - name: Create build directories run: | mkdir _install @@ -366,10 +366,10 @@ jobs: - name: Checkout uses: actions/checkout@v3 - name: Install docs env - run: share/ci/scripts/linux/apt/install_docs_env.sh + run: share/ci/scripts/linux/yum/install_docs_env.sh if: matrix.build-docs == 'ON' - name: Install tests env - run: share/ci/scripts/linux/apt/install_tests_env.sh + run: share/ci/scripts/linux/yum/install_tests_env.sh - name: Create build directories run: | mkdir _install diff --git a/.github/workflows/dependencies_latest.yml b/.github/workflows/dependencies_latest.yml index aeb7aeb90a..d95d732c85 100644 --- a/.github/workflows/dependencies_latest.yml +++ b/.github/workflows/dependencies_latest.yml @@ -92,10 +92,10 @@ jobs: - name: Checkout uses: actions/checkout@v3 - name: Install docs env - run: share/ci/scripts/linux/apt/install_docs_env.sh + run: share/ci/scripts/linux/yum/install_docs_env.sh if: matrix.build-docs == 'ON' - name: Install tests env - run: share/ci/scripts/linux/apt/install_tests_env.sh + run: share/ci/scripts/linux/yum/install_tests_env.sh - name: Setup ext environment run: | EXT_PATH=/usr/local diff --git a/.github/workflows/platform_latest.yml b/.github/workflows/platform_latest.yml index fa802bca4f..3279f7f1a9 100644 --- a/.github/workflows/platform_latest.yml +++ b/.github/workflows/platform_latest.yml @@ -88,7 +88,7 @@ jobs: - name: Checkout uses: actions/checkout@v4 - name: Install tests env - run: share/ci/scripts/linux/apt/install_tests_env.sh + run: share/ci/scripts/linux/yum/install_tests_env.sh - name: Create build directories run: | mkdir _install diff --git a/share/ci/scripts/linux/yum/install_doxygen.sh b/share/ci/scripts/linux/yum/install_doxygen.sh index d51d2611fe..b4ca659325 100755 --- a/share/ci/scripts/linux/yum/install_doxygen.sh +++ b/share/ci/scripts/linux/yum/install_doxygen.sh @@ -5,9 +5,16 @@ set -ex DOXYGEN_VERSION="$1" +YUM_CMD="yum" +# RockyLinux instead of CentOS? +if command -v dnf >/dev/null; then + YUM_CMD="dnf" +fi + +$YUM_CMD install -y epel-release if [ "$DOXYGEN_VERSION" == "latest" ]; then - yum install -y doxygen + $YUM_CMD install -y doxygen else - yum install -y doxygen-${DOXYGEN_VERSION} + $YUM_CMD install -y doxygen-${DOXYGEN_VERSION} fi From c679b0e0c57f6229f9448b7d54f38659a893d68d Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Fri, 4 Jul 2025 00:16:57 -0400 Subject: [PATCH 19/36] Fix wheel builds on Linux Signed-off-by: Michael Dolan --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index bfc59e1248..356f50f215 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -27,7 +27,7 @@ test-command = [ ] [tool.cibuildwheel.linux] -before-build = "share/ci/scripts/linux/apt/install_docs_env.sh" +before-build = "share/ci/scripts/linux/yum/install_docs_env.sh" [tool.cibuildwheel.macos] # cibuildwheel in some cases set this to 10.9 by default, OCIO needs >= 10.13 From e57733f50fa81916753eae6f0b63593013e04cdb Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Fri, 4 Jul 2025 00:21:42 -0400 Subject: [PATCH 20/36] Skip epel install Signed-off-by: Michael Dolan --- share/ci/scripts/linux/yum/install_doxygen.sh | 1 - 1 file changed, 1 deletion(-) diff --git a/share/ci/scripts/linux/yum/install_doxygen.sh b/share/ci/scripts/linux/yum/install_doxygen.sh index b4ca659325..e4d11b472c 100755 --- a/share/ci/scripts/linux/yum/install_doxygen.sh +++ b/share/ci/scripts/linux/yum/install_doxygen.sh @@ -12,7 +12,6 @@ if command -v dnf >/dev/null; then YUM_CMD="dnf" fi -$YUM_CMD install -y epel-release if [ "$DOXYGEN_VERSION" == "latest" ]; then $YUM_CMD install -y doxygen else From 17a57c0f2eb1233d5027cf6745e2b23652907335 Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Fri, 4 Jul 2025 16:02:27 -0400 Subject: [PATCH 21/36] Add manual doxygen install option Signed-off-by: Michael Dolan --- .github/workflows/analysis_workflow.yml | 4 +-- .github/workflows/ci_workflow.yml | 8 ++--- .github/workflows/dependencies_latest.yml | 4 +-- .github/workflows/platform_latest.yml | 2 +- .../contributing/documentation_guidelines.rst | 2 +- pyproject.toml | 2 +- .../linux/{yum => dnf}/install_docs_env.sh | 0 share/ci/scripts/linux/dnf/install_doxygen.sh | 33 +++++++++++++++++++ .../linux/{yum => dnf}/install_tests_env.sh | 0 share/ci/scripts/linux/yum/install_doxygen.sh | 19 ----------- 10 files changed, 44 insertions(+), 30 deletions(-) rename share/ci/scripts/linux/{yum => dnf}/install_docs_env.sh (100%) mode change 100755 => 100644 create mode 100644 share/ci/scripts/linux/dnf/install_doxygen.sh rename share/ci/scripts/linux/{yum => dnf}/install_tests_env.sh (100%) mode change 100755 => 100644 delete mode 100755 share/ci/scripts/linux/yum/install_doxygen.sh diff --git a/.github/workflows/analysis_workflow.yml b/.github/workflows/analysis_workflow.yml index 7a7bfbbbeb..f465b51098 100644 --- a/.github/workflows/analysis_workflow.yml +++ b/.github/workflows/analysis_workflow.yml @@ -47,9 +47,9 @@ jobs: - name: Install sonar-scanner and build-wrapper uses: sonarsource/sonarcloud-github-c-cpp@v2 - name: Install docs env - run: share/ci/scripts/linux/yum/install_docs_env.sh + run: share/ci/scripts/linux/dnf/install_docs_env.sh - name: Install tests env - run: share/ci/scripts/linux/yum/install_tests_env.sh + run: share/ci/scripts/linux/dnf/install_tests_env.sh - name: Create build directories run: | mkdir _install diff --git a/.github/workflows/ci_workflow.yml b/.github/workflows/ci_workflow.yml index 4d81c63f1c..c69ef6bd64 100644 --- a/.github/workflows/ci_workflow.yml +++ b/.github/workflows/ci_workflow.yml @@ -154,10 +154,10 @@ jobs: - name: Checkout uses: actions/checkout@v4 - name: Install docs env - run: share/ci/scripts/linux/yum/install_docs_env.sh + run: share/ci/scripts/linux/dnf/install_docs_env.sh if: matrix.build-docs == 'ON' - name: Install tests env - run: share/ci/scripts/linux/yum/install_tests_env.sh + run: share/ci/scripts/linux/dnf/install_tests_env.sh - name: Create build directories run: | mkdir _install @@ -366,10 +366,10 @@ jobs: - name: Checkout uses: actions/checkout@v3 - name: Install docs env - run: share/ci/scripts/linux/yum/install_docs_env.sh + run: share/ci/scripts/linux/dnf/install_docs_env.sh if: matrix.build-docs == 'ON' - name: Install tests env - run: share/ci/scripts/linux/yum/install_tests_env.sh + run: share/ci/scripts/linux/dnf/install_tests_env.sh - name: Create build directories run: | mkdir _install diff --git a/.github/workflows/dependencies_latest.yml b/.github/workflows/dependencies_latest.yml index d95d732c85..9cebbb3ce5 100644 --- a/.github/workflows/dependencies_latest.yml +++ b/.github/workflows/dependencies_latest.yml @@ -92,10 +92,10 @@ jobs: - name: Checkout uses: actions/checkout@v3 - name: Install docs env - run: share/ci/scripts/linux/yum/install_docs_env.sh + run: share/ci/scripts/linux/dnf/install_docs_env.sh if: matrix.build-docs == 'ON' - name: Install tests env - run: share/ci/scripts/linux/yum/install_tests_env.sh + run: share/ci/scripts/linux/dnf/install_tests_env.sh - name: Setup ext environment run: | EXT_PATH=/usr/local diff --git a/.github/workflows/platform_latest.yml b/.github/workflows/platform_latest.yml index 3279f7f1a9..ab1749bab5 100644 --- a/.github/workflows/platform_latest.yml +++ b/.github/workflows/platform_latest.yml @@ -88,7 +88,7 @@ jobs: - name: Checkout uses: actions/checkout@v4 - name: Install tests env - run: share/ci/scripts/linux/yum/install_tests_env.sh + run: share/ci/scripts/linux/dnf/install_tests_env.sh - name: Create build directories run: | mkdir _install diff --git a/docs/guides/contributing/documentation_guidelines.rst b/docs/guides/contributing/documentation_guidelines.rst index bccb462719..2b952befb4 100644 --- a/docs/guides/contributing/documentation_guidelines.rst +++ b/docs/guides/contributing/documentation_guidelines.rst @@ -28,7 +28,7 @@ will install the Python-related requirements for building the documentation 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`` +uncomment the relevant line in ``share/ci/scripts/linux/dnf/install_docs_env.sh`` Use GitBash (`provided with Git for Windows `_) to execute the script on Windows. diff --git a/pyproject.toml b/pyproject.toml index 356f50f215..793353ff6d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -27,7 +27,7 @@ test-command = [ ] [tool.cibuildwheel.linux] -before-build = "share/ci/scripts/linux/yum/install_docs_env.sh" +before-build = "share/ci/scripts/linux/dnf/install_docs_env.sh" [tool.cibuildwheel.macos] # cibuildwheel in some cases set this to 10.9 by default, OCIO needs >= 10.13 diff --git a/share/ci/scripts/linux/yum/install_docs_env.sh b/share/ci/scripts/linux/dnf/install_docs_env.sh old mode 100755 new mode 100644 similarity index 100% rename from share/ci/scripts/linux/yum/install_docs_env.sh rename to share/ci/scripts/linux/dnf/install_docs_env.sh diff --git a/share/ci/scripts/linux/dnf/install_doxygen.sh b/share/ci/scripts/linux/dnf/install_doxygen.sh new file mode 100644 index 0000000000..28bf4c82c1 --- /dev/null +++ b/share/ci/scripts/linux/dnf/install_doxygen.sh @@ -0,0 +1,33 @@ +#!/usr/bin/env bash +# SPDX-License-Identifier: BSD-3-Clause +# Copyright Contributors to the OpenColorIO Project. + +set -ex + +DOXYGEN_VERSION="$1" + +if command -v dnf >/dev/null; then + if [ "$DOXYGEN_VERSION" == "latest" ]; then + dnf install -y doxygen + else + dnf install -y doxygen-${DOXYGEN_VERSION} + fi +else + # Is some version of doxygen already available? + if command -v doxygen >/dev/null; then + if [ "$DOXYGEN_VERSION" == "latest" ]; then + # Get latest doxygen version from GH + DOXYGEN_VERSION=$( + curl --silent https://api.github.com/repos/doxygen/doxygen/releases/latest | \ + grep '"tag_name":' | \ + sed -E 's/.*"Release_([0-9_]+)".*/\1/' | \ + tr '_' '.' + ) + fi + + # Manual install + wget https://doxygen.nl/files/doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz + tar -xzf doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz + cp doxygen-${DOXYGEN_VERSION}/bin/doxygen /usr/local/bin/ + fi +fi diff --git a/share/ci/scripts/linux/yum/install_tests_env.sh b/share/ci/scripts/linux/dnf/install_tests_env.sh old mode 100755 new mode 100644 similarity index 100% rename from share/ci/scripts/linux/yum/install_tests_env.sh rename to share/ci/scripts/linux/dnf/install_tests_env.sh diff --git a/share/ci/scripts/linux/yum/install_doxygen.sh b/share/ci/scripts/linux/yum/install_doxygen.sh deleted file mode 100755 index e4d11b472c..0000000000 --- a/share/ci/scripts/linux/yum/install_doxygen.sh +++ /dev/null @@ -1,19 +0,0 @@ -#!/usr/bin/env bash -# SPDX-License-Identifier: BSD-3-Clause -# Copyright Contributors to the OpenColorIO Project. - -set -ex - -DOXYGEN_VERSION="$1" -YUM_CMD="yum" - -# RockyLinux instead of CentOS? -if command -v dnf >/dev/null; then - YUM_CMD="dnf" -fi - -if [ "$DOXYGEN_VERSION" == "latest" ]; then - $YUM_CMD install -y doxygen -else - $YUM_CMD install -y doxygen-${DOXYGEN_VERSION} -fi From 22a61f515d41471200c0d451843e19e2c2ccf208 Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Fri, 4 Jul 2025 20:18:05 -0400 Subject: [PATCH 22/36] Make dnf scripts executable Signed-off-by: Michael Dolan --- share/ci/scripts/linux/dnf/install_docs_env.sh | 0 share/ci/scripts/linux/dnf/install_doxygen.sh | 0 share/ci/scripts/linux/dnf/install_tests_env.sh | 0 3 files changed, 0 insertions(+), 0 deletions(-) mode change 100644 => 100755 share/ci/scripts/linux/dnf/install_docs_env.sh mode change 100644 => 100755 share/ci/scripts/linux/dnf/install_doxygen.sh mode change 100644 => 100755 share/ci/scripts/linux/dnf/install_tests_env.sh diff --git a/share/ci/scripts/linux/dnf/install_docs_env.sh b/share/ci/scripts/linux/dnf/install_docs_env.sh old mode 100644 new mode 100755 diff --git a/share/ci/scripts/linux/dnf/install_doxygen.sh b/share/ci/scripts/linux/dnf/install_doxygen.sh old mode 100644 new mode 100755 diff --git a/share/ci/scripts/linux/dnf/install_tests_env.sh b/share/ci/scripts/linux/dnf/install_tests_env.sh old mode 100644 new mode 100755 From 4a879cc1b445c797c1314a004bc647e0d03cfe95 Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Sat, 5 Jul 2025 01:18:43 -0400 Subject: [PATCH 23/36] special doxygen case for centos Signed-off-by: Michael Dolan --- share/ci/scripts/linux/apt/install_doxygen.sh | 2 +- share/ci/scripts/linux/dnf/install_doxygen.sh | 8 ++++++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/share/ci/scripts/linux/apt/install_doxygen.sh b/share/ci/scripts/linux/apt/install_doxygen.sh index 21439065bf..c30532a05e 100755 --- a/share/ci/scripts/linux/apt/install_doxygen.sh +++ b/share/ci/scripts/linux/apt/install_doxygen.sh @@ -6,7 +6,7 @@ set -ex DOXYGEN_VERSION="$1" -if [ "$DOXYGEN_VERSION" == "latest" ]; then +if [ "$DOXYGEN_VERSION" = "latest" ]; then apt-get install doxygen else apt-get install doxygen=${DOXYGEN_VERSION} diff --git a/share/ci/scripts/linux/dnf/install_doxygen.sh b/share/ci/scripts/linux/dnf/install_doxygen.sh index 28bf4c82c1..260c7e1540 100755 --- a/share/ci/scripts/linux/dnf/install_doxygen.sh +++ b/share/ci/scripts/linux/dnf/install_doxygen.sh @@ -7,7 +7,7 @@ set -ex DOXYGEN_VERSION="$1" if command -v dnf >/dev/null; then - if [ "$DOXYGEN_VERSION" == "latest" ]; then + if [ "$DOXYGEN_VERSION" = "latest" ]; then dnf install -y doxygen else dnf install -y doxygen-${DOXYGEN_VERSION} @@ -15,7 +15,11 @@ if command -v dnf >/dev/null; then else # Is some version of doxygen already available? if command -v doxygen >/dev/null; then - if [ "$DOXYGEN_VERSION" == "latest" ]; then + source /etc/os-release + if [ "$ID" = "centos" ]; then + # CentOS-7 was known to be compatible with this doxygen version + DOXYGEN_VERSION=1.8.5 + elif [ "$DOXYGEN_VERSION" = "latest" ]; then # Get latest doxygen version from GH DOXYGEN_VERSION=$( curl --silent https://api.github.com/repos/doxygen/doxygen/releases/latest | \ From 9086cb4aed9b305f6c63a2d8f2fc0796a3b818dc Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Sat, 5 Jul 2025 12:47:52 -0400 Subject: [PATCH 24/36] Trying doxygen 1.9.0 on centos-7 Signed-off-by: Michael Dolan --- share/ci/scripts/linux/dnf/install_doxygen.sh | 20 +++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/share/ci/scripts/linux/dnf/install_doxygen.sh b/share/ci/scripts/linux/dnf/install_doxygen.sh index 260c7e1540..94ed6aee76 100755 --- a/share/ci/scripts/linux/dnf/install_doxygen.sh +++ b/share/ci/scripts/linux/dnf/install_doxygen.sh @@ -6,8 +6,14 @@ set -ex DOXYGEN_VERSION="$1" +DOXYGEN_MAJOR_MINOR=$(echo "${DOXYGEN_VERSION}" | cut -d. -f-2) +DOXYGEN_MAJOR=$(echo "${DOXYGEN_VERSION}" | cut -d. -f-1) +DOXYGEN_MINOR=$(echo "${DOXYGEN_MAJOR_MINOR}" | cut -d. -f2-) +DOXYGEN_PATCH=$(echo "${DOXYGEN_VERSION}" | cut -d. -f3-) +DOXYGEN_VERSION_U="${DOXYGEN_MAJOR}_${DOXYGEN_MINOR}_${DOXYGEN_PATCH}" + if command -v dnf >/dev/null; then - if [ "$DOXYGEN_VERSION" = "latest" ]; then + if [ "$DOXYGEN_VERSION" == "latest" ]; then dnf install -y doxygen else dnf install -y doxygen-${DOXYGEN_VERSION} @@ -18,19 +24,21 @@ else source /etc/os-release if [ "$ID" = "centos" ]; then # CentOS-7 was known to be compatible with this doxygen version - DOXYGEN_VERSION=1.8.5 + DOXYGEN_VERSION=1.9.0 + DOXYGEN_VERSION_U=1_9_0 + elif [ "$DOXYGEN_VERSION" = "latest" ]; then # Get latest doxygen version from GH - DOXYGEN_VERSION=$( + DOXYGEN_VERSION_U=$( curl --silent https://api.github.com/repos/doxygen/doxygen/releases/latest | \ grep '"tag_name":' | \ - sed -E 's/.*"Release_([0-9_]+)".*/\1/' | \ - tr '_' '.' + sed -E 's/.*"Release_([0-9_]+)".*/\1/' ) + DOXYGEN_VERSION=$(tr $DOXYGEN_VERSION_U '_' '.') fi # Manual install - wget https://doxygen.nl/files/doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz + wget https://github.com/doxygen/doxygen/releases/download/Release_${DOXYGEN_VERSION_U}/doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz tar -xzf doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz cp doxygen-${DOXYGEN_VERSION}/bin/doxygen /usr/local/bin/ fi From fe3d03182b0a302e9e3d28ed70cec5a1bd71013a Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Sat, 5 Jul 2025 17:22:59 -0400 Subject: [PATCH 25/36] Try latest yum install of doxygen Signed-off-by: Michael Dolan --- share/ci/scripts/linux/dnf/install_doxygen.sh | 33 ++----------------- 1 file changed, 3 insertions(+), 30 deletions(-) diff --git a/share/ci/scripts/linux/dnf/install_doxygen.sh b/share/ci/scripts/linux/dnf/install_doxygen.sh index 94ed6aee76..a9c22cdb95 100755 --- a/share/ci/scripts/linux/dnf/install_doxygen.sh +++ b/share/ci/scripts/linux/dnf/install_doxygen.sh @@ -6,40 +6,13 @@ set -ex DOXYGEN_VERSION="$1" -DOXYGEN_MAJOR_MINOR=$(echo "${DOXYGEN_VERSION}" | cut -d. -f-2) -DOXYGEN_MAJOR=$(echo "${DOXYGEN_VERSION}" | cut -d. -f-1) -DOXYGEN_MINOR=$(echo "${DOXYGEN_MAJOR_MINOR}" | cut -d. -f2-) -DOXYGEN_PATCH=$(echo "${DOXYGEN_VERSION}" | cut -d. -f3-) -DOXYGEN_VERSION_U="${DOXYGEN_MAJOR}_${DOXYGEN_MINOR}_${DOXYGEN_PATCH}" - if command -v dnf >/dev/null; then if [ "$DOXYGEN_VERSION" == "latest" ]; then dnf install -y doxygen else dnf install -y doxygen-${DOXYGEN_VERSION} fi -else - # Is some version of doxygen already available? - if command -v doxygen >/dev/null; then - source /etc/os-release - if [ "$ID" = "centos" ]; then - # CentOS-7 was known to be compatible with this doxygen version - DOXYGEN_VERSION=1.9.0 - DOXYGEN_VERSION_U=1_9_0 - - elif [ "$DOXYGEN_VERSION" = "latest" ]; then - # Get latest doxygen version from GH - DOXYGEN_VERSION_U=$( - curl --silent https://api.github.com/repos/doxygen/doxygen/releases/latest | \ - grep '"tag_name":' | \ - sed -E 's/.*"Release_([0-9_]+)".*/\1/' - ) - DOXYGEN_VERSION=$(tr $DOXYGEN_VERSION_U '_' '.') - fi - - # Manual install - wget https://github.com/doxygen/doxygen/releases/download/Release_${DOXYGEN_VERSION_U}/doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz - tar -xzf doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz - cp doxygen-${DOXYGEN_VERSION}/bin/doxygen /usr/local/bin/ - fi +elif command -v doxygen >/dev/null; then + # Get any working version... + yum install -y doxygen fi From f75dca1030b9a4f063031f93eedcf2e0dd5fba02 Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Sat, 5 Jul 2025 17:39:25 -0400 Subject: [PATCH 26/36] Turn off docs on CentOS-7 builds Signed-off-by: Michael Dolan --- .github/workflows/ci_workflow.yml | 2 +- share/ci/scripts/linux/dnf/install_doxygen.sh | 5 +---- 2 files changed, 2 insertions(+), 5 deletions(-) diff --git a/.github/workflows/ci_workflow.yml b/.github/workflows/ci_workflow.yml index c69ef6bd64..aabacd089f 100644 --- a/.github/workflows/ci_workflow.yml +++ b/.github/workflows/ci_workflow.yml @@ -278,7 +278,7 @@ jobs: - build: 5 build-type: Release build-shared: 'ON' - build-docs: 'ON' + build-docs: 'OFF' build-openfx: 'ON' use-simd: 'OFF' use-oiio: 'OFF' diff --git a/share/ci/scripts/linux/dnf/install_doxygen.sh b/share/ci/scripts/linux/dnf/install_doxygen.sh index a9c22cdb95..bcf54e91d4 100755 --- a/share/ci/scripts/linux/dnf/install_doxygen.sh +++ b/share/ci/scripts/linux/dnf/install_doxygen.sh @@ -6,13 +6,10 @@ set -ex DOXYGEN_VERSION="$1" -if command -v dnf >/dev/null; then +if command -v doxygen >/dev/null; then if [ "$DOXYGEN_VERSION" == "latest" ]; then dnf install -y doxygen else dnf install -y doxygen-${DOXYGEN_VERSION} fi -elif command -v doxygen >/dev/null; then - # Get any working version... - yum install -y doxygen fi From a6386df507ee0032a0cb395ffacbf8beeb6bdf60 Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Sat, 5 Jul 2025 18:55:30 -0400 Subject: [PATCH 27/36] Add Windows CI with docs Signed-off-by: Michael Dolan --- .github/workflows/ci_workflow.yml | 4 ++-- share/ci/scripts/linux/dnf/install_doxygen.sh | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/ci_workflow.yml b/.github/workflows/ci_workflow.yml index aabacd089f..ca11822752 100644 --- a/.github/workflows/ci_workflow.yml +++ b/.github/workflows/ci_workflow.yml @@ -462,7 +462,7 @@ jobs: runs-on: macos-13 strategy: matrix: - build: [1, 2, 3, 4] + build: [1, 2, 3, 4, 5] include: - build: 5 arch-type: "x86_64" @@ -757,7 +757,7 @@ jobs: - build: 4 build-type: Release build-shared: 'ON' - build-docs: 'OFF' + build-docs: 'ON' build-openfx: 'ON' use-simd: 'OFF' use-oiio: 'ON' diff --git a/share/ci/scripts/linux/dnf/install_doxygen.sh b/share/ci/scripts/linux/dnf/install_doxygen.sh index bcf54e91d4..d6c588b059 100755 --- a/share/ci/scripts/linux/dnf/install_doxygen.sh +++ b/share/ci/scripts/linux/dnf/install_doxygen.sh @@ -6,7 +6,7 @@ set -ex DOXYGEN_VERSION="$1" -if command -v doxygen >/dev/null; then +if ! command -v doxygen >/dev/null; then if [ "$DOXYGEN_VERSION" == "latest" ]; then dnf install -y doxygen else From 7488fbbe523e22597f296accb453238c2a6b7f1b Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Sat, 5 Jul 2025 19:17:25 -0400 Subject: [PATCH 28/36] Use apt for linux wheel builds Signed-off-by: Michael Dolan --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 793353ff6d..bfc59e1248 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -27,7 +27,7 @@ test-command = [ ] [tool.cibuildwheel.linux] -before-build = "share/ci/scripts/linux/dnf/install_docs_env.sh" +before-build = "share/ci/scripts/linux/apt/install_docs_env.sh" [tool.cibuildwheel.macos] # cibuildwheel in some cases set this to 10.9 by default, OCIO needs >= 10.13 From c952235651b713ed95e91427a55053ccf60f9679 Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Sat, 5 Jul 2025 19:28:13 -0400 Subject: [PATCH 29/36] Testing linux distro on wheel builds Signed-off-by: Michael Dolan --- share/ci/scripts/linux/apt/install_docs_env.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/share/ci/scripts/linux/apt/install_docs_env.sh b/share/ci/scripts/linux/apt/install_docs_env.sh index 6460204155..524ddc662a 100755 --- a/share/ci/scripts/linux/apt/install_docs_env.sh +++ b/share/ci/scripts/linux/apt/install_docs_env.sh @@ -6,5 +6,6 @@ set -ex HERE=$(dirname $0) +cat /etc/os-release bash $HERE/install_doxygen.sh latest pip install -r $HERE/../../../../../docs/requirements.txt From e1c8c2546247d193015efe83bc5c6c5d4fd028bb Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Sat, 5 Jul 2025 21:32:14 -0400 Subject: [PATCH 30/36] Update yum repos on CentOS-7 Signed-off-by: Michael Dolan --- pyproject.toml | 2 +- .../ci/scripts/linux/apt/install_docs_env.sh | 1 - share/ci/scripts/linux/dnf/install_doxygen.sh | 40 +++++++++++++++++-- 3 files changed, 38 insertions(+), 5 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index bfc59e1248..793353ff6d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -27,7 +27,7 @@ test-command = [ ] [tool.cibuildwheel.linux] -before-build = "share/ci/scripts/linux/apt/install_docs_env.sh" +before-build = "share/ci/scripts/linux/dnf/install_docs_env.sh" [tool.cibuildwheel.macos] # cibuildwheel in some cases set this to 10.9 by default, OCIO needs >= 10.13 diff --git a/share/ci/scripts/linux/apt/install_docs_env.sh b/share/ci/scripts/linux/apt/install_docs_env.sh index 524ddc662a..6460204155 100755 --- a/share/ci/scripts/linux/apt/install_docs_env.sh +++ b/share/ci/scripts/linux/apt/install_docs_env.sh @@ -6,6 +6,5 @@ set -ex HERE=$(dirname $0) -cat /etc/os-release bash $HERE/install_doxygen.sh latest pip install -r $HERE/../../../../../docs/requirements.txt diff --git a/share/ci/scripts/linux/dnf/install_doxygen.sh b/share/ci/scripts/linux/dnf/install_doxygen.sh index d6c588b059..9957d138ad 100755 --- a/share/ci/scripts/linux/dnf/install_doxygen.sh +++ b/share/ci/scripts/linux/dnf/install_doxygen.sh @@ -7,9 +7,43 @@ set -ex DOXYGEN_VERSION="$1" if ! command -v doxygen >/dev/null; then - if [ "$DOXYGEN_VERSION" == "latest" ]; then - dnf install -y doxygen + if command -v dnf >/dev/null; then + if [ "$DOXYGEN_VERSION" == "latest" ]; then + dnf install -y doxygen + else + dnf install -y doxygen-${DOXYGEN_VERSION} + fi else - dnf install -y doxygen-${DOXYGEN_VERSION} + source /etc/os-release + if [ "$ID" = "centos" ]; then + mv /etc/yum.repos.d/CentOS-Base.repo /etc/yum.repos.d/CentOS-Base.repo.bak + tee /etc/yum.repos.d/CentOS-Vault.repo > /dev/null < Date: Sat, 5 Jul 2025 22:04:42 -0400 Subject: [PATCH 31/36] remove sudo Signed-off-by: Michael Dolan --- share/ci/scripts/linux/dnf/install_doxygen.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/share/ci/scripts/linux/dnf/install_doxygen.sh b/share/ci/scripts/linux/dnf/install_doxygen.sh index 9957d138ad..da5b52183b 100755 --- a/share/ci/scripts/linux/dnf/install_doxygen.sh +++ b/share/ci/scripts/linux/dnf/install_doxygen.sh @@ -36,8 +36,8 @@ baseurl=http://vault.centos.org/\$releasever/extras/\$basearch/ gpgcheck=1 gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-CentOS-\$releasever EOF - sudo yum clean all - sudo yum makecache + yum clean all + yum makecache fi if [ "$DOXYGEN_VERSION" == "latest" ]; then From d42c7ca03df68ebad2ffafb4c41af305f156aa86 Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Sat, 5 Jul 2025 23:44:47 -0400 Subject: [PATCH 32/36] Adjust CentOS-7 vault repo URLs Signed-off-by: Michael Dolan --- share/ci/scripts/linux/dnf/install_doxygen.sh | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/share/ci/scripts/linux/dnf/install_doxygen.sh b/share/ci/scripts/linux/dnf/install_doxygen.sh index da5b52183b..aeb6d8fc29 100755 --- a/share/ci/scripts/linux/dnf/install_doxygen.sh +++ b/share/ci/scripts/linux/dnf/install_doxygen.sh @@ -15,26 +15,26 @@ if ! command -v doxygen >/dev/null; then fi else source /etc/os-release - if [ "$ID" = "centos" ]; then + if [ "$ID" = "centos" ] && [ "$VERSION_ID" = "7" ]; then mv /etc/yum.repos.d/CentOS-Base.repo /etc/yum.repos.d/CentOS-Base.repo.bak tee /etc/yum.repos.d/CentOS-Vault.repo > /dev/null < Date: Sun, 6 Jul 2025 00:12:28 -0400 Subject: [PATCH 33/36] Add altarch doxygen handling Signed-off-by: Michael Dolan --- share/ci/scripts/linux/dnf/install_doxygen.sh | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/share/ci/scripts/linux/dnf/install_doxygen.sh b/share/ci/scripts/linux/dnf/install_doxygen.sh index aeb6d8fc29..58dcd5a5ba 100755 --- a/share/ci/scripts/linux/dnf/install_doxygen.sh +++ b/share/ci/scripts/linux/dnf/install_doxygen.sh @@ -16,23 +16,29 @@ if ! command -v doxygen >/dev/null; then else source /etc/os-release if [ "$ID" = "centos" ] && [ "$VERSION_ID" = "7" ]; then + if [ "$VERSION" = "7 (AltArch)" ]; then + BASE_DIR="altarch/7" + else + BASE_DIR="7.9.2009" + fi + mv /etc/yum.repos.d/CentOS-Base.repo /etc/yum.repos.d/CentOS-Base.repo.bak tee /etc/yum.repos.d/CentOS-Vault.repo > /dev/null < Date: Sun, 6 Jul 2025 16:17:45 -0400 Subject: [PATCH 34/36] Inspect Windows docs env Signed-off-by: Michael Dolan --- .github/workflows/ci_workflow.yml | 4 ++-- src/bindings/python/CMakeLists.txt | 3 +++ 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci_workflow.yml b/.github/workflows/ci_workflow.yml index ca11822752..6359ab8cec 100644 --- a/.github/workflows/ci_workflow.yml +++ b/.github/workflows/ci_workflow.yml @@ -757,7 +757,7 @@ jobs: - build: 4 build-type: Release build-shared: 'ON' - build-docs: 'ON' + build-docs: 'OFF' build-openfx: 'ON' use-simd: 'OFF' use-oiio: 'ON' @@ -766,7 +766,7 @@ jobs: - build: 3 build-type: Release build-shared: 'OFF' - build-docs: 'OFF' + build-docs: 'ON' build-openfx: 'OFF' use-simd: 'ON' use-oiio: 'OFF' diff --git a/src/bindings/python/CMakeLists.txt b/src/bindings/python/CMakeLists.txt index 94af56302e..fbee0d0a1a 100644 --- a/src/bindings/python/CMakeLists.txt +++ b/src/bindings/python/CMakeLists.txt @@ -10,6 +10,9 @@ if(OCIO_BUILD_DOCS) # Sets Python_PRE_CMD, which sets PATH and PYTHONPATH for Python get_python_pre_command() + message(STATUS, "${Python_PRE_CMD}") + message(STATUS, "${Python_EXECUTABLE}") + message(STATUS, "${EXTRACT_DOCSTRINGS_PY}") ########################################################################### ### Extract docstrings from C++ headers for Python bindings ### From c45cc0286571491049488d9ee5f2f8e6b80614d4 Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Sun, 6 Jul 2025 16:52:12 -0400 Subject: [PATCH 35/36] Remove status checks Signed-off-by: Michael Dolan --- src/bindings/python/CMakeLists.txt | 3 --- 1 file changed, 3 deletions(-) diff --git a/src/bindings/python/CMakeLists.txt b/src/bindings/python/CMakeLists.txt index fbee0d0a1a..94af56302e 100644 --- a/src/bindings/python/CMakeLists.txt +++ b/src/bindings/python/CMakeLists.txt @@ -10,9 +10,6 @@ if(OCIO_BUILD_DOCS) # Sets Python_PRE_CMD, which sets PATH and PYTHONPATH for Python get_python_pre_command() - message(STATUS, "${Python_PRE_CMD}") - message(STATUS, "${Python_EXECUTABLE}") - message(STATUS, "${EXTRACT_DOCSTRINGS_PY}") ########################################################################### ### Extract docstrings from C++ headers for Python bindings ### From d83c1fd0c04884b26497bc2680c80d2d4ceea5f1 Mon Sep 17 00:00:00 2001 From: Michael Dolan Date: Sun, 6 Jul 2025 17:15:00 -0400 Subject: [PATCH 36/36] Re-enable linux-old docs builds Signed-off-by: Michael Dolan --- .github/workflows/ci_workflow.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci_workflow.yml b/.github/workflows/ci_workflow.yml index 6359ab8cec..c4dc88b480 100644 --- a/.github/workflows/ci_workflow.yml +++ b/.github/workflows/ci_workflow.yml @@ -278,7 +278,7 @@ jobs: - build: 5 build-type: Release build-shared: 'ON' - build-docs: 'OFF' + build-docs: 'ON' build-openfx: 'ON' use-simd: 'OFF' use-oiio: 'OFF'