include/vcl/alpha.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  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_VCL_ALPHA_HXX
  21 #define INCLUDED_VCL_ALPHA_HXX
  22
  23 #include <sal/config.h>
  24
  25 #include <utility>
  26
  27 #include <vcl/dllapi.h>
  28 #include <vcl/bitmap.hxx>
  29
  30 class BitmapEx;
  31
  32 class VCL_DLLPUBLIC AlphaMask final
  33 {
  34 public:
  35                 AlphaMask();
  36     explicit    AlphaMask( const Bitmap& rBitmap );
  37                 AlphaMask( const AlphaMask& rAlphaMask );
  38                 AlphaMask( AlphaMask&& rAlphaMask );
  39     explicit    AlphaMask( const Size& rSizePixel, const sal_uInt8* pEraseTransparency = nullptr );
  40                 ~AlphaMask();
  41
  42     AlphaMask&  operator=( const Bitmap& rBitmap );
  43     AlphaMask&  operator=( const AlphaMask& rAlphaMask ) { maBitmap = rAlphaMask.maBitmap; return *this; }
  44     AlphaMask&  operator=( AlphaMask&& rAlphaMask ) noexcept { maBitmap = std::move(rAlphaMask.maBitmap); return *this; }
  45     bool        operator==( const AlphaMask& rAlphaMask ) const { return maBitmap == rAlphaMask.maBitmap; }
  46     bool        operator!=( const AlphaMask& rAlphaMask ) const { return maBitmap != rAlphaMask.maBitmap; }
  47
  48     Bitmap const & GetBitmap() const { return maBitmap; }
  49
  50     void        Erase( sal_uInt8 cTransparency );
  51     void        BlendWith(const AlphaMask& rOther);
  52
  53     /** Perform boolean OR operation with another alpha-mask
  54
  55         @param rMask
  56         The mask bitmap in the selected combine operation
  57
  58         @return true, if the operation was completed successfully.
  59      */
  60     bool        AlphaCombineOr( const AlphaMask& rMask );
  61
  62     // check if alpha is used, returns true if at least one pixel has transparence
  63     bool        hasAlpha() const;
  64
  65     bool IsEmpty() const { return maBitmap.IsEmpty(); }
  66
  67     void SetEmpty() { maBitmap.SetEmpty(); }
  68
  69     vcl::PixelFormat getPixelFormat() const { return maBitmap.getPixelFormat(); }
  70
  71     sal_Int64 GetSizeBytes() const { return maBitmap.GetSizeBytes(); }
  72
  73     Size GetSizePixel() const { return maBitmap.GetSizePixel(); }
  74
  75     void SetPrefSize( const Size& rSize ) { maBitmap.SetPrefSize(rSize); }
  76
  77     void SetPrefMapMode( const MapMode& rMapMode ) { maBitmap.SetPrefMapMode(rMapMode); }
  78
  79     BitmapChecksum GetChecksum() const { return maBitmap.GetChecksum(); }
  80
  81     bool Invert();
  82
  83     bool Mirror( BmpMirrorFlags nMirrorFlags ) { return maBitmap.Mirror(nMirrorFlags); }
  84
  85     bool Scale( const Size& rNewSize, BmpScaleFlag nScaleFlag = BmpScaleFlag::Default ) { return maBitmap.Scale(rNewSize, nScaleFlag); }
  86
  87     bool Scale( const double& rScaleX, const double& rScaleY, BmpScaleFlag nScaleFlag = BmpScaleFlag::Default )
  88     { return maBitmap.Scale(rScaleX, rScaleY, nScaleFlag); }
  89
  90     bool Convert( BmpConversion eConversion ) { return maBitmap.Convert(eConversion); }
  91
  92     vcl::Region CreateRegion( const Color& rColor, const tools::Rectangle& rRect ) const { return maBitmap.CreateRegion(rColor, rRect); }
  93
  94     bool Rotate( Degree10 nAngle10, const Color& rFillColor ) { return maBitmap.Rotate(nAngle10, rFillColor); }
  95
  96     bool Crop( const tools::Rectangle& rRectPixel ) { return maBitmap.Crop(rRectPixel); }
  97
  98     bool Expand( sal_Int32 nDX, sal_Int32 nDY, const Color* pInitColor = nullptr ) { return maBitmap.Expand(nDX, nDY, pInitColor); }
  99
 100     bool CopyPixel( const tools::Rectangle& rRectDst,
 101                     const tools::Rectangle& rRectSrc )
 102     { return maBitmap.CopyPixel(rRectDst, rRectSrc); }
 103
 104     bool CopyPixel( const tools::Rectangle& rRectDst,
 105                     const tools::Rectangle& rRectSrc,
 106                     const AlphaMask& rBmpSrc )
 107     { return maBitmap.CopyPixel(rRectDst, rRectSrc, rBmpSrc.maBitmap); }
 108
 109     bool CopyPixel_AlphaOptimized(
 110                     const tools::Rectangle& rRectDst,
 111                     const tools::Rectangle& rRectSrc )
 112     { return maBitmap.CopyPixel_AlphaOptimized(rRectDst, rRectSrc); }
 113
 114     bool CopyPixel_AlphaOptimized(
 115                     const tools::Rectangle& rRectDst,
 116                     const tools::Rectangle& rRectSrc,
 117                     const AlphaMask& rBmpSrc )
 118     { return maBitmap.CopyPixel_AlphaOptimized(rRectDst, rRectSrc, rBmpSrc); }
 119
 120 private:
 121     friend class BitmapEx;
 122     friend class ::OutputDevice;
 123     friend bool VCL_DLLPUBLIC ReadDIBBitmapEx(BitmapEx& rTarget, SvStream& rIStm, bool bFileHeader, bool bMSOFormat);
 124
 125     Bitmap maBitmap;
 126 };
 127
 128 #endif // INCLUDED_VCL_ALPHA_HXX
 129
 130 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */