1*91c99ff4SAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
3*91c99ff4SAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4*91c99ff4SAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5*91c99ff4SAndrew Rist  * distributed with this work for additional information
6*91c99ff4SAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7*91c99ff4SAndrew Rist  * to you under the Apache License, Version 2.0 (the
8*91c99ff4SAndrew Rist  * "License"); you may not use this file except in compliance
9*91c99ff4SAndrew Rist  * with the License.  You may obtain a copy of the License at
10*91c99ff4SAndrew Rist  *
11*91c99ff4SAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12*91c99ff4SAndrew Rist  *
13*91c99ff4SAndrew Rist  * Unless required by applicable law or agreed to in writing,
14*91c99ff4SAndrew Rist  * software distributed under the License is distributed on an
15*91c99ff4SAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*91c99ff4SAndrew Rist  * KIND, either express or implied.  See the License for the
17*91c99ff4SAndrew Rist  * specific language governing permissions and limitations
18*91c99ff4SAndrew Rist  * under the License.
19*91c99ff4SAndrew Rist  *
20*91c99ff4SAndrew Rist  *************************************************************/
21*91c99ff4SAndrew Rist 
22*91c99ff4SAndrew Rist 
23cdf0e10cSrcweir 
24cdf0e10cSrcweir #ifndef INCLUDED_CANVAS_ISURFACE_HXX
25cdf0e10cSrcweir #define INCLUDED_CANVAS_ISURFACE_HXX
26cdf0e10cSrcweir 
27cdf0e10cSrcweir #include <sal/types.h>
28cdf0e10cSrcweir 
29cdf0e10cSrcweir #include <boost/shared_ptr.hpp>
30cdf0e10cSrcweir 
31cdf0e10cSrcweir 
32cdf0e10cSrcweir namespace basegfx
33cdf0e10cSrcweir {
34cdf0e10cSrcweir     class B2IRange;
35cdf0e10cSrcweir     class B2IPoint;
36cdf0e10cSrcweir 	class B2IVector;
37cdf0e10cSrcweir }
38cdf0e10cSrcweir 
39cdf0e10cSrcweir namespace canvas
40cdf0e10cSrcweir {
41cdf0e10cSrcweir     struct IColorBuffer;
42cdf0e10cSrcweir 
43cdf0e10cSrcweir 	struct ISurface
44cdf0e10cSrcweir 	{
~ISurfacecanvas::ISurface45cdf0e10cSrcweir         virtual ~ISurface() {}
46cdf0e10cSrcweir 
47cdf0e10cSrcweir         /** Select texture behind this interface to be the current one
48cdf0e10cSrcweir             for primitive output.
49cdf0e10cSrcweir          */
50cdf0e10cSrcweir 		virtual bool selectTexture() = 0;
51cdf0e10cSrcweir 
52cdf0e10cSrcweir 		/** Tells wether the surface is valid or not
53cdf0e10cSrcweir 		*/
54cdf0e10cSrcweir 		virtual bool isValid() = 0;
55cdf0e10cSrcweir 
56cdf0e10cSrcweir         /** Update surface content from given IColorBuffer
57cdf0e10cSrcweir 
58cdf0e10cSrcweir             This method updates the given subarea of the surface from
59cdf0e10cSrcweir             the given color buffer bits.
60cdf0e10cSrcweir 
61cdf0e10cSrcweir             @param rDestPos
62cdf0e10cSrcweir             Position in the surface, where the subset update should
63cdf0e10cSrcweir             have its left, top edge
64cdf0e10cSrcweir 
65cdf0e10cSrcweir             @param rSourceRect
66cdf0e10cSrcweir             Size and position of the rectangular subset update in the
67cdf0e10cSrcweir             source color buffer
68cdf0e10cSrcweir 
69cdf0e10cSrcweir             @param rSource
70cdf0e10cSrcweir             Source bits to use for the update
71cdf0e10cSrcweir 
72cdf0e10cSrcweir             @return true, if the update was successful
73cdf0e10cSrcweir          */
74cdf0e10cSrcweir 		virtual bool update( const ::basegfx::B2IPoint& rDestPos,
75cdf0e10cSrcweir                              const ::basegfx::B2IRange& rSourceRect,
76cdf0e10cSrcweir                              IColorBuffer&              rSource ) = 0;
77cdf0e10cSrcweir 
78cdf0e10cSrcweir 		virtual ::basegfx::B2IVector getSize() = 0;
79cdf0e10cSrcweir 	};
80cdf0e10cSrcweir 
81cdf0e10cSrcweir     typedef ::boost::shared_ptr< ISurface > ISurfaceSharedPtr;
82cdf0e10cSrcweir }
83cdf0e10cSrcweir 
84cdf0e10cSrcweir #endif /* INCLUDED_CANVAS_ISURFACE_HXX */
85