include/vcl/BitmapWriteAccess.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 #pragma once
  11
  12 #include <vcl/alpha.hxx>
  13 #include <vcl/bitmap.hxx>
  14 #include <vcl/BitmapReadAccess.hxx>
  15 #include <optional>
  16
  17 class VCL_DLLPUBLIC BitmapWriteAccess final : public BitmapReadAccess
  18 {
  19 public:
  20     BitmapWriteAccess(Bitmap& rBitmap);
  21     BitmapWriteAccess(AlphaMask& rBitmap);
  22     virtual ~BitmapWriteAccess() override;
  23
  24     SAL_DLLPRIVATE void CopyScanline(tools::Long nY, const BitmapReadAccess& rReadAcc);
  25     SAL_DLLPRIVATE void CopyScanline(tools::Long nY, ConstScanline aSrcScanline,
  26                                      ScanlineFormat nSrcScanlineFormat,
  27                                      sal_uInt32 nSrcScanlineSize);
  28
  29     void SetPalette(const BitmapPalette& rPalette)
  30     {
  31         assert(mpBuffer && "Access is not valid!");
  32
  33         mpBuffer->maPalette = rPalette;
  34     }
  35
  36     void SetPaletteEntryCount(sal_uInt16 nCount)
  37     {
  38         assert(mpBuffer && "Access is not valid!");
  39
  40         mpBuffer->maPalette.SetEntryCount(nCount);
  41     }
  42
  43     void SetPaletteColor(sal_uInt16 nColor, const BitmapColor& rBitmapColor)
  44     {
  45         assert(mpBuffer && "Access is not valid!");
  46         assert(HasPalette() && "Bitmap has no palette!");
  47
  48         mpBuffer->maPalette[nColor] = rBitmapColor;
  49     }
  50
  51     void SetPixel(tools::Long nY, tools::Long nX, const BitmapColor& rBitmapColor)
  52     {
  53         assert(mpBuffer && "Access is not valid!");
  54         assert(nX < mpBuffer->mnWidth && "x-coordinate out of range!");
  55         assert(nY < mpBuffer->mnHeight && "y-coordinate out of range!");
  56
  57         mFncSetPixel(GetScanline(nY), nX, rBitmapColor, maColorMask);
  58     }
  59
  60     void SetPixelIndex(tools::Long nY, tools::Long nX, sal_uInt8 cIndex)
  61     {
  62         SetPixel(nY, nX, BitmapColor(cIndex));
  63     }
  64
  65     void SetLineColor(const Color& rColor);
  66
  67     void SetFillColor();
  68     void SetFillColor(const Color& rColor);
  69
  70     void Erase(const Color& rColor);
  71
  72     SAL_DLLPRIVATE void DrawLine(const Point& rStart, const Point& rEnd);
  73
  74     void FillRect(const tools::Rectangle& rRect);
  75     void DrawRect(const tools::Rectangle& rRect);
  76
  77 private:
  78     std::optional<BitmapColor> mpLineColor;
  79     std::optional<BitmapColor> mpFillColor;
  80
  81     BitmapWriteAccess() = delete;
  82     BitmapWriteAccess(const BitmapWriteAccess&) = delete;
  83     BitmapWriteAccess& operator=(const BitmapWriteAccess&) = delete;
  84 };
  85
  86 class BitmapScopedWriteAccess
  87 {
  88 public:
  89     BitmapScopedWriteAccess(Bitmap& rBitmap)
  90         : moAccess(rBitmap)
  91     {
  92     }
  93     BitmapScopedWriteAccess(AlphaMask& rBitmap)
  94         : moAccess(rBitmap)
  95     {
  96     }
  97     BitmapScopedWriteAccess() {}
  98
  99     BitmapScopedWriteAccess& operator=(Bitmap& rBitmap)
 100     {
 101         moAccess.emplace(rBitmap);
 102         return *this;
 103     }
 104
 105     BitmapScopedWriteAccess& operator=(AlphaMask& rBitmap)
 106     {
 107         moAccess.emplace(rBitmap);
 108         return *this;
 109     }
 110
 111     bool operator!() const { return !moAccess.has_value() || !*moAccess; }
 112     explicit operator bool() const { return moAccess && bool(*moAccess); }
 113
 114     void reset() { moAccess.reset(); }
 115
 116     BitmapWriteAccess* get() { return moAccess ? &*moAccess : nullptr; }
 117     const BitmapWriteAccess* get() const { return moAccess ? &*moAccess : nullptr; }
 118
 119     BitmapWriteAccess* operator->() { return &*moAccess; }
 120     const BitmapWriteAccess* operator->() const { return &*moAccess; }
 121
 122     BitmapWriteAccess& operator*() { return *moAccess; }
 123     const BitmapWriteAccess& operator*() const { return *moAccess; }
 124
 125 private:
 126     std::optional<BitmapWriteAccess> moAccess;
 127 };
 128
 129 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */