jalr/OpenRGB
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: improve wording and clarity in mode description

Browse source
This commit is contained in:
Anshi Mehta 2025-08-16 08:20:00 +00:00 • committed by Adam Honse
parent 714736bf73
commit 0eb082f21b
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
Documentation/Common-Modes.md
View file

@ -1,8 +1,8 @@
# Common Modes in OpenRGB
OpenRGB uses modes to describe RGB effects that are built into the devices' firmware. These effects can be switched by selecting the mode within the OpenRGB interface. The patterns are not generated by OpenRGB itself but instead are generated by the RGB controller itself and run without intervention from the PC. In the interest of being able to better describe these modes, we are trying to standardize the mode names across all supported devices.
OpenRGB uses "modes" to describe RGB effects built into a device’s firmware. These effects can be changed by selecting a mode in the OpenRGB interface. The patterns are generated by the device’s RGB controller, not by OpenRGB, and run independently of the PC. In the interest of being able to better describe these modes, we are trying to standardize the mode names across all supported devices.
There are several effects that are pretty common across many brands and vendors of RGB hardware. Sometimes these manufacturers don't name the modes the same thing. For instance, a mode that fades a single color in and out could be called "Fading", but it could also be called "Breathing" or "Breath". A mode that cycles through colors could be called "Cycle", "Spectrum Cycle", "Spectrum", or even something like "Rainbow". A lot of OpenRGB's existing code simply copies the same names the official software gave to the modes, but these differences in name prevent us from being able to apply what is essentially the same effect across multiple devices when the names don't match. It also prevents us from providing descriptions of the modes using tooltips. To remedy this, we have compiled a list of common modes and providing names that we can use across all devices for any mode that implements a certain style of effect. If all devices have their fade on/fade off mode called "Breathing", we can just set "Breathing" across all devices and end up with something that looks at least sort of uniform, if not synchronized in time.
There are several effects that are pretty common across many brands and vendors of RGB hardware. Manufacturers often use different names for the same mode. For example, a fade-in/fade-out effect might be called "Fading", "Breathing", or "Breath". A color-cycling effect might appear as "Cycle", "Spectrum Cycle", "Spectrum", or "Rainbow". A lot of OpenRGB's existing code simply copies the same names the official software gave to the modes, but these differences in name prevent us from being able to apply what is essentially the same effect across multiple devices when the names don't match. It also limits our ability to provide clear descriptions of modes through tooltips. To remedy this, we have compiled a list of common modes and providing names that we can use across all devices for any mode that implements a certain style of effect. If all devices have their fade on/fade off mode called "Breathing", we can just set "Breathing" across all devices and end up with something that looks at least sort of uniform, if not synchronized in time.
# Common OpenRGB Modes