FastLED 3.9.7
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
fl::PixelStream Class Reference

Detailed Description

Definition at line 22 of file pixel_stream.h.

+ Inheritance diagram for fl::PixelStream:

Public Types

enum  Type { kStreaming , kFile }
 

Public Member Functions

 PixelStream (int bytes_per_frame)
 
bool begin (fl::FileHandlePtr h)
 
bool beginStream (fl::ByteStreamPtr s)
 
void close ()
 
int32_t bytesPerFrame ()
 
bool readPixel (CRGB *dst)
 
size_t readBytes (uint8_t *dst, size_t len)
 
bool readFrame (Frame *frame)
 
bool readFrameAt (uint32_t frameNumber, Frame *frame)
 
bool hasFrame (uint32_t frameNumber)
 
int32_t framesRemaining () const
 
int32_t framesDisplayed () const
 
bool available () const
 
bool atEnd () const
 
int32_t bytesRemaining () const
 
int32_t bytesRemainingInFrame () const
 
bool rewind ()
 
Type getType () const
 
- Public Member Functions inherited from fl::Referent
virtual int ref_count () const
 

Additional Inherited Members

- Protected Member Functions inherited from fl::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 fl::PixelStream::Type

Definition at line 25 of file pixel_stream.h.

Constructor & Destructor Documentation

◆ PixelStream()

fl::PixelStream::PixelStream ( int bytes_per_frame)
explicit

Definition at line 17 of file pixel_stream.cpp.

◆ ~PixelStream()

fl::PixelStream::~PixelStream ( )
protectedvirtual

Definition at line 20 of file pixel_stream.cpp.

Member Function Documentation

◆ atEnd()

bool fl::PixelStream::atEnd ( ) const

Definition at line 66 of file pixel_stream.cpp.

◆ available()

bool fl::PixelStream::available ( ) const

Definition at line 58 of file pixel_stream.cpp.

◆ begin()

bool fl::PixelStream::begin ( fl::FileHandlePtr h)

Definition at line 24 of file pixel_stream.cpp.

◆ beginStream()

bool fl::PixelStream::beginStream ( fl::ByteStreamPtr s)

Definition at line 31 of file pixel_stream.cpp.

◆ bytesPerFrame()

int32_t fl::PixelStream::bytesPerFrame ( )

Definition at line 46 of file pixel_stream.cpp.

◆ bytesRemaining()

int32_t fl::PixelStream::bytesRemaining ( ) const

Definition at line 144 of file pixel_stream.cpp.

◆ bytesRemainingInFrame()

int32_t fl::PixelStream::bytesRemainingInFrame ( ) const

Definition at line 152 of file pixel_stream.cpp.

◆ close()

void fl::PixelStream::close ( )

Definition at line 38 of file pixel_stream.cpp.

◆ framesDisplayed()

int32_t fl::PixelStream::framesDisplayed ( ) const

Definition at line 134 of file pixel_stream.cpp.

◆ framesRemaining()

int32_t fl::PixelStream::framesRemaining ( ) const

Definition at line 125 of file pixel_stream.cpp.

◆ getType()

PixelStream::Type fl::PixelStream::getType ( ) const

Definition at line 166 of file pixel_stream.cpp.

◆ hasFrame()

bool fl::PixelStream::hasFrame ( uint32_t frameNumber)

Definition at line 90 of file pixel_stream.cpp.

◆ readBytes()

size_t fl::PixelStream::readBytes ( uint8_t * dst,
size_t len )

Definition at line 170 of file pixel_stream.cpp.

◆ readFrame()

bool fl::PixelStream::readFrame ( Frame * frame)

Definition at line 74 of file pixel_stream.cpp.

◆ readFrameAt()

bool fl::PixelStream::readFrameAt ( uint32_t frameNumber,
Frame * frame )

Definition at line 101 of file pixel_stream.cpp.

◆ readPixel()

bool fl::PixelStream::readPixel ( CRGB * dst)

Definition at line 50 of file pixel_stream.cpp.

◆ rewind()

bool fl::PixelStream::rewind ( )

Definition at line 156 of file pixel_stream.cpp.

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