Serial Wombat Arduino Library
SerialWombat18ABVGA.h
Go to the documentation of this file.
1 #pragma once
2 
3 /*
4 Copyright 2023 Broadwell Consulting Inc.
5 
6 "Serial Wombat" is a registered trademark of Broadwell Consulting Inc. in
7 the United States. See SerialWombat.com for usage guidance.
8 
9 Permission is hereby granted, free of charge, to any person obtaining a
10  * copy of this software and associated documentation files (the "Software"),
11  * to deal in the Software without restriction, including without limitation
12  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
13  * and/or sell copies of the Software, and to permit persons to whom the
14  * Software is furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17  * all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
22  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
23  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
24  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25  * OTHER DEALINGS IN THE SOFTWARE.
26 */
27 
28 #include <stdint.h>
29 #include "SerialWombat.h"
82 {
83 public:
91  int16_t begin(uint8_t vsyncPin,uint16_t bufferIndex = 0);
92 
98  int16_t writePixel(uint8_t x, uint8_t y, uint8_t color);
99 
103  int16_t fillScreen(uint8_t color);
104 
112  int16_t fillRect(uint8_t x, uint8_t y, uint8_t w, uint8_t h,
113  uint8_t color);
114 
119  int16_t setLineColor(uint8_t color, uint8_t y);
125  int16_t setLineColor(uint8_t color, uint8_t start, uint8_t end);
126 };
127 
128 
SerialWombatChip
Class for a Serial Wombat chip. Each Serial Wombat chip on a project should have its own instance.
Definition: SerialWombat.h:272
SerialWombat18ABVGA::writePixel
int16_t writePixel(uint8_t x, uint8_t y, uint8_t color)
Write a pixel to the buffer.
Definition: SerialWombat18ABVGA.cpp:27
SerialWombat18ABVGA::fillScreen
int16_t fillScreen(uint8_t color)
fill the entire screen
Definition: SerialWombat18ABVGA.cpp:42
SerialWombat.h
SerialWombat18ABVGA::fillRect
int16_t fillRect(uint8_t x, uint8_t y, uint8_t w, uint8_t h, uint8_t color)
Draw a filled rectangle on the screen.
Definition: SerialWombat18ABVGA.cpp:57
SerialWombat18ABVGA::setLineColor
int16_t setLineColor(uint8_t color, uint8_t y)
Set the color of a horizontal line.
Definition: SerialWombat18ABVGA.cpp:76
SerialWombatPin
Describes a Serial Wombat Pin. Is base class for other pin modes.
Definition: SerialWombat.h:799
SerialWombat18ABVGA
A class for the Serial Wombat SW18AB chip VGA Driver.
Definition: SerialWombat18ABVGA.h:81
SerialWombat18ABVGA::SerialWombat18ABVGA
SerialWombat18ABVGA(SerialWombatChip &serialWombat)
Constructor for the SerialWombat18ABVGA class.
Definition: SerialWombat18ABVGA.cpp:7
SerialWombat18ABVGA::begin
int16_t begin(uint8_t vsyncPin, uint16_t bufferIndex=0)
Initalize the SerialWombat18ABVGA.
Definition: SerialWombat18ABVGA.cpp:11