include/vcl/BitmapTools.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 #ifndef INCLUDED_VCL_BITMAP_TOOLS_HXX
  11 #define INCLUDED_VCL_BITMAP_TOOLS_HXX
  12
  13 #include <config_cairo_canvas.h>
  14 #include <config_wasm_strip.h>
  15
  16 #include <vcl/bitmapex.hxx>
  17 #include <vcl/ImageTree.hxx>
  18 #if ENABLE_CAIRO_CANVAS
  19 #include <vcl/cairo.hxx>
  20 #endif
  21 #include <basegfx/range/b2drectangle.hxx>
  22 #include <array>
  23 #include <vcl/RawBitmap.hxx>
  24
  25 class SvStream;
  26 namespace basegfx { class B2DHomMatrix; }
  27 namespace com::sun::star::geometry { struct IntegerRectangle2D; }
  28
  29 namespace vcl::bitmap {
  30
  31 #if !ENABLE_WASM_STRIP_PREMULTIPLY
  32 typedef std::array<std::array<sal_uInt8, 256>, 256> lookup_table;
  33
  34 VCL_DLLPUBLIC lookup_table const & get_premultiply_table();
  35 VCL_DLLPUBLIC lookup_table const & get_unpremultiply_table();
  36 #endif
  37
  38 VCL_DLLPUBLIC sal_uInt8 unpremultiply(sal_uInt8 c, sal_uInt8 a);
  39 VCL_DLLPUBLIC sal_uInt8 premultiply(sal_uInt8 c, sal_uInt8 a);
  40
  41 BitmapEx VCL_DLLPUBLIC loadFromName(const OUString& rFileName, const ImageLoadFlags eFlags = ImageLoadFlags::NONE);
  42
  43 void loadFromSvg(SvStream& rStream, const OUString& sPath, BitmapEx& rBitmapEx, double fScaleFactor);
  44
  45 /** Copy block of image data into the bitmap.
  46     Assumes that the Bitmap has been constructed with the desired size.
  47
  48     @param pData
  49     The block of data to copy
  50     @param nStride
  51     The number of bytes in a scanline, must be >= (width * bitcount / 8)
  52 */
  53 BitmapEx VCL_DLLPUBLIC CreateFromData(sal_uInt8 const *pData,
  54                                       sal_Int32 nWidth, sal_Int32 nHeight, sal_Int32 nStride,
  55                                       sal_Int8 nBitsPerPixel,
  56                                       bool bReversColors = false, bool bReverseAlpha = false);
  57
  58 BitmapEx VCL_DLLPUBLIC CreateFromData( RawBitmap && data );
  59
  60 #if ENABLE_CAIRO_CANVAS
  61 VCL_DLLPUBLIC BitmapEx* CreateFromCairoSurface(Size size, cairo_surface_t* pSurface);
  62 #endif
  63
  64 VCL_DLLPUBLIC BitmapEx CanvasTransformBitmap( const BitmapEx& rBitmap,
  65                                   const ::basegfx::B2DHomMatrix&  rTransform,
  66                                   ::basegfx::B2DRectangle const & rDestRect,
  67                                   ::basegfx::B2DHomMatrix const & rLocalTransform );
  68
  69 VCL_DLLPUBLIC void DrawAlphaBitmapAndAlphaGradient(BitmapEx & rBitmapEx, bool bFixedTransparence, float fTransparence, AlphaMask & rNewMask);
  70
  71 VCL_DLLPUBLIC void DrawAndClipBitmap(const Point& rPos, const Size& rSize, const BitmapEx& rBitmap, BitmapEx & aBmpEx, basegfx::B2DPolyPolygon const & rClipPath);
  72
  73 VCL_DLLPUBLIC css::uno::Sequence< sal_Int8 > GetMaskDIB(BitmapEx const & aBmpEx);
  74
  75 /**
  76  * @param data will be filled with alpha data, if xBitmap is alpha/transparent image
  77  * @param bHasAlpha will be set to true if resulting surface has alpha
  78  **/
  79 VCL_DLLPUBLIC void CanvasCairoExtractBitmapData( BitmapEx const & rBmpEx, Bitmap & rBitmap, unsigned char*& data, bool& bHasAlpha, tools::Long& rnWidth, tools::Long& rnHeight );
  80
  81 VCL_DLLPUBLIC css::uno::Sequence< sal_Int8 > CanvasExtractBitmapData(BitmapEx const & rBitmapEx, const css::geometry::IntegerRectangle2D& rect);
  82
  83 // helper to construct historical 8x8 bitmaps with two colors
  84
  85 BitmapEx VCL_DLLPUBLIC createHistorical8x8FromArray(std::array<sal_uInt8,64> const & pArray, Color aColorPix, Color aColorBack);
  86 bool VCL_DLLPUBLIC isHistorical8x8(const BitmapEx& rBitmapEx, Color& o_rBack, Color& o_rFront);
  87
  88 VCL_DLLPUBLIC bool convertBitmap32To24Plus8(BitmapEx const & rInput, BitmapEx & rResult);
  89
  90 /** Retrieve downsampled and cropped bitmap
  91
  92     Takes destination size in twips units.
  93
  94     @attention This method ignores negative rDstSz values, thus
  95     mirroring must happen outside this method (e.g. in DrawBitmap)
  96  */
  97 VCL_DLLPUBLIC Bitmap GetDownsampledBitmap(Size const& rDstSizeTwip, Point const& rSrcPt, Size const& rSrcSz,
  98                             Bitmap const& rBmp, tools::Long nMaxBmpDPIX, tools::Long nMaxBmpDPIY);
  99
 100 } // end vcl::bitmap
 101
 102 #endif // INCLUDED_VCL_BITMAP_TOOLS_HXX
 103
 104 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */