blender/doc
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
..
blender_file_format Cleanup: autopep8 2022-04-26 15:03:04 +10:00
doxygen Blender 3.3 bcon1 - alpha 2022-05-02 10:28:30 +02:00
guides Spelling fixes in comments and descriptions, patch by luzpaz 2019-07-31 14:27:35 +02:00
license Docs: add license text file for LGPL2.1 2022-03-18 10:27:01 +11:00
manpage Cleanup: run autopep8 on doc/ 2022-04-20 15:10:14 +10:00
python_api EEVEE & Viewport: Add a built-in shader called 3D_IMAGE, and expose to the python API 2022-05-09 08:07:37 +02:00