forked from intel/cloud-streaming
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
win/doc: add documentation for enum-adapters
Signed-off-by: Dmitry Rogozhkin <dmitry.v.rogozhkin@intel.com>
- Loading branch information
Showing
2 changed files
with
46 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
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 <dxgi|d3dkmt> | ||
Enumerate adapters using |EnumAdapters|_ uAPI (for ``dxgi``) or | ||
|D3DKMTEnumAdapters|_ (for ``d3dkmt``). Default: ``dxgi``. | ||
|
||
--debug | ||
Additionally print debug messages. | ||
|
||
--luid <high:lo> | ||
Print adapter luid for the specified adapter luid. Luid can be specified as | ||
decimal or hex (with ``0x`` prefix). | ||
|
||
--show <basic|details|off> | ||
Display specified amount of information on each adapter. Default: ``basic``. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | | ||
+-------------------+-----------+-----------------------------------------------------+ |