Commit Graph

326 Commits

Author SHA1 Message Date
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 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
baldurk dd3e7ab121 Add a modified and improved version of PyCharm's skeleton generator 2020-12-09 15:18:27 +00:00
baldurk 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
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 c9f1c9ea2e Update to AGS 6.0.1 2020-11-24 16:12:20 +00:00
baldurk 58e16414e0 Add a number of control functions to the Qt python interface 2020-11-20 17:02:33 +00:00
baldurk d0bf0f6eab Add Superluminal PerformanceAPI annotation support 2020-11-19 14:47:10 +00:00
baldurk d9121a7f90 Add half.hpp 2.1.0 from http://half.sourceforge.net/ 2020-11-09 12:25:21 +00:00
trietch e69eacf989 Add Fedora dependencies 2020-11-05 17:11:10 +00:00
baldurk f9deead680 Add open-source nvapi release headers 2020-10-28 19:07:52 +00:00
baldurk 4017dbca99 Add Kevin McCullough to credits docs page 2020-10-23 13:57:38 +01: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
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 83714b825c Remove note about android support being new 2020-08-20 10:47:16 +01:00
baldurk 0ee1209a5f Mention that Vulkan supports shader debugging in documentation 2020-08-05 11:41:32 +01:00
baldurk 9547b049e3 Update version number on in-application API documentation 2020-08-05 11:41:31 +01:00
baldurk 287bb81fca Add a note about the python module version restriction 2020-07-24 16:33:34 +01:00
baldurk 22dbb188ce Document the new custom shader directories setting 2020-07-22 17:34:40 +01:00
baldurk 5d8d57540b Update docs as vulkan pixel history and shader debugging are supported 2020-07-22 17:31:20 +01:00
baldurk 6c1376fbb9 Add credits note for vulkan pixel history 2020-07-21 19:57:09 +01:00
baldurk 6a8e7cbbe5 Fix python examples not being up to date with latest API changes 2020-07-20 10:52:59 +01:00
baldurk 2b40de2a6a Update docs about DXIL support 2020-06-19 14:46:00 +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 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
baldurk e0eb544529 Add additional notice about unacceptable use of RenderDoc 2020-06-12 13:40:02 +01:00
baldurk 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
baldurk d49d31fa86 Switch from travis/appveyor to github actions for CI 2020-06-11 22:42:44 +01:00
baldurk fe0b780bb6 Add sphinx_paramlinks fixes for sphinx 3.1 2020-06-08 18:26:12 +01:00
baldurk 9f9a4cda5e Fix search in chm-friendly RTD theme 2020-06-05 12:24:33 +01:00
baldurk fa9215477d Update examples to latest python API 2020-05-20 11:51:52 +01:00
Steve Karolewics 1d579dfb66 Update docs about D3D12 shader debugging support 2020-05-15 19:03:00 +01:00
baldurk 0b6c1c14b4 Add Steve Karolewics to credits document 2020-05-12 19:04:57 +01:00
baldurk 63c1ecd89c Handle vertexOffset properly in mesh decode example. Closes #1852 2020-04-28 18:15:34 +01:00
baldurk dd4009c588 Remove undoc-members attributes from autoclass docs builds 2020-04-07 09:55:17 +01:00
baldurk 569fb0ef47 Add fixes for sphinx 3.0 2020-04-06 23:20:38 +01:00
baldurk 55437ee0f9 Add license attribution for Compressonator 2020-03-23 11:05:24 +00:00
baldurk 5cd04f27a0 Fix some encoding issues with sphinx docs in htmlhelp builder 2020-03-09 10:57:05 +00: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 91ede3348c Update API methods for detecting RenderDoc's presence 2020-02-21 17:56:52 +00:00
baldurk 5e6ec417c1 Add a global font scale option in settings window
* This lets the user override the default application font.
* Unfortunately Qt seems to behave inconsistently with font scaling from the
  system, so we take the font size initially from QApplication::font() (which
  doesn't always pick up the font size) and scale from there. While this might
  cause some font scaling to be lost it does mean at least we have a consistent
  scale, as otherwise you get some text scaling and others not.
2020-02-13 11:01:45 +00:00
baldurk e1fe211f3c Rename Shutdown to RemoveHooks in in-application API. Version is 1.4.1
* This is a binary and source backwards compatible change.
2020-01-30 13:02:23 +00:00
baldurk da7d27fe9b Explicitly list versions of all android build components supported 2020-01-27 20:45:08 +00:00