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
673579e854
Print renderdoc and qrenderdoc module locations
2021-02-14 15:45:57 +00:00
321fbdefe9
Don't check docs build consistency if an exception happened
2021-02-14 15:10:21 +00:00
fc2b2c11cc
Include ShadingRateCombiner in the documentation
2021-02-10 15:07:37 +00:00
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
9424b8a3fe
Add documentation on setting up python dev environment
2021-01-27 16:05:03 +00:00
ae96b674c9
Update docs to reference VK_EXT_debug_utils
...
* VK_EXT_debug_marker still works fine but is deprecated.
2021-01-27 13:03:16 +00:00
3f637e0d9b
Link to renderdoc-contrib repository
2021-01-27 12:58:51 +00:00
a377a61aa2
Clarify acceptable use for issues and support even further
...
* Capturing copyrighted programs is absolutely not supported or tolerated.
2021-01-22 13:23:53 +00:00
e7e2b73170
Search extracted namespace for class, not all headers
2020-12-16 20:39:58 +00:00
fede056ef7
Fix bug in redeclarator if type hint like Tuple[int, ...] is used
...
* The ... confused the declaration process and so an empty identifier got
registered, which then broke things later.
2020-12-15 22:52:37 +00:00
ea2410fe9f
Make new python documentation checks optional
...
* Older sphinx versions don't have an easy 'objects' property so we just drop
this check. As long as it happens on CI builds that's the main thing.
2020-12-10 10:05:10 +00:00
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
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
659fdaa235
Check that all complex struct members that have :type: in docstrings
...
* Ideally we'd document every member unconditionally for best autocompletion,
but that's a lot of modification so for now we stick to just making sure that
any members that are struct types (or lists/tuples) have the :type:
declaration so that we can autocomplete inside them.
2020-12-09 15:18:27 +00:00
dd3e7ab121
Add a modified and improved version of PyCharm's skeleton generator
2020-12-09 15:18:27 +00:00
6b8ce92d88
Clean up docstrings in python interfaces to be strictly typed/formatted
...
* Also added a script that can run as part of CI to verify that the docstring
matches, by generating a regex from the docstring documented parameter types
and return type and making sure we find a match within the C headers. This
ensures all parameters are documented with the right types, no extra
parameters are documented, and the return type is correct.
* The script also checks proper scoping so that if qrenderdoc docstrings
mention a renderdoc type, they need to scope it properly.
2020-12-07 17:44:51 +00:00
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
949cff30a2
Add some Qt python interfaces not included in docs
2020-11-27 14:30:01 +00:00
6c26562201
Remove duplicate documentation entry for GlobalEnvironment
2020-11-27 14:19:33 +00:00
c9f1c9ea2e
Update to AGS 6.0.1
2020-11-24 16:12:20 +00:00
58e16414e0
Add a number of control functions to the Qt python interface
2020-11-20 17:02:33 +00:00
d0bf0f6eab
Add Superluminal PerformanceAPI annotation support
2020-11-19 14:47:10 +00:00
d9121a7f90
Add half.hpp 2.1.0 from http://half.sourceforge.net/
2020-11-09 12:25:21 +00:00
e69eacf989
Add Fedora dependencies
2020-11-05 17:11:10 +00:00
f9deead680
Add open-source nvapi release headers
2020-10-28 19:07:52 +00:00
4017dbca99
Add Kevin McCullough to credits docs page
2020-10-23 13:57:38 +01:00
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
c8fcdbae05
Update fetch_shader python example to latest API
2020-09-14 15:58:20 +01:00
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
83714b825c
Remove note about android support being new
2020-08-20 10:47:16 +01:00
0ee1209a5f
Mention that Vulkan supports shader debugging in documentation
2020-08-05 11:41:32 +01:00
9547b049e3
Update version number on in-application API documentation
2020-08-05 11:41:31 +01:00
287bb81fca
Add a note about the python module version restriction
2020-07-24 16:33:34 +01:00
22dbb188ce
Document the new custom shader directories setting
2020-07-22 17:34:40 +01:00
5d8d57540b
Update docs as vulkan pixel history and shader debugging are supported
2020-07-22 17:31:20 +01:00
6c1376fbb9
Add credits note for vulkan pixel history
2020-07-21 19:57:09 +01:00
6a8e7cbbe5
Fix python examples not being up to date with latest API changes
2020-07-20 10:52:59 +01:00
2b40de2a6a
Update docs about DXIL support
2020-06-19 14:46:00 +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
19c066c6fc
Move issue/pull request templates to .github folder and split up
...
* Now that we have a .github folder we can have separate templates for bug
reports and feature requests.
2020-06-12 13:40:02 +01:00
e0eb544529
Add additional notice about unacceptable use of RenderDoc
2020-06-12 13:40:02 +01:00
e05224753c
Adopt v2.0 of the contributor covenant
...
* This better details the inclusionary community desired and has more specific
additional language on how the code of conduct will be enforced as needed.
* In addition the file is copied to the .github folder for additional
visibility.
2020-06-12 13:40:02 +01:00
d49d31fa86
Switch from travis/appveyor to github actions for CI
2020-06-11 22:42:44 +01:00
fe0b780bb6
Add sphinx_paramlinks fixes for sphinx 3.1
2020-06-08 18:26:12 +01:00
9f9a4cda5e
Fix search in chm-friendly RTD theme
2020-06-05 12:24:33 +01:00
fa9215477d
Update examples to latest python API
2020-05-20 11:51:52 +01:00
1d579dfb66
Update docs about D3D12 shader debugging support
2020-05-15 19:03:00 +01:00
baldurk