update docs

Author: robertsulej

plotoptix/enums.py

@@ -25,8 +25,9 @@ class MissProgram(Enum):
 
     Miss program is executed when ray segment is not intersecting any object
     at a defined maximum distance. Radiance assigned to the ray by the miss
-    program appears as a color of the background (e.g. on primary segments)
-    or environmental light color (segments scattered off a diffuse surfaces).
+    program appears as a color of the background (i.e. on primary segments)
+    or environmental light color (segments scattered off a diffuse surfaces)
+    or sub-surface color (segments scattered inside volumes).
 
     See Also
     --------

plotoptix/materials.py

@@ -12,7 +12,7 @@
       "OcclusionProgram": "materials7.ptx::__closesthit__occlusion",
     }
 """
-Super-fast material, color is not shaded anyhow. Use color components range <0; 1>.
+Super-fast material, color is not shaded anyhow. Use color components range ``<0; 1>``.
 """
 
 m_eye_normal_cos = {
@@ -21,7 +21,7 @@
     }
 """
 Fast material, color is shaded by the cos(eye-hit-normal). Use color components range
-<0; 1>.
+``<0; 1>``.
 """
 
 m_diffuse = {
@@ -31,7 +31,7 @@
     }
 """
 Lambertian diffuse material. Note it is available by default under the name "diffuse".
-Use color components range <0; 1>.
+Use color components range ``<0; 1>``.
 """
 
 m_matt_diffuse = {
@@ -41,7 +41,7 @@
       "VarFloat": { "base_roughness": 1 }
     }
 """
-Oren-Nayar diffuse material. Surface roughness range is <0; inf), 0 is equivalent to
+Oren-Nayar diffuse material. Surface roughness range is ``<0; inf)``, 0 is equivalent to
 the Lambertian "diffuse" material.
 """
 
@@ -68,7 +68,7 @@
 Reflective mirror, quite simple to calculate and therefore fast material. Note, this material
 has default values: ``reflectivity_index = 1`` and ``reflectivity_range = 1``. In this configuration
 the shading algorithm overrides ``surface_albedo`` with the color assigned to each primitive (RGB
-range <0; 1>), which results with colorized reflections.
+range ``<0; 1>``), which results with colorized reflections.
 """
 
 m_metallic = {
@@ -168,7 +168,12 @@
     }
 """
 Glass, with reflection and refraction simulated. Color components meaning is "attenuation length"
-and the color range is <0; inf>.
+and the color range is <0; inf>. Set ``radiation_length > 0`` to enable sub-surface scattering. It
+is supported in background modes :attr:`plotoptix.enums.MissProgram.AmbientAndVolume`,
+:attr:`plotoptix.enums.MissProgram.TextureFixed` and :attr:`plotoptix.enums.MissProgram.TextureEnvironment`,
+see also :meth:`plotoptix.NpOptiX.set_background_mode`. Use ``subsurface_color`` to set diffuse color of
+scattering (RGB components range should be ``<0; 1>``). Volumes can emit light in  ``subsurface_color``
+if ``light_emission > 0``.
 """
 
 m_matt_glass = {
@@ -188,7 +193,12 @@
     }
 """
 Glass with surface roughness configured to obtain matt appearance. Color components meaning is
-"attenuation length" and the color range is <0; inf>.
+"attenuation length" and the color range is <0; inf>. Set ``radiation_length > 0`` to enable
+sub-surface scattering. It is supported in background modes :attr:`plotoptix.enums.MissProgram.AmbientAndVolume`,
+:attr:`plotoptix.enums.MissProgram.TextureFixed` and :attr:`plotoptix.enums.MissProgram.TextureEnvironment`,
+see also :meth:`plotoptix.NpOptiX.set_background_mode`. Use ``subsurface_color`` to set diffuse color of
+scattering (RGB components range should be ``<0; 1>``). Volumes can emit light in  ``subsurface_color``
+if ``light_emission > 0``.
 """
 
 m_dispersive_glass = {
@@ -208,7 +218,12 @@
 """
 Clear glass, with reflection and refraction simulated. Refraction index is varying with the wavelength,
 resulting with the light dispersion. Color components meaning is "attenuation length"
-and the range is <0; inf>.
+and the range is <0; inf>. Set ``radiation_length > 0`` to enable sub-surface scattering. It
+is supported in background modes :attr:`plotoptix.enums.MissProgram.AmbientAndVolume`,
+:attr:`plotoptix.enums.MissProgram.TextureFixed` and :attr:`plotoptix.enums.MissProgram.TextureEnvironment`,
+see also :meth:`plotoptix.NpOptiX.set_background_mode`. Use ``subsurface_color`` to set diffuse color of
+scattering (RGB components range should be ``<0; 1>``). Volumes can emit light in  ``subsurface_color``
+if ``light_emission > 0``.
 """
 
 m_thin_walled = {
@@ -226,5 +241,5 @@
 """
 Ideal for the soap-like bubbles. Reflection amount depends on the refraction index, however, there is
 no refraction on crossing the surface. Reflections can be textured or colorized with the primitive
-colors, and the color values range is <0; inf>.
+colors, and the color values range is ``<0; inf)``.
 """