From 574f77f59fb28557600916f726c42e940e9d15cf Mon Sep 17 00:00:00 2001 From: barry Date: Mon, 1 Apr 2019 10:15:33 -0700 Subject: [PATCH] Updated documentation for the example applications: - added common set of command line arguments to the main examples page - updated pages for each example to reflect revised usage - updated the See Also list --- documentation/code_examples.rst | 33 +++++++++++++++--- documentation/dxptexviewer.rst | 34 +++++++++---------- documentation/dxviewer.rst | 14 +++----- documentation/examples_see_also.rst | 7 ++-- documentation/glevallimit.rst | 9 ++--- documentation/glfvarviewer.rst | 21 +++++------- documentation/glpainttest.rst | 19 ++++------- documentation/glptexviewer.rst | 52 +++++++++-------------------- documentation/glsharetopology.rst | 8 ++--- documentation/glstencilviewer.rst | 13 +++----- documentation/glviewer.rst | 27 ++++----------- 11 files changed, 105 insertions(+), 132 deletions(-) diff --git a/documentation/code_examples.rst b/documentation/code_examples.rst index 36df43b8..6064a62f 100644 --- a/documentation/code_examples.rst +++ b/documentation/code_examples.rst @@ -38,12 +38,12 @@ of the software. :widths: 50 50 * - | `glViewer `_ - | `glPtexViewer `_ | `glEvalLimit `_ - - | `glStencilViewer `_ | `glPaintTest `_ + | `glPtexViewer `_ + - | `glFVarViewer `_ + | `glStencilViewer `_ | `glShareTopology `_ - | `glFVarViewer `_ .. list-table:: **DirectX examples** :class: quickref @@ -54,10 +54,35 @@ of the software. ---- +Common Command Line Options +=========================== + +While the following command line options are common, not all examples support +all -- in some cases, certain options are not applicable. + +:: + + -f : launches the application in full-screen mode (if supported by GLFW + on the OS) + -u : apply uniform subdivision to all meshes + -a : apply adaptive subdivision to create patches for the limit surface + -l depth : level of uniform or adaptive refinement to apply + -c count : number of repetitions of the animation loop when supported (default + of 0 is infinite) + objfile(s) : a set of one or more meshes in Obj format (requiring a .obj suffix) + that may be distinct meshes or animated versions of a single mesh + -anim : interpret a given set of Obj files as an animated sequence rather + than a set of distinct meshes + -catmark : apply the Catmark scheme to all meshes in given Obj files (default) + -loop : apply the Loop scheme to all meshes in given Obj files + -bilinear : apply the Bilinear scheme to all meshes in given Obj files + +---- + Common Keyboard Controls ======================== - .. code:: c++ +:: Left mouse button drag : orbit camera Middle mouse button drag : pan camera diff --git a/documentation/dxptexviewer.rst b/documentation/dxptexviewer.rst index aebb644b..1d6ee3ca 100644 --- a/documentation/dxptexviewer.rst +++ b/documentation/dxptexviewer.rst @@ -35,18 +35,14 @@ SYNOPSIS .. parsed-literal:: :class: codefhead - **dxPtexViewer** - [**-e** *environment map*] - [**-d** *HDR diffuse map*] - [**-s** *HDR specular map*] - [**-y**] - [**--disp** *displacement scale*] - [**-l** *isolation level*] - *ptex color file* - *ptex displacement file* - *ptex occlusion file* - *ptex specular file* - *objfile(s)* + **dxPtexViewer** [**-f**] [**-l** *isolation level*] [**-c** *animation loops*] [**-y**] + [**-e** *environment map*] [**-d** *HDR diffuse map*] [**-s** *HDR specular map*] + [**--disp** *displacement scale*] + *ptex color file* + *ptex displacement file* + *ptex occlusion file* + *ptex specular file* + *objfile(s)* DESCRIPTION =========== @@ -61,6 +57,13 @@ are available to experiment with the algorithms. OPTIONS ======= +See the description of the +`common comand line options `__ +for the subset of common options supported here. + +**-y** + Swap Z-up geometry to Y-UP. + **-e** *environment map* A low dynamic range spherical environment map used as a background. Ideally, a color-normalized version of the HDR light probe. @@ -75,13 +78,6 @@ OPTIONS **--disp** *displacement scale* A scalar multiplier for the shader displacement values. -**-y** - Swap Z-up geometry to Y-UP. - -**-l** *isolation level* - Select the desired isolation level of adaptive feature isolation. This can be - useful when trying to load large pieces of geometry. - *ptex color file* A ptex file containing RGB channels read as material albedo color. diff --git a/documentation/dxviewer.rst b/documentation/dxviewer.rst index e5493333..cb3c5394 100644 --- a/documentation/dxviewer.rst +++ b/documentation/dxviewer.rst @@ -35,7 +35,8 @@ SYNOPSIS .. parsed-literal:: :class: codefhead - **dxViewer** [**-d** *isolation level*] [**-c** *animation loops*] *objfile(s)* + **dxViewer** [**-u**] [**-a**] [**-l** *refinement level*] [**-c** *animation loops*] + *objfile(s)* [**-anim**] [**-catmark**] [**-loop**] [**-bilinear**] DESCRIPTION =========== @@ -58,13 +59,8 @@ shapes. Multiple controls are available to experiment with the algorithms. OPTIONS ======= -**-d** *isolation level* - Select the desired isolation level of adaptive feature isolation. This can be - useful when trying to load large pieces of geometry. - -**-c** *animation frequency* - Number of repetitions of the animation loop (default=0 is infinite) - - +See the description of the +`common comand line options `__ +for the subset of common options supported here. .. include:: examples_see_also.rst diff --git a/documentation/examples_see_also.rst b/documentation/examples_see_also.rst index 7aa65a68..3024ae47 100644 --- a/documentation/examples_see_also.rst +++ b/documentation/examples_see_also.rst @@ -3,11 +3,12 @@ SEE ALSO Other `examples `__ \ : `glViewer `__, \ -`glShareTopology `__, \ +`glFVarViewer `__, \ +`glEvalLimit `__, \ `glStencilViewer `__, \ `glPtexViewer `__, \ -`glEvalLimit `__, \ -`glFVarViewer `__, \ +`glPaintTest `__, \ +`glShareTopology `__, \ `dxViewer `__, \ `dxPtexViewer `__, \ diff --git a/documentation/glevallimit.rst b/documentation/glevallimit.rst index 7e7aa261..d23da653 100644 --- a/documentation/glevallimit.rst +++ b/documentation/glevallimit.rst @@ -35,7 +35,8 @@ SYNOPSIS .. parsed-literal:: :class: codefhead - **limitEval** [**-f**] *objfile(s)* + **glEvalLimit** [**-f**] [**-u**] [**-a**] [**-l** *refinement level*] + *objfile(s)* [**-catmark**] [**-loop**] [**-bilinear**] DESCRIPTION =========== @@ -75,8 +76,8 @@ Multiple controls are available to experiment with the algorithms. OPTIONS ======= -**-f** - Launches the application in full-screen mode (if is supported by GLFW on the - OS) +See the description of the +`common comand line options `__ +for the subset of common options supported here. .. include:: examples_see_also.rst diff --git a/documentation/glfvarviewer.rst b/documentation/glfvarviewer.rst index 0ca84577..9f7cbbc4 100644 --- a/documentation/glfvarviewer.rst +++ b/documentation/glfvarviewer.rst @@ -32,7 +32,12 @@ glFVarViewer SYNOPSIS ======== - **glFVarViewer** [**-d** *isolation level*] [**-c** *animation loops*] [**-f**] *objfile(s)* +.. parsed-literal:: + :class: codefhead + + **glFVarViewer** [**-f**] [**-u**] [**-a**] [**-l** *refinement level*] [**-c** *animation loops*] + *objfile(s)* [**-catmark**] [**-loop**] [**-bilinear**] + DESCRIPTION =========== @@ -54,16 +59,8 @@ interpolation rules and tags. OPTIONS ======= -**-d** *isolation level* - Select the desired isolation level of adaptive feature isolation. This can be - useful when trying to load large pieces of geometry. - -**-c** *animation frequency* - Number of repetitions of the animation loop (default=0 is infinite) - -**-f** - Launches the application in full-screen mode (if is supported by GLFW on the - OS) - +See the description of the +`common comand line options `__ +for the subset of common options supported here. .. include:: examples_see_also.rst diff --git a/documentation/glpainttest.rst b/documentation/glpainttest.rst index d88ee8a1..4238c6b2 100644 --- a/documentation/glpainttest.rst +++ b/documentation/glpainttest.rst @@ -35,9 +35,9 @@ SYNOPSIS .. parsed-literal:: :class: codefhead - **glPaintTest** - [**-f**] - *objfile(s)* + **glPaintTest** [**-f**] [**-l** *adaptive refinement level*] + *objfile(s)* [**-catmark**] [**-loop**] + DESCRIPTION =========== @@ -53,16 +53,11 @@ using GPU limit tessellation for painting and sculpting applications. OPTIONS ======= -**-f** - Launches the application in full-screen mode (if is supported by GLFW on the - OS) +See the description of the +`common comand line options `__ +for the subset of common options supported here. -*objfile(s)* - A sequence of obj files used as an animation loop (the topology has to match - the data contained in all the ptex files !) - - -Keyboard Controls +KEYBOARD CONTROLS ================= .. code:: c++ diff --git a/documentation/glptexviewer.rst b/documentation/glptexviewer.rst index f1da0a81..60d0e143 100644 --- a/documentation/glptexviewer.rst +++ b/documentation/glptexviewer.rst @@ -35,21 +35,14 @@ SYNOPSIS .. parsed-literal:: :class: codefhead - **glPtexViewer** - [**-e** *environment map*] - [**-d** *HDR diffuse map*] - [**-s** *HDR specular map*] - [**-y**] - [**--disp** *displacement scale*] - [**--bump** *bump scale*] - [**-l** *isolation level*] - [**-c** *animation loops*] - [**-f**] - *ptex color file* - *ptex displacement file* - *ptex occlusion file* - *ptex specular file* - *objfile(s)* + **glPtexViewer** [**-f**] [**-u**] [**-a**] [**-l** *isolation level*] [**-c** *animation loops*] [**-y**] + [**-e** *environment map*] [**-d** *HDR diffuse map*] [**-s** *HDR specular map*] + [**--disp** *displacement scale*] [**--bump** *bump scale*] + *ptex color file* + *ptex displacement file* + *ptex occlusion file* + *ptex specular file* + *objfile(s)* DESCRIPTION =========== @@ -66,6 +59,13 @@ are available to experiment with the algorithms. OPTIONS ======= +See the description of the +`common comand line options `__ +for the subset of common options supported here. + +**-y** + Swap Z-up geometry to Y-UP. + **-e** *environment map* A low dynamic range spherical environment map used as a background. Ideally, a color-normalized version of the HDR light probe. @@ -83,20 +83,6 @@ OPTIONS **--bump** *displacement scale* A scalar multiplier for the shader bump values. -**-y** - Swap Z-up geometry to Y-UP. - -**-l** *isolation level* - Select the desired isolation level of adaptive feature isolation. This can be - useful when trying to load large pieces of geometry. - -**-c** *animation frequency* - Number of repetitions of the animation loop (default=0 is infinite) - -**-f** - Launches the application in full-screen mode (if is supported by GLFW on the - OS) - *ptex color file* A ptex file containing RGB channels read as material albedo color. @@ -112,12 +98,7 @@ OPTIONS A single-channel ptex file (preferably 8 bits precision) applied to modulate the specular reflectance of the material -*objfile(s)* - A sequence of obj files used as an animation loop (the topology has to match - the data contained in all the ptex files !) - - -Keyboard Controls +KEYBOARD CONTROLS ================= .. code:: c++ @@ -131,5 +112,4 @@ Keyboard Controls e : draw normals - .. include:: examples_see_also.rst diff --git a/documentation/glsharetopology.rst b/documentation/glsharetopology.rst index 12a87aae..3a624492 100644 --- a/documentation/glsharetopology.rst +++ b/documentation/glsharetopology.rst @@ -35,7 +35,7 @@ SYNOPSIS .. parsed-literal:: :class: codefhead - **glShareTopology** [**-d** *isolation level*] *objfile(s)* + **glShareTopology** [**-u**] [**-a**] [**-l** *refinement level*] DESCRIPTION =========== @@ -51,8 +51,8 @@ instancing across Compute contexts. Multiple controls are available to experimen OPTIONS ======= -**-d** *isolation level* - Select the desired isolation level of adaptive feature isolation. This can be - useful when trying to load large pieces of geometry. +See the description of the +`common comand line options `__ +for the subset of common options supported here. .. include:: examples_see_also.rst diff --git a/documentation/glstencilviewer.rst b/documentation/glstencilviewer.rst index c502c171..80670805 100644 --- a/documentation/glstencilviewer.rst +++ b/documentation/glstencilviewer.rst @@ -35,7 +35,8 @@ SYNOPSIS .. parsed-literal:: :class: codefhead - **glStencilViewer** [**-d** *isolation level*] [**-f**] *objfile(s)* + **glStencilViewer** [**-f**] [**-u**] [**-a**] [**-l** *refinement level*] + *objfile(s)* [**-catmark**] [**-loop**] [**-bilinear**] DESCRIPTION =========== @@ -52,12 +53,8 @@ controls are available to experiment with the algorithms. OPTIONS ======= -**-d** *isolation level* - Select the desired isolation level of adaptive feature isolation. This can be - useful when trying to load large pieces of geometry. - -**-f** - Launches the application in full-screen mode (if is supported by GLFW on the - OS) +See the description of the +`common comand line options `__ +for the subset of common options supported here. .. include:: examples_see_also.rst diff --git a/documentation/glviewer.rst b/documentation/glviewer.rst index 0dcf7f8c..4614d742 100644 --- a/documentation/glviewer.rst +++ b/documentation/glviewer.rst @@ -35,12 +35,8 @@ SYNOPSIS .. parsed-literal:: :class: codefhead - **glViewer** - [**-d** *isolation level*] - [**-c** *animation loops*] - [**-f**] - [**-axis**] - *objfile(s)* + **glViewer** [**-f**] [**-u**] [**-a**] [**-l** *refinement level*] [**-axis**] [**-c** *animation loops*] + *objfile(s)* [**-anim**] [**-catmark**] [**-loop**] [**-bilinear**] DESCRIPTION =========== @@ -57,22 +53,11 @@ shapes. Multiple controls are available to experiment with the algorithms. OPTIONS ======= -**-d** *isolation level* - Select the desired isolation level of adaptive feature isolation. This can be - useful when trying to load large pieces of geometry. - -**-c** *animation frequency* - Number of repetitions of the animation loop (default=0 is infinite) - -**-f** - Launches the application in full-screen mode (if is supported by GLFW on the - OS) +See the description of the +`common comand line options `__ +for the subset of common options supported here. **-axis** - Swap Y-up / Z-up axis when loading obj files - -*objfile(s)* - A sequence of obj files used as an animation loop (the topology has to match - the data contained in all the ptex files !) + Swap Y-up / Z-up axis when loading Obj files .. include:: examples_see_also.rst