Skip to content

Commit 9a82ddb

Browse files
authored
Add NamedTransform Processor constructors (#1689)
* Add NamedTransform Processor constructors Signed-off-by: Michael Dolan <[email protected]> * Update frozen Python API docs Signed-off-by: Michael Dolan <[email protected]> * Add NamedTransform::GetTransform static function to public API Signed-off-by: Michael Dolan <[email protected]> * Move function from NamedTransformImpl to NamedTransform Signed-off-by: Michael Dolan <[email protected]> * Update Python frozen rst with API changes Signed-off-by: Michael Dolan <[email protected]> * Update comment and variable naming Signed-off-by: Michael Dolan <[email protected]> Signed-off-by: Michael Dolan <[email protected]>
1 parent b236bd8 commit 9a82ddb

File tree

58 files changed

+1169
-255
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+1169
-255
lines changed

docs/api/python/frozen/pyopencolorio_allocation.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,7 @@
3131
:module: PyOpenColorIO
3232
:value: <Allocation.ALLOCATION_UNKNOWN: 0>
3333

34+
35+
.. py:property:: Allocation.value
36+
:module: PyOpenColorIO
37+

docs/api/python/frozen/pyopencolorio_baker.rst

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,10 @@
6161
:module: PyOpenColorIO
6262

6363

64+
.. py:method:: Baker.getDisplay(self: PyOpenColorIO.Baker) -> str
65+
:module: PyOpenColorIO
66+
67+
6468
.. py:method:: Baker.getFormat(self: PyOpenColorIO.Baker) -> str
6569
:module: PyOpenColorIO
6670

@@ -94,6 +98,10 @@
9498
:module: PyOpenColorIO
9599

96100

101+
.. py:method:: Baker.getView(self: PyOpenColorIO.Baker) -> str
102+
:module: PyOpenColorIO
103+
104+
97105
.. py:method:: Baker.setConfig(self: PyOpenColorIO.Baker, config: PyOpenColorIO.Config) -> None
98106
:module: PyOpenColorIO
99107

@@ -103,7 +111,13 @@
103111
.. py:method:: Baker.setCubeSize(self: PyOpenColorIO.Baker, cubeSize: int) -> None
104112
:module: PyOpenColorIO
105113

106-
Override the default cube sample size. default: <format specific>
114+
Override the main LUT (3d or 1d) sample size. Default value is -1, which allows each format to use its own most appropriate size.
115+
116+
117+
.. py:method:: Baker.setDisplayView(self: PyOpenColorIO.Baker, display: str, view: str) -> None
118+
:module: PyOpenColorIO
119+
120+
Set the display and view to apply during the baking. Must not be used if setTargetSpace is used.
107121

108122

109123
.. py:method:: Baker.setFormat(self: PyOpenColorIO.Baker, formatName: str) -> None
@@ -133,13 +147,13 @@
133147
.. py:method:: Baker.setShaperSpace(self: PyOpenColorIO.Baker, shaperSpace: str) -> None
134148
:module: PyOpenColorIO
135149

136-
Set an *optional* :ref:`ColorSpace` to be used to shape / transfer the input colorspace. This is mostly used to allocate an HDR luminance range into an LDR one. If a shaper space is not explicitly specified, and the file format supports one, the :ref:`ColorSpace` Allocation will be used (not implemented for all formats).
150+
Set an *optional* :ref:`ColorSpace` to shape the incoming values of the LUT. When baking 3DLUT, this will correspond to the 1D shaper used to normalise incoming values to the unit range. When baking 1D LUT, this will be used to determine the input range of the LUT.
137151

138152

139153
.. py:method:: Baker.setTargetSpace(self: PyOpenColorIO.Baker, targetSpace: str) -> None
140154
:module: PyOpenColorIO
141155

142-
Set the target device colorspace for the LUT.
156+
Set the target (i.e., output) color space for the LUT. Must not be used if setDisplayView is used.
143157

144158

145159
.. py:class:: FormatIterator

docs/api/python/frozen/pyopencolorio_bitdepth.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222

2323
BIT_DEPTH_UINT16 :
2424

25-
BIT_DEPTH_UINT32 :
25+
BIT_DEPTH_UINT32 : Here for historical reason but that's not supported.
2626

2727
BIT_DEPTH_F16 :
2828

@@ -75,3 +75,7 @@
7575
:module: PyOpenColorIO
7676
:value: <BitDepth.BIT_DEPTH_UNKNOWN: 0>
7777

78+
79+
.. py:property:: BitDepth.value
80+
:module: PyOpenColorIO
81+

docs/api/python/frozen/pyopencolorio_cdlstyle.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,7 @@
3131
:module: PyOpenColorIO
3232
:value: <CDLStyle.CDL_NO_CLAMP: 1>
3333

34+
35+
.. py:property:: CDLStyle.value
36+
:module: PyOpenColorIO
37+

docs/api/python/frozen/pyopencolorio_channelordering.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,7 @@
4747
:module: PyOpenColorIO
4848
:value: <ChannelOrdering.CHANNEL_ORDERING_RGBA: 0>
4949

50+
51+
.. py:property:: ChannelOrdering.value
52+
:module: PyOpenColorIO
53+

docs/api/python/frozen/pyopencolorio_colorspace.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@
1010

1111
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).
1212

13-
*ColorSpaces* are specific to a particular image precision (float32, uint8, etc.), and the set of ColorSpaces that provide equivalent mappings (at different precisions) are referred to as a 'family'.
14-
1513

1614
.. py:method:: ColorSpace.__init__(*args, **kwargs)
1715
:module: PyOpenColorIO
@@ -97,7 +95,7 @@
9795
.. py:method:: ColorSpace.getEqualityGroup(self: PyOpenColorIO.ColorSpace) -> str
9896
:module: PyOpenColorIO
9997

100-
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). This is often, though not always, set to the same value as 'family'.
98+
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).
10199

102100

103101
.. py:method:: ColorSpace.getFamily(self: PyOpenColorIO.ColorSpace) -> str

docs/api/python/frozen/pyopencolorio_colorspacedirection.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,7 @@
2424
:module: PyOpenColorIO
2525
:value: <ColorSpaceDirection.COLORSPACE_DIR_TO_REFERENCE: 0>
2626

27+
28+
.. py:property:: ColorSpaceDirection.value
29+
:module: PyOpenColorIO
30+

docs/api/python/frozen/pyopencolorio_colorspacevisibility.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,7 @@
3131
:module: PyOpenColorIO
3232
:value: <ColorSpaceVisibility.COLORSPACE_INACTIVE: 1>
3333

34+
35+
.. py:property:: ColorSpaceVisibility.value
36+
:module: PyOpenColorIO
37+

0 commit comments

Comments
 (0)