filter.h

// Aseprite
// Copyright (C) 2019  Igara Studio S.A.
// Copyright (C) 2001-2015  David Capello
//
// This program is distributed under the terms of
// the End-User License Agreement for Aseprite.

#ifndef FILTERS_FILTER_H_INCLUDED
#define FILTERS_FILTER_H_INCLUDED
#pragma once

namespace doc {
  class PalettePicks;
}

namespace filters {

  class FilterManager;

  // Interface which applies a filter to a sprite given a FilterManager
  // which indicates where we have to apply the filter.
  class Filter {
  public:
    virtual ~Filter() { }

    // Returns a proper name for the filter. It is used to show a label
    // with the Undo action.
    virtual const char* getName() = 0;

    // Applies the filter to one RGBA row. You must use
    // FilterManager::getSourceAddress() and advance 32 bits to modify
    // each pixel.
    virtual void applyToRgba(FilterManager* filterMgr) = 0;

    // Applies the filter to one grayscale row. You must use
    // FilterManager::getSourceAddress() and advance 16 bits to modify
    // each pixel.
    virtual void applyToGrayscale(FilterManager* filterMgr) = 0;

    // Applies the filter to one indexed row. You must use
    // FilterManager::getSourceAddress() and advance 8 bits to modify
    // each pixel.
    virtual void applyToIndexed(FilterManager* filterMgr) = 0;

    // Applies the filter to the color palette.
    virtual void applyToPalette(FilterManager* filterMgr) { }
  };

  // Filter that support applying it only to palette colors.
  class FilterWithPalette : public Filter {
  public:
    FilterWithPalette();
    void applyToPalette(FilterManager* filterMgr) override;

  protected:
    virtual void onApplyToPalette(FilterManager* filterMgr,
                                  const doc::PalettePicks& picks) = 0;

    // Use the palette to replace colors in RGB images
    bool m_usePaletteOnRGB;
  };

} // namespace filters

#endif