Commit Graph

55 Commits

Author SHA1 Message Date
baldurk e690587683 Update docs for D3D12 shader debugging 2024-12-20 12:03:34 +00:00
baldurk 11463be8a7 Update stale mentions of Vulkan 1.2 2024-05-28 15:09:11 +01:00
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 72d4d2702d Remove references to Stadia 2022-10-28 15:36:26 +01:00
baldurk 7393c6db5a Don't refer specifically to windows 10, include all versions
* Windows versions numbers no longer make sense since 11 is just 10 with a worse
  UI refresh, but since it works the same it will be supported as well.
2022-10-28 15:36:15 +01: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 eb1e625b96 Add better documentation for how to specify separate shader debug info 2022-03-30 14:53:20 +01:00
baldurk 6d5140e5b5 Remove links to deleted wiki pages, and planned/roadmap features doc 2022-03-15 14:34:38 +00: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
Steve Karolewics 1d579dfb66 Update docs about D3D12 shader debugging support 2020-05-15 19:03:00 +01:00
baldurk 91ede3348c Update API methods for detecting RenderDoc's presence 2020-02-21 17:56:52 +00:00
baldurk 0e7f772596 Add Vulkan 1.2 support 2020-01-15 14:00:30 +00:00
Piotr Szpetkowski 343fbed90a Update Vulkan features with VK_EXT_debug_utils 2019-10-25 16:53:29 +01:00
baldurk 1d270254c1 Add documentation for replay options 2019-08-27 18:51:57 +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 25260c29f7 Add mention of Stadia support to README and docs 2019-03-20 05:32:53 +00:00
baldurk db89f50a30 Rename Mesh Output panel to Mesh Viewer, since it displays inputs too 2019-03-08 15:40:11 +00:00
baldurk 3c43b2193c Update docs for new verify buffer access option 2018-11-30 15:40:13 +00:00
baldurk 6aa79f54bd Add Nintendo Switch as supported platform to documentation
* Nintendo Switch support is distributed separately for authorized developers as
  part of the NintendoSDK. For more information, consult the Nintendo Developer
  Portal.
2018-11-30 15:21:16 +00:00
baldurk dc584a6516 Update API versions listed as supported in FAQ 2018-11-30 11:06:43 +00:00
baldurk 046ca0ad12 Document RenderDoc controlling API validation while active. Closes #1121 2018-10-05 18:17:00 +01:00
baldurk 8410cfd5ab Update documentation for latest code changes and features. 2018-07-18 16:23:11 +01:00
baldurk 11091f1e54 Tidy up python documentation and add examples 2018-06-15 19:44:37 +01: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 86200f1a10 Update documentation with new minimum requirements for OpenGL 2017-01-17 18:59:36 +00:00
baldurk 10053b8be8 Update docs to mention that Vulkan/D3D12 don't support Map() verifying 2017-01-09 11:42:47 +00:00
baldurk c1591a5fe6 Update docs with D3D12 support and progress on Qt 2016-11-28 12:42:15 +01:00
baldurk 9ee4653a7a Add triangle size overlay, showing heatmap of triangles < 4x4 in area 2016-10-02 20:04:43 +02:00
baldurk b4503f95cf Remove manual html target="_blank" links from documentation 2016-09-27 15:55:53 +02:00
baldurk 0809778b26 Add a FAQ entry about hooking child processes 2016-09-12 15:09:25 +02:00
baldurk 5b74d2f90a Add a little Ctrl-G popup on the texture viewer to jump to a pixel 2016-07-22 12:28:26 +02:00
baldurk e263c107de Rejig the features list in the docs so it's not one-per-API
* It doesn't make sense when 90% of the features are available in all
  APIs now.
2016-06-09 15:59:43 -07:00
baldurk 0cb940fcbe Support LZ4 compression of stripped separate debug blobs 2016-05-30 12:12:18 +02:00
baldurk 4b7e068703 Rename 'create debug device' capture option to 'API validation'
* More appropriate for non-D3D11 APIs and will cause less confusion.
2016-05-17 21:16:17 +02:00
baldurk 8890233fe0 Set external links to open with target="_blank" for benefit of chm
* Without this, the chm viewer attempts to open the external link in its
  own windows. With some ancient IE6 monstrosity. Ouch.
2016-05-16 20:01:17 +02: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 4a90373458 Add an anchor for the tip about using RenderDoc as an image viewer 2016-05-16 15:42:53 +02:00
baldurk 440c9c4569 Move in application API to root level 2016-05-16 14:43:46 +02:00
baldurk 2b59a806cf Remove header from API page 2016-05-16 14:39:06 +02:00
baldurk e1c63c9561 Fill out the text on the options window page 2016-05-16 13:20:03 +02:00
baldurk a29bed7a5b Refer to images under correct paths 2016-05-15 21:34:06 +02:00
baldurk 1e8967a862 Fix some enumerator definitions that referenced ranges of enums 2016-05-15 21:34:04 +02:00
baldurk e53f50ce03 A couple of FAQ questions not properly header'd 2016-05-15 21:34:01 +02:00
baldurk 81a1b2e020 Add syntax highlighting 2016-05-15 21:34:00 +02:00