mirror of
https://github.com/gnif/LookingGlass.git
synced 2025-10-18 05:18:09 +00:00
[doc]: a bunch of consistency fixes
This commit is contained in:
Tudor Brindus
committed by
Geoffrey McRae
Geoffrey McRae
parent
0c63a901be
commit
6a9075b412
310
doc/usage.rst
310
doc/usage.rst
@@ -3,7 +3,7 @@
|
||||
Client usage
|
||||
------------
|
||||
|
||||
**looking-glass-client** [\-\-help] [\-f] [\-F] [\-s] [\-S] [options...]
|
||||
**``looking-glass-client``** ``[--help] [-f] [-F] [-s] [-S] [options...]``
|
||||
|
||||
|
||||
.. _client_cli_options:
|
||||
@@ -97,9 +97,9 @@ Configuration files
|
||||
By default, Looking Glass will load config files from
|
||||
the following locations:
|
||||
|
||||
- /etc/looking-glass-client.ini
|
||||
- ~/.looking-glass-client.ini
|
||||
- $XDG_CONFIG_HOME/looking-glass/client.ini (usually ~/.config/looking-glass/client.ini)
|
||||
- ``/etc/looking-glass-client.ini``
|
||||
- ``~/.looking-glass-client.ini``
|
||||
- ``$XDG_CONFIG_HOME/looking-glass/client.ini`` (usually ``~/.config/looking-glass/client.ini``)
|
||||
|
||||
All config files are loaded in order. Duplicate entries override earlier ones.
|
||||
This means you can set a system-wide configuration in
|
||||
@@ -108,7 +108,7 @@ your user in ``~/.looking-glass-client.ini``, which is overlayed on top of
|
||||
the system-wide configuration.
|
||||
|
||||
When first launched, the Looking-Glass client will create the folder
|
||||
$XDG_CONFIG_HOME/looking-glass/ if it does not yet exist.
|
||||
``$XDG_CONFIG_HOME/looking-glass/`` if it does not yet exist.
|
||||
|
||||
The format of config files is the commonly known INI format, for example::
|
||||
|
||||
@@ -135,13 +135,13 @@ These include:
|
||||
|
||||
(see :ref:`client_config_widget`)
|
||||
|
||||
You can also reposition and resize enabled widgets, like the FPS/UPS Display,
|
||||
and Performance Metrics.
|
||||
You can also reposition and resize enabled widgets, like the FPS/UPS display,
|
||||
and performance metrics.
|
||||
|
||||
Enter and exit Overlay Mode with :kbd:`ScrLk` + :kbd:`O`.
|
||||
:kbd:`ESC` can also be used to exit. (see :ref:`client_key_bindings`)
|
||||
|
||||
Modifications done to widgets in Overlay Mode are stored in
|
||||
Modifications done to widgets in overlay mode are stored in
|
||||
``$XDG_CONFIG_HOME/looking-glass/imgui.ini``.
|
||||
Please do not manually edit this file while Looking Glass is running,
|
||||
as your changes may be discarded.
|
||||
@@ -151,52 +151,52 @@ as your changes may be discarded.
|
||||
Configuration widget
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The Configuration Widget is accessible through the Overlay Mode. The
|
||||
The configuration widget is accessible through the overlay mode. The
|
||||
widget has multiple tabs that allow setting a variety of modes and
|
||||
parameters for Looking Glass at runtime.
|
||||
|
||||
Settings tab
|
||||
^^^^^^^^^^^^
|
||||
|
||||
- Performance Metrics: A toggle for the Performance Metrics Widget.
|
||||
- *Performance Metrics*: A toggle for the performance metrics widget.
|
||||
Multiple graphs are available, and they will stack vertically.
|
||||
- EGL: Modify EGL features, such as the algorithm used for scaling, and
|
||||
- *EGL*: Modify EGL settings, such as the algorithm used for scaling, and
|
||||
night vision mode.
|
||||
|
||||
Changes in the Settings tab are not persistent, and will change back to
|
||||
Changes in the settings tab are not persistent, and will be reset back to
|
||||
their default values when the client is restarted.
|
||||
|
||||
EGL filters tab
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
The EGL Filters tab contains options for toggling, configuring, and ordering
|
||||
The EGL filters tab contains options for toggling, configuring, and ordering
|
||||
post-processing filters. Each filter can be expanded to open its settings.
|
||||
Filters can also be re-ordered by dragging them up or down. Filters are applied
|
||||
from top to bottom, keep this in mind when ordering them, e.g applying CAS
|
||||
before FSR might have different results than the reverse. Users are encouraged
|
||||
to experiment with the order and parameters to achieve optimal results. The
|
||||
currently available filters include:
|
||||
from top to bottom. Keep this in mind when ordering them -- for example,
|
||||
applying CAS before FSR might have different results than the reverse. Users
|
||||
are encouraged to experiment with the order and parameters to achieve optimal
|
||||
results. The currently available filters include:
|
||||
|
||||
- Downscaler: Filter for downscaling the host resolution. Can be used to undo
|
||||
- *Downscaler*: Filter for downscaling the host resolution. Can be used to undo
|
||||
poor upscaling on the VM to better utilize AMD FSR (see below). The filter
|
||||
has a pixel-size setting that is used to set the effective downscaling ratio,
|
||||
and a configurable interpolation algorithm.
|
||||
|
||||
- AMD FidelityFX Super Resolution (FSR): Spatial upscaling filter that works
|
||||
- *AMD FidelityFX Super Resolution (FSR)*: Spatial upscaling filter that works
|
||||
on low resolution frames from the guest VM and intelligently upscales to a
|
||||
higher resolution. The filter sharpness is tunable, and displays the
|
||||
equivalent AMD quality mode based on the resolution difference.
|
||||
|
||||
- AMD FidelityFX Contrast Adaptive Sharpening (CAS): Filter that
|
||||
- *AMD FidelityFX Contrast Adaptive Sharpening (CAS)*: Filter that
|
||||
increases visual quality by applying a sharpening algorithm to the
|
||||
video. CAS can sometimes restore detail lost in a typical upscaling
|
||||
application. Has adjustable sharpness setting.
|
||||
|
||||
The filter settings and order can be saved to presets so that it can be restored
|
||||
at a later time. As filter settings are usually application specific, multiple
|
||||
presets can be defined for each case scenario. To save a preset, click on "Save
|
||||
preset as..." and enter a preset name. Presets are loaded by selecting them in
|
||||
the "Preset name" pull down. Presets are persistent and are stored on disk at
|
||||
presets can be defined for each case scenario. To save a preset, click on *"Save
|
||||
preset as..."* and enter a preset name. Presets are loaded by selecting them in
|
||||
the *Preset name* pull down. Presets are persistent and are stored on disk at
|
||||
``$XDG_CONFIG_HOME/looking-glass/presets``.
|
||||
|
||||
.. warning::
|
||||
@@ -213,127 +213,127 @@ the "Preset name" pull down. Presets are persistent and are stored on disk at
|
||||
All command line options
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The following is a complete list of options accepted by this application
|
||||
.. code-block::
|
||||
|
||||
+------------------------+-------+------------------------+-----------------------------------------------------------------------------------------+
|
||||
| Long | Short | Value | Description |
|
||||
+------------------------+-------+------------------------+-----------------------------------------------------------------------------------------+
|
||||
| app:configFile | -C | NULL | A file to read additional configuration from |
|
||||
| app:renderer | -g | auto | Specify the renderer to use |
|
||||
| app:license | -l | no | Show the license for this application and then terminate |
|
||||
| app:cursorPollInterval | | 1000 | How often to check for a cursor update in microseconds |
|
||||
| app:framePollInterval | | 1000 | How often to check for a frame update in microseconds |
|
||||
| app:allowDMA | | yes | Allow direct DMA transfers if supported (see `README.md` in the `module` dir) |
|
||||
| app:shmFile | -f | /dev/shm/looking-glass | The path to the shared memory file, or the name of the kvmfr device to use, e.g. kvmfr0 |
|
||||
+------------------------+-------+------------------------+-----------------------------------------------------------------------------------------+
|
||||
+------------------------+-------+------------------------+-----------------------------------------------------------------------------------------+
|
||||
| Long | Short | Value | Description |
|
||||
+------------------------+-------+------------------------+-----------------------------------------------------------------------------------------+
|
||||
| app:configFile | -C | NULL | A file to read additional configuration from |
|
||||
| app:renderer | -g | auto | Specify the renderer to use |
|
||||
| app:license | -l | no | Show the license for this application and then terminate |
|
||||
| app:cursorPollInterval | | 1000 | How often to check for a cursor update in microseconds |
|
||||
| app:framePollInterval | | 1000 | How often to check for a frame update in microseconds |
|
||||
| app:allowDMA | | yes | Allow direct DMA transfers if supported (see `README.md` in the `module` dir) |
|
||||
| app:shmFile | -f | /dev/shm/looking-glass | The path to the shared memory file, or the name of the kvmfr device to use, e.g. kvmfr0 |
|
||||
+------------------------+-------+------------------------+-----------------------------------------------------------------------------------------+
|
||||
|
||||
+-------------------------+-------+------------------------+----------------------------------------------------------------------+
|
||||
| Long | Short | Value | Description |
|
||||
+-------------------------+-------+------------------------+----------------------------------------------------------------------+
|
||||
| win:title | | Looking Glass (client) | The window title |
|
||||
| win:position | | center | Initial window position at startup |
|
||||
| win:size | | 1024x768 | Initial window size at startup |
|
||||
| win:autoResize | -a | no | Auto resize the window to the guest |
|
||||
| win:allowResize | -n | yes | Allow the window to be manually resized |
|
||||
| win:keepAspect | -r | yes | Maintain the correct aspect ratio |
|
||||
| win:forceAspect | | yes | Force the window to maintain the aspect ratio |
|
||||
| win:dontUpscale | | no | Never try to upscale the window |
|
||||
| win:intUpscale | | no | Allow only integer upscaling |
|
||||
| win:shrinkOnUpscale | | no | Limit the window dimensions when dontUpscale is enabled |
|
||||
| win:borderless | -d | no | Borderless mode |
|
||||
| win:fullScreen | -F | no | Launch in fullscreen borderless mode |
|
||||
| win:maximize | -T | no | Launch window maximized |
|
||||
| win:minimizeOnFocusLoss | | no | Minimize window on focus loss |
|
||||
| win:fpsMin | -K | -1 | Frame rate minimum (0 = disable - not recommended, -1 = auto detect) |
|
||||
| win:ignoreQuit | -Q | no | Ignore requests to quit (i.e. Alt+F4) |
|
||||
| win:noScreensaver | -S | no | Prevent the screensaver from starting |
|
||||
| win:autoScreensaver | | no | Prevent the screensaver from starting when guest requests it |
|
||||
| win:alerts | -q | yes | Show on screen alert messages |
|
||||
| win:quickSplash | | no | Skip fading out the splash screen when a connection is established |
|
||||
| win:overlayDimsDesktop | | yes | Dim the desktop when in interactive overlay mode |
|
||||
| win:rotate | | 0 | Rotate the displayed image (0, 90, 180, 270) |
|
||||
| win:uiFont | | DejaVu Sans Mono | The font to use when rendering on-screen UI |
|
||||
| win:uiSize | | 14 | The font size to use when rendering on-screen UI |
|
||||
| win:jitRender | | no | Enable just-in-time rendering |
|
||||
| win:showFPS | -k | no | Enable the FPS & UPS display |
|
||||
+-------------------------+-------+------------------------+----------------------------------------------------------------------+
|
||||
+-------------------------+-------+------------------------+----------------------------------------------------------------------+
|
||||
| Long | Short | Value | Description |
|
||||
+-------------------------+-------+------------------------+----------------------------------------------------------------------+
|
||||
| win:title | | Looking Glass (client) | The window title |
|
||||
| win:position | | center | Initial window position at startup |
|
||||
| win:size | | 1024x768 | Initial window size at startup |
|
||||
| win:autoResize | -a | no | Auto resize the window to the guest |
|
||||
| win:allowResize | -n | yes | Allow the window to be manually resized |
|
||||
| win:keepAspect | -r | yes | Maintain the correct aspect ratio |
|
||||
| win:forceAspect | | yes | Force the window to maintain the aspect ratio |
|
||||
| win:dontUpscale | | no | Never try to upscale the window |
|
||||
| win:intUpscale | | no | Allow only integer upscaling |
|
||||
| win:shrinkOnUpscale | | no | Limit the window dimensions when dontUpscale is enabled |
|
||||
| win:borderless | -d | no | Borderless mode |
|
||||
| win:fullScreen | -F | no | Launch in fullscreen borderless mode |
|
||||
| win:maximize | -T | no | Launch window maximized |
|
||||
| win:minimizeOnFocusLoss | | no | Minimize window on focus loss |
|
||||
| win:fpsMin | -K | -1 | Frame rate minimum (0 = disable - not recommended, -1 = auto detect) |
|
||||
| win:ignoreQuit | -Q | no | Ignore requests to quit (i.e. Alt+F4) |
|
||||
| win:noScreensaver | -S | no | Prevent the screensaver from starting |
|
||||
| win:autoScreensaver | | no | Prevent the screensaver from starting when guest requests it |
|
||||
| win:alerts | -q | yes | Show on screen alert messages |
|
||||
| win:quickSplash | | no | Skip fading out the splash screen when a connection is established |
|
||||
| win:overlayDimsDesktop | | yes | Dim the desktop when in interactive overlay mode |
|
||||
| win:rotate | | 0 | Rotate the displayed image (0, 90, 180, 270) |
|
||||
| win:uiFont | | DejaVu Sans Mono | The font to use when rendering on-screen UI |
|
||||
| win:uiSize | | 14 | The font size to use when rendering on-screen UI |
|
||||
| win:jitRender | | no | Enable just-in-time rendering |
|
||||
| win:showFPS | -k | no | Enable the FPS & UPS display |
|
||||
+-------------------------+-------+------------------------+----------------------------------------------------------------------+
|
||||
|
||||
+------------------------------+-------+---------------------+----------------------------------------------------------------------------------+
|
||||
| Long | Short | Value | Description |
|
||||
+------------------------------+-------+---------------------+----------------------------------------------------------------------------------+
|
||||
| input:grabKeyboard | -G | yes | Grab the keyboard in capture mode |
|
||||
| input:grabKeyboardOnFocus | | no | Grab the keyboard when focused |
|
||||
| input:releaseKeysOnFocusLoss | | yes | On focus loss, send key up events to guest for all held keys |
|
||||
| input:escapeKey | -m | 70 = KEY_SCROLLLOCK | Specify the escape/menu key to use (use "help" to see valid values) |
|
||||
| input:ignoreWindowsKeys | | no | Do not pass events for the windows keys to the guest |
|
||||
| input:hideCursor | -M | yes | Hide the local mouse cursor |
|
||||
| input:mouseSens | | 0 | Initial mouse sensitivity when in capture mode (-9 to 9) |
|
||||
| input:mouseSmoothing | | yes | Apply simple mouse smoothing when rawMouse is not in use (helps reduce aliasing) |
|
||||
| input:rawMouse | | no | Use RAW mouse input when in capture mode (good for gaming) |
|
||||
| input:mouseRedraw | | yes | Mouse movements trigger redraws (ignores FPS minimum) |
|
||||
| input:autoCapture | | no | Try to keep the mouse captured when needed |
|
||||
| input:captureOnly | | no | Only enable input via SPICE if in capture mode |
|
||||
| input:helpMenuDelay | | 200 | Show help menu after holding down the escape key for this many milliseconds |
|
||||
+------------------------------+-------+---------------------+----------------------------------------------------------------------------------+
|
||||
+------------------------------+-------+---------------------+----------------------------------------------------------------------------------+
|
||||
| Long | Short | Value | Description |
|
||||
+------------------------------+-------+---------------------+----------------------------------------------------------------------------------+
|
||||
| input:grabKeyboard | -G | yes | Grab the keyboard in capture mode |
|
||||
| input:grabKeyboardOnFocus | | no | Grab the keyboard when focused |
|
||||
| input:releaseKeysOnFocusLoss | | yes | On focus loss, send key up events to guest for all held keys |
|
||||
| input:escapeKey | -m | 70 = KEY_SCROLLLOCK | Specify the escape/menu key to use (use "help" to see valid values) |
|
||||
| input:ignoreWindowsKeys | | no | Do not pass events for the windows keys to the guest |
|
||||
| input:hideCursor | -M | yes | Hide the local mouse cursor |
|
||||
| input:mouseSens | | 0 | Initial mouse sensitivity when in capture mode (-9 to 9) |
|
||||
| input:mouseSmoothing | | yes | Apply simple mouse smoothing when rawMouse is not in use (helps reduce aliasing) |
|
||||
| input:rawMouse | | no | Use RAW mouse input when in capture mode (good for gaming) |
|
||||
| input:mouseRedraw | | yes | Mouse movements trigger redraws (ignores FPS minimum) |
|
||||
| input:autoCapture | | no | Try to keep the mouse captured when needed |
|
||||
| input:captureOnly | | no | Only enable input via SPICE if in capture mode |
|
||||
| input:helpMenuDelay | | 200 | Show help menu after holding down the escape key for this many milliseconds |
|
||||
+------------------------------+-------+---------------------+----------------------------------------------------------------------------------+
|
||||
|
||||
+------------------------+-------+-----------+---------------------------------------------------------------------+
|
||||
| Long | Short | Value | Description |
|
||||
+------------------------+-------+-----------+---------------------------------------------------------------------+
|
||||
| spice:enable | -s | yes | Enable the built in SPICE client for input and/or clipboard support |
|
||||
| spice:host | -c | 127.0.0.1 | The SPICE server host or UNIX socket |
|
||||
| spice:port | -p | 5900 | The SPICE server port (0 = unix socket) |
|
||||
| spice:input | | yes | Use SPICE to send keyboard and mouse input events to the guest |
|
||||
| spice:clipboard | | yes | Use SPICE to synchronize the clipboard contents with the guest |
|
||||
| spice:clipboardToVM | | yes | Allow the clipboard to be synchronized TO the VM |
|
||||
| spice:clipboardToLocal | | yes | Allow the clipboard to be synchronized FROM the VM |
|
||||
| spice:audio | | yes | Enable SPICE audio support |
|
||||
| spice:scaleCursor | -j | yes | Scale cursor input position to screen size when up/down scaled |
|
||||
| spice:captureOnStart | | no | Capture mouse and keyboard on start |
|
||||
| spice:alwaysShowCursor | | no | Always show host cursor |
|
||||
| spice:showCursorDot | | yes | Use a "dot" cursor when the window does not have focus |
|
||||
+------------------------+-------+-----------+---------------------------------------------------------------------+
|
||||
+------------------------+-------+-----------+---------------------------------------------------------------------+
|
||||
| Long | Short | Value | Description |
|
||||
+------------------------+-------+-----------+---------------------------------------------------------------------+
|
||||
| spice:enable | -s | yes | Enable the built in SPICE client for input and/or clipboard support |
|
||||
| spice:host | -c | 127.0.0.1 | The SPICE server host or UNIX socket |
|
||||
| spice:port | -p | 5900 | The SPICE server port (0 = unix socket) |
|
||||
| spice:input | | yes | Use SPICE to send keyboard and mouse input events to the guest |
|
||||
| spice:clipboard | | yes | Use SPICE to synchronize the clipboard contents with the guest |
|
||||
| spice:clipboardToVM | | yes | Allow the clipboard to be synchronized TO the VM |
|
||||
| spice:clipboardToLocal | | yes | Allow the clipboard to be synchronized FROM the VM |
|
||||
| spice:audio | | yes | Enable SPICE audio support |
|
||||
| spice:scaleCursor | -j | yes | Scale cursor input position to screen size when up/down scaled |
|
||||
| spice:captureOnStart | | no | Capture mouse and keyboard on start |
|
||||
| spice:alwaysShowCursor | | no | Always show host cursor |
|
||||
| spice:showCursorDot | | yes | Use a "dot" cursor when the window does not have focus |
|
||||
+------------------------+-------+-----------+---------------------------------------------------------------------+
|
||||
|
||||
+------------------------+-------+--------+-------------------------------------------------------------------------------+
|
||||
| Long | Short | Value | Description |
|
||||
+------------------------+-------+--------+-------------------------------------------------------------------------------+
|
||||
| audio:periodSize | | 2048 | Requested audio device period size in samples |
|
||||
| audio:bufferLatency | | 13 | Additional buffer latency in milliseconds |
|
||||
| audio:micDefault | | prompt | Default action when an application opens the microphone (prompt, allow, deny) |
|
||||
| audio:micShowIndicator | | yes | Display microphone usage indicator |
|
||||
+------------------------+-------+--------+-------------------------------------------------------------------------------+
|
||||
+------------------------+-------+--------+-------------------------------------------------------------------------------+
|
||||
| Long | Short | Value | Description |
|
||||
+------------------------+-------+--------+-------------------------------------------------------------------------------+
|
||||
| audio:periodSize | | 2048 | Requested audio device period size in samples |
|
||||
| audio:bufferLatency | | 13 | Additional buffer latency in milliseconds |
|
||||
| audio:micDefault | | prompt | Default action when an application opens the microphone (prompt, allow, deny) |
|
||||
| audio:micShowIndicator | | yes | Display microphone usage indicator |
|
||||
+------------------------+-------+--------+-------------------------------------------------------------------------------+
|
||||
|
||||
+------------------+-------+-------+---------------------------------------------------------------------------+
|
||||
| Long | Short | Value | Description |
|
||||
+------------------+-------+-------+---------------------------------------------------------------------------+
|
||||
| egl:vsync | | no | Enable vsync |
|
||||
| egl:doubleBuffer | | no | Enable double buffering |
|
||||
| egl:multisample | | yes | Enable Multisampling |
|
||||
| egl:nvGainMax | | 1 | The maximum night vision gain |
|
||||
| egl:nvGain | | 0 | The initial night vision gain at startup |
|
||||
| egl:cbMode | | 0 | Color Blind Mode (0 = Off, 1 = Protanope, 2 = Deuteranope, 3 = Tritanope) |
|
||||
| egl:scale | | 0 | Set the scale algorithm (0 = auto, 1 = nearest, 2 = linear) |
|
||||
| egl:debug | | no | Enable debug output |
|
||||
| egl:noBufferAge | | no | Disable partial rendering based on buffer age |
|
||||
| egl:noSwapDamage | | no | Disable swapping with damage |
|
||||
| egl:scalePointer | | yes | Keep the pointer size 1:1 when downscaling |
|
||||
| egl:preset | | NULL | The initial filter preset to load |
|
||||
+------------------+-------+-------+---------------------------------------------------------------------------+
|
||||
+------------------+-------+-------+---------------------------------------------------------------------------+
|
||||
| Long | Short | Value | Description |
|
||||
+------------------+-------+-------+---------------------------------------------------------------------------+
|
||||
| egl:vsync | | no | Enable vsync |
|
||||
| egl:doubleBuffer | | no | Enable double buffering |
|
||||
| egl:multisample | | yes | Enable Multisampling |
|
||||
| egl:nvGainMax | | 1 | The maximum night vision gain |
|
||||
| egl:nvGain | | 0 | The initial night vision gain at startup |
|
||||
| egl:cbMode | | 0 | Color Blind Mode (0 = Off, 1 = Protanope, 2 = Deuteranope, 3 = Tritanope) |
|
||||
| egl:scale | | 0 | Set the scale algorithm (0 = auto, 1 = nearest, 2 = linear) |
|
||||
| egl:debug | | no | Enable debug output |
|
||||
| egl:noBufferAge | | no | Disable partial rendering based on buffer age |
|
||||
| egl:noSwapDamage | | no | Disable swapping with damage |
|
||||
| egl:scalePointer | | yes | Keep the pointer size 1:1 when downscaling |
|
||||
| egl:preset | | NULL | The initial filter preset to load |
|
||||
+------------------+-------+-------+---------------------------------------------------------------------------+
|
||||
|
||||
+----------------------+-------+-------+---------------------------------------------+
|
||||
| Long | Short | Value | Description |
|
||||
+----------------------+-------+-------+---------------------------------------------+
|
||||
| opengl:mipmap | | yes | Enable mipmapping |
|
||||
| opengl:vsync | | no | Enable vsync |
|
||||
| opengl:preventBuffer | | yes | Prevent the driver from buffering frames |
|
||||
| opengl:amdPinnedMem | | yes | Use GL_AMD_pinned_memory if it is available |
|
||||
+----------------------+-------+-------+---------------------------------------------+
|
||||
+----------------------+-------+-------+---------------------------------------------+
|
||||
| Long | Short | Value | Description |
|
||||
+----------------------+-------+-------+---------------------------------------------+
|
||||
| opengl:mipmap | | yes | Enable mipmapping |
|
||||
| opengl:vsync | | no | Enable vsync |
|
||||
| opengl:preventBuffer | | yes | Prevent the driver from buffering frames |
|
||||
| opengl:amdPinnedMem | | yes | Use GL_AMD_pinned_memory if it is available |
|
||||
+----------------------+-------+-------+---------------------------------------------+
|
||||
|
||||
+-----------------------+-------+-------+-------------------------+
|
||||
| Long | Short | Value | Description |
|
||||
+-----------------------+-------+-------+-------------------------+
|
||||
| wayland:warpSupport | | yes | Enable cursor warping |
|
||||
| wayland:fractionScale | | yes | Enable fractional scale |
|
||||
+-----------------------+-------+-------+-------------------------+
|
||||
+-----------------------+-------+-------+-------------------------+
|
||||
| Long | Short | Value | Description |
|
||||
+-----------------------+-------+-------+-------------------------+
|
||||
| wayland:warpSupport | | yes | Enable cursor warping |
|
||||
| wayland:fractionScale | | yes | Enable fractional scale |
|
||||
+-----------------------+-------+-------+-------------------------+
|
||||
|
||||
.. _host_usage:
|
||||
|
||||
@@ -343,7 +343,7 @@ Host usage
|
||||
By default the host application will simply work however there are some
|
||||
configurable options available. While the host application will accept command
|
||||
line arguments just as the client will it is more convenient to create the
|
||||
`looking-glass-host.ini` file with the desired configuration options.
|
||||
``looking-glass-host.ini`` file with the desired configuration options.
|
||||
|
||||
This file must be placed in the same directory that the Looking Glass host
|
||||
application was installed for it to be found and used by the application
|
||||
@@ -366,7 +366,7 @@ however this can be changed via the ini file with the following configuration:
|
||||
[app]
|
||||
capture=<INTERFACE>
|
||||
|
||||
Where `<INTERFACE>` is one of `dxgi` or `nvfbc`
|
||||
Where ``<INTERFACE>`` is one of ``dxgi`` or ``nvfbc``
|
||||
|
||||
.. _host_capture_dxgi:
|
||||
|
||||
@@ -386,12 +386,12 @@ the cursor directly, as such titles that do not use a mouse (most FPV games)
|
||||
are not affected.
|
||||
|
||||
The other drawback of this API is the overall system overhead, however this can
|
||||
be mitigated by using the DirectX 12 back end. Please be aware though that this
|
||||
back end is not experimental because it's new, but rather it's a slight
|
||||
abuse/misuse of the DXGI API and allows us to bypass some windows internals.
|
||||
be mitigated by using the DirectX 12 backend. Please be aware though that this
|
||||
backend is not experimental because it's new, but rather it's a slight
|
||||
abuse/misuse of the DXGI API and allows us to bypass some Windows internals.
|
||||
|
||||
To enable the DirectX 12 back end the following configuration needs to be added
|
||||
to the `looking-glass-host.ini` configuration:
|
||||
To enable the DirectX 12 backend the following configuration needs to be added
|
||||
to the ``looking-glass-host.ini`` configuration:
|
||||
|
||||
.. code:: ini
|
||||
|
||||
@@ -403,7 +403,7 @@ to the `looking-glass-host.ini` configuration:
|
||||
d3d12CopySleep=5
|
||||
disableDamage=false
|
||||
|
||||
The option `d3d12CopySleep` is to work around the lack of locking this misuse
|
||||
The option ``d3d12CopySleep`` is to work around the lack of locking this misuse
|
||||
of the API allows and you will need to tune this value to what suits your
|
||||
hardware best. The default value is 5ms as this should work for most, lowing
|
||||
it below 2ms is doubtful to be of practical use to anyone. If this value is too
|
||||
@@ -412,25 +412,25 @@ a window around on the Windows desktop.
|
||||
|
||||
.. note::
|
||||
Lowering d3d12CopySleep can improve the UPS however the UPS metric makes
|
||||
little sense when using the d3d12 back end as if this value is too low
|
||||
little sense when using the d3d12 backend as if this value is too low
|
||||
unchanged frames will be doubled up.
|
||||
|
||||
The `disableDamage` option may be needed to avoid screen corruption however
|
||||
please note that this will increase the bandwidth required and in turn the
|
||||
overall load on your system.
|
||||
The ``disableDamage`` option may be needed to avoid screen corruption. Note
|
||||
that this will increase the bandwidth required and in turn the overall load on
|
||||
your system.
|
||||
|
||||
The DXGI capture interface also offers a feature that allows downsampling the
|
||||
captured frames in the guest GPU before transferring them to shared memory.
|
||||
This feature is very useful if you are super scaling for better picture quality
|
||||
and wish to reduce system memory pressure.
|
||||
|
||||
The configuration for this is fairly straight forward and is defined as set of
|
||||
The configuration for this is fairly straightforward and is defined as set of
|
||||
rules to determine when to perform this downsampling. The format is as follows:
|
||||
|
||||
.. code:: ini
|
||||
|
||||
[dxgi]
|
||||
downssample=RULE1,RULE2,RULE3
|
||||
downsample=RULE1,RULE2,RULE3
|
||||
|
||||
The rules are written as follows:
|
||||
|
||||
@@ -438,7 +438,7 @@ The rules are written as follows:
|
||||
|
||||
(>|>=)(WIDTH)x(HEIGHT):(LEVEL)
|
||||
|
||||
The `LEVEL` is the fractional scale level where 1 = 50%, 2 = 25%, 3 = 12.5%.
|
||||
The ``LEVEL`` is the fractional scale level where 1 = 50%, 2 = 25%, 3 = 12.5%.
|
||||
|
||||
**Examples:**
|
||||
|
||||
@@ -470,7 +470,7 @@ system load and lower latency capture, and does not suffer from the mouse
|
||||
motion stutter issues that DXGI suffers from.
|
||||
|
||||
To enable it's usage use the following configuration in the
|
||||
`looking-glass-host.ini` file:
|
||||
``looking-glass-host.ini`` file:
|
||||
|
||||
.. code:: ini
|
||||
|
||||
@@ -492,7 +492,7 @@ rules to determine when to perform this downsampling. The format is as follows:
|
||||
.. code:: ini
|
||||
|
||||
[nvfbc]
|
||||
downssample=RULE1,RULE2,RULE3
|
||||
downsample=RULE1,RULE2,RULE3
|
||||
|
||||
The rules are written as follows:
|
||||
|
||||
@@ -515,5 +515,5 @@ The rules are written as follows:
|
||||
downsample=3840x2160:1920x1080,3840x2400:1920x1200
|
||||
|
||||
This capture interface also looks for and reads the value of the system
|
||||
environment variable `NVFBC_PRIV_DATA` if it has been set, documentation on
|
||||
it's usage however is unavailable.
|
||||
environment variable ``NVFBC_PRIV_DATA`` if it has been set, documentation on
|
||||
its usage however is unavailable.
|
||||
|
||||
Reference in New Issue
Block a user