xref: /AOO41X/main/canvas/inc/canvas/rendering/isurface.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef INCLUDED_CANVAS_ISURFACE_HXX
29*cdf0e10cSrcweir #define INCLUDED_CANVAS_ISURFACE_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include <sal/types.h>
32*cdf0e10cSrcweir 
33*cdf0e10cSrcweir #include <boost/shared_ptr.hpp>
34*cdf0e10cSrcweir 
35*cdf0e10cSrcweir 
36*cdf0e10cSrcweir namespace basegfx
37*cdf0e10cSrcweir {
38*cdf0e10cSrcweir     class B2IRange;
39*cdf0e10cSrcweir     class B2IPoint;
40*cdf0e10cSrcweir 	class B2IVector;
41*cdf0e10cSrcweir }
42*cdf0e10cSrcweir 
43*cdf0e10cSrcweir namespace canvas
44*cdf0e10cSrcweir {
45*cdf0e10cSrcweir     struct IColorBuffer;
46*cdf0e10cSrcweir 
47*cdf0e10cSrcweir 	struct ISurface
48*cdf0e10cSrcweir 	{
49*cdf0e10cSrcweir         virtual ~ISurface() {}
50*cdf0e10cSrcweir 
51*cdf0e10cSrcweir         /** Select texture behind this interface to be the current one
52*cdf0e10cSrcweir             for primitive output.
53*cdf0e10cSrcweir          */
54*cdf0e10cSrcweir 		virtual bool selectTexture() = 0;
55*cdf0e10cSrcweir 
56*cdf0e10cSrcweir 		/** Tells wether the surface is valid or not
57*cdf0e10cSrcweir 		*/
58*cdf0e10cSrcweir 		virtual bool isValid() = 0;
59*cdf0e10cSrcweir 
60*cdf0e10cSrcweir         /** Update surface content from given IColorBuffer
61*cdf0e10cSrcweir 
62*cdf0e10cSrcweir             This method updates the given subarea of the surface from
63*cdf0e10cSrcweir             the given color buffer bits.
64*cdf0e10cSrcweir 
65*cdf0e10cSrcweir             @param rDestPos
66*cdf0e10cSrcweir             Position in the surface, where the subset update should
67*cdf0e10cSrcweir             have its left, top edge
68*cdf0e10cSrcweir 
69*cdf0e10cSrcweir             @param rSourceRect
70*cdf0e10cSrcweir             Size and position of the rectangular subset update in the
71*cdf0e10cSrcweir             source color buffer
72*cdf0e10cSrcweir 
73*cdf0e10cSrcweir             @param rSource
74*cdf0e10cSrcweir             Source bits to use for the update
75*cdf0e10cSrcweir 
76*cdf0e10cSrcweir             @return true, if the update was successful
77*cdf0e10cSrcweir          */
78*cdf0e10cSrcweir 		virtual bool update( const ::basegfx::B2IPoint& rDestPos,
79*cdf0e10cSrcweir                              const ::basegfx::B2IRange& rSourceRect,
80*cdf0e10cSrcweir                              IColorBuffer&              rSource ) = 0;
81*cdf0e10cSrcweir 
82*cdf0e10cSrcweir 		virtual ::basegfx::B2IVector getSize() = 0;
83*cdf0e10cSrcweir 	};
84*cdf0e10cSrcweir 
85*cdf0e10cSrcweir     typedef ::boost::shared_ptr< ISurface > ISurfaceSharedPtr;
86*cdf0e10cSrcweir }
87*cdf0e10cSrcweir 
88*cdf0e10cSrcweir #endif /* INCLUDED_CANVAS_ISURFACE_HXX */
89