diff --git a/documentation/CMakeLists.txt b/documentation/CMakeLists.txt index cf7b9afe..32b12a3d 100644 --- a/documentation/CMakeLists.txt +++ b/documentation/CMakeLists.txt @@ -87,6 +87,8 @@ if (DOCUTILS_FOUND AND PYTHONINTERP_FOUND) intro.rst license.rst mod_notes.rst + mtlviewer.rst + mtlptexviewer.rst osd_overview.rst osd_shader_interface.rst porting.rst diff --git a/documentation/code_examples.rst b/documentation/code_examples.rst index feb75a22..3b974e8e 100644 --- a/documentation/code_examples.rst +++ b/documentation/code_examples.rst @@ -38,20 +38,26 @@ of the software. :widths: 50 50 * - | `glViewer `_ + | `glFVarViewer `_ | `glEvalLimit `_ - | `glPaintTest `_ - | `glPtexViewer `_ - - | `glFVarViewer `_ | `glStencilViewer `_ + - | `glPtexViewer `_ + | `glPaintTest `_ | `glShareTopology `_ .. list-table:: **DirectX examples** :class: quickref - :widths: 50 50 * - | `dxViewer `_ - | `dxPtexViewer `_ +.. list-table:: **Metal examples** + :class: quickref + :widths: 50 50 + + * - | `mtlViewer `_ + - | `mtlPtexViewer `_ + ---- Common Command Line Options diff --git a/documentation/images/mtlptexviewer.png b/documentation/images/mtlptexviewer.png new file mode 100644 index 00000000..bcfce252 Binary files /dev/null and b/documentation/images/mtlptexviewer.png differ diff --git a/documentation/images/mtlviewer.png b/documentation/images/mtlviewer.png new file mode 100644 index 00000000..4e4ab50f Binary files /dev/null and b/documentation/images/mtlviewer.png differ diff --git a/documentation/mtlptexviewer.rst b/documentation/mtlptexviewer.rst new file mode 100644 index 00000000..8e45c8b2 --- /dev/null +++ b/documentation/mtlptexviewer.rst @@ -0,0 +1,57 @@ +.. + Copyright 2013 Pixar + + Licensed under the Apache License, Version 2.0 (the "Apache License") + with the following modification; you may not use this file except in + compliance with the Apache License and the following modification to it: + Section 6. Trademarks. is deleted and replaced with: + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor + and its affiliates, except as required to comply with Section 4(c) of + the License and to reproduce the content of the NOTICE file. + + You may obtain a copy of the Apache License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the Apache License with the above modification is + distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the Apache License for the specific + language governing permissions and limitations under the Apache License. + + +mtlPtexViewer +------------- + +.. contents:: + :local: + :backlinks: none + +DESCRIPTION +=========== + +``mtlPtexViewer`` is a stand-alone application that showcases advanced HDR shading +with color, displacement, occlusion and specular ptex maps. Multiple controls +are available to experiment with the algorithms. + +.. image:: images/mtlptexviewer.png + :width: 400px + :align: center + :target: images/mtlptexviewer.png + +KEYBOARD CONTROLS +================= + + .. code:: c++ + + q : quit + esc : hide GUI + x : save screenshot + f : fit frame + +/- : increase / decrease tessellation rate + r : reload and re-compile the shader files + e : draw normals + +.. include:: examples_see_also.rst diff --git a/documentation/mtlviewer.rst b/documentation/mtlviewer.rst new file mode 100644 index 00000000..c5fb0a41 --- /dev/null +++ b/documentation/mtlviewer.rst @@ -0,0 +1,44 @@ +.. + Copyright 2019 Pixar + + Licensed under the Apache License, Version 2.0 (the "Apache License") + with the following modification; you may not use this file except in + compliance with the Apache License and the following modification to it: + Section 6. Trademarks. is deleted and replaced with: + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor + and its affiliates, except as required to comply with Section 4(c) of + the License and to reproduce the content of the NOTICE file. + + You may obtain a copy of the Apache License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the Apache License with the above modification is + distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the Apache License for the specific + language governing permissions and limitations under the Apache License. + + +mtlViewer +--------- + +.. contents:: + :local: + :backlinks: none + +DESCRIPTION +=========== + +``mtlViewer`` 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. + +.. image:: images/mtlviewer.png + :width: 400px + :align: center + :target: images/mtlviewer.png + +.. include:: examples_see_also.rst