Difference between revisions of "Chroma:clear"

From GiderosMobile
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
<languages />
+
'''Available since:''' Gideros 2020.7<br/>
'''<translate>Available since</translate>:''' Gideros 2020.7<br/>
+
'''Class:''' [[chroma]]<br/>
'''<translate>Class</translate>:''' [[Special:MyLanguage/chroma|chroma]]<br/>
+
 
=== <translate>Description</translate> ===
+
=== Description ===
<translate>Basically sets all the LED colours on the device to a specific colour.</translate>
+
Basically sets all the LED colours on the device to a specific colour.
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
(number) = Chroma:clear(device,color,flush)
 
(number) = Chroma:clear(device,color,flush)
</source>
+
</syntaxhighlight>
=== <translate>Parameters</translate> ===
+
 
'''device''': (text) <translate>Name of the device, eg keyboard, mouse.</translate><br/>
+
=== Parameters ===
'''colour''': (number) <translate>BGR colour value.</translate><br/>
+
'''device''': (text) name of the device, eg keyboard, mouse<br/>
'''flush''': (bool) <translate>True to send the colours to the device, default false. </translate> '''optional'''<br/>
+
'''colour''': (number) BGR colour value<br/>
=== <translate>Return values</translate> ===
+
'''flush''': (bool) True to send the colours to the device, default false '''optional'''<br/>
 +
 
 +
=== Return values ===
  
  
 
{{Chroma}}
 
{{Chroma}}

Latest revision as of 21:45, 6 November 2024

Available since: Gideros 2020.7
Class: chroma

Description

Basically sets all the LED colours on the device to a specific colour.

(number) = Chroma:clear(device,color,flush)

Parameters

device: (text) name of the device, eg keyboard, mouse
colour: (number) BGR colour value
flush: (bool) True to send the colours to the device, default false optional

Return values