Added python API to background options and documented it.

docs/sphinx/en/python_api/image.rst

@@ -3,7 +3,21 @@ image module
 
 .. automodule:: mrv2.image
     :members:
-    :exclude-members: Mirror, Color, Levels, ImageFilters, SoftClip, DisplayOptions, LUTOptions, ImageOptions, EnvironmentMapOptions, Stereo3DOptions
+    :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:: g
+      :annotation: = float
+
+   .. autoattribute:: a
+      :annotation: = float
 
 .. autoclass:: mrv2.image.Mirror
 

docs/sphinx/en/python_api/math.rst

@@ -3,7 +3,7 @@ math module
 
 .. automodule:: mrv2.math
 		:members:
-		:exclude-members: Vector2i, Vector2f, Vector3f, Vector4f
+		:exclude-members: Vector2i, Vector2f, Vector3f, Vector4f, Size2i
 
 .. autoclass:: mrv2.math.Vector2i
 
@@ -45,3 +45,11 @@ math module
 
    .. autoattribute:: w
       :annotation: = float
+
+.. autoclass:: mrv2.math.Size2i
+
+   .. autoattribute:: w
+      :annotation: = int
+
+   .. autoattribute:: h
+      :annotation: = int

docs/sphinx/es/python_api/image.rst

@@ -3,7 +3,21 @@ Módulo image
 
 .. automodule:: mrv2.image
     :members:
-    :exclude-members: Mirror, Color, Levels, ImageFilters, SoftClip, DisplayOptions, LUTOptions, ImageOptions, EnvironmentMapOptions, Stereo3DOptions
+    :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:: g
+      :annotation: = float
+
+   .. autoattribute:: a
+      :annotation: = float
 
 .. autoclass:: mrv2.image.Mirror
 

docs/sphinx/es/python_api/math.rst

@@ -2,6 +2,8 @@ Módulo math
 ===========
 
 .. automodule:: mrv2.math
+		:members:
+		:exclude-members: Vector2i, Vector2f, Vector3f, Vector4f, Size2i
 
 .. autoclass:: mrv2.math.Vector2i
 
@@ -43,3 +45,11 @@ Módulo math
 
    .. autoattribute:: w
       :annotation: = float
+
+.. autoclass:: mrv2.math.Size2i
+
+   .. autoattribute:: w
+      :annotation: = int
+
+   .. autoattribute:: h
+      :annotation: = int

mrv2/docs/en/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 3bed6507af48dcb1fabb1871af566283
+config: 48b784a9235c1c7a657c0806b86322e5
 tags: 645f666f9bcd5a90fca523b33c5a78b7

mrv2/docs/en/_sources/python_api/image.rst.txt

@@ -3,7 +3,21 @@ image module
 
 .. automodule:: mrv2.image
     :members:
-    :exclude-members: Mirror, Color, Levels, ImageFilters, SoftClip, DisplayOptions, LUTOptions, ImageOptions, EnvironmentMapOptions, Stereo3DOptions
+    :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:: g
+      :annotation: = float
+
+   .. autoattribute:: a
+      :annotation: = float
 
 .. autoclass:: mrv2.image.Mirror
 

mrv2/docs/en/_sources/python_api/math.rst.txt

@@ -3,7 +3,7 @@ math module
 
 .. automodule:: mrv2.math
 		:members:
-		:exclude-members: Vector2i, Vector2f, Vector3f, Vector4f
+		:exclude-members: Vector2i, Vector2f, Vector3f, Vector4f, Size2i
 
 .. autoclass:: mrv2.math.Vector2i
 
@@ -45,3 +45,11 @@ math module
 
    .. autoattribute:: w
       :annotation: = float
+
+.. autoclass:: mrv2.math.Size2i
+
+   .. autoattribute:: w
+      :annotation: = int
+
+   .. autoattribute:: h
+      :annotation: = int

mrv2/docs/en/genindex.html

@@ -103,6 +103,8 @@ <h1 id="index">Index</h1>
 <h2 id="A">A</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="python_api/image.html#mrv2.image.Color4f.a">a (mrv2.image.Color4f attribute)</a>
+</li>
       <li><a href="python_api/plug-ins.html#mrv2.plugin.Plugin.active">active() (mrv2.plugin.Plugin method)</a>
 </li>
       <li><a href="python_api/media.html#mrv2.media.activeFiles">activeFiles() (in module mrv2.media)</a>
@@ -137,12 +139,18 @@ <h2 id="A">A</h2>
 <h2 id="B">B</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="python_api/mrv2.html#mrv2.TimeRange.before">before() (mrv2.TimeRange method)</a>
+      <li><a href="python_api/image.html#mrv2.image.Background">Background (class in mrv2.image)</a>
 </li>
