include/canvas/rendering/isurfaceproxy.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_CANVAS_ISURFACEPROXY_HXX
  21 #define INCLUDED_CANVAS_ISURFACEPROXY_HXX
  22
  23 #include <canvas/rendering/irendermodule.hxx>
  24
  25 #include <boost/shared_ptr.hpp>
  26
  27 namespace basegfx
  28 {
  29     class B2DRange;
  30     class B2DPoint;
  31     class B2DPolyPolygon;
  32     class B2DHomMatrix;
  33 }
  34
  35 namespace canvas
  36 {
  37     struct ISurfaceProxy
  38     {
  39         virtual ~ISurfaceProxy() {}
  40
  41         /** Notify the proxy that the color buffer has changed
  42          */
  43         virtual void setColorBufferDirty() = 0;
  44
  45         /** Render the surface content to screen.
  46
  47             @param fAlpha
  48             Overall alpha for content
  49
  50             @param rPos
  51             Output position
  52
  53             @param rTransform
  54             Output transformation (does not affect output position)
  55          */
  56         virtual bool draw( double                         fAlpha,
  57                            const ::basegfx::B2DPoint&     rPos,
  58                            const ::basegfx::B2DHomMatrix& rTransform ) = 0;
  59
  60         /** Render the surface content to screen.
  61
  62             @param fAlpha
  63             Overall alpha for content
  64
  65             @param rPos
  66             Output position
  67
  68             @param rArea
  69             Subset of the surface to render. Coordinate system are
  70             surface area pixel, given area will be clipped to the
  71             surface bounds.
  72
  73             @param rTransform
  74             Output transformation (does not affect output position)
  75          */
  76         virtual bool draw( double                         fAlpha,
  77                            const ::basegfx::B2DPoint&     rPos,
  78                            const ::basegfx::B2DRange&     rArea,
  79                            const ::basegfx::B2DHomMatrix& rTransform ) = 0;
  80
  81         /** Render the surface content to screen.
  82
  83             @param fAlpha
  84             Overall alpha for content
  85
  86             @param rPos
  87             Output position
  88
  89             @param rClipPoly
  90             Clip polygon for the surface. The clip polygon is also
  91             subject to the output transformation.
  92
  93             @param rTransform
  94             Output transformation (does not affect output position)
  95          */
  96         virtual bool draw( double                           fAlpha,
  97                            const ::basegfx::B2DPoint&       rPos,
  98                            const ::basegfx::B2DPolyPolygon& rClipPoly,
  99                            const ::basegfx::B2DHomMatrix&   rTransform ) = 0;
 100     };
 101
 102     typedef ::boost::shared_ptr< ISurfaceProxy > ISurfaceProxySharedPtr;
 103 }
 104
 105 #endif /* INCLUDED_CANVAS_ISURFACEPROXY_HXX */
 106
 107 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */