Updated English docs.

ggarra13 · Apr 30, 2024 · 9d2865d · 9d2865d
1 parent 4f848f3
commit 9d2865d
Show file tree

Hide file tree

Showing 82 changed files with 4,383 additions and 12 deletions.
diff --git a/.github/workflows/full_win64.yml b/.github/workflows/full_win64.yml
@@ -64,7 +64,7 @@ jobs:
 
     - name: Build mrv2
       run: |
-        ./runme_nolog.sh reldeb -t package -D TLRENDER_USD=OFF
+        ./runme_nolog.sh reldeb -v -t package -D TLRENDER_USD=OFF
         
     - name: Upload binaries  # Conditional step
       run: |

diff --git a/docs/sphinx/en/user_docs/images/preferences-15.png b/docs/sphinx/en/user_docs/images/preferences-15.png
diff --git a/docs/sphinx/en/user_docs/images/preferences-16.png b/docs/sphinx/en/user_docs/images/preferences-16.png
diff --git a/docs/sphinx/en/user_docs/images/preferences-17.png b/docs/sphinx/en/user_docs/images/preferences-17.png
diff --git a/docs/sphinx/en/user_docs/images/preferences-18.png b/docs/sphinx/en/user_docs/images/preferences-18.png
diff --git a/docs/sphinx/en/user_docs/images/preferences-19.png b/docs/sphinx/en/user_docs/images/preferences-19.png
diff --git a/docs/sphinx/en/user_docs/images/preferences-20.png b/docs/sphinx/en/user_docs/images/preferences-20.png
diff --git a/docs/sphinx/en/user_docs/images/preferences-21.png b/docs/sphinx/en/user_docs/images/preferences-21.png
diff --git a/docs/sphinx/en/user_docs/preferences.rst b/docs/sphinx/en/user_docs/preferences.rst
@@ -151,7 +151,21 @@ Here you can customize the colors and language used in mrv2.
 .. topic:: View Colors
 
 	   You can establish the colors for the background, the selection rectangle, the text overlay (unused) and the HUD.
+
+
+Render
+======
+
+.. image:: ./images/preferences-15.png
+   :align: center
+
+Fonts
+=====
+
+.. image:: ./images/preferences-16.png
+   :align: center
 
+
 Positioning
 ===========
 
@@ -238,7 +252,7 @@ Playback
 Timeline
 ========
 
-.. image:: ./images/preferences-07.png
+.. image:: ./images/preferences-17.png
    :align: center
 
 .. topic:: Display
@@ -248,14 +262,29 @@ Timeline
 .. topic:: Preview Thumbnails
 
 	   Whether to show a thumbnail above the timeline when moving or dragging on the timeline.
+
+.. topic:: Remove EDLs in Temporary Folder
 
-Edit Viewport
-+++++++++++++
+	   When creating playlists (EDLs), .otio files are saved in your
+	   temporary folder.  Selecting this will remove those files on
+	   program exit.
 
 .. topic:: Start in Edit mode
 
 	   When selected, the UI will start in Edit mode by default.
+
 
+Edit Viewport
++++++++++++++
+
+.. image:: ./images/preferences-18.png
+   :align: center
+
+.. topic:: Default View
+
+	   Whether to show Video Only or Video and Audio in the Edit
+	   Viewport.
+
 .. topic:: Thumbnails
 
 	   The size of the thumbnails or None for no thumbnails.
@@ -268,6 +297,15 @@ Edit Viewport
 
 	   Whether Markers are shown as a bar in Edit mode.
 
+.. topic:: Editable
+
+	   Whether the Edit viewport is editable by default.
+
+.. topic:: Edit Associated Clips
+
+	   Whether Video and Audio clips with *exactly* equal start times
+	   and durations can be moved together by default.
+
 
 Pixel Toolbar
 =============
@@ -397,11 +435,90 @@ Network
 
 The Network preferences allows you to set what settings are sent and received by the local machine when connected on a network to another server or client.
 
+OpenGL
+======
+
+.. image:: ./images/preferences-19.png
+   :align: center
+
+OpenGL is the default API used for 3D rendering in the timeline and viewports.
+
+.. topic:: Monitor VSync
+
+	   Defaults to Always.  It allows drawings to wait for the monitor sync
+	   to avoid tearing.  You can set it to No or to Presentation.
+	   Turning off Monitor Vsync will improve performance, but will probably
+	   result in tearing.
+
+.. topic:: Color Buffers' Accuracy
+
+	   Controls the quality used in the calculations of OpenGL.
+
+	   - Automatic: Default, which will set the buffers to
+	     be equal to the bit depth of the image.
+	   - Half Float: It will set the bit depth to half float.  It will
+	     keep most floating point information with some precision errors.
+	   - Float: It will preserve floating point information accurately.
+	   - Fast: It will work in 8-bits.
+
+.. topic:: Blit Viewports
+
+	   Assuming your Desktop system allows it, blitting will be used to
+	   moving and panning in the image, which is usually faster.  Otherwise
+	   a shader must be used.
+
+.. topic:: Blit Timeline
+
+	   Assuming your Desktop system allows it, blitting will be used to
+	   moving and panning in the timeline, which is usually faster.
+	   Otherwise a shader must be used.
+
 Errors
 ======
 
