update docs

MrKepzie · Feb 17, 2017 · 1668917 · 1668917
1 parent ce223e0
commit 1668917
Show file tree

Hide file tree

Showing 18 changed files with 460 additions and 166 deletions.
diff --git a/Documentation/source/_groupTransform.rst b/Documentation/source/_groupTransform.rst
@@ -7,6 +7,7 @@ The following sections contain documentation about every node in the  Transform
     :maxdepth: 1
 
     plugins/net.sf.openfx.AdjustRoDPlugin.rst
+    plugins/net.sf.openfx.Card3D.rst
     plugins/net.sf.openfx.CornerPinPlugin.rst
     plugins/net.sf.openfx.CornerPinMaskedPlugin.rst
     plugins/net.sf.openfx.CropPlugin.rst

diff --git a/Documentation/source/plugins/fr.inria.openfx.ReadFFmpeg.rst b/Documentation/source/plugins/fr.inria.openfx.ReadFFmpeg.rst
@@ -12,6 +12,10 @@ Description
 
 Read video using FFmpeg.
 
+All formats supported by FFmpeg should be supported, but there may be issues with some non-conform files. In this case, it is recommended to transcode the video to a digital intermediate format, which is more suitable for grading, compositing and video editing.
+
+This can be done using the ffmpeg command-line tool, by following the instructions at https://trac.ffmpeg.org/wiki/Encode/VFX
+
 FFmpeg versions (compiled with / running with):
 
 libavformat 57.56.100 / 57.56.100

diff --git a/Documentation/source/plugins/fr.inria.openfx.ReadOIIO.rst b/Documentation/source/plugins/fr.inria.openfx.ReadOIIO.rst
@@ -66,9 +66,9 @@ All supported formats and extensions: bmp: bmp; cineon: cin; dds: dds; dpx: dpx;
 
 OIIO versions:
 
-compiled with 1.7.10
+compiled with 1.7.11
 
-running with 1.7.10
+running with 1.7.11
 
 Inputs
 ------

diff --git a/Documentation/source/plugins/fr.inria.openfx.WriteFFmpeg.rst b/Documentation/source/plugins/fr.inria.openfx.WriteFFmpeg.rst
diff --git a/Documentation/source/plugins/fr.inria.openfx.WriteOIIO.rst b/Documentation/source/plugins/fr.inria.openfx.WriteOIIO.rst
@@ -56,9 +56,9 @@ All supported formats and extensions: bmp: bmp; cineon: cin; dds: dds; dpx: dpx;
 
 OIIO versions:
 
-compiled with 1.7.10
+compiled with 1.7.11
 
-running with 1.7.10
+running with 1.7.11
 
 Inputs
 ------

diff --git a/Documentation/source/plugins/net.sf.openfx.Card3D.rst b/Documentation/source/plugins/net.sf.openfx.Card3D.rst
diff --git a/Documentation/source/plugins/net.sf.openfx.CheckerBoardPlugin.rst b/Documentation/source/plugins/net.sf.openfx.CheckerBoardPlugin.rst
@@ -43,6 +43,8 @@ Controls
 +--------------------------------------------+-----------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | Center / ``recenter``                      | Button    |                             | Centers the region of definition to the input region of definition. If there is no input, then the region of definition is centered to the project window.   |
 +--------------------------------------------+-----------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Reformat / ``reformat``                    | Boolean   | Off                         | Set the output format to the given extent.                                                                                                                   |
++--------------------------------------------+-----------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | Format / ``NatronParamFormatChoice``       | Choice    | HD 1920x1080                | The output format                                                                                                                                            |
 +--------------------------------------------+-----------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | Bottom Left / ``bottomLeft``               | Double    | x: 0 y: 0                   | Coordinates of the bottom left corner of the size rectangle.                                                                                                 |

diff --git a/Documentation/source/plugins/net.sf.openfx.ColorBars.rst b/Documentation/source/plugins/net.sf.openfx.ColorBars.rst
@@ -43,6 +43,8 @@ Controls
 +--------------------------------------------+-----------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | Center / ``recenter``                      | Button    |                 | Centers the region of definition to the input region of definition. If there is no input, then the region of definition is centered to the project window.      |
 +--------------------------------------------+-----------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Reformat / ``reformat``                    | Boolean   | Off             | Set the output format to the given extent.                                                                                                                      |
++--------------------------------------------+-----------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | Format / ``NatronParamFormatChoice``       | Choice    | HD 1920x1080    | The output format                                                                                                                                               |
 +--------------------------------------------+-----------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | Bottom Left / ``bottomLeft``               | Double    | x: 0 y: 0       | Coordinates of the bottom left corner of the size rectangle.                                                                                                    |

diff --git a/Documentation/source/plugins/net.sf.openfx.ColorWheel.rst b/Documentation/source/plugins/net.sf.openfx.ColorWheel.rst
@@ -43,6 +43,8 @@ Controls
 +--------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | Center / ``recenter``                      | Button    |                 | Centers the region of definition to the input region of definition. If there is no input, then the region of definition is centered to the project window.   |
 +--------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Reformat / ``reformat``                    | Boolean   | Off             | Set the output format to the given extent.                                                                                                                   |
++--------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | Format / ``NatronParamFormatChoice``       | Choice    | HD 1920x1080    | The output format                                                                                                                                            |
 +--------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | Bottom Left / ``bottomLeft``               | Double    | x: 0 y: 0       | Coordinates of the bottom left corner of the size rectangle.                                                                                                 |

diff --git a/Documentation/source/plugins/net.sf.openfx.ConstantPlugin.rst b/Documentation/source/plugins/net.sf.openfx.ConstantPlugin.rst
@@ -41,6 +41,8 @@ Controls
 +--------------------------------------------+-----------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | Center / ``recenter``                      | Button    |                       | Centers the region of definition to the input region of definition. If there is no input, then the region of definition is centered to the project window.   |
 +--------------------------------------------+-----------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Reformat / ``reformat``                    | Boolean   | Off                   | Set the output format to the given extent.                                                                                                                   |
++--------------------------------------------+-----------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | Format / ``NatronParamFormatChoice``       | Choice    | HD 1920x1080          | The output format                                                                                                                                            |
 +--------------------------------------------+-----------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | Bottom Left / ``bottomLeft``               | Double    | x: 0 y: 0             | Coordinates of the bottom left corner of the size rectangle.                                                                                                 |