initial commit

libraries/FastLED/src/fx/frame.h

@@ -0,0 +1,52 @@
+#pragma once
+
+#include <string.h>
+
+#include "crgb.h"
+#include "fl/namespace.h"
+#include "fl/memory.h"
+#include "fl/xymap.h"
+#include "fl/vector.h"
+
+#include "fl/allocator.h"
+#include "fl/draw_mode.h"
+
+namespace fl {
+
+FASTLED_SMART_PTR(Frame);
+
+// Frames are used to hold led data. This includes an optional alpha channel.
+// This object is used by the fx and video engines. Most of the memory used for
+// Fx and Video will be located in instances of this class. See
+// Frame::SetAllocator() for custom memory allocation.
+class Frame {
+  public:
+    // Frames take up a lot of memory. On some devices like ESP32 there is
+    // PSRAM available. You should see allocator.h ->
+    // SetPSRamAllocator(...) on setting a custom allocator for these large
+    // blocks.
+    explicit Frame(int pixels_per_frame);
+    ~Frame();
+    CRGB *rgb() { return mRgb.data(); }
+    const CRGB *rgb() const { return mRgb.data(); }
+    size_t size() const { return mPixelsCount; }
+    void copy(const Frame &other);
+    void interpolate(const Frame &frame1, const Frame &frame2,
+                     uint8_t amountOfFrame2);
+    static void interpolate(const Frame &frame1, const Frame &frame2,
+                            uint8_t amountofFrame2, CRGB *pixels);
+    void draw(CRGB *leds, DrawMode draw_mode = DRAW_MODE_OVERWRITE) const;
+    void drawXY(CRGB *leds, const XYMap &xyMap,
+                DrawMode draw_mode = DRAW_MODE_OVERWRITE) const;
+    void clear();
+
+  private:
+    const size_t mPixelsCount;
+    fl::vector<CRGB, fl::allocator_psram<CRGB>> mRgb;
+};
+
+inline void Frame::copy(const Frame &other) {
+    memcpy(mRgb.data(), other.mRgb.data(), other.mPixelsCount * sizeof(CRGB));
+}
+
+} // namespace fl