intermediate documentation check-in : adding content

documentation/CMakeLists.txt

@@ -100,9 +100,11 @@ if (NOT NO_DOC)
             intro.rst 
             cmake_build.rst
             code_examples.rst
+            dxviewer.rst
             getting_started.rst
             glviewer.rst
             glbatchviewer.rst
+            limiteval.rst
             ptexviewer.rst
             release_notes.rst 
             subdivision_surfaces.rst 

documentation/api_overview.rst

@@ -76,7 +76,13 @@ is both layered and modular.
 Opt-In Features
 ===============
 
-XXXX
+One of the fundamental requirement of all our API's design patterns is the opt-in
+implementation of features. Because most of the algorithms are used within the
+constraints of interactive applications, we want to provide optimal code paths
+wherever possible. 
+
+Therefore, client-code should always have the option to opt-out of the memory and
+processing costs of any given feature that is not used.
 
 ----
 

documentation/cmake_build.rst

@@ -199,8 +199,35 @@ Step 3: Building
 
 The steps differ for different OS'es:
 
-    Windows : launch VC++ with the solution generated by cmake in your build directory.
+    * Windows : 
+      launch VC++ with the solution generated by cmake in your build directory.
 
-    OSX : run xcodebuild in your build directory
+    * OSX : 
+      run xcodebuild in your build directory
+
+    * \*Nix : 
+      run make in your build directory
+    
+----
+
+Build Targets
+_____________
+
+Makefile-based builds allow the use of named target. Here are some of the more
+useful target names:
+    
+*osd_\<static\|dynamic\>_\<CPU\|GPU\>*
+   The core components of the OpenSubdiv libraries
+
+*\<example_name\>*
+   Builds specific code examples by name (glViewer, ptexViewer...)
+
+*doc*
+   Builds ReST and doxygen documentation
+
+*doc_html*
+   Builds ReST documentation
+
+*doc_doxy*
+   Builds Doxygen documentation
 
-    \*Nix : run make in your build directory

documentation/code_examples.rst

@@ -74,7 +74,7 @@ of the software.
        | `glBatchViewer <glbatchviewer.html>`_
        | `ptexViewer <ptexviewer.html>`_
      - | `paintTest <painttest.html>`_
-       | `evalLimit <evallimit.html>`_
+       | `limitEval <limiteval.html>`_
 
 .. list-table:: **DirectX examples**
    :class: quickref
@@ -90,6 +90,12 @@ of the software.
    * - | `mayaViewer <mayaviewer.html>`_
      - | `mayaPtexViewer <mayaptexviewer.html>`_
 
+
+Note : the Maya plugins are currently unsupported and they may fail to compile
+or work with current versions of OpenSubdiv. These were originally written for 
+the sole purpose of live demonstrations and the code is provided only as an 
+implementation example.
+
 ----
 
 Common Keyboard Controls

documentation/css/rst.css

