fl::Video Class Reference

Detailed Description

Definition at line 30 of file video.h.

Inheritance diagram for fl::Video:

Public Member Functions
	Video (size_t pixelsPerFrame, float fps=30.0f, size_t frameHistoryCount=DefaultFrameHistoryCount())
	Video (const Video &)
Video &	operator= (const Video &)
void	draw (DrawContext context) override
Str	fxName () const override
bool	begin (fl::FileHandlePtr h)
bool	beginStream (fl::ByteStreamPtr s)
bool	draw (uint32_t now, CRGB *leds)
bool	draw (uint32_t now, Frame *frame)
void	end ()
bool	finished ()
bool	rewind ()
void	setTimeScale (float timeScale)
float	timeScale () const
Str	error () const
void	setError (const Str &error)
size_t	pixelsPerFrame () const
void	pause (uint32_t now) override
void	resume (uint32_t now) override
	operator bool () const
Public Member Functions inherited from fl::Fx1d
	Fx1d (uint16_t numLeds)
void	setXmap (const XMap &xMap)
uint16_t	xyMap (uint16_t x) const
Public Member Functions inherited from fl::Fx
	Fx (uint16_t numLeds)
virtual bool	hasFixedFrameRate (float *fps) const
uint16_t	getNumLeds () const
Public Member Functions inherited from fl::Referent
virtual int	ref_count () const

Static Public Member Functions
static size_t	DefaultFrameHistoryCount ()

Additional Inherited Members
Public Types inherited from fl::Fx
using	DrawContext = _DrawContext
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 ()
Protected Attributes inherited from fl::Fx1d
XMap	mXMap
Protected Attributes inherited from fl::Fx
uint16_t	mNumLeds

Constructor & Destructor Documentation

Video() [1/2]

fl::Video::Video

(

)

Definition at line 28 of file video.cpp.

Video() [2/2]

fl::Video::Video	(	size_t	pixelsPerFrame,
		float	fps = 30.0f,
		size_t	frameHistoryCount = DefaultFrameHistoryCount() )

Definition at line 31 of file video.cpp.

Member Function Documentation

begin()

bool fl::Video::begin

(

fl::FileHandlePtr

h

)

Definition at line 51 of file video.cpp.

beginStream()

bool fl::Video::beginStream

(

fl::ByteStreamPtr

s

)

Definition at line 70 of file video.cpp.

DefaultFrameHistoryCount()

static size_t fl::Video::DefaultFrameHistoryCount ( )

inlinestatic

Definition at line 32 of file video.h.

draw() [1/3]

void fl::Video::draw ( DrawContext context )

overridevirtual

Parameters

now	The current time in milliseconds. Fx writers are encouraged to use this instead of millis() directly as this will more deterministic behavior.

Implements fl::Fx.

Definition at line 98 of file video.cpp.

draw() [2/3]

bool fl::Video::draw	(	uint32_t	now,
		CRGB *	leds )

Definition at line 85 of file video.cpp.

draw() [3/3]

bool fl::Video::draw	(	uint32_t	now,
		Frame *	frame )

Definition at line 110 of file video.cpp.

end()

void fl::Video::end

(

)

Definition at line 117 of file video.cpp.

error()

Str fl::Video::error

(

)

const

Definition at line 137 of file video.cpp.

finished()

bool fl::Video::finished

(

)

Definition at line 148 of file video.cpp.

fxName()

Str fl::Video::fxName ( ) const

overridevirtual

Implements fl::Fx.

Definition at line 106 of file video.cpp.

operator bool()

fl::Video::operator bool ( ) const

inline

Definition at line 71 of file video.h.

pause()

void fl::Video::pause ( uint32_t now )

overridevirtual

Reimplemented from fl::Fx.

Definition at line 35 of file video.cpp.

pixelsPerFrame()

size_t fl::Video::pixelsPerFrame

(

)

const

Definition at line 141 of file video.cpp.

resume()

void fl::Video::resume ( uint32_t now )

overridevirtual

Reimplemented from fl::Fx.

Definition at line 41 of file video.cpp.

rewind()

bool fl::Video::rewind

(

)

Definition at line 155 of file video.cpp.

setError()

void fl::Video::setError ( const Str & error )

inline

Definition at line 65 of file video.h.

setTimeScale()

void fl::Video::setTimeScale

(

float

timeScale

)

Definition at line 123 of file video.cpp.

timeScale()

float fl::Video::timeScale

(

)

const

Definition at line 130 of file video.cpp.

---

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

• /home/runner/work/FastLED/FastLED/src/fx/video.h
• /home/runner/work/FastLED/FastLED/src/fx/video.cpp