Commit Graph

74 Commits

Author SHA1 Message Date
baldurk 565fe17ba2 Add API and usage documentation for custom annotations system 2026-01-28 14:42:11 +00:00
baldurk 94f469de63 Update documentation to account for new mesh viewer options 2025-12-08 18:24:19 +00:00
baldurk 41adeb65b1 Add UI to manage the list of ignored PDBs for callstacks. Closes #3329 2024-06-27 13:54:41 +01:00
baldurk d4b8504bdc Add instructions to documentation on enabling the Nsight perf SDK 2024-04-16 11:04:58 +01:00
baldurk 04bfedcdd5 Add documentation entry for new offset/size configuration option 2024-01-26 12:02:35 +00: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 d77fc1ed22 Update documentation to mention meshlet solid shading 2023-11-30 14:41:14 +00:00
baldurk e7430226e9 Match SPIR-V version as much as possible when rebuilding shaders 2023-08-22 13:41:39 +01:00
baldurk e4751e66f3 Update docs for buffer viewer changes 2022-05-20 14:15:31 +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 8aa0390948 Add string messages to returned result codes to display to user
* Most of the main entry points that can fail with relevant reasons now has a
  way of specifying a message to return with it. This message can be displayed
  to the user to give more information or context about an error.
2022-04-26 16:21:54 +01:00
baldurk eb1e625b96 Add better documentation for how to specify separate shader debug info 2022-03-30 14:53:20 +01:00
baldurk a21d245114 Remove show unused/show empty options from texture viewer 2021-08-26 09:51:37 +01:00
baldurk 6130a120ef Update some out-of-date docs 2021-07-19 16:51:50 +01:00
baldurk 4170e51255 Fix mistaken reference in documentation 2021-07-01 20:29:37 +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 6272683678 Remove event browser settings about hiding empty regions 2021-07-01 15:15:03 +01:00
baldurk fb95285ca1 Put all annotation docs into the same 'how do I' page. Refs #2285
* This page now documents both how to annotate things from code in the
  application, as well as at runtime in the UI.
2021-06-01 13:29:09 +01:00
baldurk 50b2cecc50 Add documentation for shader messages window 2021-05-28 12:19:12 +01:00
baldurk ae96b674c9 Update docs to reference VK_EXT_debug_utils
* VK_EXT_debug_marker still works fine but is deprecated.
2021-01-27 13:03:16 +00:00
baldurk 22dbb188ce Document the new custom shader directories setting 2020-07-22 17:34:40 +01:00
baldurk 5e6ec417c1 Add a global font scale option in settings window
* This lets the user override the default application font.
* Unfortunately Qt seems to behave inconsistently with font scaling from the
  system, so we take the font size initially from QApplication::font() (which
  doesn't always pick up the font size) and scale from there. While this might
  cause some font scaling to be lost it does mean at least we have a consistent
  scale, as otherwise you get some text scaling and others not.
2020-02-13 11:01:45 +00:00
baldurk 5192becb73 Document incomplete texture detection in pipeline state 2020-01-14 18:02:10 +00:00
baldurk 69b998104a Fix xuint -> xint typo in documentation 2020-01-06 16:20:44 +00:00
Steve Karolewics a9a2c3e359 Add tests for viewing depth with ClearBeforeDraw.
Also updated documentation/README files to reflect the changes and
help others get up to speed on editing tests/documentation.
2019-12-20 20:11:53 +00:00
baldurk c82d0f58b9 Rename WASD to Flycam in mesh viewer controls
* This should now work regardless of keyboard layout, e.g. on AZERTY the same
  physical keys will still work. We also add arrow keys as a backup
2019-12-13 16:37:14 +00:00
baldurk 9a5c4531e9 Explicitly document what capturing frame 0 means. 2019-11-01 11:31:25 +00:00
baldurk 1d270254c1 Add documentation for replay options 2019-08-27 18:51:57 +01:00
baldurk 5cdaf8491b Explain the background colour for view-important pipeline state bindings 2019-07-22 14:52:42 +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 a820934a22 Fix description of float controls - maximum decimal places not sigfigs 2019-04-26 14:02:42 +01:00
baldurk 1296f92a94 Mention that dynamically unused pipeline state resources are hidden 2019-04-26 13:52:34 +01:00
baldurk 944c18e6fe Add mention of 'load last settings' button on capture dialog 2019-04-26 13:44:39 +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 f20e871510 Add option to make y-flipping a per-texture state instead of global 2019-02-04 18:06:10 +00:00
baldurk 13e7d1c134 Support display of YUV textures on D3D11, D3D12 and Vulkan
* Supported textures are decoded into standard format of YUVA, displayed
  visually with Y in green, U in blue, V in red.
* A new texture display mode 'YUVA decode' has been added which does a default
  full-range conversion from YUV to RGB.
* Custom shaders can be used to implement a custom decode matrix.
2018-12-14 20:14:07 +00:00
baldurk 204724bebe Add documentation for python extensions 2018-11-30 16:42:49 +00:00
baldurk fac080ab4d Add documentation for expanded shader processing tools functionality. 2018-11-30 16:25:24 +00:00
baldurk 8b1251a8b8 Add a note to the RGP howto page to enable RGP integration 2018-11-30 16:04:01 +00:00
baldurk 3c43b2193c Update docs for new verify buffer access option 2018-11-30 15:40:13 +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 e5835aa6b3 Add documentation for shader viewer and ISA disassembly views 2018-05-08 15:08:49 +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 4532d04b5b Remove stale documentation about python scripting 2017-07-14 22:44:20 +01:00
baldurk c7acbb3990 Document the QRenderDoc python API 2017-04-18 14:57:49 +01:00
baldurk 83f769a2cd Document the enums in replay_enums.h 2017-04-18 14:57:44 +01:00
baldurk d2d86b5726 Add 'floateleven' buffer format for R11G11B10 packed data, fix unpacking 2017-03-20 13:02:20 +00:00