Commit Graph

432 Commits

Author SHA1 Message Date
baldurk 62e7ccda1c Update shader fetch example for new APIs 2024-05-29 10:57:37 +01:00
baldurk 11463be8a7 Update stale mentions of Vulkan 1.2 2024-05-28 15:09:11 +01:00
baldurk d4b8504bdc Add instructions to documentation on enabling the Nsight perf SDK 2024-04-16 11:04:58 +01:00
baldurk d3dac4dfc0 Add missing documentation entries for descriptor viewer & root sig 2024-04-10 21:33:19 +01:00
baldurk b7f2e8a178 Add documentation explaining use of new descriptor abstraction in python 2024-04-10 18:58:53 +01:00
baldurk 474a991419 Update documentation to reference new descriptor APIs 2024-04-10 18:58:53 +01:00
kb1000 c16b2f34cd Add pythoncapi-compat third party library acknowledgement 2024-04-08 10:57:28 +01:00
Jake Turner 7934d1d16e Change DebugPixel() to take a DebugShaderInputs struct
DebugShaderInputs struct contains existing the parameters:

sample
primitive

and a new parameter

view

Default constructor for DebugShaderInputs sets the parameters to NoPreference (~0U).
2024-03-13 07:58:48 +00:00
Jake Turner 01b9c8234e D3D12 Pixel History support and acknowledgement 2024-03-07 12:52:41 +00:00
baldurk 9f4f0e6aa1 Update copyright years to 2024 2024-02-12 11:04:52 +00:00
baldurk 6de0787b58 Update docs to mention customising python path on module project as well 2024-01-30 20:33:13 +00:00
baldurk 1e70124bd6 Support setting overridden python path via VS properties page 2024-01-30 20:29:07 +00: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
Jake Turner 6ce881d5da UI and Config support for dec/hex display option for Offsets or Sizes
Used when fields are marked as being an Offset or Size
Include simple latch to trigger a UI refresh when closing the settings dialog.
Currently only connected to if the Offset/Size format option is altered
2023-12-06 17:19:05 +00:00
baldurk d77fc1ed22 Update documentation to mention meshlet solid shading 2023-11-30 14:41:14 +00:00
baldurk 69dcb42a05 Add enums and API-agnostic handling for new task and mesh shader stages
* The enums are given after compute, to preserve indices for the normal vertex
  pipeline.
* Mesh dispatches are considered a new action type, rather than being bundled
  into the `Drawcall` type. This will allow them to be distinguished by API
  backends as needed. The UI treats them as drawcalls
* We apply this universally even though it's not relevant to D3D11/GL. It means
  a couple of empty array entries but it should not cause any significant
  issues.
* Shader messages will be identified by group and thread as with compute
  shaders. For mesh shaders there is an additional subdivision to identify them
  by task group, since each task group can submit a grid of mesh groups.
2023-11-16 18:20:23 +00:00
Jake Turner 7d2094d52b Add a link to "below section" to the buffer viewer struct docs 2023-11-16 09:00:14 +00:00
William Pearson a64c24ff96 Add missing brackets to docs/how/how_buffer_format.rst 2023-11-09 17:57:02 +00:00
Eveline Jarosz 7f92b0241e fix copyrights 2023-09-28 13:52:23 +01:00
baldurk 815c88b932 Update Ubuntu dependencies to prioritise newer (18.04 and up) versions 2023-09-13 16:26:29 +01:00
baldurk 4d94209ec1 Change fixed clang-format version to 15
* We commit statically linked x64 binaries for clang-format-15 for windows and
  linux to make the transition easier for anyone running a linux distro that
  doesn't yet support llvm 15, or in future for distros that drop support for
  it.
2023-09-05 11:02:08 +01:00
baldurk e7430226e9 Match SPIR-V version as much as possible when rebuilding shaders 2023-08-22 13:41:39 +01:00
baldurk 09bc166f1a Add missing documentation reference 2023-08-01 09:44:00 +01:00
baldurk 9e93154383 Fix sphinx rtd theme for new sphinx version 2023-05-01 17:43:49 +01:00
baldurk 4524cddca9 Update documentation to account for GL pixel history support 2023-03-31 19:56:04 +01:00
郝华青(Huaqing.H) 58f0e7bc42 fixing a documentation example
Fix the following errors in the sample code:
AttributeError: 'renderdoc.ActionDescription' object has no attribute 'name'
NameError: name 'window_callback' is not defined
2023-03-17 08:30:09 +00:00
Orson Baines c8b011344d Remove feature toggle for OpenGL Pixel History 2023-02-25 10:52:53 +00:00
baldurk 45369d7f94 On python 3.8+ call os.add_dll_directory in documentation build
* This nonsense is needed to load the renderdoc.dll from the python module,
  because python broke normal windows DLL loading behaviour.
2023-02-02 13:14:04 +00:00
baldurk d47e79ae07 Update copyright years to 2023 2023-02-01 12:23:32 +00:00
baldurk 080b3dbb75 Add license note for nvidia nsight perfsdk redistributable portions 2023-02-01 11:22:22 +00:00
Jake Turner 25f764e702 Mac: Add 'pcre' to Mac required dependencies 2022-12-10 20:24:40 +01:00
baldurk 24da6390eb Document the new methods of generating SPIR-V shader debug information 2022-11-24 22:58:12 +00:00
baldurk dfe07d6822 Update application API to 1.6.0, add capture title setter 2022-11-21 13:49:15 +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 387a9e5702 Fix documentation references 2022-09-23 14:10:03 +01:00
Shahbaz Youssefi ed4c3756d0 Enable primitive restart for list topologies
This is supported by OpenGL, and on Vulkan with
VK_EXT_primitive_topology_list_restart.  On Vulkan, all drivers are
known to support this even without
VK_EXT_primitive_topology_list_restart.  On D3D, primitive restart is
only supported for strip topologies.

Previously, RenderDoc specifically disabled primitive restart for
non-strip topologies.  In this change, that is no longer done.  If the
app enables primitive restart, so will RenderDoc behave accordingly.  It
would be the responsibility of the app to avoid primitive restart if the
API doesn't allow it.
2022-08-29 14:59:14 +01:00
baldurk 9bb25f4652 Switch web IRC links from kiwiirc to webchat.oftc.net 2022-08-18 15:54:46 +01:00
baldurk 605f8a0566 Fix documentation issues 2022-08-10 23:52:24 +01:00
baldurk 826ec45594 Add missing struct reference in docs 2022-08-03 22:23:11 +01:00
baldurk 7c68746fd9 Add missing reference to struct in python docs 2022-07-11 13:48:28 +01:00
baldurk 6870329a9e Detect java not being in PATH at all, document java PATH requirement 2022-06-30 13:51:26 +01:00
baldurk 6d7d4829ee Fix docs build on sphinx 5 2022-05-30 17:09:17 +01:00
baldurk d7404bb66d Fix missing newline in docs code snippet 2022-05-20 17:00:47 +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
Bertrand Guay-Paquet cb0dc39bf3 Add link to the contrib repository for custom visualisation 2022-04-22 13:49:56 +01:00
baldurk eb1e625b96 Add better documentation for how to specify separate shader debug info 2022-03-30 14:53:20 +01:00