blur.h

Go to the documentation of this file.

#pragma once
 
#include "fl/gfx/canvas.h"
#include "fl/stl/int.h"
#include "fl/stl/span.h"
#include "fl/stl/compiler_control.h"
#include "fl/stl/type_traits.h"
#include "fl/stl/noexcept.h"
 
namespace fl {
namespace gfx {


void blur1d(fl::span<CRGB> leds, fract8 blur_amount) FL_NOEXCEPT;

inline void blur1d(CRGB *leds, u16 numLeds, fract8 blur_amount) FL_NOEXCEPT {
    blur1d(fl::span<CRGB>(leds, numLeds), blur_amount);
}

void blur2d(fl::span<CRGB> leds, u8 width, u8 height, fract8 blur_amount,
            const XYMap &xymap) FL_NOEXCEPT;

inline void blur2d(CRGB *leds, u8 width, u8 height, fract8 blur_amount,
                   const XYMap &xymap) FL_NOEXCEPT {
    blur2d(fl::span<CRGB>(leds, u16(width) * u16(height)), width, height,
           blur_amount, xymap);
}

void blur2d(CRGB *leds, u8 width, u8 height, fract8 blur_amount) FL_NOEXCEPT
    FASTLED_DEPRECATED("Use blur2d(..., const XYMap& xymap) instead");

void blurRows(fl::span<CRGB> leds, u8 width, u8 height, fract8 blur_amount,
              const XYMap &xymap) FL_NOEXCEPT;

inline void blurRows(CRGB *leds, u8 width, u8 height, fract8 blur_amount,
                     const XYMap &xymap) FL_NOEXCEPT {
    blurRows(fl::span<CRGB>(leds, u16(width) * u16(height)), width, height,
             blur_amount, xymap);
}

void blurColumns(fl::span<CRGB> leds, u8 width, u8 height, fract8 blur_amount,
                 const XYMap &xymap) FL_NOEXCEPT;

inline void blurColumns(CRGB *leds, u8 width, u8 height, fract8 blur_amount,
                        const XYMap &xymap) FL_NOEXCEPT {
    blurColumns(fl::span<CRGB>(leds, u16(width) * u16(height)), width, height,
                blur_amount, xymap);
}

void blur2d(Canvas<CRGB> &canvas, alpha8 blur_amount) FL_NOEXCEPT;

void blurRows(Canvas<CRGB> &canvas, alpha8 blur_amount) FL_NOEXCEPT;

void blurColumns(Canvas<CRGB> &canvas, alpha8 blur_amount) FL_NOEXCEPT;


template <int hRadius, int vRadius, typename RGB_T>
void blurGaussian(Canvas<RGB_T> &canvas, alpha8 dimFactor) FL_NOEXCEPT;

template <int hRadius, int vRadius, typename RGB_T>
void blurGaussian(Canvas<RGB_T> &canvas, alpha16 dimFactor) FL_NOEXCEPT;

template <int hRadius, int vRadius, typename RGB_T>
inline void blurGaussian(Canvas<RGB_T> &canvas) FL_NOEXCEPT {
    blurGaussian<hRadius, vRadius>(canvas, alpha8(255));
}

template <int hRadius, int vRadius, typename RGB_T>
void blurGaussian(CanvasMapped<RGB_T> &canvas, alpha8 dimFactor) FL_NOEXCEPT;

template <int hRadius, int vRadius, typename RGB_T>
void blurGaussian(CanvasMapped<RGB_T> &canvas, alpha16 dimFactor) FL_NOEXCEPT;
 
} // namespace gfx
 
// Span-based bindings — forward fl::blur* to fl::gfx::blur*
inline void blur1d(fl::span<CRGB> leds, fract8 blur_amount) FL_NOEXCEPT {
    gfx::blur1d(leds, blur_amount);
}
inline void blur2d(fl::span<CRGB> leds, u8 width, u8 height,
                   fract8 blur_amount, const XYMap &xymap) FL_NOEXCEPT {
    gfx::blur2d(leds, width, height, blur_amount, xymap);
}
inline void blurRows(fl::span<CRGB> leds, u8 width, u8 height,
                     fract8 blur_amount, const XYMap &xymap) FL_NOEXCEPT {
    gfx::blurRows(leds, width, height, blur_amount, xymap);
}
inline void blurColumns(fl::span<CRGB> leds, u8 width, u8 height,
                        fract8 blur_amount, const XYMap &xymap) FL_NOEXCEPT {
    gfx::blurColumns(leds, width, height, blur_amount, xymap);
}
 
// Canvas-based bindings — forward fl::blur* to fl::gfx::blur*
inline void blur2d(gfx::Canvas<CRGB> &canvas, alpha8 blur_amount) FL_NOEXCEPT {
    gfx::blur2d(canvas, blur_amount);
}
inline void blurRows(gfx::Canvas<CRGB> &canvas, alpha8 blur_amount) FL_NOEXCEPT {
    gfx::blurRows(canvas, blur_amount);
}
inline void blurColumns(gfx::Canvas<CRGB> &canvas, alpha8 blur_amount) FL_NOEXCEPT {
    gfx::blurColumns(canvas, blur_amount);
}
 
// Legacy raw-pointer bindings — forward fl::blur* to fl::gfx::blur*
inline void blur1d(CRGB *leds, u16 numLeds, fract8 blur_amount) FL_NOEXCEPT {
    gfx::blur1d(leds, numLeds, blur_amount);
}
inline void blur2d(CRGB *leds, u8 width, u8 height, fract8 blur_amount,
                   const XYMap &xymap) FL_NOEXCEPT {
    gfx::blur2d(leds, width, height, blur_amount, xymap);
}
FASTLED_DEPRECATED("Use blur2d(..., const XYMap& xymap) instead") FL_NOEXCEPT
inline void blur2d(CRGB *leds, u8 width, u8 height, fract8 blur_amount) {
    FL_DISABLE_WARNING_PUSH
    FL_DISABLE_WARNING(deprecated-declarations)
    gfx::blur2d(leds, width, height, blur_amount);
    FL_DISABLE_WARNING_POP
}
inline void blurRows(CRGB *leds, u8 width, u8 height, fract8 blur_amount,
                     const XYMap &xymap) FL_NOEXCEPT {
    gfx::blurRows(leds, width, height, blur_amount, xymap);
}
inline void blurColumns(CRGB *leds, u8 width, u8 height, fract8 blur_amount,
                        const XYMap &xymap) FL_NOEXCEPT {
    gfx::blurColumns(leds, width, height, blur_amount, xymap);
}
 
} // namespace fl