Mirrored_Repos/LookingGlass
1
0
Fork 0
mirror of https://github.com/gnif/LookingGlass.git synced 2026-11-06 11:57:20 +00:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

[doc] overview: Finishing touches

Browse Source
This commit is contained in:
Jonathan Rubenstein
2026-10-04 19:57:30 +03:00
committed by Geoffrey McRae
parent c6f40a6f82
commit eb120d3299
1 changed files with 25 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
doc/overview.rst
View File

@@ -5,8 +5,8 @@ Overview
Looking Glass displays a Windows virtual machine in a low-latency Linux
window. It transfers completed frames through shared memory instead of sending
compressed video over a network. The current IDD provides video and direct
input through LGMP, while SPICE normally provides audio, clipboard and fallback
compressed video over a network. The IDD provides video and direct
input through LGMP, while SPICE provides audio, clipboard, and fallback
services.
.. _documentation:
@@ -41,9 +41,8 @@ Windows guest
The Windows virtual machine shown by Looking Glass.
Looking Glass Client
The Linux application that displays the guest and sends user input. There
are currently no distribution packages for it, so it must be built from
source before installation.
The Linux application that displays video from the guest, relays audio, and
sends user input.
Looking Glass Server
The Windows guest application that generates the video feed for the Looking
@@ -53,7 +52,7 @@ Looking Glass Server
Looking Glass IDD
The recommended Windows Indirect Display Driver. It creates a virtual
monitor, sends its frames to the client and provides direct keyboard and
mouse input. The installer also includes the IDD helper and input driver.
mouse input.
Legacy Host Application
The older Windows capture application. It captures an existing display
@@ -62,16 +61,18 @@ Legacy Host Application
KVMFR and IVSHMEM
The shared-memory path between the Windows guest and Linux host. KVMFR is
the recommended Linux kernel module because it permits direct GPU imports
where supported.
the recommended Linux kernel module, as it permits direct GPU imports where
supported.
LGMP
The protocol used by Looking Glass components over shared memory.
SPICE
An optional fallback transport for video, input, audio and clipboard
services. With the IDD active, Looking Glass normally uses its direct input
path and uses SPICE only for services that are enabled and available.
Remote communications protocol for virtual machines. Used by Looking Glass
for its emulated USB audio device. Also serves as an optional fallback
transport for video, input, audio and clipboard services.
.. _recommended_setup:
Recommended setup
-----------------
@@ -80,27 +81,28 @@ For a new installation, use:
* the current Looking Glass Client on the Linux host;
* KVMFR shared memory attached to the Windows guest;
* the matching Looking Glass IDD in the Windows guest; and
* SPICE only for the fallback or convenience services you need.
* the current Looking Glass IDD in the Windows guest; and
* SPICE installed on the Linux host
Use matching Looking Glass releases for the current client, IDD, and OBS plugin.
The shared-memory protocol changes between releases and incompatible components
will not connect. Users of the legacy host application must use the complete
matching B7 stack described below.
Make sure to use the same version of Looking Glass for the client, IDD, and OBS
plugin. The shared-memory protocol changes between releases and incompatible
components are unable to connect. Users of the Legacy Host Application must use
the complete B7 stack described below.
.. _legacy_host_policy:
Legacy Host Application
-----------------------
The Host Application is the legacy implementation of the Looking Glass server.
The IDD is recommended because it does not require a physical monitor or dummy
plug and supports current display, input and scheduling features.
The Legacy Host Application is the legacy implementation of the Looking Glass
server. The IDD is recommended, because it does not require a physical monitor
or dummy plug, and supports current display, input, and scheduling features.
If your workflow specifically requires non-capture mouse input with the Host
Application, B7 is the last recommended release. Use the matching B7 client,
Host Application and B7 documentation together; do not mix B7 components with
current releases.
Application, B7 is the last recommended release. Use the B7 client, Host
Application and B7 documentation together; do not mix B7 components with current
releases.
Download the complete B7 release from https://looking-glass.io/downloads and see
the :ref:`legacy_host` section.