@@ -356,10 +356,14 @@ h1.title {
     margin-bottom: 23px;
     padding: 0.2em 1em 1em 1em;
     border: 3px inset;
-    border-color: #CCCCCC;
+    border-color: #A77;
     clear: both;
     margin-left: 60px;
     margin-right: 60px;
+    background-color: #CAA;
+    border-radius:15px;
+    -moz-border-radius:15px;
+    -webkit-border-radius:15px;
 }
 
 ul.auto-toc li {

documentation/dxviewer.rst

@@ -0,0 +1,104 @@
+..  
+       Copyright (C) Pixar. All rights reserved.
+  
+       This license governs use of the accompanying software. If you
+       use the software, you accept this license. If you do not accept
+       the license, do not use the software.
+  
+       1. Definitions
+       The terms "reproduce," "reproduction," "derivative works," and
+       "distribution" have the same meaning here as under U.S.
+       copyright law.  A "contribution" is the original software, or
+       any additions or changes to the software.
+       A "contributor" is any person or entity that distributes its
+       contribution under this license.
+       "Licensed patents" are a contributor's patent claims that read
+       directly on its contribution.
+  
+       2. Grant of Rights
+       (A) Copyright Grant- Subject to the terms of this license,
+       including the license conditions and limitations in section 3,
+       each contributor grants you a non-exclusive, worldwide,
+       royalty-free copyright license to reproduce its contribution,
+       prepare derivative works of its contribution, and distribute
+       its contribution or any derivative works that you create.
+       (B) Patent Grant- Subject to the terms of this license,
+       including the license conditions and limitations in section 3,
+       each contributor grants you a non-exclusive, worldwide,
+       royalty-free license under its licensed patents to make, have
+       made, use, sell, offer for sale, import, and/or otherwise
+       dispose of its contribution in the software or derivative works
+       of the contribution in the software.
+  
+       3. Conditions and Limitations
+       (A) No Trademark License- This license does not grant you
+       rights to use any contributor's name, logo, or trademarks.
+       (B) If you bring a patent claim against any contributor over
+       patents that you claim are infringed by the software, your
+       patent license from such contributor to the software ends
+       automatically.
+       (C) If you distribute any portion of the software, you must
+       retain all copyright, patent, trademark, and attribution
+       notices that are present in the software.
+       (D) If you distribute any portion of the software in source
+       code form, you may do so only under this license by including a
+       complete copy of this license with your distribution. If you
+       distribute any portion of the software in compiled or object
+       code form, you may only do so under a license that complies
+       with this license.
+       (E) The software is licensed "as-is." You bear the risk of
+       using it. The contributors give no express warranties,
+       guarantees or conditions. You may have additional consumer
+       rights under your local laws which this license cannot change.
+       To the extent permitted under your local laws, the contributors
+       exclude the implied warranties of merchantability, fitness for
+       a particular purpose and non-infringement.
+  
+
+dxViewer
+--------
+
+.. contents::
+   :local:
+   :backlinks: none
+
+SYNOPSIS
+========
+
+.. parsed-literal:: 
+   :class: codefhead
+
+   **dxViewer** [**-f**] *objfile(s)*
+
+DESCRIPTION
+===========
+
+``glViewer`` is a stand-alone application that showcases the application of 
+uniform and feature adaptive subdivision schemes to a collection of geometric
+shapes. Multiple controls are available to experiment with the algorithms.
+
+
+.. container:: impnotip
+
+   * **Note:** 
+     
+      dxViewer requires Microsoft's DirectX 11 SDK
+
+OPTIONS
+=======
+
+**-f**
+  Launches the application in full-screen mode (if is supported by GLFW on the
+  OS)
+
+SEE ALSO
+========
+
+`Code Examples <code_examples.html>`__, \
+`glViewer <glviewer.html>`__, \
+`glBatchViewer <glbatchviewer.html>`__, \
+`ptexViewer <ptexviewer.html>`__, \
+`paintTest <painttest.html>`__, \
+`limitEval <limiteval.html>`__, \
+`dxViewer <dxviewer.html>`__, \
+

documentation/glbatchviewer.rst

@@ -80,10 +80,10 @@ reduce the number of GPU calls.
 
 Multiple controls are available to experiment with the algorithms.
 
-.. image:: images/glbatchviewer.png 
+.. image:: images/glbatchviewer.jpg 
    :width: 400px
    :align: center
-   :target: images/glbatchviewer.png 
+   :target: images/glbatchviewer.jpg 
 
 
 OPTIONS
@@ -111,3 +111,11 @@ Keyboard Controls
 SEE ALSO
 ========
 
+`Code Examples <code_examples.html>`__, \
+`glViewer <glviewer.html>`__, \
+`glBatchViewer <glbatchviewer.html>`__, \
+`ptexViewer <ptexviewer.html>`__, \
+`paintTest <painttest.html>`__, \
+`limitEval <limiteval.html>`__, \
+`dxViewer <dxviewer.html>`__, \
+

documentation/glviewer.rst

@@ -77,10 +77,10 @@ DESCRIPTION
 uniform and feature adaptive subdivision schemes to a collection of geometric
 shapes. Multiple controls are available to experiment with the algorithms.
 
-.. image:: images/glviewer.png 
+.. image:: images/glviewer.jpg 
    :width: 400px
    :align: center
-   :target: images/glviewer.png 
+   :target: images/glviewer.jpg 
 
 OPTIONS
 =======
@@ -99,3 +99,11 @@ OPTIONS
 SEE ALSO
 ========
 
+`Code Examples <code_examples.html>`__, \
+`glViewer <glviewer.html>`__, \
+`glBatchViewer <glbatchviewer.html>`__, \
+`ptexViewer <ptexviewer.html>`__, \
+`paintTest <painttest.html>`__, \
+`limitEval <limiteval.html>`__, \
+`dxViewer <dxviewer.html>`__, \
+

documentation/limiteval.rst

@@ -0,0 +1,103 @@
+..  
+       Copyright (C) Pixar. All rights reserved.
+  
+       This license governs use of the accompanying software. If you
+       use the software, you accept this license. If you do not accept
+       the license, do not use the software.
+  
+       1. Definitions
+       The terms "reproduce," "reproduction," "derivative works," and
+       "distribution" have the same meaning here as under U.S.
+       copyright law.  A "contribution" is the original software, or
+       any additions or changes to the software.
+       A "contributor" is any person or entity that distributes its
+       contribution under this license.
+       "Licensed patents" are a contributor's patent claims that read
+       directly on its contribution.
+  
+       2. Grant of Rights
+       (A) Copyright Grant- Subject to the terms of this license,
+       including the license conditions and limitations in section 3,
+       each contributor grants you a non-exclusive, worldwide,
+       royalty-free copyright license to reproduce its contribution,
+       prepare derivative works of its contribution, and distribute
+       its contribution or any derivative works that you create.
+       (B) Patent Grant- Subject to the terms of this license,
+       including the license conditions and limitations in section 3,
+       each contributor grants you a non-exclusive, worldwide,
+       royalty-free license under its licensed patents to make, have
+       made, use, sell, offer for sale, import, and/or otherwise
+       dispose of its contribution in the software or derivative works
+       of the contribution in the software.
+  
+       3. Conditions and Limitations
+       (A) No Trademark License- This license does not grant you
+       rights to use any contributor's name, logo, or trademarks.
+       (B) If you bring a patent claim against any contributor over
+       patents that you claim are infringed by the software, your
+       patent license from such contributor to the software ends
+       automatically.
+       (C) If you distribute any portion of the software, you must
+       retain all copyright, patent, trademark, and attribution
+       notices that are present in the software.
+       (D) If you distribute any portion of the software in source
+       code form, you may do so only under this license by including a
+       complete copy of this license with your distribution. If you
+       distribute any portion of the software in compiled or object
+       code form, you may only do so under a license that complies
+       with this license.
+       (E) The software is licensed "as-is." You bear the risk of
+       using it. The contributors give no express warranties,
+       guarantees or conditions. You may have additional consumer
+       rights under your local laws which this license cannot change.
+       To the extent permitted under your local laws, the contributors
+       exclude the implied warranties of merchantability, fitness for
+       a particular purpose and non-infringement.
+  
+
+limitEval
+---------
+
+.. contents::
+   :local:
+   :backlinks: none
+
+SYNOPSIS
+========
+
+.. parsed-literal:: 
+   :class: codefhead
+
+   **limitEval** [**-f**] *objfile(s)*
+
+DESCRIPTION
+===========
+
+``limitEval`` is a stand-alone application that showcases the limit surface
+Eval module. On the given shape, random samples are generated in local u,v space.
+Vertex, varying and face-varying data is then computed on the surface limit and
+displayed as colors. Multiple controls are available to experiment with the algorithms.
+
+.. image:: images/evalLimit_hedit0.jpg 
+   :width: 400px
+   :align: center
+   :target: images/evalLimit_hedit0.jpg 
+
+OPTIONS
+=======
+
+**-f**
+  Launches the application in full-screen mode (if is supported by GLFW on the
+  OS)
+
+SEE ALSO
+========
+
+`Code Examples <code_examples.html>`__, \
+`glViewer <glviewer.html>`__, \
+`glBatchViewer <glbatchviewer.html>`__, \
+`ptexViewer <ptexviewer.html>`__, \
+`paintTest <painttest.html>`__, \
+`limitEval <limiteval.html>`__, \
+`dxViewer <dxviewer.html>`__, \
+

documentation/ptexviewer.rst

@@ -163,3 +163,11 @@ Keyboard Controls
 SEE ALSO
 ========
 
+`Code Examples <code_examples.html>`__, \
+`glViewer <glviewer.html>`__, \
+`glBatchViewer <glbatchviewer.html>`__, \
+`ptexViewer <ptexviewer.html>`__, \
+`paintTest <painttest.html>`__, \
+`limitEval <limiteval.html>`__, \
+`dxViewer <dxviewer.html>`__, \
+