blend.h

Go to the documentation of this file.

/*
Fx2d class that allows to blend multiple Fx2d layers together.
The bottom layer is always drawn at full capacity. Upper layers
are blended by the the max luminance of the components.
*/
 
#pragma once
 
#include "fl/stl/stdint.h"
 
#include "fl/fx/fx2d.h"
#include "fl/stl/noexcept.h"
 
// Forward declarations to reduce header overhead
namespace fl {
class Frame;
class XYMap;
template<typename T>  // IWYU pragma: keep
class vector;  // IWYU pragma: keep
 
struct Blend2dParams {
    u8 blur_amount = 0;
    u8 blur_passes = 1;
};
 
FASTLED_SHARED_PTR(Blend2d);
 
class Blend2d : public Fx2d {
  public:
    using Params = Blend2dParams;
    // Note that if this xymap is non rectangular then it's recommended that the
    // Fx2d layers that are added should be rectangular.
    Blend2d(const XYMap &xymap) FL_NO_EXCEPT;
    fl::string fxName() const FL_NO_EXCEPT override;
    void add(Fx2dPtr layer, const Params &p = Params()) FL_NO_EXCEPT;
    void add(Fx2d &layer, const Params &p = Params()) FL_NO_EXCEPT;
    void draw(DrawContext context) FL_NO_EXCEPT override;
    void clear() FL_NO_EXCEPT;
    void setGlobalBlurAmount(u8 blur_amount) FL_NO_EXCEPT {
        mGlobalBlurAmount = blur_amount;
    }
    void setGlobalBlurPasses(u8 blur_passes) FL_NO_EXCEPT {
        mGlobalBlurPasses = blur_passes;
    }
    bool setParams(Fx2dPtr fx, const Params &p) FL_NO_EXCEPT;
    bool setParams(Fx2d &fx, const Params &p) FL_NO_EXCEPT;
 
  protected:
    struct Entry {
        Fx2dPtr fx;
        u8 blur_amount = 0;
        u8 blur_passes = 1;
        Entry() FL_NO_EXCEPT = default;
        Entry(Fx2dPtr fx, u8 blur_amount, u8 blur_passes)
            FL_NO_EXCEPT : fx(fx), blur_amount(blur_amount), blur_passes(blur_passes) {}
    };
    vector<Entry> mLayers;
    fl::shared_ptr<Frame> mFrame;
    fl::shared_ptr<Frame> mFrameTransform;
    u8 mGlobalBlurAmount = 0;
    u8 mGlobalBlurPasses = 1;
};
 
} // namespace fl