diff options
Diffstat (limited to 'docs/feature_oled_driver.md')
| -rw-r--r-- | docs/feature_oled_driver.md | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/docs/feature_oled_driver.md b/docs/feature_oled_driver.md index d2dc6103a..f3b659b1b 100644 --- a/docs/feature_oled_driver.md +++ b/docs/feature_oled_driver.md | |||
| @@ -263,22 +263,11 @@ void oled_write(const char *data, bool invert); | |||
| 263 | void oled_write_ln(const char *data, bool invert); | 263 | void oled_write_ln(const char *data, bool invert); |
| 264 | 264 | ||
| 265 | // Pans the buffer to the right (or left by passing true) by moving contents of the buffer | 265 | // Pans the buffer to the right (or left by passing true) by moving contents of the buffer |
| 266 | // Useful for moving the screen in preparation for new drawing | 266 | // Useful for moving the screen in preparation for new drawing |
| 267 | // oled_scroll_left or oled_scroll_right should be preferred for all cases of moving a static | 267 | // oled_scroll_left or oled_scroll_right should be preferred for all cases of moving a static |
| 268 | // image such as a logo or to avoid burn-in as it's much, much less cpu intensive | 268 | // image such as a logo or to avoid burn-in as it's much, much less cpu intensive |
| 269 | void oled_pan(bool left); | 269 | void oled_pan(bool left); |
| 270 | 270 | ||
| 271 | // Writes a PROGMEM string to the buffer at current cursor position | ||
| 272 | // Advances the cursor while writing, inverts the pixels if true | ||
| 273 | // Remapped to call 'void oled_write(const char *data, bool invert);' on ARM | ||
| 274 | void oled_write_P(const char *data, bool invert); | ||
| 275 | |||
| 276 | // Writes a PROGMEM string to the buffer at current cursor position | ||
| 277 | // Advances the cursor while writing, inverts the pixels if true | ||
| 278 | // Advances the cursor to the next page, wiring ' ' to the remainder of the current page | ||
| 279 | // Remapped to call 'void oled_write_ln(const char *data, bool invert);' on ARM | ||
| 280 | void oled_write_ln_P(const char *data, bool invert); | ||
| 281 | |||
| 282 | // Returns a pointer to the requested start index in the buffer plus remaining | 271 | // Returns a pointer to the requested start index in the buffer plus remaining |
| 283 | // buffer length as struct | 272 | // buffer length as struct |
| 284 | oled_buffer_reader_t oled_read_raw(uint16_t start_index); | 273 | oled_buffer_reader_t oled_read_raw(uint16_t start_index); |
| @@ -289,13 +278,24 @@ void oled_write_raw(const char *data, uint16_t size); | |||
| 289 | // Writes a single byte into the buffer at the specified index | 278 | // Writes a single byte into the buffer at the specified index |
| 290 | void oled_write_raw_byte(const char data, uint16_t index); | 279 | void oled_write_raw_byte(const char data, uint16_t index); |
| 291 | 280 | ||
| 292 | // Writes a PROGMEM string to the buffer at current cursor position | ||
| 293 | void oled_write_raw_P(const char *data, uint16_t size); | ||
| 294 | |||
| 295 | // Sets a specific pixel on or off | 281 | // Sets a specific pixel on or off |
| 296 | // Coordinates start at top-left and go right and down for positive x and y | 282 | // Coordinates start at top-left and go right and down for positive x and y |
| 297 | void oled_write_pixel(uint8_t x, uint8_t y, bool on); | 283 | void oled_write_pixel(uint8_t x, uint8_t y, bool on); |
| 298 | 284 | ||
| 285 | // Writes a PROGMEM string to the buffer at current cursor position | ||
| 286 | // Advances the cursor while writing, inverts the pixels if true | ||
| 287 | // Remapped to call 'void oled_write(const char *data, bool invert);' on ARM | ||
| 288 | void oled_write_P(const char *data, bool invert); | ||
| 289 | |||
| 290 | // Writes a PROGMEM string to the buffer at current cursor position | ||
| 291 | // Advances the cursor while writing, inverts the pixels if true | ||
| 292 | // Advances the cursor to the next page, wiring ' ' to the remainder of the current page | ||
| 293 | // Remapped to call 'void oled_write_ln(const char *data, bool invert);' on ARM | ||
| 294 | void oled_write_ln_P(const char *data, bool invert); | ||
| 295 | |||
| 296 | // Writes a PROGMEM string to the buffer at current cursor position | ||
| 297 | void oled_write_raw_P(const char *data, uint16_t size); | ||
| 298 | |||
| 299 | // Can be used to manually turn on the screen if it is off | 299 | // Can be used to manually turn on the screen if it is off |
| 300 | // Returns true if the screen was on or turns on | 300 | // Returns true if the screen was on or turns on |
| 301 | bool oled_on(void); | 301 | bool oled_on(void); |
