Commit Graph
51 Commits
Author SHA1 Message Date
baldurk 83c53890da Mark accessors/return values that can be None with Optional[]
* This helps with type checkers to know that things can be None or not (both to
  silence previous warnings about "unnecessary" checks that are actually
  necessary, and to ensure those checks aren't omitted by accident)
2026-09-11 15:04:03 +01:00
baldurk da4350a759 Add an example of advanced buffer format/processing 2026-08-13 21:05:16 +01:00
baldurk ed38da72ab Add writeups of each example 2026-08-13 21:05:11 +01:00
baldurk ec5cd1f049 Add new python examples, also available embedded into UI 2026-08-13 21:05:11 +01:00
baldurk 11b83f2272 Remove old python documentation, ready for replacement 2026-08-13 21:05:11 +01:00
baldurk d4130ce42a Enable nitpicking in sphinx documentation build and fix some broken refs 2026-08-13 17:46:49 +01:00
baldurk bb4017a965 Add a spellchecking mode for sphinx and fix some typos
* The worst one was Persistant -> Persistent. This involved renaming
  PersistentConfig but the impact of that is considered minimal enough to be
  worth fixing.
2026-08-13 17:46:47 +01:00
baldurk 950568fb8f Rename previous/next to previousAction/nextAction in ActionDescription
* swig internally creates 'next' member which we normally want to avoid, so
  prevent shadowing here by using a distinct name.
2026-08-13 17:46:47 +01:00
Kirill Kozlov 39ecdedcc1 Fix code snippet in the fetch_shader.rst
Make it the same as in the fetch_shader.py
2026-06-30 20:53:42 +09:00
baldurk 6ded6187dc Update python example code using old API member 2025-04-28 11:34:18 +01: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 62e7ccda1c Update shader fetch example for new APIs 2024-05-29 10:57:37 +01:00
baldurk 474a991419 Update documentation to reference new descriptor APIs 2024-04-10 18:58:53 +01: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 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 62babcb497 Fix python example for API change 2021-11-24 14:08:52 +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 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 c8fcdbae05 Update fetch_shader python example to latest API 2020-09-14 15:58:20 +01:00
baldurk d5f45f6476 Allow overriding the python install on windows
* Also document the new requirement for os.add_dll_directory as of python 3.8
2020-08-31 12:38:49 +01:00
baldurk 287bb81fca Add a note about the python module version restriction 2020-07-24 16:33:34 +01:00
baldurk 6a8e7cbbe5 Fix python examples not being up to date with latest API changes 2020-07-20 10:52:59 +01:00
sindney 34b3484baa Update decode_mesh.py 2020-06-16 11:01:28 +01:00
sindney 689f6960c0 fix unpackData max negative 2020-06-16 11:01:28 +01:00
sindney 8e267c01ba fix unpackData bug when unpacking UNorm and SNorm data 2020-06-16 11:01:28 +01:00
baldurk fa9215477d Update examples to latest python API 2020-05-20 11:51:52 +01:00
baldurk 63c1ecd89c Handle vertexOffset properly in mesh decode example. Closes #1852 2020-04-28 18:15:34 +01:00
baldurk 98af55d513 Fix fetch_shader example for latest API changes 2020-03-05 19:35:45 +00:00
baldurk 4e4ef40612 Add replay API initialisation/shutdown to python examples 2020-03-05 19:35:45 +00:00
baldurk 82fca7d325 Make the display_window.py example quit after a few loops 2020-01-15 10:02:20 +00:00
baldurk 7d22448d3f Sample code should take the capture to load as an argument
* This makes it easier to run the examples from the command line without editing
  them
2020-01-15 09:23:12 +00:00
baldurk b450b3ff29 Fix qrenderdoc examples for latest API 2020-01-10 14:59:11 +00:00
baldurk ba16bd9bfe Pass PSO when decoding cbuffer variables in python example 2019-09-18 13:04:50 +01:00
baldurk 702c7cf093 Add use of ReplayOptions to python API examples 2019-09-18 13:04:38 +01:00
Waffle fa18367109 Updated documentation with unpackData fix
Updated example documentation to match the already accepted "Fixed Incorrect Tuple Usage in unpackData" fix.
2019-08-13 10:33:34 +01:00
baldurk e2704fa2eb Add an abstracted interface around android-specific handling
* This makes it easier to use the same kind of interface to manage other kinds
  of devices.
2019-07-31 17:51:13 +01:00
Waffle 9aaca1bb5f Fixed Incorrect Tuple Usage in unpackData
Fixed "IndexError: tuple index out of range"
`value = tuple(float(value[i]) / divisor for i in value)`
Was effectively attempting to access the value tuple using an element as an index.

`value = tuple(float(i) / divisor for i in value)`
Uses the elements from the tuple and modifies them.

Ex: (0,0,0,255) becomes: (0.0, 0.0, 0.0, 255.0)
Instead of throwing an error.
2019-07-22 12:42:26 +01:00
baldurk ec1f104b44 Shutdown capture file properly in python example 2019-04-12 11:04:54 +01:00
baldurk 27a4353ffa Fix out of date python use in documentation examples 2019-01-16 12:38:10 +00:00
baldurk 416646d027 Fix example python scripts to work in the UI as well
* In the UI program we can't import renderdoc (it's already imported) so we just
  alias it to rd.
2018-08-29 20:50:14 +01:00
baldurk bd97664681 Fix incorrect copy-pasted title on docs page 2018-07-26 17:24:24 +01:00
baldurk 34d689b809 Include fetch_counters example in index 2018-06-25 21:58:02 +01:00
baldurk 2476474ca9 Add python sample for fetching counters 2018-06-25 18:14:04 +01:00
baldurk 24adf08a75 Remove references to deleted CommonPipelineState 2018-06-21 17:46:15 +01:00
baldurk 0dda96a045 Change previous/next/parent IDs in DrawcallDescription to pointers
* This is a legacy holdover from the C# interop not being able to preserve
  pointers easily.
2018-06-18 18:39:06 +01:00
baldurk 14e3a3d360 Move API-agnostic pipeline state wrapper into core interface
* There's no need for this to be in the UI, and moving it allows it to be used
  from script which is very useful.
2018-06-18 18:39:06 +01:00