Commit Graph

102 Commits

Author SHA1 Message Date
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 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
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
Aliya Pazylbekova 9ebd796cd8 Remove GGP support 2024-07-08 14:19:42 +01:00
Jake Turner 1ae6882c90 Updated python setup documentation to include instructions for "VS Code" 2024-06-17 10:41:38 +01:00
baldurk 62e7ccda1c Update shader fetch example for new APIs 2024-05-29 10:57:37 +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
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
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
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 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
baldurk 09bc166f1a Add missing documentation reference 2023-08-01 09:44:00 +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
baldurk d47e79ae07 Update copyright years to 2023 2023-02-01 12:23:32 +00: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 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 e4751e66f3 Update docs for buffer viewer changes 2022-05-20 14:15:31 +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 fcdea67879 Update copyright years to 2022 2022-02-17 17:38:32 +00:00
Remi Palandri d1858f4479 add support for VK_QCOM_FDM_offset 2022-02-14 21:02:27 +00:00
baldurk 7320aa27a1 Add ShaderSourcePrefix to docs index 2022-01-31 20:38:06 +00:00
baldurk 62babcb497 Fix python example for API change 2021-11-24 14:08:52 +00:00
John Kattukudiyil a2978dc33d readded custom axis mapping button and updated documentation 2021-11-08 11:39:28 +00:00
baldurk 88d005d945 Update python examples to work with latest code 2021-07-28 11:37:14 +01:00
baldurk d0accc409b Rename 'name' member of ActionDescription to 'customName'
* This is a deliberate break of compatibility since the field is now often
  empty, for non-markers. This means code will get a more explicit error when
  the name is being referenced, so it can be updated to fetch the name it needs
  as needed.
2021-07-01 15:15:05 +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 57a0463aa2 Add new classes to python documentation index 2021-05-11 17:34:31 +01:00
baldurk 2a61a7f32d Fix documentation build 2021-04-14 19:59:07 +01:00
baldurk 30dd13feb8 Pull index byte width and topology out of drawcall state
* These are treated as state on most APIs, only GL treats it as a drawcall
  parameter.
2021-02-24 13:52:07 +00:00
baldurk fc2b2c11cc Include ShadingRateCombiner in the documentation 2021-02-10 15:07:37 +00:00
baldurk dabd2a803a Give specific instructions on writing UI extensions
* This goes through a worked example of a simple extension.
2021-01-27 16:05:03 +00:00
baldurk 9424b8a3fe Add documentation on setting up python dev environment 2021-01-27 16:05:03 +00:00
baldurk 7ff7e0a71d Replace fixed C arrays with wrapper class in public interface
* These map more naturally to python tuples and are easier to wrap in and out.
* We also tidy up the FloatVecVal etc and standardise the members of
  ShaderValue.
2020-12-09 18:16:08 +00:00
baldurk 580f96c8a1 Rename ShaderVariableType/Descriptor to ShaderConstant
* These structs are no longer used with ShaderVariable so the name is misleading
  at best.
2020-12-09 15:18:27 +00:00
baldurk df6fec13f9 Remove use of automodule in docs
* One automodule in a file for our modules is way too much, so we split it into
  files. Unfortunately this means that only one file can have those classes and
  functions be linkable from elsewhere.
* Instead we bite the bullet and manually curate the items into pages, and at
  the same time subdivide the 'enums and data' page more which is a general
  readability and usability win as well.
* We also add some previously not-included functions, and add a doc-build time
  check to ensure that functions and classes aren't omitted from the
  documentation in future
2020-12-07 17:44:50 +00:00
baldurk 949cff30a2 Add some Qt python interfaces not included in docs 2020-11-27 14:30:01 +00:00
baldurk 6c26562201 Remove duplicate documentation entry for GlobalEnvironment 2020-11-27 14:19:33 +00:00
baldurk 58e16414e0 Add a number of control functions to the Qt python interface 2020-11-20 17:02:33 +00:00
baldurk 75c3156286 Add note that python scripting on Android is unreliable and unsupported
* It may work since the python scripting is generally not Android specific, but
  Android itself is quite likely going to cause problems that are out of scope.
2020-10-21 10:24:35 +01:00