Missing docs update for new texture dimensions API. (#1833)

* Missing docs update for new texture dimensions API.

Signed-off-by: Eric Renaud-Houde <[email protected]>

* Further docs update through using frozen docs generation.

Signed-off-by: Eric Renaud-Houde <[email protected]>

---------

Signed-off-by: Eric Renaud-Houde <[email protected]>
Co-authored-by: Michael Dolan <[email protected]>
Co-authored-by: Doug Walker <[email protected]>

Author: 3 people

docs/api/python/frozen/pyopencolorio_gpushadercreator.rst

@@ -50,6 +50,47 @@
        }                                     //
 
 
+   .. py:attribute:: GpuShaderCreator.TEXTURE_1D
+      :module: PyOpenColorIO
+      :value: <TextureDimensions.TEXTURE_1D: 1>
+
+
+   .. py:attribute:: GpuShaderCreator.TEXTURE_2D
+      :module: PyOpenColorIO
+      :value: <TextureDimensions.TEXTURE_2D: 2>
+
+
+   .. 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: <TextureDimensions.TEXTURE_1D: 1>
+
+
+      .. py:attribute:: GpuShaderCreator.TextureDimensions.TEXTURE_2D
+         :module: PyOpenColorIO
+         :value: <TextureDimensions.TEXTURE_2D: 2>
+
+
+      .. 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
 
@@ -99,6 +140,10 @@
       :module: PyOpenColorIO
 
 
+   .. py:method:: GpuShaderCreator.getAllowTexture1D(self: PyOpenColorIO.GpuShaderCreator) -> bool
+      :module: PyOpenColorIO
+
+
    .. py:method:: GpuShaderCreator.getCacheID(self: PyOpenColorIO.GpuShaderCreator) -> str
       :module: PyOpenColorIO
 
@@ -148,6 +193,12 @@
       :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
 

docs/api/python/frozen/pyopencolorio_gpushaderdesc.rst

@@ -146,6 +146,51 @@
       Create the default shader description.
 
 
+   .. py:attribute:: GpuShaderDesc.TEXTURE_1D
+      :module: PyOpenColorIO
+      :value: <TextureDimensions.TEXTURE_1D: 1>
+
+
+   .. py:attribute:: GpuShaderDesc.TEXTURE_2D
+      :module: PyOpenColorIO
+      :value: <TextureDimensions.TEXTURE_2D: 2>
+
+
+   .. 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: <TextureDimensions.TEXTURE_1D: 1>
+
+
+      .. py:attribute:: GpuShaderDesc.TextureDimensions.TEXTURE_2D
+         :module: PyOpenColorIO
+         :value: <TextureDimensions.TEXTURE_2D: 2>
+
+
+      .. 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
 
@@ -159,10 +204,10 @@
          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, interpolation: PyOpenColorIO.Interpolation, values: buffer) -> None
+   .. 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 2D texture (1D texture if height equals 1).
+      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.
@@ -221,6 +266,10 @@
       :module: PyOpenColorIO
 
 
+   .. py:method:: GpuShaderDesc.getAllowTexture1D(self: PyOpenColorIO.GpuShaderCreator) -> bool
+      :module: PyOpenColorIO
+
+
    .. py:method:: GpuShaderDesc.getCacheID(self: PyOpenColorIO.GpuShaderCreator) -> str
       :module: PyOpenColorIO
 
@@ -284,6 +333,12 @@
       :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
 
@@ -379,6 +434,10 @@
       :module: PyOpenColorIO.GpuShaderDesc
 
 
+   .. py:property:: Texture.dimensions
+      :module: PyOpenColorIO.GpuShaderDesc
+
+
    .. py:method:: Texture.getValues(self: PyOpenColorIO.GpuShaderDesc.Texture) -> numpy.ndarray
       :module: PyOpenColorIO.GpuShaderDesc