Skip to content

Commit b6d33f7

Browse files
remiaremia
authored
Update Python frozen docs (#2168)
* Remove excluded member Signed-off-by: Rémi Achard <remiachard@gmail.com> * Fix import errors Signed-off-by: Rémi Achard <remiachard@gmail.com> * Remove duplicated members Signed-off-by: Rémi Achard <remiachard@gmail.com> * Remove unused file Signed-off-by: Rémi Achard <remiachard@gmail.com> * Avoid package name duplication in Python documentation type hints Signed-off-by: Rémi Achard <remiachard@gmail.com> * Build frozen docs Signed-off-by: Rémi Achard <remiachard@gmail.com> --------- Signed-off-by: Rémi Achard <remiachard@gmail.com>
1 parent 6c15d45 commit b6d33f7

File tree

125 files changed

+593
-343
lines changed

Some content is hidden

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

125 files changed

+593
-343
lines changed

‎docs/api/python/frozen/pyopencolorio_allocation.rst‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
66
.. py:class:: Allocation
77
:module: PyOpenColorIO
8+
:canonical: PyOpenColorIO.Allocation
89

910
Members:
1011

@@ -14,8 +15,6 @@
1415

1516
ALLOCATION_LG2 :
1617

17-
.. py:method:: name() -> str
18-
:property:
1918

2019
.. py:attribute:: Allocation.ALLOCATION_LG2
2120
:module: PyOpenColorIO

‎docs/api/python/frozen/pyopencolorio_allocationtransform.rst‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
66
.. py:class:: AllocationTransform
77
:module: PyOpenColorIO
8+
:canonical: PyOpenColorIO.AllocationTransform
89

910
Forward direction wraps the 'expanded' range into the specified, often compressed, range.
1011

@@ -16,7 +17,7 @@
1617

1718
1. __init__(self: PyOpenColorIO.AllocationTransform) -> None
1819

19-
2. __init__(self: PyOpenColorIO.AllocationTransform, allocation: PyOpenColorIO.Allocation = <Allocation.ALLOCATION_UNIFORM: 1>, vars: List[float] = [], direction: PyOpenColorIO.TransformDirection = <TransformDirection.TRANSFORM_DIR_FORWARD: 0>) -> None
20+
2. __init__(self: PyOpenColorIO.AllocationTransform, allocation: PyOpenColorIO.Allocation = <Allocation.ALLOCATION_UNIFORM: 1>, vars: list[float] = [], direction: PyOpenColorIO.TransformDirection = <TransformDirection.TRANSFORM_DIR_FORWARD: 0>) -> None
2021

2122

2223
.. py:method:: AllocationTransform.getAllocation(self: PyOpenColorIO.AllocationTransform) -> PyOpenColorIO.Allocation
@@ -31,7 +32,7 @@
3132
:module: PyOpenColorIO
3233

3334

34-
.. py:method:: AllocationTransform.getVars(self: PyOpenColorIO.AllocationTransform) -> List[float]
35+
.. py:method:: AllocationTransform.getVars(self: PyOpenColorIO.AllocationTransform) -> list[float]
3536
:module: PyOpenColorIO
3637

3738

@@ -45,7 +46,7 @@
4546
Note that this only affects the evaluation and not the values stored in the object.
4647

4748

48-
.. py:method:: AllocationTransform.setVars(self: PyOpenColorIO.AllocationTransform, vars: List[float]) -> None
49+
.. py:method:: AllocationTransform.setVars(self: PyOpenColorIO.AllocationTransform, vars: list[float]) -> None
4950
:module: PyOpenColorIO
5051

5152

‎docs/api/python/frozen/pyopencolorio_baker.rst‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
66
.. py:class:: Baker
77
:module: PyOpenColorIO
8+
:canonical: PyOpenColorIO.Baker
89

910
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.
1011

@@ -20,8 +21,8 @@
2021
baker->setShaperSpace("log");
2122
baker->setTargetSpace("sRGB");
2223
auto & metadata = baker->getFormatMetadata();
23-
metadata.addChildElement(:ref:`OCIO::METADATA_DESCRIPTION`, "A first comment");
24-
metadata.addChildElement(:ref:`OCIO::METADATA_DESCRIPTION`, "A second comment");
24+
metadata.addChildElement(OCIO::METADATA_DESCRIPTION, "A first comment");
25+
metadata.addChildElement(OCIO::METADATA_DESCRIPTION, "A second comment");
2526
std::ostringstream out;
2627
baker->bake(out); // fresh bread anyone!
2728
std::cout << out.str();
@@ -147,7 +148,7 @@
147148
.. py:method:: Baker.setShaperSpace(self: PyOpenColorIO.Baker, shaperSpace: str) -> None
148149
:module: PyOpenColorIO
149150

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.
151+
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.
151152

152153

153154
.. py:method:: Baker.setTargetSpace(self: PyOpenColorIO.Baker, targetSpace: str) -> None
@@ -158,6 +159,7 @@
158159

159160
.. py:class:: FormatIterator
160161
:module: PyOpenColorIO.Baker
162+
:canonical: PyOpenColorIO.Baker.FormatIterator
161163

162164
Iterator on LUT baker Formats.
163165

‎docs/api/python/frozen/pyopencolorio_bitdepth.rst‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
66
.. py:class:: BitDepth
77
:module: PyOpenColorIO
8+
:canonical: PyOpenColorIO.BitDepth
89

910
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.
1011

@@ -28,8 +29,6 @@
2829

2930
BIT_DEPTH_F32 :
3031

31-
.. py:method:: name() -> str
32-
:property:
3332

3433
.. py:attribute:: BitDepth.BIT_DEPTH_F16
3534
:module: PyOpenColorIO

‎docs/api/python/frozen/pyopencolorio_builtintransform.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
66
.. py:class:: BuiltinTransform
77
:module: PyOpenColorIO
8+
:canonical: PyOpenColorIO.BuiltinTransform
89

910
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.
1011

‎docs/api/python/frozen/pyopencolorio_builtintransformregistry.rst‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
66
.. py:class:: BuiltinTransformRegistry
77
:module: PyOpenColorIO
8+
:canonical: PyOpenColorIO.BuiltinTransformRegistry
89

910
The built-in transform registry contains all the existing built-in transforms which can be used by a configuration (version 2 or higher only).
1011

@@ -21,6 +22,7 @@
2122

2223
.. py:class:: BuiltinStyleIterator
2324
:module: PyOpenColorIO.BuiltinTransformRegistry
25+
:canonical: PyOpenColorIO.BuiltinTransformRegistry.BuiltinStyleIterator
2426

2527

2628
.. py:method:: BuiltinStyleIterator.__getitem__(self: PyOpenColorIO.BuiltinTransformRegistry.BuiltinStyleIterator, arg0: int) -> str
@@ -41,6 +43,7 @@
4143

4244
.. py:class:: BuiltinIterator
4345
:module: PyOpenColorIO.BuiltinTransformRegistry
46+
:canonical: PyOpenColorIO.BuiltinTransformRegistry.BuiltinIterator
4447

4548

4649
.. py:method:: BuiltinIterator.__getitem__(self: PyOpenColorIO.BuiltinTransformRegistry.BuiltinIterator, arg0: int) -> tuple

‎docs/api/python/frozen/pyopencolorio_cdlstyle.rst‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
66
.. py:class:: CDLStyle
77
:module: PyOpenColorIO
8+
:canonical: PyOpenColorIO.CDLStyle
89

910
Members:
1011

@@ -14,8 +15,6 @@
1415

1516
CDL_TRANSFORM_DEFAULT :
1617

17-
.. py:method:: name() -> str
18-
:property:
1918

2019
.. py:attribute:: CDLStyle.CDL_ASC
2120
:module: PyOpenColorIO

‎docs/api/python/frozen/pyopencolorio_cdltransform.rst‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
66
.. py:class:: CDLTransform
77
:module: PyOpenColorIO
8+
:canonical: PyOpenColorIO.CDLTransform
89

910
An implementation of the ASC Color Decision List (CDL), based on the ASC v1.2 specification.
1011

@@ -45,7 +46,7 @@
4546

4647
2. __init__(self: PyOpenColorIO.CDLTransform, direction: PyOpenColorIO.TransformDirection = <TransformDirection.TRANSFORM_DIR_FORWARD: 0>) -> None
4748

48-
3. __init__(self: PyOpenColorIO.CDLTransform, slope: List[float[3]] = [1.0, 1.0, 1.0], offset: List[float[3]] = [0.0, 0.0, 0.0], power: List[float[3]] = [1.0, 1.0, 1.0], sat: float = 1.0, id: str = '', description: str = '', direction: PyOpenColorIO.TransformDirection = <TransformDirection.TRANSFORM_DIR_FORWARD: 0>) -> None
49+
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 = <TransformDirection.TRANSFORM_DIR_FORWARD: 0>) -> None
4950

5051

5152
.. py:method:: CDLTransform.equals(self: PyOpenColorIO.CDLTransform, other: PyOpenColorIO.CDLTransform) -> bool
@@ -70,29 +71,29 @@
7071
The get/setID methods are now deprecated. The preferred way of interacting with the ID is now via the transform's formatMetadata.
7172

7273

73-
.. py:method:: CDLTransform.getOffset(self: PyOpenColorIO.CDLTransform) -> List[float[3]]
74+
.. py:method:: CDLTransform.getOffset(self: PyOpenColorIO.CDLTransform) -> Annotated[list[float], FixedSize(3)]
7475
:module: PyOpenColorIO
7576

7677

77-
.. py:method:: CDLTransform.getPower(self: PyOpenColorIO.CDLTransform) -> List[float[3]]
78+
.. py:method:: CDLTransform.getPower(self: PyOpenColorIO.CDLTransform) -> Annotated[list[float], FixedSize(3)]
7879
:module: PyOpenColorIO
7980

8081

81-
.. py:method:: CDLTransform.getSOP(self: PyOpenColorIO.CDLTransform) -> List[float[9]]
82+
.. py:method:: CDLTransform.getSOP(self: PyOpenColorIO.CDLTransform) -> Annotated[list[float], FixedSize(9)]
8283
:module: PyOpenColorIO
8384

