Difference between revisions of "Lua API:Graphics"
m (Handle Constants better) |
(Add gfx.drawPixel) |
||
(8 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
− | + | Various methods that allow lua to draw on the simulation screen. | |
== Methods == | == Methods == | ||
+ | |||
+ | === graphics.textSize === | ||
+ | number, number graphics.textSize(string text) | ||
+ | Returns the width and height of the specified text. | ||
+ | |||
+ | === graphics.drawText === | ||
+ | graphics.drawText(number x, number y, string text, [number r, number g, number b, [number a]]) | ||
+ | Draws the specified text at (x,y). Providing the color is optional, if not provided defaults to white. | ||
+ | |||
+ | === graphics.drawPixel === | ||
+ | graphics.drawPixel(number x, number y, [number r, number g, number b, [number a]]) | ||
+ | Draws a pixel at (x, y). Providing the color is optional, if not provided defaults to white. | ||
=== graphics.drawLine === | === graphics.drawLine === | ||
− | + | graphics.drawLine(number x1, number y1, number x2, number y2, [number r, number g, number b, [number a]]) | |
− | + | Draws a line from (x1,y1) to (x2,y2). Providing the color is optional, if not provided defaults to white. | |
=== graphics.drawRect === | === graphics.drawRect === | ||
− | + | graphics.drawRect(number x, number y, number width, number height, [number r, number g, number b, [number a]]) | |
+ | Draws a hollow rectangle at (x,y) with the specified width and height. Providing the color is optional, if not provided defaults to white. | ||
+ | === graphics.fillRect === | ||
+ | graphics.fillRect(number x, number y, number width, number height, [number r, number g, number b, [number a]]) | ||
+ | Draws a filled rectangle at (x,y) with the specified width and height. Providing the color is optional, if not provided defaults to white. | ||
=== graphics.drawCircle === | === graphics.drawCircle === | ||
− | + | graphics.drawCircle(number x, number y, number radiusW, number radiusH, [number r, number g, number b, [number a]]) | |
− | + | Draws a hollow circle at (x,y) with radius of (radiusW,radiusH). Providing the color is optional, if not provided defaults to white. | |
=== graphics.fillCircle === | === graphics.fillCircle === | ||
− | + | graphics.fillCircle(number x, number y, number radiusW, number radiusH, [number r, number g, number b, [number a]]) | |
− | + | Draws a filled circle at (x,y) with radius of (radiusW,radiusH). Providing the color is optional, if not provided defaults to white. | |
− | === graphics. | + | === graphics.getColors === |
− | + | graphics.getColors(number color) | |
+ | Converts color from hex. Return number r,g,b,a. | ||
+ | === graphics.getHexColor === | ||
+ | graphics.getHexColor( [number r], [number g], [number b], [number a]) | ||
+ | Converts color to hex. | ||
− | === graphics. | + | === graphics.setClipRect === |
− | + | graphics.setClipRect([number x], [number y], [number w], [number h]) | |
− | + | Sets the clip rect used while drawing graphics to the screen. Graphics drawn outside the given rectangle will be clipped out. The default clip rect is the entire screen, and clip rects will be reset to this after every frame. | |
− | |||
− | |||
− | |||
+ | Returns the old clip rect (x, y, w, h). | ||
== Constants == | == Constants == | ||
− | + | ; graphics.WIDTH | |
+ | The complete window width including side buttons, usually 629. | ||
+ | ; graphics.HEIGHT | ||
+ | The complete window height including the bottom area, usually 424. | ||
− | + | [[Category:Lua]] | |
− | |||
− |
Latest revision as of 20:31, 10 March 2024
Various methods that allow lua to draw on the simulation screen.
Contents
Methods
graphics.textSize
number, number graphics.textSize(string text)
Returns the width and height of the specified text.
graphics.drawText
graphics.drawText(number x, number y, string text, [number r, number g, number b, [number a]])
Draws the specified text at (x,y). Providing the color is optional, if not provided defaults to white.
graphics.drawPixel
graphics.drawPixel(number x, number y, [number r, number g, number b, [number a]])
Draws a pixel at (x, y). Providing the color is optional, if not provided defaults to white.
graphics.drawLine
graphics.drawLine(number x1, number y1, number x2, number y2, [number r, number g, number b, [number a]])
Draws a line from (x1,y1) to (x2,y2). Providing the color is optional, if not provided defaults to white.
graphics.drawRect
graphics.drawRect(number x, number y, number width, number height, [number r, number g, number b, [number a]])
Draws a hollow rectangle at (x,y) with the specified width and height. Providing the color is optional, if not provided defaults to white.
graphics.fillRect
graphics.fillRect(number x, number y, number width, number height, [number r, number g, number b, [number a]])
Draws a filled rectangle at (x,y) with the specified width and height. Providing the color is optional, if not provided defaults to white.
graphics.drawCircle
graphics.drawCircle(number x, number y, number radiusW, number radiusH, [number r, number g, number b, [number a]])
Draws a hollow circle at (x,y) with radius of (radiusW,radiusH). Providing the color is optional, if not provided defaults to white.
graphics.fillCircle
graphics.fillCircle(number x, number y, number radiusW, number radiusH, [number r, number g, number b, [number a]])
Draws a filled circle at (x,y) with radius of (radiusW,radiusH). Providing the color is optional, if not provided defaults to white.
graphics.getColors
graphics.getColors(number color)
Converts color from hex. Return number r,g,b,a.
graphics.getHexColor
graphics.getHexColor( [number r], [number g], [number b], [number a])
Converts color to hex.
graphics.setClipRect
graphics.setClipRect([number x], [number y], [number w], [number h])
Sets the clip rect used while drawing graphics to the screen. Graphics drawn outside the given rectangle will be clipped out. The default clip rect is the entire screen, and clip rects will be reset to this after every frame.
Returns the old clip rect (x, y, w, h).
Constants
- graphics.WIDTH
The complete window width including side buttons, usually 629.
- graphics.HEIGHT
The complete window height including the bottom area, usually 424.