roo_display
API Documentation for roo_display
Loading...
Searching...
No Matches
roo_display::BufferedColorWriter Class Reference

Buffered writer for sequential color values (used with setAddress()). More...

#include <buffered_drawing.h>

Public Member Functions

 BufferedColorWriter (DisplayOutput &device)
 
void writeColor (Color color)
 Write a single color value.
 
void writeColorN (Color color, uint16_t count)
 Write count pixels with the same color.
 
void writeColors (Color *colors, uint16_t count)
 Write count pixels with distinct colors.
 
uint16_t remaining_buffer_space () const
 Return remaining buffer capacity before a flush is needed.
 
Colorbuffer_ptr ()
 Return raw access to the buffer at the current write position.
 
void advance_buffer_ptr (uint16_t count)
 Advance the buffer after direct writes via buffer_ptr().
 
uint16_t writeColorsAligned (Color *colors, uint16_t count)
 Write up to the remaining buffer space and return count written.
 
 ~BufferedColorWriter ()
 

Detailed Description

Buffered writer for sequential color values (used with setAddress()).

Definition at line 189 of file buffered_drawing.h.

Constructor & Destructor Documentation

◆ BufferedColorWriter()

roo_display::BufferedColorWriter::BufferedColorWriter ( DisplayOutput device)
inline

Definition at line 191 of file buffered_drawing.h.

◆ ~BufferedColorWriter()

roo_display::BufferedColorWriter::~BufferedColorWriter ( )
inline

Definition at line 287 of file buffered_drawing.h.

Member Function Documentation

◆ advance_buffer_ptr()

void roo_display::BufferedColorWriter::advance_buffer_ptr ( uint16_t  count)
inline

Advance the buffer after direct writes via buffer_ptr().

Definition at line 260 of file buffered_drawing.h.

References roo_display::kPixelWritingBufferSize, and roo_display::DisplayOutput::write().

◆ buffer_ptr()

Color * roo_display::BufferedColorWriter::buffer_ptr ( )
inline

Return raw access to the buffer at the current write position.

Definition at line 257 of file buffered_drawing.h.

◆ remaining_buffer_space()

uint16_t roo_display::BufferedColorWriter::remaining_buffer_space ( ) const
inline

Return remaining buffer capacity before a flush is needed.

Definition at line 252 of file buffered_drawing.h.

References roo_display::kPixelWritingBufferSize.

◆ writeColor()

void roo_display::BufferedColorWriter::writeColor ( Color  color)
inline

Write a single color value.

Definition at line 195 of file buffered_drawing.h.

References color, and roo_display::kPixelWritingBufferSize.

◆ writeColorN()

void roo_display::BufferedColorWriter::writeColorN ( Color  color,
uint16_t  count 
)
inline

Write count pixels with the same color.

Definition at line 202 of file buffered_drawing.h.

References color, roo_display::FillColor(), roo_display::kPixelWritingBufferSize, and roo_display::DisplayOutput::write().

◆ writeColors()

void roo_display::BufferedColorWriter::writeColors ( Color colors,
uint16_t  count 
)
inline

Write count pixels with distinct colors.

Definition at line 225 of file buffered_drawing.h.

References roo_display::kPixelWritingBufferSize, and roo_display::DisplayOutput::write().

◆ writeColorsAligned()

uint16_t roo_display::BufferedColorWriter::writeColorsAligned ( Color colors,
uint16_t  count 
)
inline

Write up to the remaining buffer space and return count written.

Definition at line 270 of file buffered_drawing.h.

References roo_display::kPixelWritingBufferSize, and roo_display::DisplayOutput::write().


The documentation for this class was generated from the following file: