-
-
Notifications
You must be signed in to change notification settings - Fork 60
Settings Performance
The Performance settings page (PerformanceSettingPage) 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 — Close, Pause, or Resume. All of these settings persist to Backgroundog.json and are enforced by the background monitor service, Backgroundog-Service, which must be enabled via the master Performance Counter switch. This page documents every control, its key, default, and range.
- Where to find it
- The PerformanceType action model
- Master controls
- System resource rules & thresholds
- Network rule, thresholds & units
- Operating‑system condition rules
- Laptop / battery rules
- Application‑state rules
- Heavy vs Light pause
- Notes
- See also
In the Portal, open Settings (footer gear) → Performance (icon DesktopPulse16).
📷 Screenshot needed: Portal → Settings → Performance page showing the per‑condition Close/Pause/Resume combo boxes and the threshold number boxes.
The recurring control on this page is a PerformanceType ComboBox with three values:
| Value | Meaning |
|---|---|
Resume |
Keep the engine running (default for most conditions) |
Pause |
Pause rendering for that condition (see Heavy vs Light pause) |
Close |
Kill the live engine entirely for that condition |
When a condition's action fires, the Backgroundog-Service closes, pauses, or resumes the wallpaper engine accordingly. See Performance-Rules for the end‑user explanation of these rules.
| Setting | Control | Key | JSON file | Default | Range / options | Effect |
|---|---|---|---|---|---|---|
| Performance Counter | ToggleSwitch | PerformanceCounter |
Backgroundog.json |
true |
true / false | Master switch; starts/kills the Backgroundog monitor service |
| Pause performance type | ComboBox | PausePerformanceType |
Backgroundog.json |
Light |
Heavy, Light
|
Whether "Pause" is a light pause or a heavy thread‑suspend |
| Communication type | ComboBox | CommunicationType |
Backgroundog.json |
Transmission |
Pipe, Signal, Transmission
|
How Backgroundog pushes live data to engines (see IPC) |
| Setting | Control | Key | JSON file | Default | Range / options | Effect |
|---|---|---|---|---|---|---|
| Processor performance | ComboBox | ProcessorPerformance |
Backgroundog.json |
Resume |
Close / Pause / Resume | Action when CPU usage exceeds its threshold |
| → Processor usage threshold | NumberBox | ProcessorUsage |
Backgroundog.json |
70 |
0–100 (%) | CPU % that triggers the rule |
| Graphic performance | ComboBox | GraphicPerformance |
Backgroundog.json |
Resume |
Close / Pause / Resume | Action when GPU usage exceeds its threshold |
| → Graphic adapter | ComboBox | GraphicAdapter |
Backgroundog.json |
(empty = first/auto) | from enumerated GPUs | Which GPU to monitor |
| → Graphic usage threshold | NumberBox | GraphicUsage |
Backgroundog.json |
70 |
0–100 (%) | GPU % that triggers the rule |
| Memory performance | ComboBox | MemoryPerformance |
Backgroundog.json |
Resume |
Close / Pause / Resume | Action when RAM usage exceeds its threshold |
| → Memory usage threshold | NumberBox | MemoryUsage |
Backgroundog.json |
80 |
0–100 (%) | RAM % that triggers the rule |
| Setting | Control | Key | JSON file | Default | Range / options | Effect |
|---|---|---|---|---|---|---|
| Network performance | ComboBox | NetworkPerformance |
Backgroundog.json |
Resume |
Close / Pause / Resume | Action when network activity exceeds the configured thresholds |
| → Network adapter | ComboBox | NetworkAdapter |
Backgroundog.json |
(empty = first/auto) | from enumerated adapters | Which NIC to monitor |
| → Upload value | NumberBox | UploadValue |
Backgroundog.json |
800 |
0–99999999 | Upload threshold value |
| → Upload unit | ComboBox | UploadType |
Backgroundog.json |
Kilobyte |
StorageType units |
Unit for the upload threshold |
| → Download value | NumberBox | DownloadValue |
Backgroundog.json |
10 |
0–99999999 | Download threshold value |
| → Download unit | ComboBox | DownloadType |
Backgroundog.json |
Megabyte |
StorageType units |
Unit for the download threshold |
| → Ping value | NumberBox | PingValue |
Backgroundog.json |
100 |
0–1000 (ms) | Ping threshold in milliseconds |
| → Ping host | ComboBox | PingType |
Backgroundog.json |
"Bing" |
from Network.GetHost()
|
Host used to measure ping |
| Setting | Control | Key | JSON file | Default | Effect |
|---|---|---|---|---|---|
| Lock (workstation locked) | ComboBox | LockPerformance |
Backgroundog.json |
Close |
Action when the workstation is locked |
| Sleep | ComboBox | SleepPerformance |
Backgroundog.json |
Close |
Action when the system enters sleep |
| Console (user switch) | ComboBox | ConsolePerformance |
Backgroundog.json |
Close |
Action on fast‑user‑switch / console disconnect |
| Session (logoff) | ComboBox | SessionPerformance |
Backgroundog.json |
Close |
Action on session logoff |
| Screen Saver | ComboBox | ScreenSaverPerformance |
Backgroundog.json |
Pause |
Action while the screensaver runs |
| Virtual (VM) | ComboBox | VirtualPerformance |
Backgroundog.json |
Resume |
Action when running inside a virtual machine |
| Remote (RDP) | ComboBox | RemotePerformance |
Backgroundog.json |
Resume |
Action during a remote‑desktop session |
| Setting | Control | Key | JSON file | Default | Range / options | Effect |
|---|---|---|---|---|---|---|
| Battery | ComboBox | BatteryPerformance |
Backgroundog.json |
Resume |
Close / Pause / Resume | Action when battery drops below its threshold |
| → Battery usage threshold | NumberBox | BatteryUsage |
Backgroundog.json |
50 |
0–100 (%) | Battery % that triggers the rule |
| Battery Saver | ComboBox | BatterySaverPerformance |
Backgroundog.json |
Resume |
Close / Pause / Resume | Action while Windows Battery Saver is on |
| Setting | Control | Key | JSON file | Default | Effect |
|---|---|---|---|---|---|
| Full Screen (app maximized) | ComboBox | FullScreenPerformance |
Backgroundog.json |
Resume |
Action when a foreground app is full screen |
| Focus (app focused) | ComboBox | FocusPerformance |
Backgroundog.json |
Resume |
Action when an app has focus over the desktop |
The Pause performance type (PausePerformanceType) decides what a "Pause" action actually does:
-
Light(default) — pauses rendering only; the engine process keeps running and resumes quickly. -
Heavy— 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.
Choose Heavy if you want maximum resource recovery during conditions like full screen or lock; choose Light for snappier resumes.
- The whole page is inert unless Performance Counter is on — it is the master switch that runs the Backgroundog-Service. Turning it off disables all condition rules.
- The default rule set is tuned to stop wallpapers when they're not visible and you're not interacting (Lock/Sleep/Console/Session =
Close, Screen Saver =Pause) while keeping them running everywhere else (Resume). -
Communication type also controls how the engine receives the live Audio/System data feed used by reactive web wallpapers; the default is
Transmission(TCP loopback). See IPC and Create-Web-Architecture. - Thresholds are checked against the selected adapter/GPU; leaving the adapter empty uses the first/auto‑detected device.
- Performance-Rules — the end‑user explanation of the Close/Pause/Resume rules and defaults
- Backgroundog-Service — the service that enforces these rules and pumps live data
-
IPC — Pipe / Signal / Transmission communication and the
CommunicationTypesetting - Settings-Overview — how settings are stored and applied
- Settings-All-Keys — every setting in one master table
Getting Started
- Installation
- System Requirements
- Quick Start
- Portal Interface Tour
- Updating Sucrose
- Uninstalling Sucrose
Wallpaper Types
Using Sucrose
- Managing Library
- Using Store
- Customizing Wallpaper
- Multi-Monitor
- Wallpaper Cycling
- Choosing Engines
- Performance Rules
- Theme, Tray & Startup
- Discord Rich Presence
Settings Reference
- Settings Overview
- Settings: General
- Settings: Personal
- Settings: Performance
- Settings: Wallpaper
- Settings: System
- Settings: Other
- Settings: All Keys
Creating Wallpapers
- Create Overview
- Create: Step By Step
- Create: Package Format
- Create: Customization Controls
- Create: JS Bridge
- Create: Audio API
- Create: System API
- Create: Property Listener & Filters
- Create: Web Architecture
- Create: Compatibility
- Create: Example Wallpapers
- Create: Sharing & Publishing
Engine Reference
- Engines Overview
- Engine: MpvPlayer
- Engine: VlcPlayer
- Engine: WebView
- Engine: CefSharp
- Engine: Nebula
- Engine: Vexana
- Engine: Xavier
- Engine: Aurora
- Engine Comparison
Automation & Command Line
Architecture & Internals
- Architecture Overview
- Lifecycle
- Commandog Dispatcher
- Single-Instance Mutexes
- IPC
- Backgroundog Service
- Crash Reporting
- Update Internals
- Property Service
- Undo Internals
Data, Files & Diagnostics
Building & Contributing
- Building From Source
- Repository Layout
- Shared Item Projects
- Code Conventions
- Preprocessor Symbols
- Publish Pipeline
- Bundle Installer Internals
- Extending Sucrose
- Contributing
- Translating with Localizer
- Localization Coverage
- Security Policy
- Privacy & Telemetry
Help & Support