Skip to content

Commit 125d799

Browse files
committed
docs update
1 parent ee97fb3 commit 125d799

File tree

7 files changed

+113
-324
lines changed

7 files changed

+113
-324
lines changed

FAQ.md

Lines changed: 1 addition & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -2,72 +2,4 @@
22

33
---
44

5-
### > I'm seeing black only
6-
7-
Make sure you're using __Windows 10, version 2004__ (build 19041) or __Windows 11__.
8-
9-
---
10-
11-
### > Can I use it with Reshade?
12-
13-
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.
14-
15-
---
16-
17-
### > I see yellow border around captured screen/window
18-
19-
#### Windows 10
20-
21-
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:
22-
* start up your game in Windowed mode
23-
* in ShaderGlass choose Input -> Window -> choose your game's window
24-
* click onto your game window to give it focus
25-
* press Ctrl+Shift+G to make ShaderGlass fullscreen
26-
27-
#### Windows 11
28-
29-
It's possible to disable yellow border but only on Windows 11. If you are using Windows 11 and still seeing the border,
30-
open Windows Settings app and search for "screenshot borders". Make sure all the options and ShaderGlass are allowed to
31-
remove the border per below:
32-
33-
![screenshot](images/windows-settings.png)
34-
35-
---
36-
37-
### > I can't capture using OBS
38-
39-
OBS can capture ShaderGlass but only as a Game Capture source (not Window Capture nor Desktop Capture). Use "Capture specific window" within
40-
Game Capture to select ShaderGlass window only.
41-
42-
![screenshot](images/obs.png)
43-
44-
---
45-
46-
## > Text/letters are all blurry or pixelated
47-
48-
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.
49-
50-
---
51-
52-
## > Can I save a profile?
53-
54-
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.
55-
56-
---
57-
58-
## > I don't see my favourite RetroArch shader
59-
60-
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).
61-
Differences vs RA repository are tracked in [this PR](https://github.com/mausimus/slang-shaders/pull/1).
62-
63-
---
64-
65-
## > ShaderGlass can't capture some windows
66-
67-
Unfortunately some old-style rendering windows are not supported by modern Windows Capture API. Please use Desktop mode to capture those.
68-
69-
---
70-
71-
## > Can I...
72-
73-
Please read through [README](README.md) to find functionality you are looking for.
5+
FAQ is now part of the [Online Manual](https://mausimus.github.io/ShaderGlass/MANUAL.html).

Misc/MANUAL.html

Lines changed: 92 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
</head>
88
<body>
99
<div id='content'>
10-
<h2 id="shaderglass">ShaderGlass v1.1</h2>
10+
<h2 id="shaderglass">ShaderGlass v1.2</h2>
1111
<p>Overlay for running GPU shaders on top of Windows desktop</p>
1212
<p style="font-size: 12px;">
1313
Copyright (c) 2021-2025 mausimus (<a href="https://mausimus.net">mausimus.net</a>)<br />
@@ -33,15 +33,16 @@ <h3 id="features">Features</h3>
3333
</ul>
3434
<li>excellent companion for pixel art showing shaded and/or aspect-ratio corrected preview</li>
3535
<li>you can even use it on top of YouTube, Twitch or modern games</li>
36-
<li>saving and loading profiles</li>
37-
<li>import of external .slangp/.slang shaders</li>
36+
<li>allows capture from a USB source (webcam or capture card)</li>
37+
<li>saving and loading profiles and custom shaders</li>
3838
<li>high customizability with various options, operating modes and shader parameters</li>
3939
<li>can be captured by OBS (using Game Capture source)</li>
4040
</ul>
4141
<p><br /></p>
4242
<h3 id="download">Download</h3>
4343
<p>GitHub: <a href="https://github.com/mausimus/ShaderGlass">https://github.com/mausimus/ShaderGlass</a></p>
4444
<p>Itch: <a href="https://mausimus.itch.io/shaderglass">https://mausimus.itch.io/shaderglass</a></p>
45+
<p>Steam: <a href="https://store.steampowered.com/app/3613770/ShaderGlass/">https://store.steampowered.com/app/3613770/ShaderGlass/</a></p>
4546
<p><br /></p>
4647
<h3 id="requirements">Requirements</h3>
4748
<ul>
@@ -55,8 +56,12 @@ <h2 id="menu-options" style="page-break-before: always;">Menu Options</h2>
5556
<p>Currently supported options are:</p>
5657
<h4 id="processing">Processing</h4>
5758
<ul>
58-
<li><p><strong>Enable Global Hotkeys</strong> - toggle use of global hotkeys (if they conflict with another app)</p></li>
59-
<li><p><strong>Show Menu</strong> - toggle menu bar ('m')</p></li>
59+
<li><p><strong>Global Hotkeys</strong></p></li>
60+
<ul>
61+
<li><strong>Enable</strong> - toggle use of global hotkeys (if they conflict with another app)</li>
62+
<li><strong>...</strong> - set global hotkey for each of the possible actions</li>
63+
</ul>
64+
<li><p><strong>Toggle Menu</strong> - toggle menu bar ('m' or global hotkey); this will also work in fullscreen</p></li>
6065
<li><p><strong>Remember Position</strong> - remember previous window position and size on startup</p></li>
6166
<li><p><strong>GPU</strong> - shows the GPU which Windows assigned to ShaderGlass (read-only)</p></li>
6267
<li><p><strong>FPS</strong> - by default ShaderGlass runs at V-Sync, you can reduce GPU load by lowering the frame rate (for pixel art etc.)</p></li>
@@ -66,6 +71,7 @@ <h4 id="processing">Processing</h4>
6671
<li><p><strong>Use Flip Mode</strong> - uses DXGI Flip Presentation mode (as opposed to BitBlt) which is faster but a little unstable (especially on Windows 10)</p></li>
6772
<li><p><strong>Allow Tearing</strong> - removes explicit V-Sync, required for VRR to work</p></li>
6873
<li><p><strong>Max Capture Rate</strong> - remove capture frame limit of WGC, only supported since Windows 11 24H2</p></li>
74+
<li><p><strong>Use HDR</strong> - use HDR-compatible RGBAf capture and display formats (experimental)</p></li>
6975
</ul>
7076
<li><p><strong>Load/Save/Recent Profiles</strong> - you can save ShaderGlass' configuration into a profile file and load later</p></li>
7177
<li><p><strong>Set as default/Remove default</strong> - make current settings the default when starting up</p></li>
@@ -76,10 +82,10 @@ <h4 id="input">Input</h4>
7682
<ul><li><p><strong>Lock Current Area</strong> - always capture current area even if ShaderGlass window is moved</p></li></ul>
7783
<li><p><strong>Window</strong> - captures the selected window, defaults to Clone mode</p></li>
7884
<ul>
79-
<li><p><strong>Rescan</strong> - refresh the list of open windows</p></li>
8085
<li><p><strong>Crop</strong> - remove border around captured window, if your emulator has a toolbar for example</p></li>
8186
</ul>
82-
<li><p><strong>File</strong> - load a .png or .jpg file as input</p></li>
87+
<li><p><strong>Device</strong> - captures an external/USB device (webcam or capture card)</p></li>
88+
<li><p><strong>File</strong> - load a .png/.jpg/.gif file as input</p></li>
8389
<li><p><strong>Pixel Size</strong> - 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</p></li>
8490
<ul>
8591
<li>
@@ -89,10 +95,16 @@ <h4 id="input">Input</h4>
8995
</p>
9096
</li>
9197
</ul>
92-
<li><p><strong>Capture Cursor</strong> - whether to include mouse cursor in capture</p></li>
98+
<li>
99+
<div class="break"></div>
100+
<p>
101+
<strong>Capture Cursor</strong> - whether to include mouse cursor in capture; this will not work 100% of the time unfortunately, it will only hide system cursors but not custom cursors some games set;
102+
see FAQ for workarounds
103+
</p>
104+
</li>
93105
<li><p><strong>Remove Yellow Border</strong> - disables yellow frame around captured area (forced security feature); currently only supported on Windows 11</p></li>
94106
</ul>
95-
<h4 id="output" style="page-break-before: always;">Output</h4>
107+
<h4 id="output">Output</h4>
96108
<ul>
97109
<li><p><strong>Mode</strong> - overrides default mode for the input type:</p></li>
98110
<ul>
@@ -122,7 +134,7 @@ <h4 id="output" style="page-break-before: always;">Output</h4>
122134
</li>
123135
<li><p><strong>Take Snapshot</strong> - export current image in .png format</p></li>
124136
</ul>
125-
<h4 id="shader">Shader</h4>
137+
<h4 id="shader" style="page-break-before: always;">Shader</h4>
126138
<ul>
127139
<li><p><strong>Choose from Library</strong> - open Shader Browser to switch the current shader:</p></li>
128140
<ul>
@@ -137,11 +149,11 @@ <h4 id="shader">Shader</h4>
137149
<li><p><strong>Import custom</strong> - load and compile an external .slangp/.slang shader</p></li>
138150
<li><p><strong>Parameters</strong> - show and modify active shader's parameters</p></li>
139151
</ul>
140-
<p style="page-break-before: always;">&nbsp;</p>
141152
<p>
142153
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
143154
line and ShaderGlass will load it on startup.
144155
</p>
156+
<p>If you associate ShaderGlass with .sgp extension in Windows (double-click .sgp file and choose ShaderGlass) you will be able to start it up by double-clicking a profile file.</p>
145157
<p><br /></p>
146158
<h2 id="command-line">Command Line</h2>
147159
<pre><code><span>ShaderGlass.exe [-p|--paused]</span> <span>[-f|--fullscreen]</span> <span>[profile.sgp]</span>
@@ -166,6 +178,7 @@ <h2 id="tuning">Tuning</h2>
166178
try to match Input Pixel Size setting with your input's size to achieve that.
167179
</p>
168180
<p><br /></p>
181+
<div class="break"></div>
169182
<h2 id="parameters">Parameters</h2>
170183
<p>
171184
All shaders start using default Parameters as defined by their authors, but you can also tweak them using
@@ -178,7 +191,14 @@ <h2 id="emulators">Emulators</h2>
178191
ShaderGlass window will remain topmost so just position it over the
179192
game window and Alt-Tab to the game to have mouse and focus captured.
180193
</p>
181-
<h3 id="scummvm" style="page-break-before: always;">ScummVM</h3>
194+
<h3 id="dosbox">DOSBox</h3>
195+
<p>
196+
DOSBox often defaults to exclusive fullscreen - for best results, run it in Windowed or Borderless Fullscreen.
197+
</p>
198+
<p>
199+
You may also find mouse input doesn't work correctly with DOSBox. To remedy, tick Output -> Window -> Click-through in ShaderGlass.
200+
</p>
201+
<h3 id="scummvm">ScummVM</h3>
182202
<p>
183203
ScummVM doesn't capture mouse cursor by default so for best results follow below steps:
184204
<ol>
@@ -194,6 +214,7 @@ <h3 id="scummvm" style="page-break-before: always;">ScummVM</h3>
194214
and/or aspect ratio correction in ShaderGlass and enjoy the game.
195215
</p>
196216
<p><br /></p>
217+
<div class="break"></div>
197218
<h2 id="parameters">Importing Custom Shaders</h2>
198219
<p>
199220
ShaderGlass comes with a large built-in library of shaders, but you can also import custom ones
@@ -255,10 +276,42 @@ <h3 id="-textletters-are-all-blurry-or-pixelated">&gt; Text/letters are all blur
255276
<p>For maximum sharpness set Input -&gt; Pixel Size -&gt; x1 but note that a lot of shaders expect pixelated input so set this option accordingly to each scenario.</p>
256277
<h3 id="-i-dont-see-my-favourite-retroarch-shader">&gt; I don't see my favourite RetroArch shader</h3>
257278
<p>
258-
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).<br />
279+
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.
280+
Differences versus upstream RetroArch shader repository are tracked <a href="https://github.com/mausimus/slang-shaders/pull/1">in this PR</a>.
259281
</p>
260-
<h3 id="-shaderglass-cant-capture-some-windows">&gt; ShaderGlass can't capture some windows</h3>
282+
<h3 id="-shaderglass-cant-capture-some-windows" style="page-break-before: always;">&gt; ShaderGlass can't capture some windows</h3>
261283
<p>Unfortunately some old-style rendering windows are not supported by modern Windows Capture API. Please use Desktop mode to capture those.</p>
284+
<h3 id="-mouse-cursor">&gt; Mouse cursor isn't properly captured (duplicate and/or wrong image)</h3>
285+
<p>
286+
This is the case when a Windows-native game sets a custom cursor shape; ShaderGlass cannot override such cursors so they will remain visible. There are two possible workarounds:
287+
<ul>
288+
<li>
289+
Use Window Clone mode - if you have another display, run your game in a window on that display and ShaderGlass on another display.
290+
<ol>
291+
<li>
292+
Use Input -> Window with Capture Cursor enabled, and move mouse over to the game window, while watching the result in ShaderGlass window.
293+
294+
</li>
295+
</ol>
296+
<li>
297+
Use a Virtual Display - install an open-source virtual monitor driver and run the game on there; then in ShaderGlass use Display Clone mode to see the game with mouse cursor properly captured:
298+
<ol>
299+
<li>Download and install <a href="https://github.com/VirtualDrivers/Virtual-Display-Driver">Virtual Display Driver</a></li>
300+
<li>Configure the virtual display to the same resolution and refresh rate as your main display using Windows Display Settings</li>
301+
<li>Start up your game in borderless fullscreen and use Win+Shift+Arrow keys to position it on the virtual display</li>
302+
<li>Set Input -> Desktop to the virtual display in ShaderGlass</li>
303+
<li>Set Output -> Mode -> Clone in ShaderGlass</li>
304+
<li>Make sure Capture Cursor is ticked</li>
305+
<li>Go to Fullscreen in ShaderGlass (Ctrl+Shift+G)</li>
306+
<li>Move mouse over to the virtual display and play the game</li>
307+
</ol>
308+
Virtual Display Driver can also be used to capture popup windows like menus or notifications that normally ShaderGlass cannot get in front of.
309+
</li>
310+
</ul>
311+
</p>
312+
<h3 id="-mouse-cursor">&gt; A different issue...</h3>
313+
<p>
314+
Check <a href="https://github.com/mausimus/ShaderGlass/issues?q=is%3Aissue">Issues section on GitHub</a> for known problems and workarounds.
262315
<p><br /></p>
263316
<h2 id="notices">Notices</h2>
264317
<ul>
@@ -275,10 +328,23 @@ <h2 id="notices">Notices</h2>
275328
</div>
276329
<style type='text/css'>
277330

278-
@page {
279-
size: auto; /* auto is the initial value */
280-
/* this affects the margin in the printer settings */
281-
margin: 50mm 50mm 50mm 50mm;
331+
@media print {
332+
@page {
333+
size: auto; /* auto is the initial value */
334+
/* this affects the margin in the printer settings */
335+
margin: 50mm 50mm 50mm 50mm;
336+
}
337+
338+
.break {
339+
page-break-before: always;
340+
height: 20px;
341+
}
342+
}
343+
344+
@media screen {
345+
.break {
346+
display: none;
347+
}
282348
}
283349

284350
body {
@@ -292,6 +358,8 @@ <h2 id="notices">Notices</h2>
292358
font-feature-settings: "kern" 1;
293359
font-kerning: normal;
294360
padding: 30px;
361+
max-width: 960px;
362+
margin: 0 auto;
295363
}
296364

297365
@media only screen and (max-width: 600px) {
@@ -331,11 +399,11 @@ <h2 id="notices">Notices</h2>
331399
}
332400

333401
a:visited {
334-
color: #0366d6;
402+
color: #d19a66;
335403
}
336404

337405
a:hover {
338-
color: #0366d6;
406+
color: #d19a66;
339407
text-decoration: underline;
340408
}
341409

@@ -444,17 +512,16 @@ <h2 id="notices">Notices</h2>
444512
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
445513
}
446514

447-
a:visited {
448-
color: #0366d6;
449-
}
450-
451515
h1,
452516
h2,
453517
h3 {
454-
border-bottom: 1px solid #aaacaf;
455518
color: #eee;
456519
}
457520

521+
h2 {
522+
border-bottom: 1px solid #aaacaf;
523+
}
524+
458525
code > * {
459526
font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace !important;
460527
}

Misc/MANUAL.pdf

12.6 KB
Binary file not shown.

Misc/README.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
ShaderGlass v1.1.0
1+
ShaderGlass v1.2.0
22

33
ShaderGlass - overlay for running GPU shaders over Windows desktop
44
https://github.com/mausimus/ShaderGlass

0 commit comments

Comments
 (0)