Skip to content

Commit 2ea8feb

Browse files
committed
Updated documentation
1 parent 09d0f94 commit 2ea8feb

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Paypal https://paypal.me/bitluni
99

1010
# Acknowledgements
1111
Thanks to Ivan Grokhotkov & Jeroen Domburg (aka Sprite_tm) for their great work on I2S revealing some nitty-gritty details and quirks of the ESP32.
12+
Special thanks to Fabrizio Di Vittorio for the inpiration to look deeper into 8Bit modes enabling higher resolutions. He developed the FabGL library simultaneously.
1213

1314
# License
1415
bitluni 2019
@@ -35,9 +36,13 @@ To be able to use the library featues the main header needs to included in the s
3536
## VGA Features
3637

3738
ESP32Lib implements VGA output over I²S.
38-
The highest possible resolution with this library is 460x480.
39+
The highest possible resolution with this library is 800x600.
3940
Many common resolutions like 320x240 are preconfigured und can be used without any effort.
40-
Two color depths are available. 14Bit R5G5B4 and 3Bit(8 color) R1G1B1 for convenience.
41+
Two color depths are available. 14Bit R5G5B4 and 3Bit(8 color) R1G1B1 for convenience and memory savings.
42+
43+
To simplify things you can find boards specially designed to work with this library in my shop:
44+
https://www.tindie.com/stores/bitluni/
45+
Any purchase supports the further development. Thanks!
4146

4247
### Pin configuration
4348

@@ -73,11 +78,11 @@ Here is an overview for your convenience:
7378

7479
There are 4 diffent VGA Drivers **VGA3Bit**, **VGA3BitI**, **VGA14Bit** and **VGA14BitI**.
7580
VGA3Bit, VGA14Bit are the high performance drivers that don't need any CPU time to
76-
serve the VGA. However the VGA3Bit driver is very memory hungry compared to VGA3BitI.
81+
serve the VGA. However the VGA3Bit driver takes twice the memory compared to VGA3BitI.
7782
The high performace drivers work the best with the WiFi features. The other driver might
7883
cause errors. WiFi should connect first before VGA3BitI and VGA14BitI is initialized.
7984
The *I* drivers are using an interrupt to feed the pixels to the I²S. This feature can be used for realtime outputs (Check the **VGANoFramebuffer** example).
80-
An instance of the driver has to be created. The optional parameter is the I²S bus to be used. If no parameter is given 1 is used by default to keep I²S0 free for audio output.
85+
An instance of the driver has to be created. The optional parameter (only for 14 bit versions) is the I²S bus to be used. If no parameter is given 1 is used by default to keep I²S0 free for audio output.
8186
```cpp
8287
VGA14Bit vga(1);
8388
```
@@ -112,16 +117,16 @@ The following modes are predefined:
112117
- MODE200x150
113118
- MODE500x480
114119
- MODE500x240
120+
- MODE800x600
121+
- MODE720x400
122+
- MODE720x350
123+
- MODE640x480
115124

116125
These native modes require a too high pixel clock but can be used as a base to create a custom resolution. Please check out the **VGACustomResolution** example:
117126
- MODE1280x1024
118127
- MODE1280x960
119128
- MODE1280x800
120129
- MODE1024x768
121-
- MODE800x600
122-
- MODE720x400
123-
- MODE720x350
124-
- MODE640x480
125130

126131
### 2D features
127132
The vga instance implements several drawing methods that can be seen in the **VGA2DFeatures** example.

0 commit comments

Comments
 (0)