[Bf-docboard-svn] bf-manual: [9828] trunk/blender_docs/manual: Document viewport compositor and supported nodes

Thu Dec 22 14:45:22 CET 2022

Revision: 9828
          https://developer.blender.org/rBM9828
Author:   OmarSquircleArt
Date:     2022-12-22 14:45:22 +0100 (Thu, 22 Dec 2022)
Log Message:
-----------
Document viewport compositor and supported nodes

This patch adds the initial documentation for the viewport compositor as
well as the supported node for it.

Modified Paths:
--------------
    trunk/blender_docs/manual/compositing/types/color/z_combine.rst
    trunk/blender_docs/manual/compositing/types/converter/color_space.rst
    trunk/blender_docs/manual/compositing/types/converter/id_mask.rst
    trunk/blender_docs/manual/compositing/types/distort/corner_pin.rst
    trunk/blender_docs/manual/compositing/types/distort/displace.rst
    trunk/blender_docs/manual/compositing/types/distort/map_uv.rst
    trunk/blender_docs/manual/compositing/types/distort/movie_distortion.rst
    trunk/blender_docs/manual/compositing/types/distort/plane_track_deform.rst
    trunk/blender_docs/manual/compositing/types/distort/rotate.rst
    trunk/blender_docs/manual/compositing/types/distort/stabilize_2d.rst
    trunk/blender_docs/manual/compositing/types/distort/transform.rst
    trunk/blender_docs/manual/compositing/types/distort/translate.rst
    trunk/blender_docs/manual/compositing/types/filter/anti_aliasing.rst
    trunk/blender_docs/manual/compositing/types/filter/defocus.rst
    trunk/blender_docs/manual/compositing/types/filter/denoise.rst
    trunk/blender_docs/manual/compositing/types/filter/glare.rst
    trunk/blender_docs/manual/compositing/types/filter/inpaint.rst
    trunk/blender_docs/manual/compositing/types/filter/sun_beams.rst
    trunk/blender_docs/manual/compositing/types/filter/vector_blur.rst
    trunk/blender_docs/manual/compositing/types/input/mask.rst
    trunk/blender_docs/manual/compositing/types/input/render_layers.rst
    trunk/blender_docs/manual/compositing/types/input/texture.rst
    trunk/blender_docs/manual/compositing/types/matte/cryptomatte.rst
    trunk/blender_docs/manual/compositing/types/matte/cryptomatte_legacy.rst
    trunk/blender_docs/manual/compositing/types/matte/double_edge_mask.rst
    trunk/blender_docs/manual/compositing/types/matte/keying.rst
    trunk/blender_docs/manual/compositing/types/matte/keying_screen.rst
    trunk/blender_docs/manual/compositing/types/output/file.rst
    trunk/blender_docs/manual/editors/3dview/display/shading.rst

Modified: trunk/blender_docs/manual/compositing/types/color/z_combine.rst
===================================================================

--- trunk/blender_docs/manual/compositing/types/color/z_combine.rst	2022-12-22 13:34:10 UTC (rev 9827)
+++ trunk/blender_docs/manual/compositing/types/color/z_combine.rst	2022-12-22 13:45:22 UTC (rev 9828)
@@ -9,6 +9,8 @@
    :align: right
    :alt: Z Combine Node.
 
+:guilabel:`CPU Compositor Only`
+
 The Z Combine node combines two images based on their Z-depth maps.
 It overlays the images using the provided Z values to
 detect which parts of one image are in front of the other.

Modified: trunk/blender_docs/manual/compositing/types/converter/color_space.rst
===================================================================
--- trunk/blender_docs/manual/compositing/types/converter/color_space.rst	2022-12-22 13:34:10 UTC (rev 9827)
+++ trunk/blender_docs/manual/compositing/types/converter/color_space.rst	2022-12-22 13:45:22 UTC (rev 9828)
@@ -9,6 +9,8 @@
    :align: right
    :alt: Color Space Node.
 
+:guilabel:`CPU Compositor Only`
+
 The *Color Space Node* converts images from one :term:`color spaces <Color Space>`.
 
 .. note::

Modified: trunk/blender_docs/manual/compositing/types/converter/id_mask.rst
===================================================================
--- trunk/blender_docs/manual/compositing/types/converter/id_mask.rst	2022-12-22 13:34:10 UTC (rev 9827)
+++ trunk/blender_docs/manual/compositing/types/converter/id_mask.rst	2022-12-22 13:45:22 UTC (rev 9828)
@@ -9,6 +9,8 @@
    :align: right
    :alt: ID Mask Node.
 
+:guilabel:`CPU Compositor Only`
+
 The *ID Mask Node* can be used to access an alpha mask per object or per material.
 
 

