https://sourceforge.net/p/sucrose/wiki/Settings%2520Performance/Recent changes to Settings PerformanceenSat, 04 Jul 2026 04:15:45 -0000https://sourceforge.net/p/sucrose/wiki/Settings%2520Performance/<div class="markdown_content"><pre>--- v2 +++ v3 @@ -18,7 +18,7 @@ ## Where to find it -In the Portal, open **Settings** (footer gear) → **Performance** (icon `DesktopPulse16`). +In the Portal, open **Settings** (top toolbar gear) → **Performance** (icon `DesktopPulse16`).  </pre> </div>Bayram EmekliSat, 04 Jul 2026 04:15:45 -0000https://sourceforge.netd5b3eae39cfe8303f6cda13ca9cef63ca57d2b91https://sourceforge.net/p/sucrose/wiki/Settings%2520Performance/<div class="markdown_content"><pre>--- v1 +++ v2 @@ -20,7 +20,7 @@ In the Portal, open **Settings** (footer gear) → **Performance** (icon `DesktopPulse16`). -&gt; 📷 **Screenshot needed:** Portal → Settings → Performance page showing the per‑condition Close/Pause/Resume combo boxes and the threshold number boxes. + ## The PerformanceType action model </pre> </div>Bayram EmekliSat, 04 Jul 2026 04:15:44 -0000https://sourceforge.netf4c12004eac1eab6b4e85e6fcec20b9a479a97b5https://sourceforge.net/p/sucrose/wiki/Settings%2520Performance/<div class="markdown_content"><h1 id="h-settings-performance">Settings: Performance</h1> <p>The <strong>Performance</strong> settings page (<code>PerformanceSettingPage</code>) is where you decide how Sucrose should react to system conditions so your wallpaper never gets in the way of real work or drains a laptop. Every condition (the workstation locking, an app going full screen, the battery getting low, CPU/GPU/RAM/network crossing a threshold, and more) maps to one of three actions — <strong>Close</strong>, <strong>Pause</strong>, or <strong>Resume</strong>. All of these settings persist to <code>Backgroundog.json</code> and are enforced by the background monitor service, <a href="./Backgroundog-Service">Backgroundog-Service</a>, which must be enabled via the master <strong>Performance Counter</strong> switch. This page documents every control, its key, default, and range.</p> <h2 id="h-contents">Contents</h2> <ul> <li><a href="#where-to-find-it">Where to find it</a></li> <li><a href="#the-performancetype-action-model">The PerformanceType action model</a></li> <li><a href="#master-controls">Master controls</a></li> <li><a href="#system-resource-rules--thresholds">System resource rules &amp; thresholds</a></li> <li><a href="#network-rule-thresholds--units">Network rule, thresholds &amp; units</a></li> <li><a href="#operatingsystem-condition-rules">Operating‑system condition rules</a></li> <li><a href="#laptop--battery-rules">Laptop / battery rules</a></li> <li><a href="#applicationstate-rules">Application‑state rules</a></li> <li><a href="#heavy-vs-light-pause">Heavy vs Light pause</a></li> <li><a href="#notes">Notes</a></li> <li><a href="#see-also">See also</a></li> </ul> <h2 id="h-where-to-find-it">Where to find it</h2> <p>In the Portal, open <strong>Settings</strong> (footer gear) → <strong>Performance</strong> (icon <code>DesktopPulse16</code>).</p> <blockquote> <p>📷 <strong>Screenshot needed:</strong> Portal → Settings → Performance page showing the per‑condition Close/Pause/Resume combo boxes and the threshold number boxes.</p> </blockquote> <h2 id="h-the-performancetype-action-model">The PerformanceType action model</h2> <p>The recurring control on this page is a <strong><code>PerformanceType</code></strong> ComboBox with three values:</p> <table> <thead> <tr> <th>Value</th> <th>Meaning</th> </tr> </thead> <tbody> <tr> <td><code>Resume</code></td> <td>Keep the engine running (default for most conditions)</td> </tr> <tr> <td><code>Pause</code></td> <td>Pause rendering for that condition (see <a href="#heavy-vs-light-pause">Heavy vs Light pause</a>)</td> </tr> <tr> <td><code>Close</code></td> <td>Kill the live engine entirely for that condition</td> </tr> </tbody> </table> <p>When a condition's action fires, the <a href="./Backgroundog-Service">Backgroundog-Service</a> closes, pauses, or resumes the wallpaper engine accordingly. See <a href="./Performance-Rules">Performance-Rules</a> for the end‑user explanation of these rules.</p> <h2 id="h-master-controls">Master controls</h2> <table> <thead> <tr> <th>Setting</th> <th>Control</th> <th>Key</th> <th>JSON file</th> <th>Default</th> <th>Range / options</th> <th>Effect</th> </tr> </thead> <tbody> <tr> <td>Performance Counter</td> <td>ToggleSwitch</td> <td><code>PerformanceCounter</code></td> <td><code>Backgroundog.json</code></td> <td><code>true</code></td> <td>true / false</td> <td>Master switch; starts/kills the Backgroundog monitor service</td> </tr> <tr> <td>Pause performance type</td> <td>ComboBox</td> <td><code>PausePerformanceType</code></td> <td><code>Backgroundog.json</code></td> <td><code>Light</code></td> <td><code>Heavy</code>, <code>Light</code></td> <td>Whether "Pause" is a light pause or a heavy thread‑suspend</td> </tr> <tr> <td>Communication type</td> <td>ComboBox</td> <td><code>CommunicationType</code></td> <td><code>Backgroundog.json</code></td> <td><code>Transmission</code></td> <td><code>Pipe</code>, <code>Signal</code>, <code>Transmission</code></td> <td>How Backgroundog pushes live data to engines (see <a href="/p/sucrose/wiki/IPC/">IPC</a>)</td> </tr> </tbody> </table> <h2 id="h-system-resource-rules-thresholds">System resource rules &amp; thresholds</h2> <table> <thead> <tr> <th>Setting</th> <th>Control</th> <th>Key</th> <th>JSON file</th> <th>Default</th> <th>Range / options</th> <th>Effect</th> </tr> </thead> <tbody> <tr> <td>Processor performance</td> <td>ComboBox</td> <td><code>ProcessorPerformance</code></td> <td><code>Backgroundog.json</code></td> <td><code>Resume</code></td> <td>Close / Pause / Resume</td> <td>Action when CPU usage exceeds its threshold</td> </tr> <tr> <td>→ Processor usage threshold</td> <td>NumberBox</td> <td><code>ProcessorUsage</code></td> <td><code>Backgroundog.json</code></td> <td><code>70</code></td> <td>0–100 (%)</td> <td>CPU % that triggers the rule</td> </tr> <tr> <td>Graphic performance</td> <td>ComboBox</td> <td><code>GraphicPerformance</code></td> <td><code>Backgroundog.json</code></td> <td><code>Resume</code></td> <td>Close / Pause / Resume</td> <td>Action when GPU usage exceeds its threshold</td> </tr> <tr> <td>→ Graphic adapter</td> <td>ComboBox</td> <td><code>GraphicAdapter</code></td> <td><code>Backgroundog.json</code></td> <td><em>(empty = first/auto)</em></td> <td>from enumerated GPUs</td> <td>Which GPU to monitor</td> </tr> <tr> <td>→ Graphic usage threshold</td> <td>NumberBox</td> <td><code>GraphicUsage</code></td> <td><code>Backgroundog.json</code></td> <td><code>70</code></td> <td>0–100 (%)</td> <td>GPU % that triggers the rule</td> </tr> <tr> <td>Memory performance</td> <td>ComboBox</td> <td><code>MemoryPerformance</code></td> <td><code>Backgroundog.json</code></td> <td><code>Resume</code></td> <td>Close / Pause / Resume</td> <td>Action when RAM usage exceeds its threshold</td> </tr> <tr> <td>→ Memory usage threshold</td> <td>NumberBox</td> <td><code>MemoryUsage</code></td> <td><code>Backgroundog.json</code></td> <td><code>80</code></td> <td>0–100 (%)</td> <td>RAM % that triggers the rule</td> </tr> </tbody> </table> <h2 id="h-network-rule-thresholds-units">Network rule, thresholds &amp; units</h2> <table> <thead> <tr> <th>Setting</th> <th>Control</th> <th>Key</th> <th>JSON file</th> <th>Default</th> <th>Range / options</th> <th>Effect</th> </tr> </thead> <tbody> <tr> <td>Network performance</td> <td>ComboBox</td> <td><code>NetworkPerformance</code></td> <td><code>Backgroundog.json</code></td> <td><code>Resume</code></td> <td>Close / Pause / Resume</td> <td>Action when network activity exceeds the configured thresholds</td> </tr> <tr> <td>→ Network adapter</td> <td>ComboBox</td> <td><code>NetworkAdapter</code></td> <td><code>Backgroundog.json</code></td> <td><em>(empty = first/auto)</em></td> <td>from enumerated adapters</td> <td>Which NIC to monitor</td> </tr> <tr> <td>→ Upload value</td> <td>NumberBox</td> <td><code>UploadValue</code></td> <td><code>Backgroundog.json</code></td> <td><code>800</code></td> <td>0–99999999</td> <td>Upload threshold value</td> </tr> <tr> <td>→ Upload unit</td> <td>ComboBox</td> <td><code>UploadType</code></td> <td><code>Backgroundog.json</code></td> <td><code>Kilobyte</code></td> <td><code>StorageType</code> units</td> <td>Unit for the upload threshold</td> </tr> <tr> <td>→ Download value</td> <td>NumberBox</td> <td><code>DownloadValue</code></td> <td><code>Backgroundog.json</code></td> <td><code>10</code></td> <td>0–99999999</td> <td>Download threshold value</td> </tr> <tr> <td>→ Download unit</td> <td>ComboBox</td> <td><code>DownloadType</code></td> <td><code>Backgroundog.json</code></td> <td><code>Megabyte</code></td> <td><code>StorageType</code> units</td> <td>Unit for the download threshold</td> </tr> <tr> <td>→ Ping value</td> <td>NumberBox</td> <td><code>PingValue</code></td> <td><code>Backgroundog.json</code></td> <td><code>100</code></td> <td>0–1000 (ms)</td> <td>Ping threshold in milliseconds</td> </tr> <tr> <td>→ Ping host</td> <td>ComboBox</td> <td><code>PingType</code></td> <td><code>Backgroundog.json</code></td> <td><code>"Bing"</code></td> <td>from <code>Network.GetHost()</code></td> <td>Host used to measure ping</td> </tr> </tbody> </table> <h2 id="h-operatingsystem-condition-rules">Operating‑system condition rules</h2> <table> <thead> <tr> <th>Setting</th> <th>Control</th> <th>Key</th> <th>JSON file</th> <th>Default</th> <th>Effect</th> </tr> </thead> <tbody> <tr> <td>Lock (workstation locked)</td> <td>ComboBox</td> <td><code>LockPerformance</code></td> <td><code>Backgroundog.json</code></td> <td><code>Close</code></td> <td>Action when the workstation is locked</td> </tr> <tr> <td>Sleep</td> <td>ComboBox</td> <td><code>SleepPerformance</code></td> <td><code>Backgroundog.json</code></td> <td><code>Close</code></td> <td>Action when the system enters sleep</td> </tr> <tr> <td>Console (user switch)</td> <td>ComboBox</td> <td><code>ConsolePerformance</code></td> <td><code>Backgroundog.json</code></td> <td><code>Close</code></td> <td>Action on fast‑user‑switch / console disconnect</td> </tr> <tr> <td>Session (logoff)</td> <td>ComboBox</td> <td><code>SessionPerformance</code></td> <td><code>Backgroundog.json</code></td> <td><code>Close</code></td> <td>Action on session logoff</td> </tr> <tr> <td>Screen Saver</td> <td>ComboBox</td> <td><code>ScreenSaverPerformance</code></td> <td><code>Backgroundog.json</code></td> <td><code>Pause</code></td> <td>Action while the screensaver runs</td> </tr> <tr> <td>Virtual (VM)</td> <td>ComboBox</td> <td><code>VirtualPerformance</code></td> <td><code>Backgroundog.json</code></td> <td><code>Resume</code></td> <td>Action when running inside a virtual machine</td> </tr> <tr> <td>Remote (RDP)</td> <td>ComboBox</td> <td><code>RemotePerformance</code></td> <td><code>Backgroundog.json</code></td> <td><code>Resume</code></td> <td>Action during a remote‑desktop session</td> </tr> </tbody> </table> <h2 id="h-laptop-battery-rules">Laptop / battery rules</h2> <table> <thead> <tr> <th>Setting</th> <th>Control</th> <th>Key</th> <th>JSON file</th> <th>Default</th> <th>Range / options</th> <th>Effect</th> </tr> </thead> <tbody> <tr> <td>Battery</td> <td>ComboBox</td> <td><code>BatteryPerformance</code></td> <td><code>Backgroundog.json</code></td> <td><code>Resume</code></td> <td>Close / Pause / Resume</td> <td>Action when battery drops below its threshold</td> </tr> <tr> <td>→ Battery usage threshold</td> <td>NumberBox</td> <td><code>BatteryUsage</code></td> <td><code>Backgroundog.json</code></td> <td><code>50</code></td> <td>0–100 (%)</td> <td>Battery % that triggers the rule</td> </tr> <tr> <td>Battery Saver</td> <td>ComboBox</td> <td><code>BatterySaverPerformance</code></td> <td><code>Backgroundog.json</code></td> <td><code>Resume</code></td> <td>Close / Pause / Resume</td> <td>Action while Windows Battery Saver is on</td> </tr> </tbody> </table> <h2 id="h-applicationstate-rules">Application‑state rules</h2> <table> <thead> <tr> <th>Setting</th> <th>Control</th> <th>Key</th> <th>JSON file</th> <th>Default</th> <th>Effect</th> </tr> </thead> <tbody> <tr> <td>Full Screen (app maximized)</td> <td>ComboBox</td> <td><code>FullScreenPerformance</code></td> <td><code>Backgroundog.json</code></td> <td><code>Resume</code></td> <td>Action when a foreground app is full screen</td> </tr> <tr> <td>Focus (app focused)</td> <td>ComboBox</td> <td><code>FocusPerformance</code></td> <td><code>Backgroundog.json</code></td> <td><code>Resume</code></td> <td>Action when an app has focus over the desktop</td> </tr> </tbody> </table> <h2 id="h-heavy-vs-light-pause">Heavy vs Light pause</h2> <p>The <strong>Pause performance type</strong> (<code>PausePerformanceType</code>) decides what a "Pause" action actually does:</p> <ul> <li><strong><code>Light</code></strong> (default) — pauses rendering only; the engine process keeps running and resumes quickly.</li> <li><strong><code>Heavy</code></strong> — suspends the engine's threads (including any browser child processes and the Aurora‑embedded application), freeing more CPU/GPU at the cost of a slower resume.</li> </ul> <p>Choose <code>Heavy</code> if you want maximum resource recovery during conditions like full screen or lock; choose <code>Light</code> for snappier resumes.</p> <h2 id="h-notes">Notes</h2> <ul> <li>The whole page is inert unless <strong>Performance Counter</strong> is on — it is the master switch that runs the <a href="./Backgroundog-Service">Backgroundog-Service</a>. Turning it off disables all condition rules.</li> <li>The default rule set is tuned to <strong>stop wallpapers when they're not visible and you're not interacting</strong> (Lock/Sleep/Console/Session = <code>Close</code>, Screen Saver = <code>Pause</code>) while keeping them running everywhere else (<code>Resume</code>).</li> <li><strong>Communication type</strong> also controls how the engine receives the live Audio/System data feed used by reactive web wallpapers; the default is <code>Transmission</code> (TCP loopback). See <a href="/p/sucrose/wiki/IPC/">IPC</a> and <a href="./Create-Web-Architecture">Create-Web-Architecture</a>.</li> <li>Thresholds are checked against the selected adapter/GPU; leaving the adapter empty uses the first/auto‑detected device.</li> </ul> <h2 id="h-see-also">See also</h2> <ul> <li><a href="./Performance-Rules">Performance-Rules</a> — the end‑user explanation of the Close/Pause/Resume rules and defaults</li> <li><a href="./Backgroundog-Service">Backgroundog-Service</a> — the service that enforces these rules and pumps live data</li> <li><a href="/p/sucrose/wiki/IPC/">IPC</a> — Pipe / Signal / Transmission communication and the <code>CommunicationType</code> setting</li> <li><a href="./Settings-Overview">Settings-Overview</a> — how settings are stored and applied</li> <li><a href="./Settings-All-Keys">Settings-All-Keys</a> — every setting in one master table</li> </ul></div>Bayram EmekliSat, 04 Jul 2026 04:15:35 -0000https://sourceforge.netb39b82d507b28f1d7ba8dd8601b38205d9349f07