Commit Graph

18 Commits

Author SHA1 Message Date
Dan Hawson 442b48bb77 Mesh exploder
New 'Exploded' visualisation mode in BufferViewer with new exploder controls
hidden when not in 'Exploded' mode.

Change 'solidShading' and 'solidShadeMode' to 'visualisation' and
'visualisationMode'.

Hide the 'highlightVerts' widget when using 'Exploded' vis for both
real-estate and practical implementation reasons.
2023-12-09 11:40:30 +00:00
baldurk 949165d739 Split mesh and buffer viewer documentation up
* There's no reason to make users aware that the mesh viewer and buffer viewer
  are implemented in a common way, they are very different and should be
  documented separately.
* This hasn't updated the buffer viewer documentation with the recently added
  features.
2022-05-20 13:37:26 +01:00
baldurk b64fa99d2b Update documentation for event browser changes 2021-07-01 19:27:34 +01:00
baldurk 7149302680 Rename 'draw' or 'drawcall' to action
* There's not a good accepted terminology for this kind of event, and for
  historical reasons 'drawcall' has been the accepted term, even though
  that can be quite confusing when a dispatch or a copy is a 'drawcall'.
* This is particularly highlighted by the event browser filters where
  $draw() includes draws and dispatches, but $dispatch() only includes
  dispatches, it's hard to intuitively understand why $draw() matches all
  of these calls.
* As a result we've defined the term 'action' to cover these types of
  events in the same way that we defined 'event' in the first place to
  mean a single atomic API call.
2021-07-01 15:15:05 +01:00
baldurk c276d3dc4f Make some misc tweaks and updates to the docs 2021-06-29 16:55:53 +01:00
Wasin Thonkaew 1026ce481d fix url of debug markers sample 2019-07-23 14:46:04 +01:00
baldurk 96cc08b960 Rename 'show disabled' button to 'show unused' as it is clearer
* Bindings that are unused aren't disabled - they may in fact be explicitly
  enabled - but they are unused by the pipeline which is why they're hidden.
2019-05-17 16:32:55 +01:00
baldurk 06b91f3d57 Update quick start image of timeline bar & remove mention of pip colours 2019-05-17 16:32:55 +01:00
baldurk db89f50a30 Rename Mesh Output panel to Mesh Viewer, since it displays inputs too 2019-03-08 15:40:11 +00:00
baldurk 1a9e22e2f2 Correct spelling/grammar mistakes in docs 2018-05-08 14:09:27 +01:00
baldurk 933c00985d Update documentation for v1.0
* Screenshots and icons are updated to latest style
* Many out-dated references and mentions of support updated.
* Documentation added for new windows like resource inspector and
  performance counter viewer, as well as new features like saving
  bookmarks, resource names.
* Added documentation for Android support as well as OpenGL ES support.
2018-02-25 23:27:13 +00:00
baldurk 8bc80b41b0 Various improvements/tweaks/missing bits/extra links
* General proof-reading pass on the new docs, so some of these issues
  are old and just haven't been noticed before.
2016-05-16 20:01:15 +02:00
baldurk 3146b905b5 Remove unneeded toctree:: statements in non-index pages 2016-05-16 18:35:39 +02:00
baldurk a29bed7a5b Refer to images under correct paths 2016-05-15 21:34:06 +02:00
Matthäus G. Chajdas 4bb04c6dae Fix broken link and some missing emphasis. 2016-05-15 21:33:55 +02:00
Matthäus G. Chajdas f124f3f389 Port the remaining pages where I know how to style them. 2016-05-15 21:33:54 +02:00
Matthäus G. Chajdas 6557cec9ea Fix various internal links. 2016-05-15 21:33:53 +02:00
Matthäus G. Chajdas c04dd86d8d Initial commit of new restructuredtext docs 2016-05-15 21:33:51 +02:00