[BlackBerry] Add WebPageCompositor class to BlackBerry WebKit API
[WebKit-https.git] / Source / WebKit / blackberry / Api / WebPageCompositor.h
1 /*
2  * Copyright (C) 2011, 2012 Research In Motion Limited. All rights reserved.
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
17  */
18
19 #ifndef WebPageCompositor_h
20 #define WebPageCompositor_h
21
22 #include "BlackBerryGlobal.h"
23
24 #include <BlackBerryPlatformGLES2Context.h>
25 #include <BlackBerryPlatformGraphics.h>
26 #include <BlackBerryPlatformPrimitives.h>
27
28 namespace BlackBerry {
29 namespace WebKit {
30
31 class WebPage;
32 class WebPageCompositorClient;
33 class WebPageCompositorPrivate;
34
35 class BLACKBERRY_EXPORT WebPageCompositor {
36 public:
37     WebPageCompositor(WebPage*, WebPageCompositorClient*);
38     virtual ~WebPageCompositor();
39
40     WebPageCompositorClient* client() const;
41
42     void prepareFrame(Platform::Graphics::GLES2Context*, double timestamp);
43
44     // FIXME: dstRect should be a Platform::TransformationMatrix instead. PR142628
45     void render(Platform::Graphics::GLES2Context*, const Platform::IntRect& dstRect, const Platform::IntRect& contents);
46
47     void cleanup(Platform::Graphics::GLES2Context*);
48
49     void contextLost();
50
51 private:
52     WebPageCompositorPrivate *d;
53 };
54
55 } // namespace WebKit
56 } // namespace BlackBerry
57
58 #endif // WebPageCompositor_h