include/vcl/BitmapMonochromeFilter.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  */
  10
  11 #ifndef INCLUDED_INCLUDE_VCL_BITMAPMONOCHROMEFILTER_HXX
  12 #define INCLUDED_INCLUDE_VCL_BITMAPMONOCHROMEFILTER_HXX
  13
  14 #include <vcl/BitmapFilter.hxx>
  15
  16 class VCL_DLLPUBLIC BitmapMonochromeFilter final : public BitmapFilter
  17 {
  18 public:
  19     /** Convert to 2 color bitmap.
  20
  21         Converts to a 2 color indexed bitmap - note that we don't change to black
  22         and white monochrome, but we pick the closest color to black and white in
  23         the bitmap.
  24
  25         @param cThreshold
  26         Luminance value that determines whether the colour should be black (or
  27         closest color to black) or white (or closest color to white).
  28
  29      */
  30     BitmapMonochromeFilter(sal_uInt8 cThreshold)
  31         : mcThreshold(cThreshold)
  32     {
  33     }
  34
  35     virtual BitmapEx execute(BitmapEx const& rBitmapEx) const override;
  36
  37 private:
  38     sal_uInt8 const mcThreshold;
  39 };
  40
  41 #endif
  42
  43 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */