Detailed Description

Definition at line 21 of file data_stream.h.

Inheritance diagram for DataStream:

Public Types
enum	Type { kStreaming , kFile }

Public Member Functions
	DataStream (int bytes_per_frame)

bool	begin (FileHandleRef h)

bool	beginStream (ByteStreamRef s)

void	close ()

int32_t	bytesPerFrame ()

bool	readPixel (CRGB *dst)

size_t	readBytes (uint8_t *dst, size_t len)

bool	readFrame (Frame *frame)

int32_t	framesRemaining () const

int32_t	framesDisplayed () const

bool	available () const

int32_t	bytesRemaining () const

int32_t	bytesRemainingInFrame () const

bool	rewind ()

Type	getType () const

Public Member Functions inherited from Referent
virtual int	ref_count () const

Additional Inherited Members
Protected Member Functions inherited from Referent
	Referent (const Referent &)

Referent &	operator= (const Referent &)

	Referent (Referent &&)

Referent &	operator= (Referent &&)

virtual void	ref ()

virtual void	unref ()

virtual void	destroy ()

Member Enumeration Documentation

◆ Type

enum DataStream::Type

Definition at line 24 of file data_stream.h.

Constructor & Destructor Documentation

◆ DataStream()

DataStream::DataStream ( int bytes_per_frame )

explicit

Definition at line 14 of file data_stream.cpp.

◆ ~DataStream()

DataStream::~DataStream ( )

protectedvirtual

Definition at line 17 of file data_stream.cpp.

Member Function Documentation

◆ available()

bool DataStream::available ( ) const

Definition at line 56 of file data_stream.cpp.

◆ begin()

bool DataStream::begin ( FileHandleRef h )

Definition at line 21 of file data_stream.cpp.

◆ beginStream()

bool DataStream::beginStream ( ByteStreamRef s )

Definition at line 29 of file data_stream.cpp.

◆ bytesPerFrame()

int32_t DataStream::bytesPerFrame ( )

Definition at line 44 of file data_stream.cpp.

◆ bytesRemaining()

int32_t DataStream::bytesRemaining ( ) const

Definition at line 96 of file data_stream.cpp.

◆ bytesRemainingInFrame()

int32_t DataStream::bytesRemainingInFrame ( ) const

Definition at line 104 of file data_stream.cpp.

◆ close()

void DataStream::close ( )

Definition at line 36 of file data_stream.cpp.

◆ framesDisplayed()

int32_t DataStream::framesDisplayed ( ) const

Definition at line 86 of file data_stream.cpp.

◆ framesRemaining()

int32_t DataStream::framesRemaining ( ) const

Definition at line 77 of file data_stream.cpp.

◆ getType()

DataStream::Type DataStream::getType ( ) const

Definition at line 118 of file data_stream.cpp.

◆ readBytes()

size_t DataStream::readBytes	(	uint8_t *	dst,
		size_t	len )

Definition at line 122 of file data_stream.cpp.

◆ readFrame()

bool DataStream::readFrame ( Frame * frame )

Definition at line 64 of file data_stream.cpp.

◆ readPixel()

bool DataStream::readPixel ( CRGB * dst )

Definition at line 48 of file data_stream.cpp.

◆ rewind()

bool DataStream::rewind ( )

Definition at line 108 of file data_stream.cpp.

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

/home/runner/work/FastLED/FastLED/src/fx/detail/data_stream.h
/home/runner/work/FastLED/FastLED/src/fx/detail/data_stream.cpp