mirror of
https://github.com/baldurk/renderdoc.git
synced 2026-05-04 17:10:47 +00:00
baldurk
73 lines
6.1 KiB
Markdown
73 lines
6.1 KiB
Markdown
<p align="center"><img src="https://user-images.githubusercontent.com/661798/36482670-f81601c0-170b-11e8-8adb-2365b346ac27.png" /></p>
|
|
|
|
[](LICENSE.md)
|
|
[](https://github.com/baldurk/renderdoc/actions)
|
|
[](docs/CODE_OF_CONDUCT.md)
|
|
|
|
RenderDoc is a frame-capture based graphics debugger, currently available for Vulkan, D3D11, D3D12, OpenGL, and OpenGL ES development on Windows 7 - 10, Linux, Android, Stadia, and Nintendo Switch™. It is completely open-source under the MIT license.
|
|
|
|
If you have any questions, suggestions or problems or you can [create an issue](https://github.com/baldurk/renderdoc/issues/new) here on github, [email me directly](mailto:baldurk@baldurk.org) or come into [IRC](https://kiwiirc.com/client/irc.freenode.net/#renderdoc) or [Discord](https://discord.gg/ahq6yRB) to discuss it.
|
|
|
|
To install on windows run the appropriate installer for your OS ([64-bit](https://renderdoc.org/stable/latest/RenderDoc_latest_64.msi) | [32-bit](https://renderdoc.org/stable/latest/RenderDoc_latest_32.msi)) or download the portable zip from the [builds page](https://renderdoc.org/builds). The 64-bit windows build fully supports capturing from 32-bit programs. On linux there is a [binary tarball](https://renderdoc.org/stable/latest/renderdoc_latest.tar.gz) available, or your distribution may package it. If not you can [build from source](docs/CONTRIBUTING/Compiling.md).
|
|
|
|
* **Downloads**: Stable and nightly builds: https://renderdoc.org/builds ( [Symbol server](https://renderdoc.org/symbols) )
|
|
* **Documentation**: [HTML online](https://renderdoc.org/docs), [CHM in builds](https://renderdoc.org/docs/renderdoc.chm), [Videos](http://www.youtube.com/user/baldurkarlsson/)
|
|
* **Contact**: [baldurk@baldurk.org](mailto:baldurk@baldurk.org), [#renderdoc on freenode IRC](https://kiwiirc.com/client/irc.freenode.net/#renderdoc), [Discord server](https://discord.gg/ahq6yRB)
|
|
* **Code of Conduct**: [Contributor Covenant](docs/CODE_OF_CONDUCT.md)
|
|
* **Information for contributors**: [All contribution information](docs/CONTRIBUTING.md), [Compilation instructions](docs/CONTRIBUTING/Compiling.md), [Roadmap](https://github.com/baldurk/renderdoc/wiki/Roadmap)
|
|
* **Community extensions**: [Extensions repository](https://github.com/baldurk/renderdoc-contrib)
|
|
|
|
Screenshots
|
|
--------------
|
|
|
|
| [  ](https://renderdoc.org/fp/screen1.jpg) | [  ](https://renderdoc.org/fp/screen2.png) |
|
|
| --- | --- |
|
|
| [  ](https://renderdoc.org/fp/screen3.png) | [  ](https://renderdoc.org/fp/screen4.png) |
|
|
|
|
API Support
|
|
--------------
|
|
|
|
| | Windows | Linux | Android | Stadia |
|
|
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
|
| Vulkan | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
|
| OpenGL ES 2.0 - 3.2 | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A |
|
|
| OpenGL 3.2 - 4.6 Core | :heavy_check_mark: | :heavy_check_mark: | N/A | N/A |
|
|
| D3D11 & D3D12 | :heavy_check_mark: | N/A | N/A | N/A |
|
|
| OpenGL 1.0 - 2.0 Compat | :heavy_multiplication_x: | :heavy_multiplication_x: | N/A | N/A |
|
|
| D3D9 & 10 | :heavy_multiplication_x: | N/A | N/A | N/A |
|
|
| Metal | N/A | N/A | N/A | N/A |
|
|
|
|
* Nintendo Switch™ support is distributed separately for authorized developers as part of the NintendoSDK. For more information, consult the Nintendo Developer Portal.
|
|
|
|
Downloads
|
|
--------------
|
|
|
|
There are [binary releases](https://renderdoc.org/builds) available, built from the release targets. If you just want to use the program and you ended up here, this is what you want :).
|
|
|
|
It's recommended that if you're new you start with the stable builds. Nightly builds are available every day from the [v1.x branch here](https://renderdoc.org/builds#nightly) if you need it, but correspondingly may be less stable.
|
|
|
|
Documentation
|
|
--------------
|
|
|
|
The text documentation is available [online for the latest stable version](https://renderdoc.org/docs/), as well as in [renderdoc.chm](https://renderdoc.org/docs/renderdoc.chm) in any build. It's built from [restructured text with sphinx](docs).
|
|
|
|
As mentioned above there are some [youtube videos](http://www.youtube.com/user/baldurkarlsson/) showing the use of some basic features and an introduction/overview.
|
|
|
|
There is also a great presentation by [@Icetigris](https://twitter.com/Icetigris) which goes into some details of how RenderDoc can be used in real world situations: [slides are up here](https://docs.google.com/presentation/d/1LQUMIld4SGoQVthnhT1scoA3k4Sg0as14G4NeSiSgFU/edit#slide=id.p).
|
|
|
|
License
|
|
--------------
|
|
|
|
RenderDoc is released under the MIT license, see [LICENSE.md](LICENSE.md) for full text as well as 3rd party library acknowledgements.
|
|
|
|
Compiling
|
|
---------
|
|
|
|
Building RenderDoc is fairly straight forward on most platforms. See [Compiling.md](docs/CONTRIBUTING/Compiling.md) for more details.
|
|
|
|
Contributing & Development
|
|
--------------
|
|
|
|
I've added some notes on how to contribute, as well as where to get started looking through the code in [Developing-Change.md](docs/CONTRIBUTING/Developing-Change.md). All contribution information is available under [CONTRIBUTING.md](docs/CONTRIBUTING.md).
|
|
|