[Bf-docboard-svn] bf-manual: [9814] trunk/blender_docs/manual/render: Add documentation for OptiX OSL support

[Aaron Carlisle]

Revision: 9814
          https://developer.blender.org/rBM9814
Author:   Blendify
Date:     2022-12-21 01:49:07 +0100 (Wed, 21 Dec 2022)
Log Message:
-----------
Add documentation for OptiX OSL support

Author: @Alaska

Differential Revision: https://developer.blender.org/D16810

Modified Paths:
--------------
    trunk/blender_docs/manual/render/cycles/gpu_rendering.rst
    trunk/blender_docs/manual/render/shader_nodes/osl.rst

Modified: trunk/blender_docs/manual/render/cycles/gpu_rendering.rst
===================================================================
--- trunk/blender_docs/manual/render/cycles/gpu_rendering.rst	2022-12-18 14:39:49 UTC (rev 9813)
+++ trunk/blender_docs/manual/render/cycles/gpu_rendering.rst	2022-12-21 00:49:07 UTC (rev 9814)
@@ -22,9 +22,10 @@
 
 .. note::
 
-   :doc:`/render/shader_nodes/osl` and :ref:`path guiding <bpy.types.CyclesRenderSettings.use_guiding>`
-   are not supported when rendering on the GPU.
+   :ref:`Path Guiding <bpy.types.CyclesRenderSettings.use_guiding>` is not supported
+   when rendering on the GPU.
 
+
 CUDA -- NVIDIA
 --------------
 
@@ -33,7 +34,9 @@
 see the `list of Nvidia graphics cards <https://developer.nvidia.com/cuda-gpus#compute>`__
 with the compute capabilities and supported graphics cards.
 
+.. note:: :doc:`/render/shader_nodes/osl` is not supported.
 
+
 .. _render-cycles-gpu-optix:
 
 OptiX -- NVIDIA
@@ -44,7 +47,12 @@
 see the `list of Nvidia graphics cards <https://developer.nvidia.com/cuda-gpus#compute>`__
 OptiX works best on RTX graphics cards with hardware ray tracing support (e.g. Turing and above).
 
+.. note::
 
+   :doc:`/render/shader_nodes/osl` is supported with a few limitations.
+   Refer to the :doc:`/render/shader_nodes/osl` documentation for a list of limitations.
+
+
 HIP -- AMD
 ----------
 
@@ -69,9 +77,12 @@
 Please refer to `AMD's website <https://www.amd.com/en/graphics>`__ for more
 information about AMD graphics cards and their architectures.
 
-.. note:: The *Clip* extension mode in the :doc:`/render/shader_nodes/textures/image` is not supported.
+.. note::
 
+   :doc:`/render/shader_nodes/osl` and the *Clip* extension mode in the
+   :doc:`/render/shader_nodes/textures/image` are not supported.
 
+
 oneAPI -- Intel
 ---------------
 
@@ -90,7 +101,9 @@
 Please refer to `Intel's website <https://www.intel.com/content/www/us/en/products/details/discrete-gpus.html>`__
 for more information about Intel graphics cards and their architectures.
 
+.. note:: :doc:`/render/shader_nodes/osl` is not supported.
 
+
 Metal -- Apple (macOS)
 ----------------------
 
@@ -100,7 +113,9 @@
 Apple Silicon and AMD graphics cards also work on macOS 12.3 and newer, however
 without support for :ref:`MNEE caustics <bpy.types.CyclesObjectSettings.is_caustics_caster>`.
 
+.. note:: :doc:`/render/shader_nodes/osl` is not supported.
 
+
 Frequently Asked Questions
 ==========================
 

Modified: trunk/blender_docs/manual/render/shader_nodes/osl.rst
===================================================================
--- trunk/blender_docs/manual/render/shader_nodes/osl.rst	2022-12-18 14:39:49 UTC (rev 9813)
+++ trunk/blender_docs/manual/render/shader_nodes/osl.rst	2022-12-21 00:49:07 UTC (rev 9814)
@@ -7,12 +7,20 @@
 
 It is also possible to create your own nodes using
 `Open Shading Language <https://github.com/AcademySoftwareFoundation/OpenShadingLanguage>`__ (OSL).
-Note that these nodes will only work for CPU rendering;
-there is no support for running OSL code on the GPU.
+These nodes will only work with the CPU and OptiX rendering backend.
 
 To enable it, select *Open Shading Language* as the shading system in the render settings.
 
+.. note::
+   
+   Some OSL features are not available when using the OptiX backend. Examples include: 
+   
+   - Images can not be loaded from inside a OSL script. An :doc:`/render/shader_nodes/textures/image`
+     must be used instead.
+   - Some noise functions are not available. Examples include *Cell*, *Simplex*, and *Gabor*.
+   - The :ref:`trace <render-shader-nodes-osl-trace>` function can't be used.
 
+
 .. _bpy.types.ShaderNodeScript:
 
 Script Node
@@ -198,16 +206,18 @@
 ``particle:angular_velocity``
    Angular velocity of the particle.
 
+.. _render-shader-nodes-osl-trace:
 
 Trace
 =====
 
-We support the ``trace(point pos, vector dir, ...)``
-function, to trace rays from the OSL shader.
-The "shade" parameter is not supported currently,
-but attributes can be retrieved from the object that was hit using the ``getmessage("trace", ..)`` function.
-See the OSL specification for details on how to use this.
+:guilabel:`CPU Only`
 
+We support the ``trace(point pos, vector dir, ...)`` function,
+to trace rays from the OSL shader. The "shade" parameter is not supported currently,
+but attributes can be retrieved from the object that was hit using the
+``getmessage("trace", ..)`` function. See the OSL specification for details on how to use this.
+
 This function cannot be used instead of lighting;
 the main purpose is to allow shaders to "probe" nearby geometry,
 for example to apply a projected texture that can be blocked by geometry,