-      <li><a href="python_api/mrv2.html#mrv2.TimeRange.begins">begins() (mrv2.TimeRange method)</a>
+      <li><a href="python_api/image.html#mrv2.image.BackgroundOptions">BackgroundOptions (class in mrv2.image)</a>
+</li>
+      <li><a href="python_api/image.html#mrv2.image.backgroundOptions">backgroundOptions() (in module mrv2.image)</a>
+</li>
+      <li><a href="python_api/mrv2.html#mrv2.TimeRange.before">before() (mrv2.TimeRange method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="python_api/mrv2.html#mrv2.TimeRange.begins">begins() (mrv2.TimeRange method)</a>
+</li>
       <li><a href="python_api/media.html#mrv2.media.Bfiles">Bfiles() (in module mrv2.media)</a>
 </li>
       <li><a href="python_api/media.html#mrv2.media.BIndexes">BIndexes() (in module mrv2.media)</a>
@@ -158,6 +166,12 @@ <h2 id="C">C</h2>
       <li><a href="python_api/image.html#mrv2.image.Channels">Channels (class in mrv2.image)</a>
 </li>
       <li><a href="python_api/image.html#mrv2.image.DisplayOptions.channels">channels (mrv2.image.DisplayOptions attribute)</a>
+</li>
+      <li><a href="python_api/image.html#mrv2.image.BackgroundOptions.checkersColor0">checkersColor0 (mrv2.image.BackgroundOptions property)</a>
+</li>
+      <li><a href="python_api/image.html#mrv2.image.BackgroundOptions.checkersColor1">checkersColor1 (mrv2.image.BackgroundOptions property)</a>
+</li>
+      <li><a href="python_api/image.html#mrv2.image.BackgroundOptions.checkersSize">checkersSize (mrv2.image.BackgroundOptions property)</a>
 </li>
       <li><a href="python_api/mrv2.html#mrv2.TimeRange.clamped">clamped() (mrv2.TimeRange method)</a>
 </li>
@@ -177,11 +191,13 @@ <h2 id="C">C</h2>
         <li><a href="python_api/media.html#mrv2.media.closeAll">(in module mrv2.media)</a>
 </li>
       </ul></li>
-      <li><a href="python_api/image.html#mrv2.image.Color">Color (class in mrv2.image)</a>
-</li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="python_api/image.html#mrv2.image.Color">Color (class in mrv2.image)</a>
+</li>
       <li><a href="python_api/image.html#mrv2.image.DisplayOptions.color">color (mrv2.image.DisplayOptions attribute)</a>
+</li>
+      <li><a href="python_api/image.html#mrv2.image.Color4f">Color4f (class in mrv2.image)</a>
 </li>
       <li><a href="python_api/cmd.html#mrv2.cmd.compare">compare() (in module mrv2.cmd)</a>
 </li>
@@ -311,6 +327,8 @@ <h2 id="F">F</h2>
 <h2 id="G">G</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="python_api/image.html#id0">g (mrv2.image.Color4f attribute)</a>, <a href="python_api/image.html#mrv2.image.Color4f.g">[1]</a>
+</li>
       <li><a href="python_api/image.html#mrv2.image.Levels.gamma">gamma (mrv2.image.Levels attribute)</a>
 </li>
       <li><a href="python_api/mrv2.html#mrv2.Path.get">get() (mrv2.Path method)</a>
@@ -336,6 +354,10 @@ <h2 id="G">G</h2>
 
 <h2 id="H">H</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="python_api/math.html#mrv2.math.Size2i.h">h (mrv2.math.Size2i attribute)</a>
+</li>
+  </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="python_api/image.html#mrv2.image.EnvironmentMapOptions.horizontalAperture">horizontalAperture (mrv2.image.EnvironmentMapOptions attribute)</a>
 </li>
@@ -590,6 +612,8 @@ <h2 id="N">N</h2>
       <li><a href="python_api/image.html#mrv2.image.AlphaBlend.name">name (mrv2.image.AlphaBlend property)</a>
 
       <ul>
+        <li><a href="python_api/image.html#mrv2.image.Background.name">(mrv2.image.Background property)</a>
+</li>
         <li><a href="python_api/image.html#mrv2.image.Channels.name">(mrv2.image.Channels property)</a>
 </li>
         <li><a href="python_api/image.html#mrv2.image.EnvironmentMapType.name">(mrv2.image.EnvironmentMapType property)</a>
@@ -691,6 +715,8 @@ <h2 id="P">P</h2>
 <h2 id="R">R</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="python_api/image.html#mrv2.image.Color4f.r">r (mrv2.image.Color4f attribute)</a>
+</li>
       <li><a href="python_api/mrv2.html#mrv2.TimeRange.range_from_start_end_time">range_from_start_end_time() (mrv2.TimeRange static method)</a>
 </li>
       <li><a href="python_api/mrv2.html#mrv2.TimeRange.range_from_start_end_time_inclusive">range_from_start_end_time_inclusive() (mrv2.TimeRange static method)</a>
@@ -700,11 +726,11 @@ <h2 id="R">R</h2>
       <li><a href="python_api/settings.html#mrv2.settings.readAhead">readAhead() (in module mrv2.settings)</a>
 </li>
       <li><a href="python_api/settings.html#mrv2.settings.readBehind">readBehind() (in module mrv2.settings)</a>
-</li>
-      <li><a href="python_api/usd.html#mrv2.usd.RenderOptions">RenderOptions (class in mrv2.usd)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="python_api/usd.html#mrv2.usd.RenderOptions">RenderOptions (class in mrv2.usd)</a>
+</li>
       <li><a href="python_api/usd.html#mrv2.usd.renderOptions">renderOptions() (in module mrv2.usd)</a>
 </li>
       <li><a href="python_api/usd.html#mrv2.usd.RenderOptions.renderWidth">renderWidth (mrv2.usd.RenderOptions attribute)</a>
@@ -748,6 +774,8 @@ <h2 id="S">S</h2>
       <li><a href="python_api/media.html#mrv2.media.setA">setA() (in module mrv2.media)</a>
 </li>
       <li><a href="python_api/media.html#mrv2.media.setB">setB() (in module mrv2.media)</a>
+</li>
+      <li><a href="python_api/image.html#mrv2.image.setBackgroundOptions">setBackgroundOptions() (in module mrv2.image)</a>
 </li>
       <li><a href="python_api/cmd.html#mrv2.cmd.setCompareOptions">setCompareOptions() (in module mrv2.cmd)</a>
 </li>
@@ -773,10 +801,10 @@ <h2 id="S">S</h2>
 </li>
       <li><a href="python_api/session.html#mrv2.session.setMetadata">setMetadata() (in module mrv2.session)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="python_api/cmd.html#mrv2.cmd.setMute">setMute() (in module mrv2.cmd)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="python_api/image.html#mrv2.image.setOcioConfig">setOcioConfig() (in module mrv2.image)</a>
 </li>
       <li><a href="python_api/image.html#mrv2.image.setOcioIcs">setOcioIcs() (in module mrv2.image)</a>
@@ -798,10 +826,14 @@ <h2 id="S">S</h2>
       <li><a href="python_api/cmd.html#mrv2.cmd.setStereo3DOptions">setStereo3DOptions() (in module mrv2.cmd)</a>
 </li>
       <li><a href="python_api/cmd.html#mrv2.cmd.setVolume">setVolume() (in module mrv2.cmd)</a>
+</li>
+      <li><a href="python_api/math.html#mrv2.math.Size2i">Size2i (class in mrv2.math)</a>
 </li>
       <li><a href="python_api/image.html#mrv2.image.SoftClip">SoftClip (class in mrv2.image)</a>
 </li>
       <li><a href="python_api/image.html#mrv2.image.DisplayOptions.softClip">softClip (mrv2.image.DisplayOptions attribute)</a>
+</li>
+      <li><a href="python_api/image.html#mrv2.image.BackgroundOptions.solidColor">solidColor (mrv2.image.BackgroundOptions property)</a>
 </li>
       <li><a href="python_api/timeline.html#mrv2.timeline.speed">speed() (in module mrv2.timeline)</a>
 </li>
@@ -855,8 +887,12 @@ <h2 id="T">T</h2>
 </li>
       <li><a href="python_api/media.html#mrv2.media.toggleB">toggleB() (in module mrv2.media)</a>
 </li>
-      <li><a href="python_api/image.html#mrv2.image.EnvironmentMapOptions.type">type (mrv2.image.EnvironmentMapOptions attribute)</a>
+      <li><a href="python_api/image.html#mrv2.image.BackgroundOptions.type">type (mrv2.image.BackgroundOptions property)</a>
+
+      <ul>
+        <li><a href="python_api/image.html#mrv2.image.EnvironmentMapOptions.type">(mrv2.image.EnvironmentMapOptions attribute)</a>
 </li>
+      </ul></li>
   </ul></td>
 </tr></table>
 
@@ -903,8 +939,12 @@ <h2 id="V">V</h2>
 <h2 id="W">W</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="python_api/math.html#mrv2.math.Vector4f.w">w (mrv2.math.Vector4f attribute)</a>
+      <li><a href="python_api/math.html#mrv2.math.Size2i.w">w (mrv2.math.Size2i attribute)</a>
+
+      <ul>
+        <li><a href="python_api/math.html#mrv2.math.Vector4f.w">(mrv2.math.Vector4f attribute)</a>
 </li>
+      </ul></li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="python_api/media.html#mrv2.media.CompareOptions.wipeCenter">wipeCenter (mrv2.media.CompareOptions attribute)</a>