8485

8586
.. py:method:: CDLTransform.getSat(self: PyOpenColorIO.CDLTransform) -> float
8687
:module: PyOpenColorIO
8788

8889

89-
.. py:method:: CDLTransform.getSatLumaCoefs(self: PyOpenColorIO.CDLTransform) -> List[float[3]]
90+
.. py:method:: CDLTransform.getSatLumaCoefs(self: PyOpenColorIO.CDLTransform) -> Annotated[list[float], FixedSize(3)]
9091
:module: PyOpenColorIO
9192

9293
These are hard-coded, by spec, to r709.
9394

9495

95-
.. py:method:: CDLTransform.getSlope(self: PyOpenColorIO.CDLTransform) -> List[float[3]]
96+
.. py:method:: CDLTransform.getSlope(self: PyOpenColorIO.CDLTransform) -> Annotated[list[float], FixedSize(3)]
9697
:module: PyOpenColorIO
9798

9899

@@ -118,23 +119,23 @@
118119
:module: PyOpenColorIO
119120

120121

121-
.. py:method:: CDLTransform.setOffset(self: PyOpenColorIO.CDLTransform, rgb: List[float[3]]) -> None
122+
.. py:method:: CDLTransform.setOffset(self: PyOpenColorIO.CDLTransform, rgb: Annotated[list[float], FixedSize(3)]) -> None
122123
:module: PyOpenColorIO
123124

124125

125-
.. py:method:: CDLTransform.setPower(self: PyOpenColorIO.CDLTransform, rgb: List[float[3]]) -> None
126+
.. py:method:: CDLTransform.setPower(self: PyOpenColorIO.CDLTransform, rgb: Annotated[list[float], FixedSize(3)]) -> None
126127
:module: PyOpenColorIO
127128

128129

129-
.. py:method:: CDLTransform.setSOP(self: PyOpenColorIO.CDLTransform, vec9: List[float[9]]) -> None
130+
.. py:method:: CDLTransform.setSOP(self: PyOpenColorIO.CDLTransform, vec9: Annotated[list[float], FixedSize(9)]) -> None
130131
:module: PyOpenColorIO
131132

132133

133134
.. py:method:: CDLTransform.setSat(self: PyOpenColorIO.CDLTransform, sat: float) -> None
134135
:module: PyOpenColorIO
135136

136137

137-
.. py:method:: CDLTransform.setSlope(self: PyOpenColorIO.CDLTransform, rgb: List[float[3]]) -> None
138+
.. py:method:: CDLTransform.setSlope(self: PyOpenColorIO.CDLTransform, rgb: Annotated[list[float], FixedSize(3)]) -> None
138139
:module: PyOpenColorIO
139140

140141

‎docs/api/python/frozen/pyopencolorio_channelordering.rst‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
66
.. py:class:: ChannelOrdering
77
:module: PyOpenColorIO
8+
:canonical: PyOpenColorIO.ChannelOrdering
89

910
Used by :ref:`PackedImageDesc` to indicate the channel ordering of the image to process.
1011

@@ -20,8 +21,6 @@
2021

2122
CHANNEL_ORDERING_BGR :
2223

23-
.. py:method:: name() -> str
24-
:property:
2524

2625
.. py:attribute:: ChannelOrdering.CHANNEL_ORDERING_ABGR
2726
:module: PyOpenColorIO

‎docs/api/python/frozen/pyopencolorio_clearallcaches.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,5 @@
1111
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.
1212

1313
.. note::
14-
The method does not apply to instance specific caches such as the processor cache in a config instance or the GPU and CPU processor caches in a processor instance. Here deleting the instance flushes the cache.
14+
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.
1515

0 commit comments

Comments
 (0)