### Displaying Host Installation Help (Windows Command Line)

Source: https://looking-glass.io/docs/B7/_sources/install_host

This command displays a list of all available command-line flags for the Looking Glass Host installer on Windows. This is useful for understanding and customizing the installation process beyond the default silent installation.

```batch
looking-glass-host-setup.exe /?
```

--------------------------------

### Example Memory Calculation for 1080p SDR

Source: https://looking-glass.io/docs/B7/_sources/install_libvirt

An example calculation demonstrating how to determine the required MiB for a 1920x1080 resolution with SDR (4 BPP), including adding 10 MiB and rounding up to the nearest power of two.

```math
1920 * 1080 * 4 * 2 = 16,588,800 bytes

16,588,800 / 1024 / 1024 = 15.82 MiB

15.82 MiB + 10 MiB = 25.82 MiB

2^ceil(log2(25.82)) = 32 MiB
```

--------------------------------

### Install NSIS for Windows Installer

Source: https://looking-glass.io/docs/B7/build

Installs the Nullsoft Scriptable Install System (NSIS) using the apt-get package manager, which is required for building the Windows installer.

```shell
apt-get install nsis
```

--------------------------------

### Install OBS Plugin (Bash)

Source: https://looking-glass.io/docs/B7/_sources/obs

Installs the Looking Glass OBS plugin after it has been built. This command executes 'make install'. If the plugin was built for system-wide installation, this command needs to be run with root privileges.

```bash
make install
```

```bash
sudo make install
```

--------------------------------

### Install OBS Plugin (as root)

Source: https://looking-glass.io/docs/B7/obs

Installs the Looking Glass OBS plugin system-wide, requiring root privileges to write to system directories.

```bash
sudo make install
```

--------------------------------

### Install Looking Glass Client (System-wide)

Source: https://looking-glass.io/docs/B7/_sources/install_client

Installs the Looking Glass client application system-wide after building from source. This command requires root privileges.

```shell
make install
```

--------------------------------

### Silent Installation of Looking Glass Host on Windows

Source: https://looking-glass.io/docs/B7/install_host

This command executes a silent installation of the Looking Glass Host application on Windows with default options. It's useful for automated deployments. The '/?' flag can be used to list all available configuration options.

```bash
looking-glass-host-setup.exe /S
```

--------------------------------

### Install Looking Glass Client (Local User)

Source: https://looking-glass.io/docs/B7/_sources/install_client

Installs the Looking Glass client application for the local user only. It configures the installation path to '~/.local' using CMake before building and installing.

```shell
cmake -DCMAKE_INSTALL_PREFIX=~/.local .. && make install
```

--------------------------------

### Run Looking Glass Client

Source: https://looking-glass.io/docs/B7/build

Executes the compiled Looking Glass client binary directly from the build directory. This allows testing the client before formal installation.

```bash
./looking-glass-client
```

--------------------------------

### Configure SPICE VM Channel for Clipboard Sync (libvirt)

Source: https://looking-glass.io/docs/B7/_sources/install_libvirt

libvirt XML configuration to enable a SPICE channel for agent communication, facilitating clipboard synchronization between the host and guest.

```xml
<channel type="spicevmc">

```

--------------------------------

### Build OBS Plugin (User Install)

Source: https://looking-glass.io/docs/B7/obs

Compiles the Looking Glass OBS plugin from source, installing it for the current user. This involves creating a build directory, configuring with CMake, and running make.

```bash
mkdir obs/build
cd obs/build
cmake -DUSER_INSTALL=1 ../
make
```

--------------------------------

### Install Build Dependencies with APT

Source: https://looking-glass.io/docs/B7/build

Installs the required libraries and tools for building the Looking Glass client on Debian-based systems. It's crucial to ensure compatibility with your audio system (PipeWire or PulseAudio) and adjust the list accordingly.

```bash
apt-get install binutils-dev cmake fonts-dejavu-core libfontconfig-dev \
gcc g++ pkg-config libegl-dev libgl-dev libgles-dev libspice-protocol-dev \
nettle-dev libx11-dev libxcursor-dev libxi-dev libxinerama-dev \
libxpresent-dev libxss-dev libxkbcommon-dev libwayland-dev wayland-protocols \
libpipewire-0.3-dev libpulse-dev libsamplerate0-dev
```

--------------------------------

### Configure SPICE VM Channel for Clipboard Sync (QEMU)

Source: https://looking-glass.io/docs/B7/_sources/install_libvirt

QEMU command-line arguments to configure the virtio serial PCI device and a SPICE channel for agent communication, enabling clipboard synchronization.

```bash
-device virtio-serial-pci \
-chardev spicevmc,id=vdagent,name=vdagent \
-device virtserialport,chardev=vdagent,name=com.redhat.spice.0
```

--------------------------------

### Install libobs-dev with apt-get

Source: https://looking-glass.io/docs/B7/obs

Installs the necessary development library for the OBS plugin using the apt-get package manager. This is a prerequisite for building the plugin.

```bash
apt-get install libobs-dev
```

--------------------------------

### Build Windows installer using makensis

Source: https://looking-glass.io/docs/B7/_sources/build

Builds the Looking Glass Windows installer package using the 'makensis' utility. This command is executed after cross-compiling the host and installing NSIS, targeting the installer script.

```bash
cd host/build/platform/Windows
   makensis installer.nsi
```

--------------------------------

### Build OBS Plugin (System-wide Install)

Source: https://looking-glass.io/docs/B7/obs

Compiles the Looking Glass OBS plugin from source, installing it system-wide. This process is similar to the user install but omits the USER_INSTALL flag during CMake configuration.

```bash
mkdir obs/build
cd obs/build
cmake ../
make
```

--------------------------------

### Build Windows Installer with NSIS

Source: https://looking-glass.io/docs/B7/build

Uses the makensis command to build the Windows installer package from the provided NSIS script.

```shell
cd host/build/platform/Windows
makensis installer.nsi
```

--------------------------------

### Install Looking Glass Build Dependencies with APT

Source: https://looking-glass.io/docs/B7/_sources/build

Installs the required packages for building Looking Glass on Debian-based systems using the apt-get package manager. It includes a warning about potential conflicts with PipeWire and PulseAudio.

```bash
apt-get install binutils-dev cmake fonts-dejavu-core libfontconfig-dev \
  gcc g++ pkg-config libegl-dev libgl-dev libgles-dev libspice-protocol-dev \
  nettle-dev libx11-dev libxcursor-dev libxi-dev libxinerama-dev \
  libxpresent-dev libxss-dev libxkbcommon-dev libwayland-dev wayland-protocols \
  libpipewire-0.3-dev libpulse-dev libsamplerate0-dev
```

--------------------------------

### Configure QEMU for SPICE Clipboard Sync

Source: https://looking-glass.io/docs/B7/install_libvirt

Sets up QEMU arguments to enable SPICE communication for clipboard synchronization. It involves adding a virtio-serial PCI device and a serial port connected to the vdagent.

```bash
-device virtio-serial-pci \
-chardev spicevmc,id=vdagent,name=vdagent \
-device serialport,chardev=vdagent,name=com.redhat.spice.0
```

--------------------------------

### Configure libvirt for SPICE Clipboard Sync

Source: https://looking-glass.io/docs/B7/install_libvirt

Configures libvirt XML to enable SPICE communication for clipboard synchronization via a virtio-serial channel. This automatically adds the necessary VirtIO Serial device.

```xml
<channel type="spicevmc">
  <target type="virtio" name="com.redhat.spice.0"/>
  <address type="virtio-serial" controller="0" bus="0" port="1"/>
</channel>
```

--------------------------------

### Example Log Output for IVSHMEM Devices

Source: https://looking-glass.io/docs/B7/usage

This example demonstrates how IVSHMEM devices are listed in the `looking-glass-host.txt` log file. It shows the device index, bus, slot, and function, with an asterisk indicating the currently selected device.

```Log
[I]     19989544      …      IVSHMEM 0  on bus 0x6, device 0x3, function 0x0
[I]     19990438      …      IVSHMEM 1* on bus 0x6, device 0x5, function 0x0
```

--------------------------------

### Add SPICE Audio Device Configuration (XML)

Source: https://looking-glass.io/docs/B7/_sources/install_libvirt

XML snippet to add an Intel HDA audio device with SPICE audio support to a libvirt VM configuration.

```xml
<sound model='ich9'>
  <audio id='1'/>
</sound>
<audio id='1' type='spice'/>
```

--------------------------------

### Install Looking Glass Host Service (CMD)

Source: https://looking-glass.io/docs/B7/_sources/faq

Command to install the Looking Glass host application as a Windows service. This allows for higher priority capture using DXGI and Secure Desktop (UAC) capture support.

```CMD
looking-glass-host.exe InstallService
```

--------------------------------

### Install build dependencies on MSYS2

Source: https://looking-glass.io/docs/B7/_sources/build

Installs essential build tools and dependencies for compiling the Looking Glass host on Windows using MSYS2. It updates package databases and installs Git, Make, GCC, and CMake.

```bash
pacman -Fy
   pacman -Sy git make mingw-w64-x86_64-gcc mingw-w64-x86_64-cmake
```

--------------------------------

### Downsampling Configuration Examples (INI)

Source: https://looking-glass.io/docs/B7/_sources/usage

Illustrates different ways to configure downsampling rules using the INI format. Examples include exact resolution matching, greater-than comparisons, and multiple rule definitions.

```ini
; Downsample exactly 3840x2160 to 1920x1080
downsample=3840x2160:1920x1080
```

```ini
; Downsample anything greater then 1920x1080 to 1920x1080
downsample=>1920x1080:1920x1080
```

```ini
; Downsample 3840x2160 to 1920x1080, or 3840x2400 to 1920x1200
downsample=3840x2160:1920x1080,3840x2400:1920x1200
```

--------------------------------

### Install KVMFR Prerequisites (Bash)

Source: https://looking-glass.io/docs/B7/_sources/ivshmem_kvmfr

Installs the necessary Linux kernel headers and DKMS for building the KVMFR module. Requires root privileges.

```bash
apt-get install linux-headers-$(uname -r) dkms
```

--------------------------------

### Configure libvirt for SPICE Input/Output

Source: https://looking-glass.io/docs/B7/install_libvirt

Configures libvirt XML to enable SPICE for keyboard, mouse, audio, and display fallback. This involves setting the video model to 'vga', removing tablet input, and adding virtio mouse and keyboard devices for optimal performance and multi-button mouse support.

```xml
<video>
  <model type='vga'/>
</video>
<input type='mouse' bus='virtio'/>
<input type='keyboard' bus='virtio'/>
```

--------------------------------

### Restart AppArmor Service

Source: https://looking-glass.io/docs/B7/_sources/install_libvirt

Restarts the AppArmor service, typically required after modifying AppArmor profiles to apply new security permissions.

```bash
sudo systemctl restart apparmor
```

--------------------------------

### Install Build Dependencies on Windows (MSYS2)

Source: https://looking-glass.io/docs/B7/build

Installs essential build tools like Git, Make, GCC, and CMake using the pacman package manager within the MSYS2 shell on Windows.

```shell
pacman -Fy
pacman -Sy git make mingw-w64-x86_64-gcc mingw-w64-x86_64-cmake
```

--------------------------------

### Disable VirtIO Memballoon Device in libvirt

Source: https://looking-glass.io/docs/B7/_sources/install_libvirt

Configures the libvirt XML to disable the VirtIO memballoon device, which can cause performance issues in VFIO passthrough setups. This is done by setting the 'model' attribute to 'none'.

```xml
<memballoon model="none"/>
```

--------------------------------

### Looking Glass Client Configuration File Format

Source: https://looking-glass.io/docs/B7/usage

Illustrates the INI format used for Looking Glass client configuration files, showing how to set options like fullscreen and EGL settings, and includes an example of a comment line.

```ini
[win]\nfullScreen=yes\n\n[egl]\nnvGain=1\n\n; this is a comment\n
```

--------------------------------

### Build Looking Glass Client

Source: https://looking-glass.io/docs/B7/build

Compiles the Looking Glass client binary after setting up the build environment and installing dependencies. This involves creating a build directory, configuring with CMake, and then making the project.

```bash
mkdir client/build
cd client/build
cmake ../
make
```

--------------------------------

### Install KVMFR DKMS Module (Bash)

Source: https://looking-glass.io/docs/B7/_sources/ivshmem_kvmfr

Installs the KVMFR module into DKMS, allowing it to be managed across kernel updates. Assumes you are in the 'module/' directory.

```bash
dkms install "."
```

--------------------------------

### Calculate Frame Buffer Size in MiB for libvirt/QEMU

Source: https://looking-glass.io/docs/B7/_sources/install_libvirt

Formulas to calculate the required frame buffer size in MiB for Looking Glass, considering resolution, bits per pixel (BPP), and rounding up to the nearest power of two. BPP is 4 for SDR and 8 for HDR.

```math
WIDTH * HEIGHT * BPP * 2 = frame size in bytes

frame size in bytes / 1024 / 1024 = frame size in MiB

frame size in MiB + 10 = required size in MiB

2^ceil(log2(required size in MiB)) = total MiB
```

--------------------------------

### Install KVMFR Module into DKMS

Source: https://looking-glass.io/docs/B7/ivshmem_kvmfr

Installs the KVMFR kernel module into the DKMS (Dynamic Kernel Module Support) framework, allowing it to be automatically rebuilt for new kernel versions.

```bash
cd module/
dkms install "."
```

--------------------------------

### Configure QEMU command line for IVSHMEM

Source: https://looking-glass.io/docs/B7/ivshmem_shm

Adds IVSHMEM device and memory backend arguments to a QEMU command line. The 'bus' parameter may need adjustment based on the specific QEMU setup.

```bash
-device ivshmem-plain,memdev=ivshmem,bus=pcie.0 \
-object memory-backend-file,id=ivshmem,share=on,mem-path=/dev/shm/looking-glass,size=32M
```

--------------------------------

### Enable libdecor for GNOME Wayland

Source: https://looking-glass.io/docs/B7/faq

This C++ code snippet demonstrates how to enable libdecor support when building the Looking Glass client for GNOME on Wayland. Libdecor helps with window decorations in Wayland environments. Ensure you have the 'libdecor-0-dev' package installed or build libdecor from source.

```bash
cmake -DENABLE_LIBDECOR=ON
```

--------------------------------

### Calculate libvirt/QEMU Memory for Looking Glass

Source: https://looking-glass.io/docs/B7/install_libvirt

Calculates the required memory size for Looking Glass based on resolution and BPP (Bits Per Pixel). The formula involves multiplying width, height, and BPP, then converting to MiB, adding a buffer, and rounding up to the nearest power of two. This ensures proper display without truncation.

```text
WIDTH×HEIGHT×BPP×2=frame size in bytes
frame size in bytes÷1024÷1024= frame size in MiB
frame size in MiB+10= required size in MiB
2⌈log2⁡(required size in MiB)⌉= total MiB
```

--------------------------------

### Add AppArmor Permissions for QEMU Shared Memory

Source: https://looking-glass.io/docs/B7/install_libvirt

Adds necessary AppArmor permissions for QEMU to access the shared memory file, typically `/dev/shm/looking-glass`. This is required for libvirt versions prior to 5.10.0 when using AppArmor.

```bash
/dev/shm/looking-glass rw,

```

--------------------------------

### Enable libdecor support for GNOME Wayland in Looking Glass client

Source: https://looking-glass.io/docs/B7/_sources/faq

This snippet shows how to enable libdecor support when building the Looking Glass client for GNOME on Wayland. This is a workaround for window decorations and resizing issues. Ensure you have the libdecor development package installed.

```bash
cmake -DENABLE_LIBDECOR=ON
make
```

--------------------------------

### Configure IVSHMEM Device Selection in Looking Glass

Source: https://looking-glass.io/docs/B7/usage

This configuration snippet shows how to specify which IVSHMEM device to use when multiple are attached to a virtual machine. The `shmDevice` option selects the Nth IVSHMEM device, ordered by PCI slot, starting from 0.

```INI
[os]
; Select the second IVSHMEM device
shmDevice=1
```

--------------------------------

### Looking Glass Client Command Line Usage

Source: https://looking-glass.io/docs/B7/usage

Demonstrates the basic command-line structure for the Looking Glass client, including help options and common arguments for shared memory files, fullscreen mode, and disabling Spice or host screensaver.

```bash
**looking-glass-client** [--help] [-f] [-F] [-s] [-S] [options...]\nExample: looking-glass-client --help\nlooking-glass-client -F\nlooking-glass-client win:fullScreen\nlooking-glass-client -f /dev/shm/my-lg-shmem\nlooking-glass-client app:shmFile=/dev/shm/my-lg-shmem
```

--------------------------------

### Configure and Build Host on Linux

Source: https://looking-glass.io/docs/B7/build

Configures the project for native Linux builds using CMake and then compiles the host application.

```shell
mkdir host/build
cd host/buildcmake ..
make
```

--------------------------------

### Configure and Build Host Cross-Compiling for Windows on Linux

Source: https://looking-glass.io/docs/B7/build

Configures the project for cross-compiling a Windows executable on Linux using the mingw64 toolchain with CMake.

```shell
mkdir host/build
cd host/buildcmake -DCMAKE_TOOLCHAIN_FILE=../toolchain-mingw64.cmake ..
make
```

--------------------------------

### Configure and Build Host on Windows (MSYS2)

Source: https://looking-glass.io/docs/B7/build

Configures the project for building on Windows using MSYS Makefiles with CMake and then compiles the host application.

```shell
mkdir host/build
cd host/buildcmake -G "MSYS Makefiles" ..
make
```

--------------------------------

### Looking Glass Command Line Options

Source: https://looking-glass.io/docs/B7/_sources/usage

Lists various command-line options for the Looking Glass client, including configurations for config files, renderers, license display, and cursor polling intervals.

```bash
Looking Glass Client Command Line Options:

+------------------------+-------+-------------+-----------------------------------------------------------------------------------------+
| Long                   | Short | Value       | Description                                                                             |
+========================+=======+=============+=========================================================================================+
| app:configFile         | -C    | NULL        | A file to read additional configuration from                                            |
+------------------------+-------+-------------+-----------------------------------------------------------------------------------------+
| app:renderer           | -g    | EGL         | 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                                  |
+------------------------+-------+-------------+-----------------------------------------------------------------------------------------+
```

--------------------------------

### Configure and build Looking Glass host on Linux

Source: https://looking-glass.io/docs/B7/_sources/build

Builds the Looking Glass host application on a Linux system. It involves creating a dedicated build directory, configuring the project using CMake, and then compiling the source code with Make.

```bash
mkdir host/build
   cd host/build
   cmake ..
   make
```

--------------------------------

### Configure and build Looking Glass host with MSYS Makefiles

Source: https://looking-glass.io/docs/B7/_sources/build

Sets up the build environment for the Looking Glass host on Windows using MSYS2 and CMake. It creates a build directory, configures the project with 'MSYS Makefiles', and then initiates the build process with 'make'.

```bash
mkdir host/build
   cd host/build
   cmake -G "MSYS Makefiles" ..
   make
```

--------------------------------

### Clone Looking Glass Repository

Source: https://looking-glass.io/docs/B7/build

Clones the Looking Glass source code repository from GitHub, including submodules, which are essential for building. This command is intended for developers.

```bash
git clone --recursive https://github.com/gnif/LookingGlass.git
```

--------------------------------

### Enable KVMFR Module with systemd (Text)

Source: https://looking-glass.io/docs/B7/_sources/ivshmem_kvmfr

Configures systemd to automatically load the KVMFR module at boot time by creating a modules-load configuration file.

```text
# KVMFR Looking Glass module
kvmfr
```

--------------------------------

### Looking Glass Client Default Key Bindings

Source: https://looking-glass.io/docs/B7/usage

Lists the default key bindings for the Looking Glass client, including toggling capture mode, quitting, audio recording, output rotation, frame timing, Spice input, overlay mode, FPS display, fullscreen, video stream, night vision, sending function keys, mute, volume control, mouse sensitivity, and Windows key.

```text
ScrLk | Toggle capture mode\nScrLk + Q | Quit\nScrLk + E | Toggle audio recording\nScrLk + R | Rotate the output clockwise by 90° increments\nScrLk + T | Show frame timing information\nScrLk + I | Spice keyboard & mouse enable toggle\nScrLk + O | Toggle overlay\nScrLk + D | FPS display toggle\nScrLk + F | Full screen toggle\nScrLk + V | Video stream toggle\nScrLk + N | Toggle night vision mode\nScrLk + F1 | Send Ctrl + Alt + F1 to the guest\nScrLk + F2 | Send Ctrl + Alt + F2 to the guest\nScrLk + F3 | Send Ctrl + Alt + F3 to the guest\nScrLk + F4 | Send Ctrl + Alt + F4 to the guest\nScrLk + F5 | Send Ctrl + Alt + F5 to the guest\nScrLk + F6 | Send Ctrl + Alt + F6 to the guest\nScrLk + F7 | Send Ctrl + Alt + F7 to the guest\nScrLk + F8 | Send Ctrl + Alt + F8 to the guest\nScrLk + F9 | Send Ctrl + Alt + F9 to the guest\nScrLk + F10 | Send Ctrl + Alt + F10 to the guest\nScrLk + F11 | Send Ctrl + Alt + F11 to the guest\nScrLk + F12 | Send Ctrl + Alt + F12 to the guest\nScrLk + M | Send mute to the guest\nScrLk + ↑ | Send volume up to the guest\nScrLk + ↓ | Send volume down to the guest\nScrLk + Insert | Increase mouse sensitivity in capture mode\nScrLk + Del | Decrease mouse sensitivity in capture mode\nScrLk + LWin | Send LWin to the guest\nScrLk + RWin | Send RWin to the guest
```

--------------------------------

### Build with Libdecor Enabled

Source: https://looking-glass.io/docs/B7/build

Configures the build process to enable libdecor support using CMake, which is recommended for users running GNOME on Wayland. This option enhances Wayland integration.

```bash
cmake -DENABLE_LIBDECOR=ON ../
```

--------------------------------

### Configure Downsampling Rules for Frame Capture

Source: https://looking-glass.io/docs/B7/usage

This configuration demonstrates how to set up downsampling rules for captured frames. The format specifies source resolution conditions (e.g., exact or greater than) and target resolutions to reduce bandwidth usage or enable scaling effects.

```INI
; Downsample exactly 3840x2160 to 1920x1080
downsample=3840x2160:1920x1080

; Downsample anything greater then 1920x1080 to 1920x1080
downsample=>1920x1080:1920x1080

; Downsample 3840x2160 to 1920x1080, or 3840x2400 to 1920x1200
downsample=3840x2160:1920x1080,3840x2400:1920x1200
```

--------------------------------

### Looking Glass Client Command-Line Usage

Source: https://looking-glass.io/docs/B7/_sources/usage

This snippet shows the basic command structure for the looking-glass-client. It includes common options for managing shared memory, fullscreen mode, disabling Spice, and disabling the host screensaver. Options can be provided in short or long form, and boolean options can be toggled.

```bash
looking-glass-client [--help] [-f] [-F] [-s] [-S] [options...]
```

--------------------------------

### Verify KVMFR Module Creation (Text)

Source: https://looking-glass.io/docs/B7/_sources/ivshmem_kvmfr

Checks dmesg output for confirmation of KVMFR module device creation, indicating successful loading.

```text
kvmfr: creating 1 static devices
```

--------------------------------

### Configuration Widget Tabs

Source: https://looking-glass.io/docs/B7/_sources/usage

The configuration widget, accessible via Overlay Mode, provides tabs for 'Settings' and 'EGL Filters' to adjust various runtime parameters.

