Commit Graph

293 Commits

Author SHA1 Message Date
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
baldurk 0e7f772596 Add Vulkan 1.2 support 2020-01-15 14:00:30 +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 4fd97e8946 D3D12 shared resources are now fully supported 2020-01-14 18:02:10 +00:00
baldurk 5192becb73 Document incomplete texture detection in pipeline state 2020-01-14 18:02:10 +00:00
baldurk b450b3ff29 Fix qrenderdoc examples for latest API 2020-01-10 14:59:11 +00:00
baldurk 8b851679a8 Fix remove_lines.py script to explicitly read input as cp1252
* The output from sphinx is in cp1252 for CHM builds, which is the only place
  this script is used. Trying to read it as UTF-8 will fail on non-ASCII
  characters.
2020-01-08 19:10:52 +00:00
baldurk 09b6804e71 Tweak issue template for clarity
* Make it clear that it's expected for feature requests as well as bug reports.
* Clarify that the API is the graphics API in use.
2020-01-06 16:20:44 +00:00
baldurk 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
baldurk 0bf65b1abc Fix sphinx-paramlinks to work with older versions of sphinx 2020-01-06 16:20:44 +00:00
baldurk 1e0c96aefa Update sphinx_paramlinks to latest version 2020-01-06 16:20:44 +00:00
baldurk 69b998104a Fix xuint -> xint typo in documentation 2020-01-06 16:20:44 +00:00
Steve Karolewics a9a2c3e359 Add tests for viewing depth with ClearBeforeDraw.
Also updated documentation/README files to reflect the changes and
help others get up to speed on editing tests/documentation.
2019-12-20 20:11:53 +00:00
baldurk 50da67195c Add missing Create*WindowingData to documented functions 2019-12-18 19:09:17 +00:00
baldurk 4481f6f3a9 Add note to CONTRIBUTING guidelines about avoiding STL use 2019-12-16 18:10:32 +00:00
baldurk c82d0f58b9 Rename WASD to Flycam in mesh viewer controls
* This should now work regardless of keyboard layout, e.g. on AZERTY the same
  physical keys will still work. We also add arrow keys as a backup
2019-12-13 16:37:14 +00:00
baldurk b15c0541f0 Explicitly report sparse features as unsupported on vulkan
* What partial support was there has rotted since vulkan was released. This
  feature is virtually unused so we just disable it being honest.
2019-12-11 15:28:38 +00:00
baldurk 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
baldurk 9a5c4531e9 Explicitly document what capturing frame 0 means. 2019-11-01 11:31:25 +00:00
baldurk 84152a74bf Tweak issue template and documentation
* Primarily to make sure that it is very clear using the template is expected.
2019-11-01 11:18:24 +00:00
baldurk 3674e5a494 Add guidance on filing good issues, and update issue template
* Issues not following the template will be closed. It is too much of a drain on
  project resources to deal with bug reports that are not well formatted and
  unclear. The template is easy to fill out and does not ask much.
2019-10-28 18:00:25 +00:00
Piotr Szpetkowski 343fbed90a Update Vulkan features with VK_EXT_debug_utils 2019-10-25 16:53:29 +01:00
baldurk a94f238e37 Ensure PersistantConfig member functions are documented 2019-10-09 10:25:49 +01: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
Hanif A 0558e9a644 Spelling error 2019-09-13 15:47:56 +01:00
baldurk 6d40bbb783 Add experimental wayland support. Refs #853
* This is only lightly tested and may break heavily. It is disabled by default
 and must be explicitly enabled.
* In particular this is only known to work for Wayland use at capture time.
 Wayland on replay is still unsupported. Known issues include: EGL pbuffer
 surfaces are not implemented on Wayland, Wayland cannot get window dimensions,
 and there are hangs/failures with GL and vulkan presentation with Wayland.
2019-09-02 15:02:27 +01:00
baldurk 1d270254c1 Add documentation for replay options 2019-08-27 18:51:57 +01:00
baldurk 8c6fc67acd Make it extra clear that RenderDoc needs to find the Android SDK 2019-08-27 18:51:56 +01:00
baldurk 07158ad24c Fix support for triangle fans on GL/Vulkan 2019-08-20 15:33:12 +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
baldurk 776b689701 Fix documentation of return types on some application API functions 2019-07-23 14:46:22 +01:00