blender/doc/python_api
Shashank Shekhar 90298c24a2 EEVEE & Viewport: Add a built-in shader called 3D_IMAGE, and expose to the python API
Adds an example python script to the documentation for the 3D_IMAGE shader.

The **use-case** is to draw textures with 3D vertex positions, in XR views as well as non-XR views (in a simpler manner).

**Testing**: I've tested that this compiles and works on my Macbook (with the example python script included in this change). I don't have access to a Windows or Linux machine right now, but this change doesn't look platform-specific and no new glsl shaders have been added or edited by this change. I'll try to get access to a Windows machine, but if someone does have one, I'd be really grateful if they could try this change. Thanks!

**Problem addressed**: The existing 2D_IMAGE shader (exposed in the python API) gets near-clipped when drawn in the
XR view, regardless of the near-clip settings. Additionally, the 2D_IMAGE shader only accepts 2D
positions for the image vertices, which means drawing textures in 3D requires providing
2D coordinates and then pushing a transform-rotate-scale matrix to the GPU, even for
non-XR (i.e. WINDOW) views. The 3D_IMAGE shader is simpler: it accepts 3D vertex positions, and doesn't require
any additional work by the scripter.

**Workaround**: The current workaround is to use custom shaders in the python script.

**Non-intrusive change**: No new glsl shaders were added. This change just bundles two existing shaders: the vertex shader used
by the 3D_IMAGE_MODULATE_ALPHA shader, and the fragment shader used by the 2D_IMAGE shader.

Reviewed By: #eevee_viewport, jbakker

Differential Revision: https://developer.blender.org/D14832
2022-05-09 08:07:37 +02:00
..
examples EEVEE & Viewport: Add a built-in shader called 3D_IMAGE, and expose to the python API 2022-05-09 08:07:37 +02:00
rst Cleanup: Use correct capitalization of "F-Curve" 2022-04-18 20:17:41 -04:00
static Python API Docs: Hide version swtich 2022-02-22 14:39:51 -05:00
templates Py Docs: Implement version switch to switch between versions on the website 2022-02-03 14:25:26 -05:00
requirements.txt PyDocs: Update theme to latest version 2021-09-14 23:16:38 -04:00
rst_from_bmesh_opdefines.py File headers: SPDX License migration 2022-02-11 09:14:36 +11:00
sphinx_changelog_gen.py File headers: SPDX License migration 2022-02-11 09:14:36 +11:00
sphinx_doc_gen.py Cleanup: run autopep8 with max-line-length=120 2022-04-20 15:47:24 +10:00
sphinx_doc_gen_monkeypatch.py File headers: SPDX License migration 2022-02-11 09:14:36 +11:00