Added new documentation pages for Metal examples:

- added new RST pages and images for the mtlViewer and mtlPtexViewer
    - added new table to the main Code Examples page for the Metal examples
This commit is contained in:
barry 2019-06-20 11:40:28 -07:00
parent 317e242bee
commit 707e585ea2
6 changed files with 113 additions and 4 deletions

View File

@ -87,6 +87,8 @@ if (DOCUTILS_FOUND AND PYTHONINTERP_FOUND)
intro.rst intro.rst
license.rst license.rst
mod_notes.rst mod_notes.rst
mtlviewer.rst
mtlptexviewer.rst
osd_overview.rst osd_overview.rst
osd_shader_interface.rst osd_shader_interface.rst
porting.rst porting.rst

View File

@ -38,20 +38,26 @@ of the software.
:widths: 50 50 :widths: 50 50
* - | `glViewer <glviewer.html>`_ * - | `glViewer <glviewer.html>`_
| `glFVarViewer <glfvarviewer.html>`_
| `glEvalLimit <glevallimit.html>`_ | `glEvalLimit <glevallimit.html>`_
| `glPaintTest <glpainttest.html>`_
| `glPtexViewer <glptexviewer.html>`_
- | `glFVarViewer <glfvarviewer.html>`_
| `glStencilViewer <glstencilviewer.html>`_ | `glStencilViewer <glstencilviewer.html>`_
- | `glPtexViewer <glptexviewer.html>`_
| `glPaintTest <glpainttest.html>`_
| `glShareTopology <glsharetopology.html>`_ | `glShareTopology <glsharetopology.html>`_
.. list-table:: **DirectX examples** .. list-table:: **DirectX examples**
:class: quickref :class: quickref
:widths: 50 50
* - | `dxViewer <dxviewer.html>`_ * - | `dxViewer <dxviewer.html>`_
- | `dxPtexViewer <dxptexviewer.html>`_ - | `dxPtexViewer <dxptexviewer.html>`_
.. list-table:: **Metal examples**
:class: quickref
:widths: 50 50
* - | `mtlViewer <mtlviewer.html>`_
- | `mtlPtexViewer <mtlptexviewer.html>`_
---- ----
Common Command Line Options Common Command Line Options

Binary file not shown.

After

Width:  |  Height:  |  Size: 832 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 730 KiB

View File

@ -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

View File

@ -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