-.. image:: ./images/preferences-14.png
+.. image:: ./images/preferences-20.png
    :align: center
 
 
-The Errors preferences allows you to establish what to do in case of an error.  You can choose to Do Nothing, Open Logs on Dock or Open Logs on Window (Default).
+The Errors preferences allows you to establish what to do in case of an error.
+
+.. topic:: On FFmpeg Error
+
+	   You can choose to Do Nothing (Default), Open Logs on Dock or Open
+	   Logs on Window.
+
+.. topic:: On Error
+
+	   You can choose to Do Nothing (Default), Open Logs on Dock or Open
+	   Logs on Window (Default).
+
+Behavior
+========
+
+.. image:: ./images/preferences-21.png
+   :align: center
+
+
+The Behavior Window allows you to control the behavior aspects of the viewer.
+
+.. topic:: Check for Updates.
+
+	   mrv2 can automatically check for updates, download and install a
+	   new version assuming you have administrative privileges.
+	   You need of course an internet connection and have compiled mrv2
+	   with Python support.
+	   Once downloaded, you will need to follow the standard procedures
+	   for an install on your platform.
+	   If the install is successful, the new mrv2 should start
+	   automatically.
+
+	   - On Demand From Help Menu.
+
+	     Updates are handled manually, only when selecting
+	     Help->Update mrv2.
+
+	    - At Start Up
+
+	      Updates are checked automatically at Start up.  If there's an
+	      update, a Window will open for you to update, reinstall or maybe
+	      downgrade if you have a beta version.
diff --git a/mrv2/docs/en/_images/preferences-07.png b/mrv2/docs/en/_images/preferences-07.png
diff --git a/mrv2/docs/en/_images/preferences-14.png b/mrv2/docs/en/_images/preferences-14.png
diff --git a/mrv2/docs/en/_images/preferences-15.png b/mrv2/docs/en/_images/preferences-15.png
diff --git a/mrv2/docs/en/_images/preferences-16.png b/mrv2/docs/en/_images/preferences-16.png
diff --git a/mrv2/docs/en/_images/preferences-17.png b/mrv2/docs/en/_images/preferences-17.png
diff --git a/mrv2/docs/en/_images/preferences-18.png b/mrv2/docs/en/_images/preferences-18.png
diff --git a/mrv2/docs/en/_images/preferences-19.png b/mrv2/docs/en/_images/preferences-19.png
diff --git a/mrv2/docs/en/_images/preferences-20.png b/mrv2/docs/en/_images/preferences-20.png
diff --git a/mrv2/docs/en/_images/preferences-21.png b/mrv2/docs/en/_images/preferences-21.png
diff --git a/mrv2/docs/en/_sources/index.rst.txt b/mrv2/docs/en/_sources/index.rst.txt
@@ -0,0 +1,24 @@
+.. mrv2 documentation master file, created by
+   sphinx-quickstart on Sun Mar 26 08:57:29 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to mrv2's documentation!
+================================
+
+Table of Contents
+^^^^^^^^^^^^^^^^^
+.. toctree::
+    :maxdepth: 2
+
+    self
+    user_docs/index
+    python_api/index
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
diff --git a/mrv2/docs/en/_sources/python_api/annotations.rst.txt b/mrv2/docs/en/_sources/python_api/annotations.rst.txt
@@ -0,0 +1,6 @@
+annotations module
+==================
+
+.. automodule:: mrv2.annotations
+    :members:
+
diff --git a/mrv2/docs/en/_sources/python_api/cmd.rst.txt b/mrv2/docs/en/_sources/python_api/cmd.rst.txt
@@ -0,0 +1,6 @@
+cmd module
+==========
+
+.. automodule:: mrv2.cmd
+    :members:
+
diff --git a/mrv2/docs/en/_sources/python_api/image.rst.txt b/mrv2/docs/en/_sources/python_api/image.rst.txt
@@ -0,0 +1,166 @@
+image module
+============
+
+.. automodule:: mrv2.image
+    :members:
+    :exclude-members: Mirror, Color, Levels, ImageFilters, SoftClip, DisplayOptions, LUTOptions, ImageOptions, EnvironmentMapOptions, Stereo3DOptions, Color4f
+
+.. autoclass:: mrv2.image.Color4f
+
+   .. autoattribute:: r
+      :annotation: = float
+
+   .. autoattribute:: g
+      :annotation: = float
+
+   .. autoattribute:: b
+      :annotation: = float
+
+   .. autoattribute:: a
+      :annotation: = float
+
+.. autoclass:: mrv2.image.Mirror
+
+   .. autoattribute:: x
+      :annotation: = bool
+
+   .. autoattribute:: y
+      :annotation: = bool
+
+.. autoclass:: mrv2.image.Color
+
+   .. autoattribute:: enabled
+      :annotation: = bool
+
+   .. autoattribute:: add
+      :annotation: = mrv2.math.Vector3f
+
+   .. autoattribute:: brightness
+      :annotation: = mrv2.math.Vector3f
+
+   .. autoattribute:: contrast
+      :annotation: = mrv2.math.Vector3f
+
+   .. autoattribute:: saturation
+      :annotation: = mrv2.math.Vector3f
+
+   .. autoattribute:: tint
+      :annotation: = float
+
+   .. autoattribute:: invert
+      :annotation: = bool
+
+.. autoclass:: mrv2.image.Levels
+
+   .. autoattribute:: enabled
+      :annotation: = bool
+
+   .. autoattribute:: inLow
+      :annotation: = float
+
+   .. autoattribute:: inHigh
+      :annotation: = float
+
+   .. autoattribute:: gamma
+      :annotation: = float
+
+   .. autoattribute:: outLow
+      :annotation: = float
+
+   .. autoattribute:: outHigh
+      :annotation: = float
+
+.. autoclass:: mrv2.image.ImageFilters
+
+   .. autoattribute:: minify
+      :annotation: = mrv2.image.ImageFilter
+
+   .. autoattribute:: magnify
+      :annotation: = mrv2.image.ImageFilter
+
+.. autoclass:: mrv2.image.SoftClip
+
+   .. autoattribute:: enabled
+      :annotation: = bool
+
+   .. autoattribute:: value
+      :annotation: = float
+
+.. autoclass:: mrv2.image.DisplayOptions
+
+   .. autoattribute:: channels
+      :annotation: = mrv2.image.Channels
+
+   .. autoattribute:: mirror
+      :annotation: = mrv2.image.Mirror
+
+   .. autoattribute:: color
+      :annotation: = mrv2.image.Color
+
+   .. autoattribute:: levels
+      :annotation: = mrv2.image.Levels
+
+   .. autoattribute:: softClip
+      :annotation: = mrv2.image.SoftClip
+
+.. autoclass:: mrv2.image.LUTOptions
+
+   .. autoattribute:: fileName
+      :annotation: = str
+
+   .. autoattribute:: order
+      :annotation: = mrv2.image.LUTOrder
+
+.. autoclass:: mrv2.image.ImageOptions
+
+   .. autoattribute:: videoLevels
+      :annotation: = mrv2.image.InputVideoLevels
+
+   .. autoattribute:: alphaBlend
+      :annotation: = mrv2.image.AlphaBlend
+
+   .. autoattribute:: imageFilters
+      :annotation: = mrv2.image.ImageFilters
+
+.. autoclass:: mrv2.image.EnvironmentMapOptions
+
+   .. autoattribute:: type
+      :annotation: = mrv2.image.EnvironmentMapType
+
+   .. autoattribute:: horizontalAperture
+      :annotation: = float
+
+   .. autoattribute:: verticalAperture
+      :annotation: = float
+
+   .. autoattribute:: focalLength
+      :annotation: = float
+
+   .. autoattribute:: rotateX
+      :annotation: = float
+
+   .. autoattribute:: rotateY
+      :annotation: = float
+
+   .. autoattribute:: subdivisionX
+      :annotation: = int
+
+   .. autoattribute:: subdivisionY
+      :annotation: = int
+
+   .. autoattribute:: spin
+      :annotation: = bool
+
+.. autoclass:: mrv2.image.Stereo3DOptions
+
+   .. autoattribute:: input
+      :annotation: = mrv2.image.Stereo3DInput
+
+   .. autoattribute:: output
+      :annotation: = mrv2.image.Stereo3DOutput
+
+   .. autoattribute:: eyeSeparation
+      :annotation: = float
+
+   .. autoattribute:: swapEyes
+      :annotation: = bool
diff --git a/mrv2/docs/en/_sources/python_api/index.rst.txt b/mrv2/docs/en/_sources/python_api/index.rst.txt
@@ -0,0 +1,10 @@
+.. _python_api_:
+
+Python API
+==========
+
+.. toctree::
+    :maxdepth: 2
+    :glob:
+
+    *