diff --git a/docs/getting_started/quick_start.rst b/docs/getting_started/quick_start.rst index ecbf9941bd8..714ce6a95a9 100644 --- a/docs/getting_started/quick_start.rst +++ b/docs/getting_started/quick_start.rst @@ -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. diff --git a/docs/imgs/Screenshots/ExploderBadShoes.webp b/docs/imgs/Screenshots/ExploderBadShoes.webp new file mode 100644 index 00000000000..d2e024c724a Binary files /dev/null and b/docs/imgs/Screenshots/ExploderBadShoes.webp differ diff --git a/docs/imgs/Screenshots/ExploderGoodShoes.webp b/docs/imgs/Screenshots/ExploderGoodShoes.webp new file mode 100644 index 00000000000..a006e48ed0d Binary files /dev/null and b/docs/imgs/Screenshots/ExploderGoodShoes.webp differ diff --git a/docs/window/mesh_viewer.rst b/docs/window/mesh_viewer.rst index bb7cdad4513..c8ff15ded20 100644 --- a/docs/window/mesh_viewer.rst +++ b/docs/window/mesh_viewer.rst @@ -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.