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