ESPHome  2024.10.2
Public Member Functions | Protected Attributes
esphome::online_image::DownloadBuffer Class Reference

#include <image_decoder.h>

Public Member Functions

 DownloadBuffer (size_t size)
 
virtual ~DownloadBuffer ()
 
uint8_t * data (size_t offset=0)
 
uint8_t * append ()
 
size_t unread () const
 
size_t size () const
 
size_t free_capacity () const
 
size_t read (size_t len)
 
size_t write (size_t len)
 
void reset ()
 

Protected Attributes

ExternalRAMAllocator< uint8_t > allocator_
 
uint8_t * buffer_
 
size_t size_
 
size_t unread_
 Total number of downloaded bytes not yet read. More...
 

Detailed Description

Definition at line 78 of file image_decoder.h.

Constructor & Destructor Documentation

◆ DownloadBuffer()

esphome::online_image::DownloadBuffer::DownloadBuffer ( size_t  size)
inline

Definition at line 80 of file image_decoder.h.

◆ ~DownloadBuffer()

virtual esphome::online_image::DownloadBuffer::~DownloadBuffer ( )
inlinevirtual

Definition at line 85 of file image_decoder.h.

Member Function Documentation

◆ append()

uint8_t* esphome::online_image::DownloadBuffer::append ( )
inline

Definition at line 89 of file image_decoder.h.

◆ data()

uint8_t * esphome::online_image::DownloadBuffer::data ( size_t  offset = 0)

Definition at line 27 of file image_decoder.cpp.

◆ free_capacity()

size_t esphome::online_image::DownloadBuffer::free_capacity ( ) const
inline

Definition at line 93 of file image_decoder.h.

◆ read()

size_t esphome::online_image::DownloadBuffer::read ( size_t  len)

Definition at line 35 of file image_decoder.cpp.

◆ reset()

void esphome::online_image::DownloadBuffer::reset ( )
inline

Definition at line 101 of file image_decoder.h.

◆ size()

size_t esphome::online_image::DownloadBuffer::size ( ) const
inline

Definition at line 92 of file image_decoder.h.

◆ unread()

size_t esphome::online_image::DownloadBuffer::unread ( ) const
inline

Definition at line 91 of file image_decoder.h.

◆ write()

size_t esphome::online_image::DownloadBuffer::write ( size_t  len)
inline

Definition at line 96 of file image_decoder.h.

Field Documentation

◆ allocator_

ExternalRAMAllocator<uint8_t> esphome::online_image::DownloadBuffer::allocator_
protected

Definition at line 104 of file image_decoder.h.

◆ buffer_

uint8_t* esphome::online_image::DownloadBuffer::buffer_
protected

Definition at line 105 of file image_decoder.h.

◆ size_

size_t esphome::online_image::DownloadBuffer::size_
protected

Definition at line 106 of file image_decoder.h.

◆ unread_

size_t esphome::online_image::DownloadBuffer::unread_
protected

Total number of downloaded bytes not yet read.

Definition at line 108 of file image_decoder.h.


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