summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMitja Felicijan <mitja.felicijan@gmail.com>2025-08-11 12:35:44 +0200
committerMitja Felicijan <mitja.felicijan@gmail.com>2025-08-11 12:35:44 +0200
commit8af1af7350281f5d263b9fbc9779ff7d4cddcf2d (patch)
tree6bcd7e9bed0eaec362eebbafd2bd298bee289c87 /README.md
parentfa1aa7793bbe2a3647435798c56f43945278bcd0 (diff)
downloadbidi-8af1af7350281f5d263b9fbc9779ff7d4cddcf2d.tar.gz
Added custom color examples and fixed arg parsing bug
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6de516d..8ff0d81 100644
--- a/README.md
+++ b/README.md
@@ -138,6 +138,36 @@ close_window()
| `color.BLANK` | 0 | 0 | 0 | 0 |
| `color.MAGENTA` | 255 | 0 | 255 | 255 |
+#### Using custom colors
+
+Color is essentially a structure with RGBA data. So constructing new colors is
+very easy.
+
+Alpha channel can be omitted and will by default be 255.
+
+```lua
+-- my_game.lua
+
+open_window(800, 800, "My Game")
+set_fps(60)
+
+my_color1 = { r = 200, g = 200, b = 200, a = 255 }
+my_color2 = { r = 200, g = 200, b = 200 }
+
+while window_running() do
+ start_drawing()
+ clear_window(color.BLACK)
+
+ draw_rect(100, 100, 100, 100, my_color1)
+ draw_rect(300, 100, 100, 100, my_color2)
+
+ draw_info()
+ stop_drawing()
+end
+
+close_window()
+```
+
## Libraries & Assets
- https://github.com/rxi/microtar