Skip to content

Missing docs update for new texture dimensions API. #1833

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
doug-walker merged 4 commits into from
Aug 30, 2023
Merged

Missing docs update for new texture dimensions API. #1833

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5584e7a
Missing docs update for new texture dimensions API.
num3ric Aug 28, 2023
eb93a86
Merge branch 'main' into docs_update
michdolan Aug 29, 2023
095efbc
Further docs update through using frozen docs generation.
num3ric Aug 29, 2023
fa30eee
Merge branch 'main' into docs_update
doug-walker Aug 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions docs/api/python/frozen/pyopencolorio_gpushadercreator.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
63 changes: 61 additions & 2 deletions docs/api/python/frozen/pyopencolorio_gpushaderdesc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down