```APIDOC
## Configuration Widget Tabs

### Description
Accesses various runtime settings through different tabs within the overlay mode.

### Method
N/A (In-application feature)

### Endpoint
N/A (In-application feature)

### Parameters
None

### Request Example
None

### Response
None

### Tabs:
- **Settings Tab**:
  - Performance Metrics: Toggle for performance metrics widget and graphs.
  - EGL: Modify EGL settings like scaling algorithm and night vision mode.
  - *Note: Changes in this tab are not persistent and reset on client restart.*
- **EGL Filters Tab**:
  - Toggle, configure, and order post-processing filters.
  - Filters applied top-to-bottom. Order can affect results (e.g., CAS vs. FSR).
  - Available Filters:
    - **Downscaler**: For downscaling host resolution. Settings: pixel-size, interpolation algorithm.
    - **AMD FidelityFX Super Resolution (FSR)**: Upscaling filter. Settings: sharpness, quality mode.
    - **AMD FidelityFX Contrast Adaptive Sharpening (CAS)**: Sharpening algorithm. Settings: sharpness.
  - **Presets**:
    - Save and load filter settings and order to presets.
    - Presets stored at: `$XDG_CONFIG_HOME/looking-glass/presets`.
    - *Warning: Do not manually edit files in the 'presets' folder.*
    - *Note: Client does not remember the last used preset; it must be manually recalled.*
```

--------------------------------

### Configure KVMFR in libvirt XML (Modern QEMU/libvirt) (XML)

Source: https://looking-glass.io/docs/B7/_sources/ivshmem_kvmfr

Adds the necessary XML configuration to a libvirt domain to enable IVSHMEM device using the KVMFR module. Requires QEMU 6.2+ and libvirt 7.9+. The 'size' parameter should be calculated in bytes.

```xml
<domain type='kvm' xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0'>
  <qemu:commandline>
    <qemu:arg value="-device"/>
    <qemu:arg value="{'driver':'ivshmem-plain','id':'shmem0','memdev':'looking-glass'}"/>
    <qemu:arg value="-object"/>
    <qemu:arg value="{'qom-type':'memory-backend-file','id':'looking-glass','mem-path':'/dev/kvmfr0','size':33554432,'share':true}"/>
  </qemu:commandline>
</domain>
```

--------------------------------

### POST /api/command-options

Source: https://looking-glass.io/docs/B7/_sources/usage

This endpoint allows setting various command-line options for the Looking Glass client application.

