Difference between revisions of "Chroma:getColor"

From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
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>Returns the colour of the LED at x,y on the device.</translate>
+
Returns the colour of the LED at x,y on the device.
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
 
(number) = Chroma:getColor(device,x,y)
 
(number) = Chroma:getColor(device,x,y)
 
</syntaxhighlight>
 
</syntaxhighlight>
=== <translate>Parameters</translate> ===
+
 
'''device''': (text) <translate>Name of the device, eg keyboard, mouse.</translate><br/>
+
=== Parameters ===
'''x''': (number) <translate>Column number of the device LED.</translate><br/>
+
'''device''': (text) name of the device, eg keyboard, mouse<br/>
'''y''': (number) <translate>Row number (if any) of the device, ignored in single row devices.</translate><br/>
+
'''x''': (number) column number of the device LED<br/>
=== <translate>Return values</translate> ===
+
'''y''': (number) row number (if any) of the device, ignored in single row devices<br/>
'''<translate>Returns</translate>''' (number) <translate>BGR colour value of the LED at X,Y on the device.</translate><br/>
+
 
 +
=== Return values ===
 +
'''Returns''' (number) BGR colour value of the LED at X,Y on the device<br/>
  
 
{{Chroma}}
 
{{Chroma}}

Latest revision as of 21:49, 6 November 2024

Available since: Gideros 2020.7
Class: chroma

Description

Returns the colour of the LED at x,y on the device.

(number) = Chroma:getColor(device,x,y)

Parameters

device: (text) name of the device, eg keyboard, mouse
x: (number) column number of the device LED
y: (number) row number (if any) of the device, ignored in single row devices

Return values

Returns (number) BGR colour value of the LED at X,Y on the device