Chroma:colorScroll: Difference between revisions
From GiderosMobile
m Text replacement - "</source>" to "</syntaxhighlight>" |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
'''Available since:''' Gideros 2020.7<br/> | |||
''' | '''Class:''' [[chroma]]<br/> | ||
''' | |||
=== | === Description === | ||
Scrolls the LED colours in a given direction. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
() = Chroma:colorScroll(device,dirX,dirY,flush) | () = Chroma:colorScroll(device,dirX,dirY,flush) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== | |||
'''device''': (text) | === Parameters === | ||
'''dirx''': (number) | '''device''': (text) name of the device, eg keyboard, mouse<br/> | ||
'''diry''': (number) | '''dirx''': (number) negative to rotate left, zero to ignore, positive to rotate right<br/> | ||
'''flush''': (bool) | '''diry''': (number) negative to rotate up, zero to ignore, positive to rotate down<br/> | ||
=== | '''flush''': (bool) True to send the colours to the device, default false '''optional'''<br/> | ||
=== Return values === | |||
{{Chroma}} | {{Chroma}} | ||
Latest revision as of 20:47, 6 November 2024
Available since: Gideros 2020.7
Class: chroma
Description
Scrolls the LED colours in a given direction.
() = Chroma:colorScroll(device,dirX,dirY,flush)
Parameters
device: (text) name of the device, eg keyboard, mouse
dirx: (number) negative to rotate left, zero to ignore, positive to rotate right
diry: (number) negative to rotate up, zero to ignore, positive to rotate down
flush: (bool) True to send the colours to the device, default false optional
Return values