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
287bb81fca
Add a note about the python module version restriction
2020-07-24 16:33:34 +01:00
6a8e7cbbe5
Fix python examples not being up to date with latest API changes
2020-07-20 10:52:59 +01:00
34b3484baa
Update decode_mesh.py
2020-06-16 11:01:28 +01:00
689f6960c0
fix unpackData max negative
2020-06-16 11:01:28 +01:00
8e267c01ba
fix unpackData bug when unpacking UNorm and SNorm data
2020-06-16 11:01:28 +01:00
fa9215477d
Update examples to latest python API
2020-05-20 11:51:52 +01:00
63c1ecd89c
Handle vertexOffset properly in mesh decode example. Closes #1852
2020-04-28 18:15:34 +01:00
dd4009c588
Remove undoc-members attributes from autoclass docs builds
2020-04-07 09:55:17 +01:00
98af55d513
Fix fetch_shader example for latest API changes
2020-03-05 19:35:45 +00:00
4e4ef40612
Add replay API initialisation/shutdown to python examples
2020-03-05 19:35:45 +00:00
82fca7d325
Make the display_window.py example quit after a few loops
2020-01-15 10:02:20 +00:00
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
b450b3ff29
Fix qrenderdoc examples for latest API
2020-01-10 14:59:11 +00:00
7454e9047e
Ensure only one sphinx module:: directive exists
...
* Others using automodule:: must have :noindex:.
* I'm unclear when this is required - travis hit an error on this but I couldn't
reproduce it locally, but it seems harmless.
2020-01-06 16:20:44 +00:00
50da67195c
Add missing Create*WindowingData to documented functions
2019-12-18 19:09:17 +00:00
47fdb5add3
Exclude StructuredBufferList, StructuredObjectList from python docs
...
* These types should be mapped/treated invisibly as native python lists.
2019-11-12 20:44:35 +00:00
a94f238e37
Ensure PersistantConfig member functions are documented
2019-10-09 10:25:49 +01:00
ba16bd9bfe
Pass PSO when decoding cbuffer variables in python example
2019-09-18 13:04:50 +01:00
702c7cf093
Add use of ReplayOptions to python API examples
2019-09-18 13:04:38 +01:00
07158ad24c
Fix support for triangle fans on GL/Vulkan
2019-08-20 15:33:12 +01:00
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
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
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
ec1f104b44
Shutdown capture file properly in python example
2019-04-12 11:04:54 +01:00
27a4353ffa
Fix out of date python use in documentation examples
2019-01-16 12:38:10 +00:00
91a7d45f85
Document new python version info functions
2018-11-30 15:48:42 +00:00
fa99ca9246
Document python extensions API
2018-10-23 14:23:12 +01:00
ce213c8f43
Add some missing items into the qrenderdoc python docs index
2018-10-18 19:38:04 +01:00
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
b1246c28ae
Update docs reference to renamed SPIRVDisassembler class
2018-08-09 17:26:47 +01:00
bd97664681
Fix incorrect copy-pasted title on docs page
2018-07-26 17:24:24 +01:00
34d689b809
Include fetch_counters example in index
2018-06-25 21:58:02 +01:00
2476474ca9
Add python sample for fetching counters
2018-06-25 18:14:04 +01:00
24adf08a75
Remove references to deleted CommonPipelineState
2018-06-21 17:46:15 +01:00
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
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
11091f1e54
Tidy up python documentation and add examples
2018-06-15 19:44:37 +01:00
933c00985d
Update documentation for v1.0
...
* Screenshots and icons are updated to latest style
* Many out-dated references and mentions of support updated.
* Documentation added for new windows like resource inspector and
performance counter viewer, as well as new features like saving
bookmarks, resource names.
* Added documentation for Android support as well as OpenGL ES support.
2018-02-25 23:27:13 +00:00
6572cd97f5
Tidy up handling of windowing data, make it a bit more type safe
2018-01-01 17:31:19 +00:00
06a25013c1
Fix ' character that was accidentally pasted in
2017-12-22 22:09:43 +00:00
691f91c9aa
Re-organise and tidy python API documentation
2017-12-22 14:41:43 +00:00
ebaefc82a9
Normalise and make python/public interface more consistent
...
* We enforce a naming scheme more strongly - types, member functions,
and enum values must be UpperCaseCamel, and member variables must be
lowerCaseCamel. No underscores allowed.
* eventId not eventID or EID, and Id preferred to ID in general. Also
for resourceId.
* Removed some lingering hungarian m_Foo naming.
* Some pipeline state structs that are almost identical between the
different APIs are pulled out into common structs. Where something
doesn't make sense (e.g. viewport enable for vulkan) it will just be
set to a sensible default (in that case always true).
* Changed scissors to be x/y & width/height instead of sometimes
left/top/right/bottom
* Abbreviations are discouraged, e.g. operation not op, function not
func.
2017-12-22 13:02:36 +00:00
229febfbcb
Update python API references to latest renames/reorganisations
2017-12-15 17:33:54 +00:00
4caa05c2b9
Remove reference to removed GetCommitHash function in the docs
2017-04-28 18:36:54 +01:00
c7acbb3990
Document the QRenderDoc python API
2017-04-18 14:57:49 +01:00
6930841705
Rename ReplayRenderer to ReplayController
...
* It's not a renderer, it's an interface to controlling the replay and
any 'renderer' type work actually happens in ReplayOutput.
2017-04-18 14:57:47 +01:00
a7ab0d9300
Move capture-file handling functions into a single interface
...
* This allows us to return complex types like byte arrays or pairs of
status & render handle.
* Also in future more introspection of the capture file will be possible
and this provides an easy extension to that without adding new entry
points.
2017-04-18 14:57:47 +01:00
f476058567
Pull the ultimate parent pipeline object to the top of any docs page
2017-04-18 14:57:46 +01:00
99063c2401
Add entries in sphinx documentation to generate correct API autodocs
2017-04-18 14:57:44 +01:00
baldurk