ifastled.h

Go to the documentation of this file.

#pragma once
 
#include "fl/stl/span.h"
#include "fl/stl/stdint.h"
#include "fl/stl/noexcept.h"
 
namespace fl {

class IFastLED {
public:
    virtual ~IFastLED() FL_NO_EXCEPT = default;
 
    // LED array access

    virtual fl::span<CRGB> getLEDs() FL_NO_EXCEPT = 0;

    virtual size_t getNumLEDs() const FL_NO_EXCEPT = 0;
 
    // Output control

    virtual void show() FL_NO_EXCEPT = 0;

    virtual void show(u8 brightness) FL_NO_EXCEPT = 0;

    virtual void clear(bool writeToStrip = false) FL_NO_EXCEPT = 0;
 
    // Brightness

    virtual void setBrightness(u8 brightness) FL_NO_EXCEPT = 0;

    virtual u8 getBrightness() const FL_NO_EXCEPT = 0;
 
    // Color correction

    virtual void setCorrection(CRGB correction) FL_NO_EXCEPT = 0;

    virtual void setTemperature(CRGB temperature) FL_NO_EXCEPT = 0;
 
    // Timing

    virtual void delay(unsigned long ms) FL_NO_EXCEPT = 0;

    virtual void setMaxRefreshRate(u16 fps) FL_NO_EXCEPT = 0;

    virtual u16 getMaxRefreshRate() const FL_NO_EXCEPT = 0;
 
    // Advanced features (segment support for WLED)

    virtual void setSegment(size_t start, size_t end) FL_NO_EXCEPT = 0;

    virtual void clearSegment() FL_NO_EXCEPT = 0;
};
 
} // namespace fl