piotr/edgetx-gx12
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

fix(doc): describe more clearly availability of colorlcd Lua API functions (#6060)

Browse Source
This commit is contained in:
Risto
2025-04-10 10:29:31 +10:00
committed by GitHub
parent cf8893f3c0
commit 8751b85b8a
1 changed files with 34 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
radio/src/lua/api_colorlcd.cpp
+34 -10
View File
@@ -256,6 +256,8 @@ Get the width and height of a text string drawn with flags
@retval w,h (integers) width and height of the text
@notice Only available on radios with color display
@status current Introduced in 2.5.0
*/
static int luaLcdSizeText(lua_State *L)
@@ -282,6 +284,8 @@ Draw text inside rectangle (x,y,w,h) with line breaks
@retval x,y (integers) point where text drawing ended
@notice Only available on radios with color display
@status current Introduced in 2.5.0, return x,y added in 2.11.0
*/
static int luaLcdDrawTextLines(lua_State *L)
@@ -498,7 +502,7 @@ Bitmap loading can fail if:
@retval bitmap (object) a bitmap object that can be used with other bitmap functions
@notice Only available on Horus
@notice Only available on radios with color display
@status current Introduced in 2.2.0
*/
@@ -551,7 +555,7 @@ Return width, height of a bitmap object
* (number) width in pixels
* (number) height in pixels
@notice Only available on Horus
@notice Only available on radios with color display
@status current Introduced in 2.2.0
*/
@@ -580,7 +584,7 @@ Return a resized bitmap object
@param height (number) the new bitmap height
@notice Only available on Horus
@notice Only available on radios with color display
@status current Introduced in 2.8.0
*/
@@ -629,7 +633,7 @@ Return a 8bit bitmap mask that can be used with lcd.drawBitmapPattern()
@retval a bitmap mask
@notice Only available on Horus
@notice Only available on radios with color display
@status current Introduced in 2.8.0
*/
@@ -677,7 +681,7 @@ Displays a bitmap at (x,y)
@param scale (positive numbers) scale in %, 50 divides size by two, 100 is unchanged, 200 doubles size.
Omitting scale draws image in 1:1 scale and is faster than specifying 100 for scale.
@notice Only available on Horus
@notice Only available on radios with color display
@status current Introduced in 2.2.0
*/
@@ -715,7 +719,7 @@ Displays a bitmap pattern at (x,y)
@param flags (optional) please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html)
@notice Only available on Horus
@notice Only available on radios with color display
@status current Introduced in 2.8.0
*/
@@ -752,7 +756,7 @@ Displays a bitmap pattern pie at (x,y)
@param flags (optional) please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html)
@notice Only available on Horus
@notice Only available on radios with color display
@status current Introduced in 2.8.0
*/
@@ -789,9 +793,9 @@ Draw a rectangle from top left corner (x,y) of specified width and height
@param flags (optional) please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html)
@param t (number) thickness in pixels, defaults to 1 (only on Horus)
@param t (number) thickness in pixels, defaults to 1 (only on radios with color display)
@param opacity (number) opacity defaults to 0 (only on Horus)
@param opacity (number) opacity defaults to 0 (only on radios with color display)
@status current Introduced in 2.0.0, changed in 2.2.0
*/
@@ -827,7 +831,7 @@ Draw a solid rectangle from top left corner (x,y) of specified width and height
@param flags (optional) please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html)
@param opacity (number) opacity defaults to 0 (only on Horus)
@param opacity (number) opacity defaults to 0 (only on radios with color display)
@status current Introduced in 2.0.0
*/
@@ -864,6 +868,8 @@ Invert a rectangle zone from top left corner (x,y) of specified width and height
@param flags (optional) please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html)
@notice Only available on radios with color display
@status current Introduced in 2.8.0
*/
static int luaLcdInvertRect(lua_State *L)
@@ -1021,6 +1027,8 @@ Draw a circle at (x, y) of specified radius
@param flags (optional) please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html)
@notice Only available on radios with color display
@status current Introduced in 2.4.0
*/
static int luaLcdDrawCircle(lua_State *L)
@@ -1050,6 +1058,8 @@ Draw a filled circle at (x, y) of specified radius
@param flags (optional) please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html)
@notice Only available on radios with color display
@status current Introduced in 2.4.0
*/
static int luaLcdDrawFilledCircle(lua_State *L)
@@ -1077,6 +1087,8 @@ Draw a triangle
@param flags (optional) please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html)
@notice Only available on radios with color display
@status current Introduced in 2.4.0
*/
static int luaLcdDrawTriangle(lua_State *L)
@@ -1109,6 +1121,8 @@ Draw a filled triangle
@param flags (optional) please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html)
@notice Only available on radios with color display
@status current Introduced in 2.4.0
*/
static int luaLcdDrawFilledTriangle(lua_State *L)
@@ -1143,6 +1157,8 @@ Draw an arc
@param flags (optional) please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html)
@notice Only available on radios with color display
@status current Introduced in 2.4.0
*/
static int luaLcdDrawArc(lua_State *L)
@@ -1177,6 +1193,8 @@ Draw a pie slice
@param flags (optional) please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html)
@notice Only available on radios with color display
@status current Introduced in 2.4.0
*/
static int luaLcdDrawPie(lua_State *L)
@@ -1211,6 +1229,8 @@ Draw an arc
@param flags (optional) please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html)
@notice Only available on radios with color display
@status current Introduced in 2.4.0
*/
static int luaLcdDrawAnnulus(lua_State *L)
@@ -1245,6 +1265,8 @@ Draw a line only inside a rectangle
@param flags (optional) please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html)
@notice Only available on radios with color display
@status current Introduced in 2.4.0
*/
static int luaLcdDrawLineWithClipping(lua_State *L)
@@ -1353,6 +1375,8 @@ Draw a rectangle in perspective
@param flags (optional) please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html)
@notice Only available on radios with color display
@status current Introduced in 2.4.0
*/
static int luaLcdDrawHudRectangle(lua_State *L)