summaryrefslogtreecommitdiff
path: root/drivers/oled/oled_driver.h
diff options
context:
space:
mode:
authorRyan <fauxpark@gmail.com>2021-06-17 17:14:23 +1000
committerGitHub <noreply@github.com>2021-06-17 17:14:23 +1000
commit2f08a343948c6db3c67505f8fca5fdbfed41831b (patch)
tree5d62c1a5229107ce9a20a230375f508905564629 /drivers/oled/oled_driver.h
parenta9c6adb083556ae485dbf1e9f86ad615e32a8b7a (diff)
OLED driver tweaks (#13215)
Diffstat (limited to 'drivers/oled/oled_driver.h')
-rw-r--r--drivers/oled/oled_driver.h12
1 files changed, 5 insertions, 7 deletions
diff --git a/drivers/oled/oled_driver.h b/drivers/oled/oled_driver.h
index cbf5380ee0..a6b85f37e6 100644
--- a/drivers/oled/oled_driver.h
+++ b/drivers/oled/oled_driver.h
@@ -226,13 +226,17 @@ void oled_write(const char *data, bool invert);
void oled_write_ln(const char *data, bool invert);
// Pans the buffer to the right (or left by passing true) by moving contents of the buffer
+// Useful for moving the screen in preparation for new drawing
void oled_pan(bool left);
// Returns a pointer to the requested start index in the buffer plus remaining
// buffer length as struct
oled_buffer_reader_t oled_read_raw(uint16_t start_index);
+// Writes a string to the buffer at current cursor position
void oled_write_raw(const char *data, uint16_t size);
+
+// Writes a single byte into the buffer at the specified index
void oled_write_raw_byte(const char data, uint16_t index);
// Sets a specific pixel on or off
@@ -251,17 +255,11 @@ void oled_write_P(const char *data, bool invert);
// Remapped to call 'void oled_write_ln(const char *data, bool invert);' on ARM
void oled_write_ln_P(const char *data, bool invert);
+// Writes a PROGMEM string to the buffer at current cursor position
void oled_write_raw_P(const char *data, uint16_t size);
#else
-// Writes a string to the buffer at current cursor position
-// Advances the cursor while writing, inverts the pixels if true
# define oled_write_P(data, invert) oled_write(data, invert)
-
-// Writes a string to the buffer at current cursor position
-// Advances the cursor while writing, inverts the pixels if true
-// Advances the cursor to the next page, wiring ' ' to the remainder of the current page
# define oled_write_ln_P(data, invert) oled_write(data, invert)
-
# define oled_write_raw_P(data, size) oled_write_raw(data, size)
#endif // defined(__AVR__)