ESP32VGA
ESP32 VGA Controller and Graphics Library
|
Represents the VGA controller. More...
#include <vgacontroller.h>
Public Member Functions | |
void | begin (gpio_num_t redGPIO, gpio_num_t greenGPIO, gpio_num_t blueGPIO, gpio_num_t HSyncGPIO, gpio_num_t VSyncGPIO) |
This is the 8 colors (5 GPIOs) initializer. More... | |
void | begin (gpio_num_t red1GPIO, gpio_num_t red0GPIO, gpio_num_t green1GPIO, gpio_num_t green0GPIO, gpio_num_t blue1GPIO, gpio_num_t blue0GPIO, gpio_num_t HSyncGPIO, gpio_num_t VSyncGPIO) |
This is the 64 colors (8 GPIOs) initializer. More... | |
uint8_t | getBitsPerChannel () |
Get number of bits allocated for each channel. More... | |
void | setResolution (char const *modeline, int viewPortWidth=-1, int viewPortHeight=-1, bool doubleBuffered=false) |
Set current resolution using linux-like modeline. More... | |
int | getScreenWidth () |
Return the screen width in pixels. More... | |
int | getScreenHeight () |
Return the screen height in pixels. More... | |
int | getViewPortCol () |
Return horizontal position of the viewport. More... | |
int | getViewPortRow () |
Return vertical position of the viewport. More... | |
int | getViewPortWidth () |
Return horizontal size of the viewport. More... | |
int | getViewPortHeight () |
Return vertical size of the viewport. More... | |
void | enableBackgroundPrimitiveExecution (bool value) |
Enable or disable drawings inside vertical retracing time. More... | |
void | suspendBackgroundPrimitiveExecution () |
Suspend drawings. More... | |
void | resumeBackgroundPrimitiveExecution () |
Resume drawings after suspendBackgroundPrimitiveExecution(). More... | |
void | processPrimitives () |
Draw immediately all primitives in the queue. More... | |
void | moveScreen (int16_t offsetX, int16_t offsetY) |
Move screen by specified horizontal and vertical offset. More... | |
void | shrinkScreen (int shrinkX, int shrinkY) |
Reduce or expands screen size by the specified horizontal and vertical offset. More... | |
template<typename T > | |
void | setSprites (T *sprites, int count) |
Set the list of active sprites. More... | |
void | removeSprites () |
Empty the list of active sprites. More... | |
void | refreshSprites () |
Force the sprites to be updated. More... | |
bool | isDoubleBuffered () |
Return true if VGAControllerClass is on double buffered mode. More... | |
Represents the VGA controller.
Use this class to set screen resolution and to associate VGA signals to ESP32 GPIO outputs.
This example initializes VGA Controller with 8 colors (5 GPIOs used) and 640x350 resolution:
// Assign GPIO22 to Red, GPIO21 to Green, GPIO19 to Blue, GPIO18 to HSync and GPIO5 to VSync VGAController.begin(GPIO_NUM_22, GPIO_NUM_21, GPIO_NUM_19, GPIO_NUM_18, GPIO_NUM_5); // Set 640x350@70Hz resolution VGAController.setResolution(VGA_640x350_70Hz);
This example initializes VGA Controller with 64 colors (8 GPIOs used) and 640x350 resolution:
// Assign GPIO22 and GPIO_NUM_21 to Red, GPIO_NUM_19 and GPIO_NUM_18 to Green, GPIO_NUM_5 and GPIO_NUM_4 to Blue, GPIO_NUM_23 to HSync and GPIO_NUM_15 to VSync VGAController.begin(GPIO_NUM_22, GPIO_NUM_21, GPIO_NUM_19, GPIO_NUM_18, GPIO_NUM_5, GPIO_NUM_4, GPIO_NUM_23, GPIO_NUM_15); // Set 640x350@70Hz resolution VGAController.setResolution(VGA_640x350_70Hz);
void FabGL::VGAControllerClass::begin | ( | gpio_num_t | redGPIO, |
gpio_num_t | greenGPIO, | ||
gpio_num_t | blueGPIO, | ||
gpio_num_t | HSyncGPIO, | ||
gpio_num_t | VSyncGPIO | ||
) |
This is the 8 colors (5 GPIOs) initializer.
One GPIO per channel, plus horizontal and vertical sync signals.
redGPIO | GPIO to use for red channel. |
greenGPIO | GPIO to use for green channel. |
blueGPIO | GPIO to use for blue channel. |
HSyncGPIO | GPIO to use for horizontal sync signal. |
VSyncGPIO | GPIO to use for vertical sync signal. |
Example:
// Use GPIO 22 for red, GPIO 21 for green, GPIO 19 for blue, GPIO 18 for HSync and GPIO 5 for VSync VGAController.begin(GPIO_NUM_22, GPIO_NUM_21, GPIO_NUM_19, GPIO_NUM_18, GPIO_NUM_5);
void FabGL::VGAControllerClass::begin | ( | gpio_num_t | red1GPIO, |
gpio_num_t | red0GPIO, | ||
gpio_num_t | green1GPIO, | ||
gpio_num_t | green0GPIO, | ||
gpio_num_t | blue1GPIO, | ||
gpio_num_t | blue0GPIO, | ||
gpio_num_t | HSyncGPIO, | ||
gpio_num_t | VSyncGPIO | ||
) |
This is the 64 colors (8 GPIOs) initializer.
Two GPIOs per channel, plus horizontal and vertical sync signals.
red1GPIO | GPIO to use for red channel, MSB bit. |
red0GPIO | GPIO to use for red channel, LSB bit. |
green1GPIO | GPIO to use for green channel, MSB bit. |
green0GPIO | GPIO to use for green channel, LSB bit. |
blue1GPIO | GPIO to use for blue channel, MSB bit. |
blue0GPIO | GPIO to use for blue channel, LSB bit. |
HSyncGPIO | GPIO to use for horizontal sync signal. |
VSyncGPIO | GPIO to use for vertical sync signal. |
Example:
// Use GPIO 22-21 for red, GPIO 19-18 for green, GPIO 5-4 for blue, GPIO 23 for HSync and GPIO 15 for VSync VGAController.begin(GPIO_NUM_22, GPIO_NUM_21, GPIO_NUM_19, GPIO_NUM_18, GPIO_NUM_5, GPIO_NUM_4, GPIO_NUM_23, GPIO_NUM_15);
void FabGL::VGAControllerClass::enableBackgroundPrimitiveExecution | ( | bool | value | ) |
Enable or disable drawings inside vertical retracing time.
When vertical retracing occurs (on Vertical Sync) an interrupt is trigged. Inside this interrupt primitives like line, circles, glyphs, etc.. are painted. This method can disable (or reenable) this behavior, making drawing instantaneous. Flickering may occur when drawings are executed out of retracing time. When background executing is disabled the queue is emptied executing all pending primitives.
value | When true drawings are done during vertical retracing, when false drawings are executed instantly. |
|
inline |
Get number of bits allocated for each channel.
Number of bits depends by which begin() initializer has been called.
|
inline |
Return the screen height in pixels.
|
inline |
Return the screen width in pixels.
|
inline |
Return horizontal position of the viewport.
|
inline |
Return vertical size of the viewport.
|
inline |
Return vertical position of the viewport.
|
inline |
Return horizontal size of the viewport.
|
inline |
Return true if VGAControllerClass is on double buffered mode.
void FabGL::VGAControllerClass::moveScreen | ( | int16_t | offsetX, |
int16_t | offsetY | ||
) |
Move screen by specified horizontal and vertical offset.
Screen moving is performed moving horizontal and vertical Front and Back porchs.
offsetX | Horizontal offset in pixels. < 0 goes left, > 0 goes right. |
offsetY | Vertical offset in pixels. < 0 goes up, > 0 goes down. |
Example:
// Move screen 4 pixels right, 1 pixel left VGAController.moveScreen(4, -1);
void IRAM_ATTR FabGL::VGAControllerClass::processPrimitives | ( | ) |
Draw immediately all primitives in the queue.
Draws all primitives before they are processed in the vertical sync interrupt. May generate flickering because don't care of vertical sync.
void FabGL::VGAControllerClass::refreshSprites | ( | ) |
Force the sprites to be updated.
Screen is automatically updated whenever a primitive is painted (look at CanvasClass). When a sprite updates its image or its position (or any other property) it is required to force a refresh using this method. VGAControllerClass.refreshSprites() is required also using double buffered mode, to paint sprites.
|
inline |
Empty the list of active sprites.
Call this method when you don't need active sprites anymore.
void FabGL::VGAControllerClass::resumeBackgroundPrimitiveExecution | ( | ) |
Resume drawings after suspendBackgroundPrimitiveExecution().
Resumes drawings enabling vertical sync interrupt.
void FabGL::VGAControllerClass::setResolution | ( | char const * | modeline, |
int | viewPortWidth = -1 , |
||
int | viewPortHeight = -1 , |
||
bool | doubleBuffered = false |
||
) |
Set current resolution using linux-like modeline.
Modeline must have following syntax (non case sensitive):
"label" clock_mhz hdisp hsyncstart hsyncend htotal vdisp vsyncstart vsyncend vtotal (+HSync | -HSync) (+VSync | -VSync) [DoubleScan] [FrontPorchBegins | SyncBegins | BackPorchBegins | VisibleBegins]
In FabGLConf.h there are macros with some predefined modelines for common resolutions.
modeline | Linux-like modeline as specified above. |
viewPortWidth | Horizontal viewport size in pixels. If less than zero (-1) it is sized to modeline visible area width. |
viewPortHeight | Vertical viewport size in pixels. If less then zero (-1) it is sized to maximum allocable. |
doubleBuffered | if True allocates another viewport of the same size to use as back buffer. Make sure there is enough free memory. |
Example:
// Use predefined modeline for 640x480@60Hz VGAController.setResolution(VGA_640x480_60Hz); // The same of above using modeline string VGAController.setResolution("\"640x480@60Hz\" 25.175 640 656 752 800 480 490 492 525 -HSync -VSync"); // Set 640x382@60Hz but limit the viewport to 640x350 VGAController.setResolution(VGA_640x382_60Hz, 640, 350);
|
inline |
Set the list of active sprites.
A sprite is an image that keeps background unchanged. There is no limit to the number of active sprites, but flickering and slow refresh happens when a lot of sprites (or large sprites) are visible. To empty the list of active sprites call VGAControllerClass.removeSprites().
sprites | The list of sprites to make currently active. |
count | Number of sprites in the list. |
Example:
// define a sprite with user data (velX and velY) struct MySprite : Sprite { int velX; int velY; }; static MySprite sprites[10]; VGAController.setSprites(sprites, 10);
void FabGL::VGAControllerClass::shrinkScreen | ( | int | shrinkX, |
int | shrinkY | ||
) |
Reduce or expands screen size by the specified horizontal and vertical offset.
Screen shrinking is performed changing horizontal and vertical Front and Back porchs.
shrinkX | Horizontal offset in pixels. > 0 shrinks, < 0 expands. |
shrinkY | Vertical offset in pixels. > 0 shrinks, < 0 expands. |
Example:
// Shrink screen by 8 pixels and move by 8 pixels to the left VGAController.shrinkScreen(8, 0); VGAController.moveScreen(8, 0);
void FabGL::VGAControllerClass::suspendBackgroundPrimitiveExecution | ( | ) |
Suspend drawings.
Suspends drawings disabling vertical sync interrupt. After call to suspendBackgroundPrimitiveExecution() adding new primitives may cause a deadlock. To avoid it a call to "processPrimitives()" should be performed very often. This method maintains a counter so can be nested.