Skip to content

Commit

Permalink
Added and tweaked docs to include 'exploder' and 'visualisation' chan…
Browse files Browse the repository at this point in the history
…ges.

Is it OK to add animated .webp images to the documentation?
  • Loading branch information
GertyP committed Nov 28, 2023
1 parent 308c7c9 commit 310b57c
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/getting_started/quick_start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ More details can be found on the :doc:`../window/mesh_viewer` page.

Mesh Viewer allows you to inspect the geometry data as it passes through the pipeline. Both raw data in a grid view and 3D inspection is possible. The tabs in the preview window allow you to choose at which part of the pipeline you'd like to visualise the data.

By default the preview shows a wireframe rendering of the mesh, but you can choose solid shading options. This can either be simple shading or use a secondary attribute as color. Right clicking on any column allows you to choose the secondary attribute for rendering.
By default the preview shows a wireframe rendering of the mesh, but you can choose different visualisations. This can either be simple shading, a vertex exploder utility, or using a secondary attribute as color. Right clicking on any column allows you to choose the secondary attribute for rendering.

You can also select which attribute is the position, in case either the auto-detection failed or you want to visualise another attribute like texture co-ordinates in 3D space.

Expand Down
Binary file added docs/imgs/Screenshots/ExploderBadShoes.webp
Binary file not shown.
Binary file added docs/imgs/Screenshots/ExploderGoodShoes.webp
Binary file not shown.
11 changes: 10 additions & 1 deletion docs/window/mesh_viewer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,20 @@ Page up and Page down will move vertically 'up' and 'down' relative to the camer
Mesh Preview
------------

In the 3D Mesh preview, you have the option to display the mesh with some solid shading modes, not just as a wireframe mesh. When solid shading you can toggle the wireframe on and off.
In the 3D Mesh preview, you have the option to display the mesh with some colored visualisations, not just as a wireframe mesh. When using one of the visualisations, you can toggle the wireframe on and off.

* Solid Color simply displays a solid color for each triangle.
* Flat Shaded will perform basic flat lighting calculations based on triangle normals to give a better idea of the topology of the mesh.
* Secondary will display the selected secondary mesh element.
* Exploded will display a shaded mesh where vertex colors are a function of the vertex index (SV_VertexID or gl_VertexID). This means adjacent primitives that do not share the exact same vertices can be more easily seen by a hard break in coloring. Additionally, a slider allows displacing vertices along an explosion direction by an amount based on the vertex index, which also helps better visualise shared or disjoint vertices and can also help in visualising other mesh problems (e.g. hidden or duplicate vertices/primitives).

.. figure:: ../imgs/Screenshots/ExploderBadShoes.webp

Exploded: Visualising a mesh with no vertex sharing.

.. figure:: ../imgs/Screenshots/ExploderGoodShoes.webp

Exploded: Visualising a mesh with widely shared vertices.

To select which element will be displayed as secondary, simply right click on the column you would like to use. This can be done on the input and output separately, and 4-component columns have the option to either show RGB as color, or alpha as grayscale.

Expand Down

0 comments on commit 310b57c

Please sign in to comment.