canvas/inc/rendering/isurface.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 B2IRange;
  25     class B2IPoint;
  26 }
  27
  28 namespace canvas
  29 {
  30     struct IColorBuffer;
  31
  32     struct ISurface
  33     {
  34         virtual ~ISurface() {}
  35
  36         /** Select texture behind this interface to be the current one
  37             for primitive output.
  38          */
  39         virtual bool selectTexture() = 0;
  40
  41         /** Tells whether the surface is valid or not
  42         */
  43         virtual bool isValid() = 0;
  44
  45         /** Update surface content from given IColorBuffer
  46
  47             This method updates the given subarea of the surface from
  48             the given color buffer bits.
  49
  50             @param rDestPos
  51             Position in the surface, where the subset update should
  52             have its left, top edge
  53
  54             @param rSourceRect
  55             Size and position of the rectangular subset update in the
  56             source color buffer
  57
  58             @param rSource
  59             Source bits to use for the update
  60
  61             @return true, if the update was successful
  62          */
  63         virtual bool update( const ::basegfx::B2IPoint& rDestPos,
  64                              const ::basegfx::B2IRange& rSourceRect,
  65                              IColorBuffer&              rSource ) = 0;
  66     };
  67 }
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */