baldurk
0628f10b9a
Fix docstring/function signature errors
2026-09-12 10:27:55 +01:00
baldurk
48b968e9a7
Add a MiniQtHelper to set spacing/margins on layouts
2026-09-11 21:17:19 +01:00
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
2ada3ed28d
Fix order of operations in shutdown
...
* When calling OnCaptureClosed now this is book-ended so called *while* the
capture is opened. Do not refresh and repopulate EventBrowser cache.
2026-09-11 15:03:59 +01:00
baldurk
ca9bde9a98
Add proper optional argument defaults for optional callbacks
2026-09-01 12:28:09 +01:00
baldurk
1aac7afdf1
Add helper function for appending text to a textedit
2026-08-31 12:13:26 +01:00
baldurk
0690269cb7
Add shortcuts for using user's preferred fixed font in MiniQtHelper
2026-08-31 11:27:30 +01:00
baldurk
da8132b69c
Add MiniQtHelper functions for scrolling widgets
2026-08-31 11:26:05 +01:00
baldurk
a1b76c231e
Improve the workflow for extensions that fail on import
2026-08-28 15:46:23 +01:00
baldurk
81bec684a3
Expose proper capture closing function to python extensions
2026-08-28 15:46:23 +01:00
baldurk
e20c2b9985
Expose buffer interpretation helpers to python
2026-08-13 21:05:15 +01:00
baldurk
022a5e1438
Change python scripting 'debug' button to just attach, not run
2026-08-13 21:05:14 +01:00
baldurk
83a80ad9dc
Add some notes to main interface docstrings of where they are obtained
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
5e462c5ebe
Add type hints to python for class constructors
...
* We enforce default and copy constructors where possible, this isn't very
pythonic but we can't use copy.deepcopy on our types.
* The structs that have specialised constructors e.g. FloatVector or Subresource
also have those documented though we have no way to enforce it.
2026-08-13 17:46:47 +01:00
baldurk
40945e6e8a
Explicitly note that MiniQtHelper callbacks are optional
2026-08-13 17:46:47 +01:00
baldurk
61e21aa7b5
Fix incorrect reference in docstring
2026-08-13 17:46:47 +01:00
baldurk
a02741381b
For convenience expose InvokeOntoUIThread directly from CaptureContext
...
* This can be useful in python scripts and it's odd to have to go via the
MiniQtHelper just for this.
2026-08-13 17:46:46 +01:00
baldurk
00159dafac
Fix overload documentation for AsyncInvoke in replay manager
...
* Python can't properly document fully independent overloads, only default-
parameter type overloads. Moving the tag to last as an optional parameter
means we can eliminate the different variants.
* For cleanliness in C++ code we make an internal variant that swaps the
parameters, since it is much cleaner to have a lambda callback as the last
parameter.
2026-08-13 17:46:46 +01:00
baldurk
2d0ba78a49
Add a function to fetch the texture display config from texture viewer
2026-08-13 17:46:46 +01:00
baldurk
7d2477026a
Add TextureViewer.GetChannelVisibility that returns a tuple
...
* This is more natural to access and use from python. The old function could
probably be removed but since we also changed the name we'll keep it.
2026-08-13 17:46:46 +01:00
baldurk
3f653cfbf2
Remove RENDERDOC_GetDefaultCaptureOptions, initialise in constructor
2026-08-13 17:46:46 +01:00
baldurk
e3b0fa0a24
Add UI thread invokers for all windows
...
* This is necessary as they expect to be run on the UI thread, but can be
fetched from python scripts running on the python script thread. We block
invoke over to the UI and suspend python's GIL to avoid deadlocks.
2026-08-13 17:46:46 +01:00
baldurk
db75eec620
Expose capture connection windows to python scripting
2026-08-13 17:46:46 +01:00
baldurk
7806d1557d
Rename CaptureDialog::TriggerCapture to Launch as better naming
2026-08-13 17:46:45 +01:00
baldurk
4f3dab116b
Properly update docstrings with optional/default parameters
2026-08-13 17:46:45 +01:00
baldurk
7fab2e0e0a
Add a forwarding ReplayController wrapper for python that auto invokes
2026-08-13 17:46:44 +01:00
baldurk
c97850e39b
Allow customisation of VS Code executable
2026-08-13 17:46:44 +01:00
baldurk
459bfb2592
Add a project explorer to the python scripting window
...
* This displays the current UI extension files, some built-in examples, and
recently opened loose files
2026-08-13 17:46:44 +01:00
baldurk
c95a69c8a1
Returning const arrays forces a copy
...
* This doesn't cover all cases but helps with 'pythonic' cases where a list
returned from a function should be expected to be mutable. Modifying direct
'members' can still modify through const.
2026-08-13 17:46:43 +01:00
baldurk
2aff86b678
Change python scripting panel to allow multiple editor windows
...
* We also remove the old completion/help functionality as it will be replaced.
2026-08-13 17:46:43 +01:00
baldurk
a70ee3a2eb
Watch python extensions for changes on disk and update status bar
...
* We show a button to quickly reload changed extensions.
2026-08-13 17:46:41 +01:00
baldurk
a995ded466
Add quick-helper to view extension output from manager dialog
2026-08-13 17:46:41 +01:00
baldurk
02ead51303
Add a status entry showing loaded python extensions & debugger status
2026-08-13 17:46:40 +01:00
baldurk
3ff393c91f
Add option to launch/wait for debugger on python contexts
2026-08-13 17:46:40 +01:00
baldurk
d71827d6a1
Load debugpy when possible to allow python debugging in-program
2026-08-13 17:46:39 +01:00
baldurk
965d788fe5
Add a settings window entry to add extra python stubs paths
2026-08-13 17:46:39 +01:00
baldurk
a23ee5f526
Change documentation for callbacks to use Callable[]
2026-08-13 17:46:38 +01:00
baldurk
206d732ade
Check serialised shader tool enums against known list
...
* Prevents an out of bound error from corrupt configs (or configs from the
future!)
2026-05-15 13:09:20 +01:00
baldurk
109e524d5c
Improve cross-module references in docstrings
2026-03-13 13:07:44 +00:00
baldurk
2d1c7653f5
Add an analytic flag for use of custom annotations API
2026-01-28 14:42:11 +00:00
baldurk
13ad7875f2
Add annotation display in resource inspector and as standalone panel
2026-01-28 14:42:10 +00:00
baldurk
5c8a4f144b
Add a custom annotation column to the event browser
2026-01-28 14:42:09 +00:00
baldurk
856c838def
Update copyright years to 2026 and fix copyright ranges
...
* In a previous update in 2021 many copyright ranges were truncated
accidentally, and some files have been copy-pasted with wrong years. These
dates have been fixed based on git history and original copyright messages.
2026-01-05 14:17:28 +00:00
Jake Turner
cf4e8b15fc
ICaptureContextx APIs for externally referenced dependency files
...
void EmbedDependentFilesIntoCapture();
void RemoveDependentFilesFromCapture();
2025-12-11 11:13:29 +13:00
baldurk
45eabffb54
Update mesh viewer to allow better customisation. Closes #1811
2025-12-08 18:24:19 +00:00
baldurk
7e518e813c
Add support for fully customised mesh viewer controls
2025-12-08 15:50:17 +00:00
Jake Turner
c2015de391
Resource Usage UI changes
...
Add a column that shows the parent marker for the event range (by default the end event ID)
Add an option to prevent combining resource usage across markers (group by marker)
The tooltip for a resource usage entry contains the full marker path
2025-12-03 11:20:23 +13:00
baldurk
9e0d6f18d6
Display a message when we can't debug a pixel shader and show a history
2025-10-08 22:34:53 +01:00
baldurk