Commit Graph

276 Commits

Author SHA1 Message Date
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
Wasin Thonkaew 1026ce481d fix url of debug markers sample 2019-07-23 14:46:04 +01:00
baldurk 5cdaf8491b Explain the background colour for view-important pipeline state bindings 2019-07-22 14:52:42 +01:00
Waffle 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
baldurk af19a21e4c Clarify that android builds are only supported from a proper bash shell
* Not from the windows cmd prompt
2019-07-01 14:56:48 +01:00
baldurk 6487acdf0f Fail to capture if Create*PipelineState has no valid shader code
* This typically means that the user hasn't checked correctly for SM6 feature
  support before trying to upload DXIL shader, which will then result in
  unpredictable behaviour or crashes on replay.
* During capture we detect this and flag it in the overlay text, and prevent
  capturing. On capture load we fail to load if we detect such a PSO.
2019-06-27 10:22:13 +01:00
baldurk e4333291a1 Allow using shader processing tools for custom shaders
* This is primarily useful for HLSL on Vulkan, but could be used with any other
  combination. If multiple tools can perform the conversion, the highest
  priority one is used.
2019-05-22 17:54:10 +01:00
baldurk 96cc08b960 Rename 'show disabled' button to 'show unused' as it is clearer
* Bindings that are unused aren't disabled - they may in fact be explicitly
  enabled - but they are unused by the pipeline which is why they're hidden.
2019-05-17 16:32:55 +01:00
baldurk 06b91f3d57 Update quick start image of timeline bar & remove mention of pip colours 2019-05-17 16:32:55 +01:00
baldurk a820934a22 Fix description of float controls - maximum decimal places not sigfigs 2019-04-26 14:02:42 +01:00
baldurk 95ce6d5b59 Add a bit more clarification on how to load and use RenderDoc's API 2019-04-26 14:00:27 +01:00
baldurk af53fdf89a Document what RENDERDOC_DevicePointer should be for D3D12 2019-04-26 13:57:16 +01:00
baldurk 1296f92a94 Mention that dynamically unused pipeline state resources are hidden 2019-04-26 13:52:34 +01:00
baldurk 944c18e6fe Add mention of 'load last settings' button on capture dialog 2019-04-26 13:44:39 +01:00
baldurk ec1f104b44 Shutdown capture file properly in python example 2019-04-12 11:04:54 +01:00
baldurk 82c54f7310 Update archlinux dependencies to include make & pkg-config 2019-04-12 10:40:44 +01:00
baldurk 25260c29f7 Add mention of Stadia support to README and docs 2019-03-20 05:32:53 +00:00
baldurk e1d39ef23b Don't require ARB_separate_shader_objects on replay
* If it's not available we must also emulate program introspection to get proper
  reflection data.
2019-03-13 11:48:57 +00:00