From 62d3cb2af53a89b3eae944c560e447a197539007 Mon Sep 17 00:00:00 2001 From: Dmitry Rogozhkin Date: Thu, 12 Oct 2023 14:16:12 -0700 Subject: [PATCH] win/doc: add documentation for enum-adapters Signed-off-by: Dmitry Rogozhkin --- sources/apps/enum-adapters/readme.rst | 26 ++++++++++++++++++++++++++ sources/apps/readme.rst | 18 ++++++++++++++++++ 2 files changed, 44 insertions(+) create mode 100644 sources/apps/enum-adapters/readme.rst create mode 100644 sources/apps/readme.rst diff --git a/sources/apps/enum-adapters/readme.rst b/sources/apps/enum-adapters/readme.rst new file mode 100644 index 0000000..e847c8c --- /dev/null +++ b/sources/apps/enum-adapters/readme.rst @@ -0,0 +1,26 @@ +Video Adapters Enumeration Tool +=============================== + +.. |EnumAdapters| replace:: IDXGIFactory1::EnumAdapters1 +.. _EnumAdapters: https://learn.microsoft.com/en-us/windows/win32/api/dxgi/nf-dxgi-idxgifactory1-enumadapters1 + +.. |D3DKMTEnumAdapters| replace:: D3DKMTEnumAdapters +.. _D3DKMTEnumAdapters: https://learn.microsoft.com/en-us/windows-hardware/drivers/ddi/d3dkmthk/nf-d3dkmthk-d3dkmtenumadapters + +``enum-adapters`` tool enumerates adapters using specified uAPI. Supported +options: + +--help Print help. + +--api + Enumerate adapters using |EnumAdapters|_ uAPI (for ``dxgi``) or + |D3DKMTEnumAdapters|_ (for ``d3dkmt``). Default: ``dxgi``. + +--debug Additionally print debug messages. + +--luid Print adapter luid for the specified adapter luid. Luid + can be specified as decimal or hex (with ``0x`` prefix). + +--show + Display specified amount of information on each adapter. + Default: ``basic``. diff --git a/sources/apps/readme.rst b/sources/apps/readme.rst new file mode 100644 index 0000000..4ffde8d --- /dev/null +++ b/sources/apps/readme.rst @@ -0,0 +1,18 @@ +Applications and Tools +====================== + +.. _idd-setup-tool: ./idd-setup-tool +.. _enum-adapters: ./enum-adapters + +This folder contains sources of applications and tools for Cloud Streaming +reference stack. + ++-------------------+-----------+-----------------------------------------------------+ +| Tool | Target OS | Description | ++===================+===========+=====================================================+ +| `enum-adapters`_ | Windows | Utility to enumerate available video adapters on | +| | | the system. | ++-------------------+-----------+-----------------------------------------------------+ +| `idd-setup-tool`_ | Windows | Tool to install, uninstall and tune virtual display | +| | | devices and drivers. | ++-------------------+-----------+-----------------------------------------------------+