Modified: trunk/blender_docs/manual/compositing/types/distort/corner_pin.rst
===================================================================
--- trunk/blender_docs/manual/compositing/types/distort/corner_pin.rst	2022-12-22 13:34:10 UTC (rev 9827)
+++ trunk/blender_docs/manual/compositing/types/distort/corner_pin.rst	2022-12-22 13:45:22 UTC (rev 9828)
@@ -8,6 +8,8 @@
    :align: right
    :alt: Corner Pin Node.
 
+:guilabel:`CPU Compositor Only`
+
 The Corner Pin node uses explicit corner values for a plane warp transformation.
 It works like the Plane Track Deform node,
 but without using "plane track" data from the Movie Clip Editor.

Modified: trunk/blender_docs/manual/compositing/types/distort/displace.rst
===================================================================
--- trunk/blender_docs/manual/compositing/types/distort/displace.rst	2022-12-22 13:34:10 UTC (rev 9827)
+++ trunk/blender_docs/manual/compositing/types/distort/displace.rst	2022-12-22 13:45:22 UTC (rev 9828)
@@ -9,6 +9,8 @@
    :align: right
    :alt: Displace Node.
 
+:guilabel:`CPU Compositor Only`
+
 The *Displace Node* displaces the pixel position based on an input vector.
 
 This node could be used to model phenomena, like hot air distortion,

Modified: trunk/blender_docs/manual/compositing/types/distort/map_uv.rst
===================================================================
--- trunk/blender_docs/manual/compositing/types/distort/map_uv.rst	2022-12-22 13:34:10 UTC (rev 9827)
+++ trunk/blender_docs/manual/compositing/types/distort/map_uv.rst	2022-12-22 13:45:22 UTC (rev 9828)
@@ -9,6 +9,8 @@
    :align: right
    :alt: Map UV node.
 
+:guilabel:`CPU Compositor Only`
+
 With this node objects can be "re-textured" after they have been rendered.
 
 To apply a texture to individual enumerated objects

Modified: trunk/blender_docs/manual/compositing/types/distort/movie_distortion.rst
===================================================================
--- trunk/blender_docs/manual/compositing/types/distort/movie_distortion.rst	2022-12-22 13:34:10 UTC (rev 9827)
+++ trunk/blender_docs/manual/compositing/types/distort/movie_distortion.rst	2022-12-22 13:45:22 UTC (rev 9828)
@@ -9,6 +9,8 @@
    :align: right
    :alt: Movie Distortion Node.
 
+:guilabel:`CPU Compositor Only`
+
 In the real world, all camera lenses produce some or the other sort of lens distortion.
 But, whatever we render has got no distortion. So, this node helps in removing distortion from movies
 or adding distortion to render to make our render blend in with the movie clip.

Modified: trunk/blender_docs/manual/compositing/types/distort/plane_track_deform.rst
===================================================================
--- trunk/blender_docs/manual/compositing/types/distort/plane_track_deform.rst	2022-12-22 13:34:10 UTC (rev 9827)
+++ trunk/blender_docs/manual/compositing/types/distort/plane_track_deform.rst	2022-12-22 13:45:22 UTC (rev 9828)
@@ -9,6 +9,8 @@
    :align: right
    :alt: Plane Track Deform Node.
 
+:guilabel:`CPU Compositor Only`
+
 The Plane Track Deform Node is used to incorporate the special "plane track" in your composite by checking areas
 which are planes, and replacing their footage with some other image.
 

Modified: trunk/blender_docs/manual/compositing/types/distort/rotate.rst
===================================================================
--- trunk/blender_docs/manual/compositing/types/distort/rotate.rst	2022-12-22 13:34:10 UTC (rev 9827)
+++ trunk/blender_docs/manual/compositing/types/distort/rotate.rst	2022-12-22 13:45:22 UTC (rev 9828)
@@ -29,7 +29,7 @@
 
    :Nearest: No interpolation, uses nearest neighboring pixel.
    :Bilinear: Simple interpolation between adjacent pixels.
-   :Bicubic: Highest quality interpolation.
+   :Bicubic: Highest quality interpolation. :guilabel:`CPU Compositor Only`
 
 
 Outputs

Modified: trunk/blender_docs/manual/compositing/types/distort/stabilize_2d.rst
===================================================================
--- trunk/blender_docs/manual/compositing/types/distort/stabilize_2d.rst	2022-12-22 13:34:10 UTC (rev 9827)
+++ trunk/blender_docs/manual/compositing/types/distort/stabilize_2d.rst	2022-12-22 13:45:22 UTC (rev 9828)
@@ -9,6 +9,8 @@
    :align: right
    :alt: Stabilize 2D Node.
 
+:guilabel:`CPU Compositor Only`
+
 Stabilizes the footage according to the settings set in
 :menuselection:`Movie Clip Editor --> Properties --> Stabilization --> 2D Stabilization`.
 For more information,

