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