db&w documentation wiki

finest software | finest docs

User Tools

Site Tools


switcheroo

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
switcheroo [2026/11/19 13:12] – lightwolfswitcheroo [2026/11/19 13:29] (current) – lightwolf
Line 9: Line 9:
 ## Requirements ## Requirements
  
-- Windows 10 or later (64-bit) +  * Windows 10 or later (64-bit) 
-- One or more displays attached to the computer+  * One or more displays attached to the computer
  
 switcheRoo uses the standard Windows display APIs, so anything Windows can switcheRoo uses the standard Windows display APIs, so anything Windows can
Line 17: Line 17:
 ## Installing ## Installing
  
-1. Run `xRoo_Installer.exe`. +  - Run `xRoo_Installer.exe`. 
-2. Accept the license agreement, choose a folder (default `C:\Program Files\xRoo`) +  - Accept the license agreement, choose a folder (default `C:\Program Files\xRoo`) and finish the wizard. The **Add to PATH** component is optional; select it to run `xRoo.exe` from any command prompt without typing the full path. 
-   and finish the wizard. The **Add to PATH** component is optional; select it to +  - The installer creates a desktop shortcut, an **xRoo** folder in the Start menu, and copies `license.txt` into the installation folder.
-   run `xRoo.exe` from any command prompt without typing the full path. +
-3. The installer creates a desktop shortcut, an **xRoo** folder in the Start menu, +
-   and copies `license.txt` into the installation folder.+
  
 Administrator rights are required because the program is installed for all users Administrator rights are required because the program is installed for all users
Line 33: Line 30:
 (the "system tray") near the clock. (the "system tray") near the clock.
  
-- Only one copy runs at a time. Starting it again shows +  - Only one copy runs at a time. Starting it again shows *"xRoo is already running in the system tray."* 
-  *"xRoo is already running in the system tray."* +  - Hover the tray icon to see a summary of every display: number, monitor name,`(primary)` marker and current resolution with refresh rate. 
-- Hover the tray icon to see a summary of every display: number, monitor name, +  - The icon may be hidden in the overflow area (the `^` arrow next to the clock); drag it onto the taskbar to keep it visible.
-  `(primary)` marker and current resolution with refresh rate. +
-- The icon may be hidden in the overflow area (the `^` arrow next to the clock); +
-  drag it onto the taskbar to keep it visible.+
  
 Closing the menu does not exit the program — use **Exit** in the menu. Closing the menu does not exit the program — use **Exit** in the menu.
  
 ## The tray menu ## The tray menu
 +
 +{{ ::01-main-menu.png?nolink&400|}}
  
 **Left-click or right-click the tray icon** to open the menu. **Left-click or right-click the tray icon** to open the menu.
- 
-``` 
-Refresh Displays 
-Identify Displays 
-──────────────────────────────────── 
- GIGABYTE M32U                  ▸ 
- DELL U2415                     ▸ 
-──────────────────────────────────── 
-Screens                         ▸ 
-Presets                         ▸ 
-──────────────────────────────────── 
-Show all modes 
-Start with Windows 
-About xRoo... 
-Exit 
-``` 
  
 The top section lists the displays that are currently part of the Windows desktop, The top section lists the displays that are currently part of the Windows desktop,
Line 70: Line 50:
 Menu conventions: Menu conventions:
  
-- **Bold** = the entry is currently in effect (current resolution, matching +  * **Bold** = the entry is currently in effect (current resolution, matching preset). 
-  preset). +  * **Checkmark** = the exact item or option is active (current refresh rate, current rotation, a display that is switched on, an enabled option). 
-- **Checkmark** = the exact item or option is active (current refresh rate, +  * An arrow `▸` means the entry opens a submenu.
-  current rotation, a display that is switched on, an enabled option). +
-- An arrow `▸` means the entry opens a submenu.+
  
 ## Display settings ## Display settings
Line 92: Line 70:
 ### Resolutions ### Resolutions
  
-- The list is sorted by size, largest first. +  * The list is sorted by size, largest first. 
-- The current resolution is shown in **bold**. +  * The current resolution is shown in **bold**. 
-- If a resolution supports more than one refresh rate, it opens a submenu; +  * If a resolution supports more than one refresh rate, it opens a submenu;  the active rate carries a checkmark. 
-  the active rate carries a checkmark. +  * If it supports only one rate, the menu shows it directly (`1920x1080 @ 60 Hz`). 
-- If it supports only one rate, the menu shows it directly +  * Clicking a resolution or refresh rate applies it immediately. Windows stores the new mode, so it is still in effect after a reboot.
-  (`1920x1080 @ 60 Hz`). +
-- Clicking a resolution or refresh rate applies it immediately. Windows stores +
-  the new mode, so it is still in effect after a reboot.+
  
 ### Display on / off ### Display on / off
  
-- The first entry reads **Display on** with a checkmark while the display is +  * The first entry reads **Display on** with a checkmark while the display is active, and **Display off** when it is switched off. 
-  active, and **Display off** when it is switched off. +  * Clicking it toggles the display. switcheRoo waits briefly for the layout change to take effect; if Windows or the driver refuses it, the display stays as it was. 
-- Clicking it toggles the display. switcheRoo waits briefly for the layout change +  * switcheRoo refuses to switch off the last active display, so you cannot end up with a blank screen and no way to recover. 
-  to take effect; if Windows or the driver refuses it, the display stays as it +  * Turning a display off is a temporary layout change: it is **not** written to the saved Windows layout. After a reboot, `Win+P`, or reconnecting the monitor, every display comes back. This is deliberate and is the easiest way to recover a display you switched off by accident. 
-  was. +  * Depending on the graphics driver, a display may disappear from the list while it is switched off. Bring it back with **Screens › Extend all displays**, with `Win+P`, or by rebooting.
-- switcheRoo refuses to switch off the last active display, so you cannot end up +
-  with a blank screen and no way to recover. +
-- Turning a display off is a temporary layout change: it is **not** written to +
-  the saved Windows layout. After a reboot, `Win+P`, or reconnecting the monitor, +
-  every display comes back. This is deliberate and is the easiest way to recover +
-  a display you switched off by accident. +
-- Depending on the graphics driver, a display may disappear from the list while +
-  it is switched off. Bring it back with **Screens › Extend all displays**, with +
-  `Win+P`, or by rebooting.+
  
 ### Rotation ### Rotation
 +
 +{{ ::03-rotation.png?nolink&400|}}
  
 **Rotation** offers: **Rotation** offers:
Line 138: Line 106:
 **Screens** controls which displays are active at all: **Screens** controls which displays are active at all:
  
-- **Extend all displays** — switch every connected display back on, using the +  *  **Extend all displays** — switch every connected display back on, using the last full extended layout that Windows has stored. This is the quickest way to undo one or more "display off" changes. 
-  last full extended layout that Windows has stored. This is the quickest way to +  * **Each display by name** — keep only that display and switch all others off.The display is switched on first if necessary. The active display has acheckmark.
-  undo one or more "display off" changes. +
-- **Each display by name** — keep only that display and switch all others off. +
-  The display is switched on first if necessary. The active display has a +
-  checkmark.+
  
 Examples: Examples:
  
-- Presenting on a projector: **Screens › Projector**, then **Screens › Extend all +  * Presenting on a projector: **Screens › Projector**, then **Screens › Extend all displays** when you are done. 
-  displays** when you are done. +  * Working on a laptop screen only: **Screens › Laptop**.
-- Working on a laptop screen only: **Screens › Laptop**.+
  
 ## Presets ## Presets
 +
 +{{ ::06-presets.png?nolink&400|}}
  
 A preset is a named snapshot of the resolution and refresh rate of every display A preset is a named snapshot of the resolution and refresh rate of every display
Line 158: Line 123:
 ### Saving a preset ### Saving a preset
  
-1. Set up all displays the way you want them. +  - Set up all displays the way you want them. 
-2. **Presets › Save current setup as preset...** +  - **Presets › Save current setup as preset...** 
-3. Enter a name in the dialog and confirm with **OK**.+  - Enter a name in the dialog and confirm with **OK**.
  
 The dialog proposes `New preset`; if that name is already used, a number is The dialog proposes `New preset`; if that name is already used, a number is
Line 175: Line 140:
 When applying, switcheRoo: When applying, switcheRoo:
  
-- skips displays that are already in the target mode, +  * skips displays that are already in the target mode, 
-- switches on a display of the preset that is currently off, if Windows still +  * switches on a display of the preset that is currently off, if Windows still knows a mode for it, 
-  knows a mode for it, +  * uses the closest available refresh rate if the exact rate is no longer offered by the monitor, 
-- uses the closest available refresh rate if the exact rate is no longer offered +  * shows a warning box listing any display that could not be set (for example "no mode 2560x1440" after a monitor was replaced).
-  by the monitor, +
-- shows a warning box listing any display that could not be set (for example +
-  "no mode 2560x1440" after a monitor was replaced).+
  
 The whole preset is applied immediately; there is no confirmation prompt. The whole preset is applied immediately; there is no confirmation prompt.
Line 187: Line 149:
 ### Renaming and deleting ### Renaming and deleting
  
-- **Presets › Rename preset ›** *name* — opens the same naming dialog, prefilled +  * **Presets › Rename preset ›** *name* — opens the same naming dialog, prefilled with the current name. Renaming to an existing name adds a number instead of creating a duplicate. 
-  with the current name. Renaming to an existing name adds a number instead of +  * **Presets › Delete preset ›** *name* — asks for confirmation (the default button is **No**) and then removes the preset permanently.
-  creating a duplicate. +
-- **Presets › Delete preset ›** *name* — asks for confirmation (the default +
-  button is **No**) and then removes the preset permanently.+
  
 ### What a preset contains ### What a preset contains
Line 212: Line 171:
 | `Ctrl+Alt+1` … `Ctrl+Alt+9` | Apply the 1st … 9th preset | | `Ctrl+Alt+1` … `Ctrl+Alt+9` | Apply the 1st … 9th preset |
  
-- Hotkeys work while switcheRoo is running, from any application. +  * Hotkeys work while switcheRoo is running, from any application. 
-- The hint `Hotkeys: Ctrl+Alt+1..9` is shown inside the Presets menu once at +  * The hint `Hotkeys: Ctrl+Alt+1..9` is shown inside the Presets menu once at  least one preset exists. 
-  least one preset exists. +  * If another program already owns one of these combinations, that hotkey simply  does nothing for switcheRoo. Pick another key combination in the other program  if this happens. 
-- If another program already owns one of these combinations, that hotkey simply +  * Presets beyond the ninth are still available from the menu.
-  does nothing for switcheRoo. Pick another key combination in the other program +
-  if this happens. +
-- Presets beyond the ninth are still available from the menu.+
  
 ## Show all modes ## Show all modes
Line 225: Line 181:
 switcheRoo hides small modes by default: switcheRoo hides small modes by default:
  
-- a mode is hidden when it is smaller than 1280×960 (both dimensions below the +  * a mode is hidden when it is smaller than 1280×960 (both dimensions below the  threshold), 
-  threshold), +  * the current mode is always shown, whatever its size.
-- the current mode is always shown, whatever its size.+
  
 Enable **Show all modes** to list every mode the monitor reports. The entry Enable **Show all modes** to list every mode the monitor reports. The entry
Line 244: Line 199:
 ## Identify and refresh ## Identify and refresh
  
-- **Identify Displays** overlays a large number on every active monitor for about +  * **Identify Displays** overlays a large number on every active monitor for about three seconds. Use it to find out which physical screen belongs to which menu entry. 
-  three seconds. Use it to find out which physical screen belongs to which menu +  * **Refresh Displays** re-reads the display list. The list is also refreshed automatically whenever Windows reports a display change (plugging a monitor, `Win+P`, a driver change, …).
-  entry. +
-- **Refresh Displays** re-reads the display list. The list is also refreshed +
-  automatically whenever Windows reports a display change (plugging a monitor, +
-  `Win+P`, a driver change, …).+
  
 ## About and Exit ## About and Exit
  
-- **About xRoo...** shows the application name, version (for example +  * **About xRoo...** shows the application name, version (for example `Version 2.0.0.0`), build date, copyright line and a link to the switcheRoo  website, <https://switcheroo.db-w.com>. Please quote the version and build date when reporting a problem. 
-  `Version 2.0.0.0`), build date, copyright line and a link to the switcheRoo +  * **Exit** closes switcheRoo and removes the tray icon. Display settings and presets stay as they are. If **Start with Windows** is enabled, switcheRoo is back after the next sign-in.
-  website, <https://switcheroo.db-w.com>. Please quote the version and build date +
-  when reporting a problem. +
-- **Exit** closes switcheRoo and removes the tray icon. Display settings and +
-  presets stay as they are. If **Start with Windows** is enabled, switcheRoo is +
-  back after the next sign-in.+
  
 ## Keyboard and mouse ## Keyboard and mouse
Line 276: Line 222:
 With the mouse: With the mouse:
  
-- hovering an entry opens its submenu after the usual system menu delay, +  * hovering an entry opens its submenu after the usual system menu delay, 
-- clicking an entry with a submenu opens it, and clicking the same entry again +  * clicking an entry with a submenu opens it, and clicking the same entry again closes it, 
-  closes it, +  * clicking a normal entry applies it and closes the menu, 
-- clicking a normal entry applies it and closes the menu, +  * clicking outside the menu closes it.
-- clicking outside the menu closes it.+
  
 The menu follows the Windows light/dark theme and is scaled for the monitor it The menu follows the Windows light/dark theme and is scaled for the monitor it
Line 323: Line 268:
 One of: One of:
  
-- the 1-based number from the tray menu or `--list-displays` (`1`, `2`, …), +  * the 1-based number from the tray menu or `--list-displays` (`1`, `2`, …), 
-- the monitor name exactly as listed, in quotes if it contains spaces +  * the monitor name exactly as listed, in quotes if it contains spaces (`"GIGABYTE M32U"`), 
-  (`"GIGABYTE M32U"`), +  * the Windows device name (`\\.\DISPLAY1`).
-- the Windows device name (`\\.\DISPLAY1`).+
  
 ### `<mode>` ### `<mode>`
  