Modified: trunk/blender_docs/manual/compositing/types/distort/transform.rst
===================================================================
--- trunk/blender_docs/manual/compositing/types/distort/transform.rst	2022-12-22 13:34:10 UTC (rev 9827)
+++ trunk/blender_docs/manual/compositing/types/distort/transform.rst	2022-12-22 13:45:22 UTC (rev 9828)
@@ -37,7 +37,7 @@
 
    :Nearest: No interpolation, uses nearest neighboring pixel.
    :Bilinear: Simple interpolation between adjacent pixels.
-   :Bicubic: Highest quality interpolation.
+   :Bicubic: Highest quality interpolation. :guilabel:`CPU Compositor Only`
 
 
 Outputs

Modified: trunk/blender_docs/manual/compositing/types/distort/translate.rst
===================================================================
--- trunk/blender_docs/manual/compositing/types/distort/translate.rst	2022-12-22 13:34:10 UTC (rev 9827)
+++ trunk/blender_docs/manual/compositing/types/distort/translate.rst	2022-12-22 13:45:22 UTC (rev 9828)
@@ -33,7 +33,11 @@
 
    None, X Axis, Y Axis, Both Axis
 
+.. note::
 
+   Individual axis wrapping is only supported in the CPU compositor.
+
+
 Outputs
 =======
 

Modified: trunk/blender_docs/manual/compositing/types/filter/anti_aliasing.rst
===================================================================
--- trunk/blender_docs/manual/compositing/types/filter/anti_aliasing.rst	2022-12-22 13:34:10 UTC (rev 9827)
+++ trunk/blender_docs/manual/compositing/types/filter/anti_aliasing.rst	2022-12-22 13:45:22 UTC (rev 9828)
@@ -9,6 +9,8 @@
    :align: right
    :alt: Anti-Aliasing Node.
 
+:guilabel:`CPU Compositor Only`
+
 The Anti-Aliasing node removes distortion artifacts around edges known as aliasing.
 
 

Modified: trunk/blender_docs/manual/compositing/types/filter/defocus.rst
===================================================================
--- trunk/blender_docs/manual/compositing/types/filter/defocus.rst	2022-12-22 13:34:10 UTC (rev 9827)
+++ trunk/blender_docs/manual/compositing/types/filter/defocus.rst	2022-12-22 13:45:22 UTC (rev 9828)
@@ -9,6 +9,8 @@
    :align: right
    :alt: Defocus Node.
 
+:guilabel:`CPU Compositor Only`
+
 The *Defocus Node* blurs areas of an image based on a map/mask input.
 
 It is typically used to emulate depth of field (:term:`DOF`) using a post-processing method with a Z-buffer input.

Modified: trunk/blender_docs/manual/compositing/types/filter/denoise.rst
===================================================================
--- trunk/blender_docs/manual/compositing/types/filter/denoise.rst	2022-12-22 13:34:10 UTC (rev 9827)
+++ trunk/blender_docs/manual/compositing/types/filter/denoise.rst	2022-12-22 13:45:22 UTC (rev 9828)
@@ -9,6 +9,8 @@
    :align: right
    :alt: Denoise Node.
 
+:guilabel:`CPU Compositor Only`
+
 The Denoise node is used to denoise renders from :doc:`Cycles </render/cycles/index>`
 and other ray tracing renderers. This helps to significantly reduce render time by
 rendering with fewer samples.

Modified: trunk/blender_docs/manual/compositing/types/filter/glare.rst
===================================================================
--- trunk/blender_docs/manual/compositing/types/filter/glare.rst	2022-12-22 13:34:10 UTC (rev 9827)
+++ trunk/blender_docs/manual/compositing/types/filter/glare.rst	2022-12-22 13:45:22 UTC (rev 9828)
@@ -39,6 +39,8 @@
       Looks similar to *Ghost*. However, it is much smaller in size
       and gives more of an atmospheric haze or "glow" around the image.
 
+      :guilabel:`CPU Compositor Only`
+
       Size
          Scale of the glow relative to the size of the original bright pixels.
    :Simple Star:

Modified: trunk/blender_docs/manual/compositing/types/filter/inpaint.rst
===================================================================
--- trunk/blender_docs/manual/compositing/types/filter/inpaint.rst	2022-12-22 13:34:10 UTC (rev 9827)
+++ trunk/blender_docs/manual/compositing/types/filter/inpaint.rst	2022-12-22 13:45:22 UTC (rev 9828)
@@ -9,6 +9,8 @@
    :align: right
    :alt: Inpaint Node.
 
+:guilabel:`CPU Compositor Only`
+
 The *Inpaint node* is used to extend borders of an image into transparent or masked regions.

@@ Diff output truncated at 10240 characters. @@
