v120

Author: mausimus

FAQ.md

@@ -2,72 +2,4 @@
 
 ---
 
-### > I'm seeing black only
-
-Make sure you're using __Windows 10, version 2004__ (build 19041) or __Windows 11__.
-
----
-
-### > Can I use it with Reshade?
-
-While there is no special support for it, you can inject Reshade into ShaderGlass just like into any other DirectX 11 app and stack Reshade shaders on top.
-
----
-
-### > I see yellow border around captured screen/window
-
-#### Windows 10
-
-Unfortunately yellow border is enforced on Windows 10 and there's no way to remove it. There are some ways to avoid it, for example:
-* start up your game in Windowed mode
-* in ShaderGlass choose Input -> Window -> choose your game's window
-* click onto your game window to give it focus
-* press Ctrl+Shift+G to make ShaderGlass fullscreen
-
-#### Windows 11
-
-It's possible to disable yellow border but only on Windows 11. If you are using Windows 11 and still seeing the border,
-open Windows Settings app and search for "screenshot borders". Make sure all the options and ShaderGlass are allowed to
-remove the border per below:
-
-![screenshot](images/windows-settings.png)
-
----
-
-### > I can't capture using OBS
-
-OBS can capture ShaderGlass but only as a Game Capture source (not Window Capture nor Desktop Capture). Use "Capture specific window" within
-Game Capture to select ShaderGlass window only.
-
-![screenshot](images/obs.png)
-
----
-
-## > Text/letters are all blurry or pixelated
-
-For maximum sharpness set Input -> Pixel Size -> x1 but note that a lot of shaders expect pixelated input so set this option accordingly to each scenario.
-
----
-
-## > Can I save a profile?
-
-Yes, you can save shader profiles as files, access from Recent Profiles menu and even load them on startup via a command line parameter. See [README](README.md) for details.
-
----
-
-## > I don't see my favourite RetroArch shader
-
-ShaderGlass includes majority of RetroArch repository at time of release, but some shaders had to be excluded because of features SG doesn't yet support (for example HDR).
-Differences vs RA repository are tracked in [this PR](https://github.com/mausimus/slang-shaders/pull/1).
-
----
-
-## > ShaderGlass can't capture some windows
-
-Unfortunately some old-style rendering windows are not supported by modern Windows Capture API. Please use Desktop mode to capture those.
-
----
-
-## > Can I...
-
-Please read through [README](README.md) to find functionality you are looking for.
+FAQ is now part of the [Online Manual](https://mausimus.github.io/ShaderGlass/MANUAL.html).

Misc/MANUAL.html

@@ -1,4 +1,4 @@
-ShaderGlass v1.1.0
+ShaderGlass v1.2.0
 
 ShaderGlass - overlay for running GPU shaders over Windows desktop
 https://github.com/mausimus/ShaderGlass

Misc/MANUAL.pdf

@@ -17,43 +17,29 @@ Overlay for running GPU shaders on top of Windows desktop.
   [ScummVM](https://github.com/scummvm/scummvm), [AGS](https://github.com/adventuregamestudio/ags), [VICE](https://sf.net/projects/vice-emu), [Aseprite](https://www.aseprite.org/) etc.
 * excellent companion for pixel art showing shaded and/or aspect-ratio corrected preview
 * you can even use it on top of YouTube, Twitch or modern games
+* allows capture from a USB source (webcam or capture card)
 * saving and loading profiles
 * import of external .slangp/.slang shaders
 * high customizability with various options, operating modes and shader parameters
 * can be captured by OBS (using Game Capture source)
 
+Check out [Online Manual](https://mausimus.github.io/ShaderGlass/MANUAL.html) for details.
+
 <br/>
 
 ### Download
 
-Latest stable release (v1.1.4, 6 Jul 2025):
-* ability to import .slangp/.slang shaders on the fly
-* shader library refresh: added koko-aio and retro-crisis
-* ability to tag personal favorites
-* new frame timing mechanism for smoother capture
-* option to save window position
-* ability to crop input window (Input -> Window -> Crop)
-* 100% FPS now default (+option to remember)
-* vertical orientation option (vertical scanlines, i.e. arcade cabinet style)
-* option to save defaults
-* option to lock scale changes
-* advanced menu with DXGI settings
-* minor menu rearrangement
-* (1.1.1) fix input alignment when using multiple monitors with different DPIs
-* (1.1.2) fix mirror/repeat stages (koko-aio)
-* (1.1.4) fix high refresh capture (removes 65 fps limit)
-
-https://github.com/mausimus/ShaderGlass/releases/download/v1.1.4/ShaderGlass-1.1.4-win-x64.zip
-
-Latest beta release (v1.1.6, 2 Aug 2025):
-* (1.1.5) Device capture input (webcam/capture card)
-* (1.1.5) Hide original mouse cursor when "Capture Cursor" is enabled
-* (1.1.6) Ability to edit global hotkeys
-* (1.1.6) New hotkeys: Capture Cursor, Shader Active, Toggle Menu
-
-https://github.com/mausimus/ShaderGlass/releases/download/v1.1.6/ShaderGlass-1.1.6-beta-win-x64.zip
-
-Get it on Steam!
+Latest stable release (v1.2.0, 5 Aug 2025):
+* device capture input (webcam/capture card)
+* hide original mouse cursor when "Capture Cursor" is enabled
+* ability to edit global hotkeys + more of them
+* minor fixes
+
+https://github.com/mausimus/ShaderGlass/releases/download/v1.2.0/ShaderGlass-1.2.0-win-x64.zip
+
+<br/>
+
+### Get it on Steam!
 
 [![ShaderGlass on Steam](images/steam.png)](https://store.steampowered.com/app/3613770/ShaderGlass/)
 
@@ -70,8 +56,6 @@ Follow [ShaderGlass on itch.io](https://mausimus.itch.io/shaderglass) for latest
   * Windows 11 allows the __removal of yellow border__ (see [FAQ](FAQ.md#windows-10) for tips on avoiding it on Windows 10)
 * DirectX 11-capable GPU
 
-If the app reports missing libraries please install [Visual C++ Redistributable 2019](https://aka.ms/vs/16/release/vc_redist.x64.exe)
-
 <br/>
 
 ### Demo
@@ -135,213 +119,19 @@ with C64 monitor shader applied.
 
 <br/>
 
-### Menu Options
-
-Currently supported options are:
-
-#### Processing
-
-* __Enable Global Hotkeys__ - toggle use of global hotkeys (if they conflict with another app)
-
-* __Show Menu__ - toggle menu bar ('m')
-
-* __Remember Position__ - remember previous window position and size on startup
-
-* __GPU__ - shows the GPU which Windows assigned to ShaderGlass (read-only)
-
-* __FPS__ - by default ShaderGlass runs at V-Sync, you can reduce GPU load by lowering the frame rate (for pixel art etc.)
-
-  * __Remember FPS__ - tick so that ShaderGlass remembers and always uses current FPS setting (this overrides any preset)
-
-* __Advanced__ - extra options for lowering latency; these options require restarting ShaderGlass
-  * __Use Flip Mode__ - uses DXGI Flip Presentation mode (as opposed to BitBlt) which is faster but a little unstable (especially on Windows 10)
-  * __Allow Tearing__ - removes explicit V-Sync, required for VRR to work
-  * __Max Capture Rate__ - remove capture frame limit of WGC, only supported since Windows 11 24H2
-
-* __Load/Save/Recent Profiles__ - you can save ShaderGlass' configuration into a profile file and load later
-
-* __Set as default/Remove default__ - make current settings the default when starting up
-
-#### Input
-
-* __Desktop__ - captures the whole desktop or an individual monitor, defaults to Glass mode
-
-  * __Lock Current Area__ - always capture current area even if ShaderGlass window is moved
-
-* __Window__ - captures the selected window, defaults to Clone mode
-
-  * __Rescan__ - refresh the list of open windows
-
-  * __Crop__ - remove border around captured window, if your emulator has a toolbar for example
-
-* __File__ - load a .png or .jpg file as input
-
-* __Pixel Size__ - indicates the size of input pixels (pre-scaling), i.e. if you run a game in x3 scaling mode set this to x3 as well so that ShaderGlass can tell the original resolution
-
-  * __Adjust for DPI Scale__ - if your source always applies Windows DPI Scaling when displaying images
-(for example browsers) enable this option to take it into account; most emulators don't do this however
-
-* __Capture Cursor__ - whether to include mouse cursor in capture
-
-* __Remove Yellow Border__ - disables yellow frame around captured area (forced security feature); currently only supported on Windows 11
-
-#### Output
-
-* __Mode__ - overrides default mode for the input type:
-
-  * __Glass__ (default for Desktop) - ShaderGlass window appears transparent, you have to position it over the window or area you'd like to capture
-
-  * __Clone__ (default for Window) - ShaderGlass copies the content of capture so you can position it anywhere; this mode is also faster and more compatible
-
-* __Window__ - override mouse behavior:
-
-  * __Solid__ (default for Clone) - ShaderGlass window area is solid (traps mouse events), with the only exception of passing focus to captured window when clicked
-
-  * __Click-through__ (default for Glass) - ShaderGlass window area is transparent and clickable/scrollable-through to window(s) underneath
-
-* __Flip__ - flip output image horizontally and/or vertically
-
-* __Scale__ - apply additional scaling to the output if you'd like it to be larger; using no pre-scaling and only output scaling should result in best performance
-
-  * __Free__ - allow manual resizing of ShaderGlass window (Window Clone and File modes only)
-
-  * __Retain__ - prevent scale from resetting when switching inputs
-
-* * __Aspect Ratio Correction__ - presets for common aspect ratio correction factors (DOS, etc.), applied horizontally to preserve scanline count
-
-  * If you select _Custom_ you can enter your own correction ratio expressed as pixel height (1.0 being square pixel). For example,
-  in MS-DOS era a picture of 320x200 resolution (16:10) was displayed on a 4:3 screen meaning each pixel was 1.2x tall on screen, 1.2 = (16/10) / (4/3)
-
-* __Orientation__ - direction of shader effect, "Vertical" emulates display rotated 90 degrees, like in arcade cabinets
-
-* __Fullscreen__ (Ctrl+Shift+G) - turn ShaderGlass into a topmost fullscreen borderless window, in Glass mode you will still see yellow outline around the screen but if you can use
-Window Glass (surrounding black bars) or Window Clone (top-left aligned) with your source then you can avoid yellow edges; press Ctrl+Shift+G to revert
-
-* __Take Snapshot__ - export current image in .png format
-
-#### Shader
-
-* __Choose from Library__ - open Shader Browser to switch the current shader; Shader Library consists of:
-
-  * __Personal Favorites__ - you can mark shaders as favorites using Add/Remove Favorite buttons
-  * __Imported__ - custom .slangp/.slang shaders you imported (these are NOT persisted between restarts)
-  * __Community Favorites__ - selection of popular shaders
-  * __RetroArch Library__ - built-in shaders from libretro repository
-
-* __Next__ - switch to the next Shader
-
-* __Random__ - choose a random Shader
-
-* __Active__ - temporarily switch to 'none' Shader to see the difference (hold TAB)
-
-* __Import custom__ - load and compile an external .slangp/.slang shader
-
-* __Parameters__ - show and modify active shader's parameters
-
-You can save and load profile files which will store all the options. It's also possible to pass profile file path on the command
-line and ShaderGlass will load it on startup.
-
-<br/>
-
-### Command Line
-
-```
-ShaderGlass.exe [-p|--paused] [-f|--fullscreen] [profile.sgp]
-```
-
-You can pass profile filename as a command-line parameter to ShaderGlass.exe and it will be auto-loaded.
-If your profile file name contains spaces please put it in quotes.
-
-In addition -p will launch in paused mode, and -f will launch in fullscreen mode.
-
-<br/>
-
-### Tuning
-
-In order to achieve the best effect it's necessary to tune parameters to match your input:
-
-* if you use scaling in your input, use nearest-neighbour (i.e. no smoothing) and set _Input -> Pixel Size_ to match
-
-* moving/resizing the window slightly might also help find the best fit for downscaling pixels
-
-* use Window Clone mode if you can, it's fastest and most compatible; if you need mouse click-through use Glass mode
-
-__Always check that input is crisply pixelated using the "none" shader__ as there is often implicit
-scaling happening (for example even when Chrome displays an image at 100%, Windows DPI scaling is still applied).
-The none shader should display a pixelated image with no smoothing whatsoever,
-try to match Input Pixel Size setting with your input's size to achieve that.
-
-### Parameters
-
-All shaders start using default Parameters as defined by their authors, but you can also tweak them using
-_Shader -> Parameters_ menu option.
-
-![params](images/params.png)
-
-##### Emulators
-
-Most emulators (DOSBox, FS-UAE, Altirra etc.) will capture mouse by default so you can use them in Window Clone mode.
-ShaderGlass window will remain topmost so just position it over the
-game window and Alt-Tab to the game to have mouse and focus captured.
-
-##### ScummVM
-
-ScummVM doesn't capture mouse cursor by default so for best results follow below steps:
-1) Use Window Clone mode, set Input/Output/Shader options to your liking
-2) Switch Output Window to Click-through
-3) Click or Alt-Tab to ScummVM game window so that it has focus
-4) Press Ctrl-M which will force ScummVM to capture mouse
-
-This way you should have the mouse captured by ScummVM so that it remains within
-the game window until you press Ctrl-M again. You can apply output scaling
-and/or aspect ratio correction in ShaderGlass and enjoy the game.
-
-<br/>
-
-### Importing Custom Shaders
-
-ShaderGlass comes with a large built-in library of shaders, but you can also import custom ones
-written in [RetroArch shader system](https://github.com/libretro/slang-shaders/blob/master/README.md).
-It accepts both individual shaders (_.slang_) and multi-pass presets (_.slangp_).
-
-When working on a custom shader, you can use _Recent imports_ menu to quickly reload it.
-
-#### RetroArch shader/preset packs
-
-A lot of preset packs out there rely on base RetroArch shaders so to import them into ShaderGlass
-install them into RetroArch first, and then Import from RetroArch's shaders directory.
-
-Please note some shaders might require Vulkan (ShaderGlass is DirectX 11 only) or rely on RetroArch
-features that ShaderGlass doesn't support so might not work just as well.
-
-#### Writing your own shaders
-
-ShaderGlass lets you easily experiment with your own shaders! [CustomShader.slang](Misc/CustomShader.slang) is a minimal example
-of a shader that swaps color channels and applies a boost, meant as an example from which you could
-start writing your own shaders and have them applied to your desktop. Check out
-[RetroArch shader repository](https://github.com/libretro/slang-shaders) for tons of examples.
-
-#### Modifying RetroArch shaders
-
-To modify shaders from RetroArch library, download their source code
-[from here](https://github.com/mausimus/slang-shaders/archive/refs/heads/shaderglass.zip),
-make changes and import.
-
-<br/>
-
-### Frequently Asked Questions
+### Instructions & Manual
 
-See FAQ [here](FAQ.md).
+See [Online Manual](https://mausimus.github.io/ShaderGlass/MANUAL.html) for option explanations and Frequently Asked Questions.
 
 <br/>
 
 ### Code
 
 Built using Visual Studio 2022 using ISO C++ 20, Windows SDK 10.0.26100, Windows Capture API and DirectX 11.
 
-ShaderGlass includes a limited implementation of RetroArch shader back-end.
+ShaderGlass includes a limited implementation of RetroArch shader back-end using DirectX 11.
 [ShaderGen](ShaderGen) is a command-line tool for converting Slang shaders 
-into .h files which can be merged into ShaderGlass. The conversion process requires:
+into .h files which can be precompiled in ShaderGlass. The conversion process relies on:
 1. [glslang](https://github.com/KhronosGroup/glslang) for converting Slang/GLSL shaders to SPIR-V
 2. [SPIR-V cross-compiler](https://github.com/KhronosGroup/SPIRV-Cross) for converting those to HLSL (DX11 format)
 3. [Direct3D Shader Compiler (fxc.exe)](https://developer.microsoft.com/en-us/windows/downloads/windows-10-sdk/) for pre-compiling into bytecode

Misc/README.txt

@@ -471,10 +471,6 @@ void ShaderWindow::StartImage(bool autoScale, int pixelSize)
     EnableMenuItem(m_outputScaleMenu, IDM_OUTPUT_FREESCALE, MF_BYCOMMAND | MF_ENABLED);
 
     // if we are *switching* to file mode, default pixel size and freescale
-    if(pixelSize)
-    {
-        SendMessage(m_mainWindow, WM_COMMAND, pixelSize, 0);
-    }
     if(autoScale && !ScaleLocked())
     {
         // set starting scale to fit within current window size
@@ -489,6 +485,10 @@ void ShaderWindow::StartImage(bool autoScale, int pixelSize)
         m_captureOptions.outputScale = (float)defaultScale;
         SetFreeScale();
     }
+    if(pixelSize)
+    {
+        SendMessage(m_mainWindow, WM_COMMAND, pixelSize, 0);
+    }
 
     if(!HasCaptureAPI() && !m_captureManager.IsActive())
     {
@@ -1765,7 +1765,7 @@ LRESULT CALLBACK ShaderWindow::WndProc(HWND hWnd, UINT message, WPARAM wParam, L
 #endif
             break;
         case ID_HELP_README:
-            ShellExecute(0, 0, L"https://github.com/mausimus/ShaderGlass/blob/master/README.md", 0, 0, SW_SHOW);
+            ShellExecute(0, 0, L"https://mausimus.github.io/ShaderGlass/MANUAL.html", 0, 0, SW_SHOW);
             break;
         case ID_HELP_FREQUENTLYASKEDQUESTIONS:
             ShellExecute(0, 0, L"https://github.com/mausimus/ShaderGlass/blob/master/FAQ.md", 0, 0, SW_SHOW);