-- `<width>x<height>`, optionally with `@<refresh rate>`: +  * `<width>x<height>`, optionally with `@<refresh rate>`: `1920x1080`, `1920x1080@144`. 
-  `1920x1080`, `1920x1080@144`. +  * Without a refresh rate, the current rate is kept when possible; otherwise the closest supported rate is used. 
-- Without a refresh rate, the current rate is kept when possible; otherwise the +  * `on` or `off` switches the display on or off instead of setting a mode.
-  closest supported rate is used. +
-- `on` or `off` switches the display on or off instead of setting a mode.+
  
 `--topology` accepts `extend` or `only-<N>` where `<N>` is a display number `--topology` accepts `extend` or `only-<N>` where `<N>` is a display number
Line 342: Line 284:
 ### Output and exit codes ### Output and exit codes
  
-- Started from a console, the output appears in that console. +  * Started from a console, the output appears in that console. 
-- When the output is redirected, plain text is written instead, so +  * When the output is redirected, plain text is written instead, so `xRoo.exe --list-displays > displays.txt` works. 
-  `xRoo.exe --list-displays > displays.txt` works. +  * Started without a console (for example from the Run dialog), results are shown in message boxes.
-- Started without a console (for example from the Run dialog), results are shown +
-  in message boxes.+
  
 | Exit code | Meaning | | Exit code | Meaning |
Line 390: Line 330:
 Deleting a file resets the corresponding settings: Deleting a file resets the corresponding settings:
  
-- delete `presets.json` to start with no presets (back it up first — this cannot +  * delete `presets.json` to start with no presets (back it up first — this cannot be undone), 
-  be undone), +  * delete `config.json` to return the menu options to their defaults.
-- delete `config.json` to return the menu options to their defaults.+
  
 ## Good to know ## Good to know
  
-- **Display off is temporary.** Windows' saved layout is untouched, so a reboot +  * **Display off is temporary.** Windows' saved layout is untouched, so a reboot or `Win+P` brings every display back. Only resolutions, refresh rates and rotation are stored permanently by Windows. 
-  or `Win+P` brings every display back. Only resolutions, refresh rates and +  * **No display can switch itself off alone.** switcheRoo blocks switching off the last active display; the menu entry does nothing in that case. 
-  rotation are stored permanently by Windows. +  * **Mode changes are checked.** If Windows or the driver rejects a resolution or refresh rate, an error box shows the Windows error code. Layout changes (switching displays on/off) are verified after they are applied; if they cannot  be made, the previous layout is left in place. 
-- **No display can switch itself off alone.** switcheRoo blocks switching off the +  * **Presets are matched by monitor, not by display number.** Each entry stores the monitor's EDID device path (with the monitor name as fallback), so a preset still finds its display after a reboot or after displays are reordered. A monitor replaced by a different model will not match. 
-  last active display; the menu entry does nothing in that case. +  * **Displays that are off at save time are skipped**, because Windows reports no mode for them. Switch them on first if they belong in the preset. 
-- **Mode changes are checked.** If Windows or the driver rejects a resolution or +  * **HDR / advanced colour is not managed** by switcheRoo. 
-  refresh rate, an error box shows the Windows error code. Layout changes +  * **Single instance.** Only one tray copy runs; command-line calls are separate short-lived processes and always work.
-  (switching displays on/off) are verified after they are applied; if they cannot +
-  be made, the previous layout is left in place. +
-- **Presets are matched by monitor, not by display number.** Each entry stores +
-  the monitor's EDID device path (with the monitor name as fallback), so a preset +
-  still finds its display after a reboot or after displays are reordered. A +
-  monitor replaced by a different model will not match. +
-- **Displays that are off at save time are skipped**, because Windows reports no +
-  mode for them. Switch them on first if they belong in the preset. +
-- **HDR / advanced colour is not managed** by switcheRoo. +
-- **Single instance.** Only one tray copy runs; command-line calls are separate +
-  short-lived processes and always work.+
  
 ## Troubleshooting ## Troubleshooting
Line 433: Line 361:
 ## Uninstalling ## Uninstalling
  
-1. Open the Start menu, folder **xRoo**, and run **Uninstall** +  - Open the Start menu, folder **xRoo**, and run **Uninstall** (or use *Settings › Apps › Installed apps* if the entry is listed there). 
-   (or use *Settings › Apps › Installed apps* if the entry is listed there). +  - Confirm the removal.
-2. Confirm the removal.+
  
 The uninstaller removes the program, its shortcuts, the uninstall registry key and The uninstaller removes the program, its shortcuts, the uninstall registry key and
switcheroo.1795090353.txt.gz · Last modified: by lightwolf