canvas/source/tools/surface.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_SOURCE_TOOLS_SURFACE_HXX
  21 #define INCLUDED_CANVAS_SOURCE_TOOLS_SURFACE_HXX
  22
  23 #include <basegfx/point/b2ipoint.hxx>
  24 #include <basegfx/point/b2dpoint.hxx>
  25 #include <basegfx/polygon/b2dpolygon.hxx>
  26 #include <basegfx/range/b2drectangle.hxx>
  27 #include <basegfx/vector/b2isize.hxx>
  28 #include <basegfx/matrix/b2dhommatrix.hxx>
  29 #include <canvas/rendering/irendermodule.hxx>
  30 #include <canvas/rendering/icolorbuffer.hxx>
  31 #include <canvas/rendering/isurface.hxx>
  32
  33 #include "surfacerect.hxx"
  34 #include "pagemanager.hxx"
  35
  36 namespace canvas
  37 {
  38
  39     // Surface
  40
  41
  42     /** surfaces denote occupied areas within pages.
  43
  44         pages encapsulate the hardware buffers that
  45         contain image data which can be used for texturing.
  46         surfaces are areas within those pages.
  47     */
  48     class Surface
  49     {
  50     public:
  51
  52         Surface( const PageManagerSharedPtr&  rPageManager,
  53                  const IColorBufferSharedPtr& rColorBuffer,
  54                  const ::basegfx::B2IPoint&   rPos,
  55                  const ::basegfx::B2ISize&    rSize );
  56         ~Surface();
  57
  58         void setColorBufferDirty();
  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 rTransform
  69             Output transformation (does not affect output position)
  70         */
  71         bool draw( double                         fAlpha,
  72                    const ::basegfx::B2DPoint&     rPos,
  73                    const ::basegfx::B2DHomMatrix& rTransform );
  74
  75         /** Render the surface content to screen.
  76
  77             @param fAlpha
  78             Overall alpha for content
  79
  80             @param rPos
  81             Output position
  82
  83             @param rArea
  84             Subset of the surface to render. Coordinate system are
  85             surface area pixel, given area will be clipped to the
  86             surface bounds.
  87
  88             @param rTransform
  89             Output transformation (does not affect output position)
  90         */
  91         bool drawRectangularArea(
  92             double                         fAlpha,
  93             const ::basegfx::B2DPoint&     rPos,
  94             const ::basegfx::B2DRange&     rArea,
  95             const ::basegfx::B2DHomMatrix& rTransform );
  96
  97         /** Render the surface content to screen.
  98
  99             @param fAlpha
 100             Overall alpha for content
 101
 102             @param rPos
 103             Output position
 104
 105             @param rClipPoly
 106             Clip polygon for the surface. The clip polygon is also
 107             subject to the output transformation.
 108
 109             @param rTransform
 110             Output transformation (does not affect output position)
 111         */
 112         bool drawWithClip( double                           fAlpha,
 113                            const ::basegfx::B2DPoint&       rPos,
 114                            const ::basegfx::B2DPolygon&     rClipPoly,
 115                            const ::basegfx::B2DHomMatrix&   rTransform );
 116
 117         // private attributes
 118     private:
 119         IColorBufferSharedPtr mpColorBuffer;
 120
 121         // invoking any of the above defined 'draw' methods
 122         // will forward primitive commands to the rendermodule.
 123         PageManagerSharedPtr  mpPageManager;
 124
 125         FragmentSharedPtr     mpFragment;
 126
 127         // the offset of this surface with regard to the source
 128         // image. if the source image had to be tiled into multiple
 129         // surfaces, this offset denotes the relative pixel distance
 130         // from the source image's upper, left corner
 131         ::basegfx::B2IPoint   maSourceOffset;
 132
 133         // the size in pixels of this surface. please note that
 134         // this size is likely to be smaller than the size of
 135         // the colorbuffer we're associated with since we
 136         // maybe represent only a part of it.
 137         ::basegfx::B2ISize    maSize;
 138
 139         bool                  mbIsDirty;
 140
 141         // private methods
 142     private:
 143         bool refresh( canvas::IColorBuffer& rBuffer ) const;
 144         void prepareRendering();
 145
 146         basegfx::B2DRectangle getUVCoords() const;
 147         basegfx::B2DRectangle getUVCoords( const ::basegfx::B2IPoint& rPos,
 148                                            const ::basegfx::B2ISize&  rSize ) const;
 149     };
 150
 151     typedef ::boost::shared_ptr< Surface > SurfaceSharedPtr;
 152 }
 153
 154 #endif
 155
 156 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */