vcl/inc/salgdiimpl.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_INC_SALGDIIMPL_HXX
  21 #define INCLUDED_VCL_INC_SALGDIIMPL_HXX
  22
  23 #include <vcl/dllapi.h>
  24
  25 #include <rtl/ustring.hxx>
  26
  27 #include <tools/solar.h>
  28
  29 #include <vcl/salgtype.hxx>
  30 #include <vcl/region.hxx>
  31 #include <vcl/salnativewidgets.hxx>
  32
  33 #include <com/sun/star/drawing/LineCap.hpp>
  34
  35 class SalGraphics;
  36 class SalBitmap;
  37 class SalFrame;
  38 class Gradient;
  39 class OpenGLContext;
  40 class SalVirtualDevice;
  41
  42 class VCL_PLUGIN_PUBLIC SalGraphicsImpl
  43 {
  44 public:
  45
  46     virtual ~SalGraphicsImpl();
  47
  48     virtual void Init() = 0;
  49
  50     virtual void DeInit() {}
  51
  52     virtual void freeResources() = 0;
  53
  54     virtual bool setClipRegion( const vcl::Region& ) = 0;
  55     //
  56     // get the depth of the device
  57     virtual sal_uInt16 GetBitCount() const = 0;
  58
  59     // get the width of the device
  60     virtual long GetGraphicsWidth() const = 0;
  61
  62     // set the clip region to empty
  63     virtual void ResetClipRegion() = 0;
  64
  65     // set the line color to transparent (= don't draw lines)
  66
  67     virtual void SetLineColor() = 0;
  68
  69     // set the line color to a specific color
  70     virtual void SetLineColor( SalColor nSalColor ) = 0;
  71
  72     // set the fill color to transparent (= don't fill)
  73     virtual void SetFillColor() = 0;
  74
  75     // set the fill color to a specific color, shapes will be
  76     // filled accordingly
  77     virtual void SetFillColor( SalColor nSalColor ) = 0;
  78
  79     // enable/disable XOR drawing
  80     virtual void SetXORMode( bool bSet, bool bInvertOnly ) = 0;
  81
  82     // set line color for raster operations
  83     virtual void SetROPLineColor( SalROPColor nROPColor ) = 0;
  84
  85     // set fill color for raster operations
  86     virtual void SetROPFillColor( SalROPColor nROPColor ) = 0;
  87
  88     // draw --> LineColor and FillColor and RasterOp and ClipRegion
  89     virtual void drawPixel( long nX, long nY ) = 0;
  90     virtual void drawPixel( long nX, long nY, SalColor nSalColor ) = 0;
  91
  92     virtual void drawLine( long nX1, long nY1, long nX2, long nY2 ) = 0;
  93
  94     virtual void drawRect( long nX, long nY, long nWidth, long nHeight ) = 0;
  95
  96     virtual void drawPolyLine( sal_uInt32 nPoints, const SalPoint* pPtAry ) = 0;
  97
  98     virtual void drawPolygon( sal_uInt32 nPoints, const SalPoint* pPtAry ) = 0;
  99
 100     virtual void drawPolyPolygon( sal_uInt32 nPoly, const sal_uInt32* pPoints, PCONSTSALPOINT* pPtAry ) = 0;
 101     virtual bool drawPolyPolygon( const ::basegfx::B2DPolyPolygon&, double fTransparency ) = 0;
 102
 103     virtual bool drawPolyLine(
 104                 const ::basegfx::B2DPolygon&,
 105                 double fTransparency,
 106                 const ::basegfx::B2DVector& rLineWidths,
 107                 basegfx::B2DLineJoin,
 108                 com::sun::star::drawing::LineCap) = 0;
 109
 110     virtual bool drawPolyLineBezier(
 111                 sal_uInt32 nPoints,
 112                 const SalPoint* pPtAry,
 113                 const sal_uInt8* pFlgAry ) = 0;
 114
 115     virtual bool drawPolygonBezier(
 116                 sal_uInt32 nPoints,
 117                 const SalPoint* pPtAry,
 118                 const sal_uInt8* pFlgAry ) = 0;
 119
 120     virtual bool drawPolyPolygonBezier(
 121                 sal_uInt32 nPoly,
 122                 const sal_uInt32* pPoints,
 123                 const SalPoint* const* pPtAry,
 124                 const sal_uInt8* const* pFlgAry ) = 0;
 125
 126     // CopyArea --> No RasterOp, but ClipRegion
 127     virtual void copyArea(
 128                 long nDestX, long nDestY,
 129                 long nSrcX, long nSrcY,
 130                 long nSrcWidth, long nSrcHeight,
 131                 sal_uInt16 nFlags ) = 0;
 132
 133     // CopyBits and DrawBitmap --> RasterOp and ClipRegion
 134     // CopyBits() --> pSrcGraphics == NULL, then CopyBits on same Graphics
 135     virtual void copyBits( const SalTwoRect& rPosAry, SalGraphics* pSrcGraphics ) = 0;
 136
 137     virtual void drawBitmap( const SalTwoRect& rPosAry, const SalBitmap& rSalBitmap ) = 0;
 138
 139     virtual void drawBitmap(
 140                 const SalTwoRect& rPosAry,
 141                 const SalBitmap& rSalBitmap,
 142                 SalColor nTransparentColor ) = 0;
 143
 144     virtual void drawBitmap(
 145                 const SalTwoRect& rPosAry,
 146                 const SalBitmap& rSalBitmap,
 147                 const SalBitmap& rMaskBitmap ) = 0;
 148
 149     virtual void drawMask(
 150                 const SalTwoRect& rPosAry,
 151                 const SalBitmap& rSalBitmap,
 152                 SalColor nMaskColor ) = 0;
 153
 154     virtual SalBitmap* getBitmap( long nX, long nY, long nWidth, long nHeight ) = 0;
 155
 156     virtual SalColor getPixel( long nX, long nY ) = 0;
 157
 158     // invert --> ClipRegion (only Windows or VirDevs)
 159     virtual void invert(
 160                 long nX, long nY,
 161                 long nWidth, long nHeight,
 162                 SalInvert nFlags) = 0;
 163
 164     virtual void invert( sal_uInt32 nPoints, const SalPoint* pPtAry, SalInvert nFlags ) = 0;
 165
 166     virtual bool drawEPS(
 167                 long nX, long nY,
 168                 long nWidth, long nHeight,
 169                 void* pPtr,
 170                 sal_uLong nSize ) = 0;
 171
 172     virtual bool blendBitmap(
 173                 const SalTwoRect&,
 174                 const SalBitmap& rBitmap ) = 0;
 175
 176     virtual bool blendAlphaBitmap(
 177                 const SalTwoRect&,
 178                 const SalBitmap& rSrcBitmap,
 179                 const SalBitmap& rMaskBitmap,
 180                 const SalBitmap& rAlphaBitmap ) = 0;
 181
 182     /** Render bitmap with alpha channel
 183
 184         @param rSourceBitmap
 185         Source bitmap to blit
 186
 187         @param rAlphaBitmap
 188         Alpha channel to use for blitting
 189
 190         @return true, if the operation succeeded, and false
 191         otherwise. In this case, clients should try to emulate alpha
 192         compositing themselves
 193      */
 194     virtual bool drawAlphaBitmap(
 195                 const SalTwoRect&,
 196                 const SalBitmap& rSourceBitmap,
 197                 const SalBitmap& rAlphaBitmap ) = 0;
 198
 199     /** draw transformed bitmap (maybe with alpha) where Null, X, Y define the coordinate system */
 200     virtual bool drawTransformedBitmap(
 201                 const basegfx::B2DPoint& rNull,
 202                 const basegfx::B2DPoint& rX,
 203                 const basegfx::B2DPoint& rY,
 204                 const SalBitmap& rSourceBitmap,
 205                 const SalBitmap* pAlphaBitmap) = 0;
 206
 207     /** Render solid rectangle with given transparency
 208
 209         @param nTransparency
 210         Transparency value (0-255) to use. 0 blits and opaque, 255 a
 211         fully transparent rectangle
 212      */
 213     virtual bool drawAlphaRect(
 214                     long nX, long nY,
 215                     long nWidth, long nHeight,
 216                     sal_uInt8 nTransparency ) = 0;
 217
 218     virtual bool drawGradient(const tools::PolyPolygon& rPolygon, const Gradient& rGradient) = 0;
 219
 220     virtual OpenGLContext *beginPaint() { return NULL; }
 221 };
 222
 223 #endif
 224
 225 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */