Commit Graph

462 Commits

Author SHA1 Message Date
baldurk dec378eb9b Remove documentation note about outdated compute shader debug limitation 2025-10-31 15:43:37 +00:00
baldurk fb6d4735b3 Do not redeclare __new__ in python stubs 2025-09-11 12:59:22 +01:00
baldurk 493f4c2ec4 Create output folder when generating python stubs and run from any cwd
* Previously it only worked when ran from the docs folder
2025-09-10 15:05:39 +01:00
baldurk 5957a2710b Enforce that all docstrings of members have a :type: 2025-09-09 18:57:35 +01:00
baldurk b4615dbd18 Add a delayed callback helper for python 2025-09-09 18:57:34 +01:00
baldurk c8dc97a34e Add pixel history to the common feature set 2025-09-04 10:06:14 +01:00
baldurk 147f010321 Update vulkan version in the docs 2025-09-04 10:05:42 +01:00
baldurk 29f39f4507 Add VkDescriptorBuffer to documentation index 2025-07-31 01:11:02 +01:00
baldurk 34c3c40787 Document the PDB search priority/algorithm
* This follows PIX's algorithm in most places which although undocumented is
  something many people expect to work. It deviates only when there would be
  significant performance penalties for little gain.
2025-05-02 10:48:10 +01:00
baldurk 6ded6187dc Update python example code using old API member 2025-04-28 11:34:18 +01:00
baldurk 2322e165de Update copyright years to 2025 2025-03-14 18:54:37 +00:00
baldurk f3129c908c Clarify renderdoc module vs library for python 2025-02-24 17:19:46 +00:00
baldurk 32879d6f7c Update docs to mention both python modules version overrides 2025-02-24 17:19:46 +00:00
baldurk 1c7a4c24dd Unwrap staticmethod if necessary when checking python docstrings
* Happens on github CI for some reason.
2025-02-11 00:21:39 +00:00
baldurk e690587683 Update docs for D3D12 shader debugging 2024-12-20 12:03:34 +00:00
baldurk 13ba321e4a Add note to docs about nvidia driver support 2024-12-17 15:33:02 +00:00
baldurk 8634d8ff22 Add page titles and header texts for all python API ref documentation
* Try to guide people looking for an introduction away from API references and
  towards actual explanations and documentation.
2024-12-17 14:32:54 +00:00
baldurk b76bb49994 Add doc about RT support 2024-12-17 14:32:54 +00:00
baldurk 7fe2749b38 Add custom D3D12 interface for per-heap descriptor naming by index 2024-12-13 21:19:47 +00:00
Jake Turner dbe18fc7fe Added ShaderDirectAccess helper struct and ShaderVariable set/get
ShaderDirectAccess is used to reference resources which are accessed directly from the Shader (not via a direct binding). Shader resource references using direct binding are stored in ShaderBindIndex.
2024-12-04 08:37:21 +00:00
baldurk 1c58364627 Update version of nvapi to R560 from github 2024-11-24 00:58:51 +00:00
baldurk 91c935ffde Fix verify-docstrings to handle rdcfixedarray tuples
* Removes a couple of exceptions from functions it can't verify.
2024-11-18 11:31:12 +00:00
baldurk f4d579ffaa Allow specifying tighter alignment than natural for odd buffer cases 2024-10-30 10:33:40 +00:00
baldurk db6e93665f Make it very clear if someone deletes a required section from template 2024-10-28 10:37:54 +00:00
baldurk 6408799b5d Allow specifying scalar pointers in buffer formatter 2024-10-19 01:21:48 +01:00
Aliya Pazylbekova 9ebd796cd8 Remove GGP support 2024-07-08 14:19:42 +01: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 2b40a17f8a Add packing rule for bitfield packing/straddling a la #pragma pack(1) 2024-06-27 13:54:41 +01:00
Jake Turner 1ae6882c90 Updated python setup documentation to include instructions for "VS Code" 2024-06-17 10:41:38 +01:00
baldurk 62b2e2226d Commit modified version of intellij-community stubgen & wrapper script 2024-06-13 13:32:58 +01:00
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