```APIDOC
## POST /api/command-options

### Description
Allows setting command-line options for the Looking Glass client.

### Method
POST

### Endpoint
`/api/command-options`

### Parameters
#### Query Parameters
- **configFile** (string) - Optional - Path to a file for additional configuration.
- **renderer** (string) - Optional - Specify the renderer to use (e.g., EGL).
- **license** (boolean) - Optional - If true, show license and terminate.
- **cursorPollInterval** (integer) - Optional - How often to check for cursor updates in microseconds (default: 1000).

### Request Example
```json
{
  "configFile": "/path/to/config.ini",
  "renderer": "EGL",
  "license": false,
  "cursorPollInterval": 500
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of settings being applied.

#### Response Example
```json
{
  "message": "Command options updated successfully."
}
```
```

--------------------------------

### Libvirt QEMU Commandline for Legacy QEMU/Libvirt

Source: https://looking-glass.io/docs/B7/ivshmem_kvmfr

Configures the IVSHMEM device for Looking Glass using legacy QEMU arguments, intended for QEMU versions older than 6.2 or libvirt versions older than 7.9.

```xml
<qemu:commandline>
  <qemu:arg value="-device"/>
  <qemu:arg value="ivshmem-plain,id=shmem0,memdev=looking-glass"/>
  <qemu:arg value="-object"/>
  <qemu:arg value="memory-backend-file,id=looking-glass,mem-path=/dev/kvmfr0,size=32M,share=yes"/>
</qemu:commandline>

```

--------------------------------

### Libvirt QEMU Commandline for Modern QEMU/Libvirt

Source: https://looking-glass.io/docs/B7/ivshmem_kvmfr

Configures the IVSHMEM device for Looking Glass using JSON-style QEMU arguments, suitable for QEMU 6.2+ and libvirt 7.9+.

```xml
<qemu:commandline>
  <qemu:arg value="-device"/>
  <qemu:arg value="{'driver':'ivshmem-plain','id':'shmem0','memdev':'looking-glass'}"/>
  <qemu:arg value="-object"/>
  <qemu:arg value="{'qom-type':'memory-backend-file','id':'looking-glass','mem-path':'/dev/kvmfr0','size':33554432,'share':true}"/>
</qemu:commandline>

```

--------------------------------

### Looking Glass Client Configuration File Format (INI)

Source: https://looking-glass.io/docs/B7/_sources/usage

This snippet demonstrates the INI file format used by Looking Glass for client configuration. It shows how to set options like fullscreen mode and specific EGL settings. Comments are supported using a semicolon. Command-line arguments override these settings.

```ini
[win]
fullScreen=yes

[egl]
nvGain=1

; this is a comment

```

--------------------------------

### AppArmor Configuration for Libvirt QEMU

Source: https://looking-glass.io/docs/B7/ivshmem_kvmfr

Adds permissions to AppArmor profile to allow access to the /dev/kvmfr0 device, necessary for libvirt-qemu.

```apparmor
# Looking Glass
/dev/kvmfr0 rw,


```

--------------------------------

### Overlay Mode

Source: https://looking-glass.io/docs/B7/_sources/usage

Overlay Mode allows runtime configuration of EGL filters, performance metrics, and debug display. Widgets can be repositioned and resized. Enter/exit with ScrLk + O or ESC. Configuration is saved to $XDG_CONFIG_HOME/looking-glass/imgui.ini.

```APIDOC
## Overlay Mode

### Description
Allows runtime configuration of EGL filters, performance metrics, and debug frame damage display. Widgets like FPS/UPS can be repositioned and resized.

### Method
N/A (In-application feature)

### Endpoint
N/A (In-application feature)

### Parameters
None

### Request Example
None

### Response
None

### Notes
- Enter/Exit: `ScrLk` + `O` or `ESC`
- Configuration saved to: `$XDG_CONFIG_HOME/looking-glass/imgui.ini`
```

--------------------------------

### Configure KVMFR in libvirt XML (Legacy QEMU/libvirt) (XML)

Source: https://looking-glass.io/docs/B7/_sources/ivshmem_kvmfr

Adds the necessary XML configuration to a libvirt domain for IVSHMEM device using the KVMFR module with legacy QEMU/libvirt syntax. This is for versions older than QEMU 6.2 or libvirt 7.9.

```xml
<domain type='kvm' xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0'>
  <qemu:commandline>
    <qemu:arg value="-device"/>
    <qemu:arg value="ivshmem-plain,id=shmem0,memdev=looking-glass"/>
    <qemu:arg value="-object"/>
  </qemu:commandline>
</domain>
```

--------------------------------

### Libvirt XML Namespace Modification for QEMU

Source: https://looking-glass.io/docs/B7/ivshmem_kvmfr

Modifies the libvirt XML domain tag to include the QEMU namespace, which is required for using QEMU commandline arguments within libvirt.

```xml
<domain type='kvm' xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0'>


```

--------------------------------

### Verify KVMFR Module Loading

Source: https://looking-glass.io/docs/B7/ivshmem_kvmfr

Checks if the KVMFR module has loaded correctly by examining dmesg output for confirmation messages and verifying the existence and type of the /dev/kvmfr0 character device.

```bash
dmesg | grep kvmfr
ls -l /dev/kvmfr0
```

--------------------------------

### Downsampling Configuration Format

Source: https://looking-glass.io/docs/B7/_sources/usage

Defines the syntax for specifying downsampling rules in the Looking Glass host application. It involves a comparison operator, source resolution, and target resolution.

```text
(>|>=)(WIDTH)x(HEIGHT):(TARGET WIDTH)x(TARGET HEIGHT)
```

--------------------------------

### Cross-compile Windows executable on Linux using MinGW64

Source: https://looking-glass.io/docs/B7/_sources/build

Cross-compiles the Looking Glass host for Windows on a Linux system using the MinGW64 toolchain. This process involves specifying a toolchain file during CMake configuration.

```bash
mkdir host/build
   cd host/build
   cmake -DCMAKE_TOOLCHAIN_FILE=../toolchain-mingw64.cmake ..
   make
```

--------------------------------

### Configure KVMFR Module for Permanent Loading

Source: https://looking-glass.io/docs/B7/ivshmem_kvmfr

Creates a configuration file in /etc/modprobe.d/ to make the KVMFR module loading with a specified static size permanent across reboots.

```bash
echo "options kvmfr static_size_mb=32" | sudo tee /etc/modprobe.d/kvmfr.conf
modprobe kvmfr
```

--------------------------------

### Create KVMFR Udev Rule (Text)

Source: https://looking-glass.io/docs/B7/_sources/ivshmem_kvmfr

Defines a udev rule to automatically set ownership and permissions for the /dev/kvmfr0 device upon creation. Replace 'user' with your username.

```text
SUBSYSTEM=="kvmfr", OWNER="user", GROUP="kvm", MODE="0660"
```

--------------------------------

### Configure capture interface (INI)

Source: https://looking-glass.io/docs/B7/usage

Sets the capture interface for the Windows host application. Options include 'd12', 'dxgi', or 'nvfbc'. This is configured within the `looking-glass-host.ini` file under the `[app]` section.

```ini
[app]
capture=<INTERFACE>
```

--------------------------------

### Enable NvFBC Capture (INI)

Source: https://looking-glass.io/docs/B7/_sources/faq

Configuration setting to enable NVFBC (NVIDIA Capture API) in the Looking Glass host INI file. Requires a professional-grade NVIDIA GPU and the NVIDIA Capture SDK.

```INI
[app]
capture=nvfbc
```

--------------------------------

### QEMU Arguments for Shared Memory

Source: https://looking-glass.io/docs/B7/_sources/ivshmem_kvmfr

Provides the arguments to be added to the QEMU command line when using QEMU directly without Libvirt. These arguments configure the shared memory device for Looking Glass.

```qemu
-device ivshmem-plain,id=shmem0,memdev=looking-glass
-object memory-backend-file,id=looking-glass,mem-path=/dev/kvmfr0,size=32M,share=yes

```

--------------------------------

### Set permissions for Looking Glass shared memory file

Source: https://looking-glass.io/docs/B7/ivshmem_shm

Configures systemd-tmpfiles to create the shared memory file with appropriate permissions for the user running Looking Glass. This ensures read/write access.

```text
# Type Path               Mode UID  GID Age Argument

f /dev/shm/looking-glass 0660 user kvm -
```

--------------------------------

### Uninstall Looking Glass Host Service (CMD)

Source: https://looking-glass.io/docs/B7/_sources/faq

Command to uninstall the Looking Glass host application service from Windows. This reverts the application's priority and capture capabilities to default settings.

```CMD
looking-glass-host.exe UninstallService
```

--------------------------------

### Configure KVMFR Module Permanently (Text)

Source: https://looking-glass.io/docs/B7/_sources/ivshmem_kvmfr

Creates a configuration file to make the KVMFR module load with a specific static memory size on boot. The 'static_size_mb' value should be adjusted.

```text
options kvmfr static_size_mb=32
```

--------------------------------

### Configure Scream IVSHMEM Device (INI)

Source: https://looking-glass.io/docs/B7/_sources/faq

Configuration setting to specify the IVSHMEM device for Scream audio in the Looking Glass host INI file. This is an alternative to the default network transfer method.

```INI
[os]
shmDevice=1
```

--------------------------------

### AppArmor Configuration for Looking Glass

Source: https://looking-glass.io/docs/B7/_sources/ivshmem_kvmfr

Adds necessary permissions for Looking Glass to access the /dev/kvmfr0 device within AppArmor policies. This file should be created or appended to the local AppArmor configuration.

```text
# Looking Glass
/dev/kvmfr0 rw,

```

--------------------------------

### Configure libvirt machine for IVSHMEM

Source: https://looking-glass.io/docs/B7/ivshmem_shm

Adds a shared memory device to a libvirt machine configuration. This requires modifying the libvirt XML definition for the virtual machine.

```xml
<shmem name='looking-glass'>
  <model type='ivshmem-plain'/>
  <size unit='M'>32</size>
</shmem>
```

--------------------------------

### Restarting Libvirt Daemon

Source: https://looking-glass.io/docs/B7/_sources/ivshmem_kvmfr

Restarts the libvirtd service to apply changes made to the cgroups configuration. This command requires superuser privileges.

```bash
sudo systemctl restart libvirtd.service

```

--------------------------------

### Build with Backtrace Disabled

Source: https://looking-glass.io/docs/B7/build

Builds Looking Glass with backtrace support disabled using CMake. This can resolve common compile errors related to backtrace functionality and is a recommended workaround if issues arise.

```bash
cmake -DENABLE_BACKTRACE=0 ../
```

--------------------------------

### Enable NVFBC Capture in Looking Glass Host

Source: https://looking-glass.io/docs/B7/usage

This configuration snippet shows how to enable the NVIDIA Frame Buffer Capture (NVFBC) interface in the Looking Glass host application by setting the 'capture' option to 'nvfbc' within the '[app]' section of the configuration file.

```ini
[app]
capture=nvfbc

```

--------------------------------

### Check KVMFR Device Node (Bash)

Source: https://looking-glass.io/docs/B7/_sources/ivshmem_kvmfr

Lists the details of the /dev/kvmfr0 character device, confirming its existence and permissions.

```bash
$ ls -l /dev/kvmfr0
crw------- 1 root root 242, 0 Mar  5 05:53 /dev/kvmfr0
```

--------------------------------

### Load KVMFR Module (Bash)

Source: https://looking-glass.io/docs/B7/_sources/ivshmem_kvmfr

Loads the KVMFR module with a specified static memory size in MB. The 'static_size_mb' parameter should be adjusted based on your requirements.

```bash
modprobe kvmfr static_size_mb=32
```

--------------------------------

### DirectX 12 Capture Options (INI)

Source: https://looking-glass.io/docs/B7/_sources/usage

Configures advanced settings for the DirectX 12 capture interface in Looking Glass. Options include adapter/output selection, damage tracking, debugging, downsampling, HDR conversion, and RGB packing.

```ini
; Adapter to capture from
adapter=MyAdapterName

; Output to capture from
output=MyOutputName

; Enable/disable bandwidth saving by only updating changed regions
trackDamage=true

; Enable DirectX 12 debugging (requires DirectX SDK)
debug=false

; Enable/disable downsampling for bandwidth saving
downsample=true

; Convert HDR16/8bpp to HDR10/4bpp to save bandwidth
HDR16to10=true

; Losslessly pack 32-bit RGBA8 into 24-bit RGB
allowRGB24=false
```

--------------------------------

### Change KVMFR Device Ownership (Bash)

Source: https://looking-glass.io/docs/B7/_sources/ivshmem_kvmfr

Manually changes the ownership of the /dev/kvmfr0 device to a specific user and group for access. Replace 'user' with your username.

```bash
sudo chown user:kvm /dev/kvmfr0
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.