From 25260c29f782c9fb9e853199b327ceb652414523 Mon Sep 17 00:00:00 2001 From: baldurk Date: Wed, 20 Mar 2019 05:32:53 +0000 Subject: [PATCH] Add mention of Stadia support to README and docs --- README.md | 20 ++++++++++---------- docs/behind_scenes/vulkan_support.rst | 5 +++++ docs/credits_acknowledgements.rst | 4 ++++ docs/getting_started/features.rst | 4 ++-- docs/include/intro_header_inc.rst | 2 +- 5 files changed, 22 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index ecda8e14a..8aee3751d 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ [![AppVeyor](https://ci.appveyor.com/api/projects/status/x46lrnvdy29ysgqp?svg=true)](https://ci.appveyor.com/project/baldurk/renderdoc) [![Coverity Scan](https://scan.coverity.com/projects/8525/badge.svg)](https://scan.coverity.com/projects/baldurk-renderdoc) -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, and Nintendo Switch™. It is completely open-source under the MIT license. +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. @@ -27,15 +27,15 @@ Screenshots API Support -------------- -| | Windows | Linux | Android | -| ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| Vulkan | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | -| OpenGL ES 2.0 - 3.2 | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | -| OpenGL 3.2 - 4.6 Core | :heavy_check_mark: | :heavy_check_mark: | N/A | -| D3D11 & D3D12 | :heavy_check_mark: | N/A | N/A | -| OpenGL 1.0 - 2.0 Compat | :heavy_multiplication_x: | :heavy_multiplication_x: | N/A | -| D3D9 & 10 | :heavy_multiplication_x: | N/A | N/A | -| Metal | N/A | N/A | N/A | +| | 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. diff --git a/docs/behind_scenes/vulkan_support.rst b/docs/behind_scenes/vulkan_support.rst index db4f2e1aa..d917e2170 100644 --- a/docs/behind_scenes/vulkan_support.rst +++ b/docs/behind_scenes/vulkan_support.rst @@ -39,6 +39,11 @@ RenderDoc has support for Vulkan version 1.1, as well as a number of extensions, * Pixel history is not implemented. * Shader debugging is not currently supported. +Stadia +------ + +Vulkan capture and replay on Stadia is natively supported. For more information on how to capture with Stadia see the Stadia documentation. + Android ------- diff --git a/docs/credits_acknowledgements.rst b/docs/credits_acknowledgements.rst index 05f816b4c..8ed387c8c 100644 --- a/docs/credits_acknowledgements.rst +++ b/docs/credits_acknowledgements.rst @@ -158,6 +158,10 @@ There have been many people who have helped in the creation of RenderDoc. Whethe * Marton Tamas * Nat Duca * Ben Clayton +* Aliya Pazylbekova +* Benson Joeris +* Haiyu Zhen +* Alex Kharlamov Contributors ------------ diff --git a/docs/getting_started/features.rst b/docs/getting_started/features.rst index e61c22bd6..9eeb53ac5 100644 --- a/docs/getting_started/features.rst +++ b/docs/getting_started/features.rst @@ -3,7 +3,7 @@ Features This page documents the current feature set of RenderDoc. This gives an overview of what RenderDoc is capable of, and where it is in its development. You might also be interested in the :doc:`../behind_scenes/planned_features`. -Currently RenderDoc supports Vulkan, D3D11, D3D12, OpenGL, and OpenGL ES on Windows, Linux, Android, and Nintendo Switch :sup:`TM`. The UI runs in Qt and will work on any desktop platform. +Currently RenderDoc supports Vulkan, D3D11, D3D12, OpenGL, and OpenGL ES on Windows, Linux, Android, Stadia, and Nintendo Switch :sup:`TM`. The UI runs in Qt and will work on any desktop platform. RenderDoc can also double as an image viewer in a simplistic fashion, separate to its functionality as a debugger. Drag in or open any of a variety of image file formats and RenderDoc will display them as if they were the only texture in a capture. This way it can be used as a simple e.g. dds viewer, with support for all sorts of formats, encodings and things typical image viewers don't tend to handle like mips, cubemaps and arrays. @@ -85,7 +85,7 @@ D3D12 Vulkan ------ -* Support for Vulkan 1.1 on Windows, Linux, and Android. +* Support for Vulkan 1.1 on Windows, Linux, Android, and Stadia. * Event markers and object naming both come from ``VK_EXT_debug_marker``. OpenGL & OpenGL ES diff --git a/docs/include/intro_header_inc.rst b/docs/include/intro_header_inc.rst index f6893e47a..066f4b3e0 100644 --- a/docs/include/intro_header_inc.rst +++ b/docs/include/intro_header_inc.rst @@ -1,7 +1,7 @@ .. image:: imgs/logo.png :align: center -Welcome to RenderDoc - a graphics debugger currently available for Vulkan, D3D11, D3D12, OpenGL, and OpenGL ES development on Windows, Linux, Android, and Nintendo Switch :sup:`TM`. +Welcome to RenderDoc - a graphics debugger currently available for Vulkan, D3D11, D3D12, OpenGL, and OpenGL ES development on Windows, Linux, Android, Stadia, and Nintendo Switch :sup:`TM`. This document serves as reference guide, introductory document and explanation of which features are available in RenderDoc and how to best use them.