b5988fc1134b4ec9096e11658d03f4533310ea2e
[WebKit-https.git] / Source / WebCore / platform / graphics / opengl / GLPlatformSurface.h
1 /*
2  * Copyright (C) 2012 Intel Corporation. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef GLPlatformSurface_h
27 #define GLPlatformSurface_h
28
29 #if USE(ACCELERATED_COMPOSITING)
30
31 #include "GLDefs.h"
32 #include "IntRect.h"
33 #include <wtf/Noncopyable.h>
34 #include <wtf/PassOwnPtr.h>
35
36 // Encapsulates a surface that can be rendered to with GL, hiding platform
37 // specific management.
38 namespace WebCore {
39
40 class GLPlatformSurface {
41     WTF_MAKE_NONCOPYABLE(GLPlatformSurface);
42
43 public:
44     enum Attributes {
45         Default = 0x00, // No Alpha channel. Only R,G,B values set.
46         SupportAlpha = 0x01,
47         DoubleBuffered = 0x04
48     };
49
50     typedef int SurfaceAttributes;
51     // Creates a GL surface used for offscreen rendering.
52     static PassOwnPtr<GLPlatformSurface> createOffScreenSurface(SurfaceAttributes = GLPlatformSurface::Default);
53
54     // Creates a GL surface used for offscreen rendering. The results can be transported
55     // to the UI process for display.
56     static PassOwnPtr<GLPlatformSurface> createTransportSurface(SurfaceAttributes = GLPlatformSurface::Default);
57
58     virtual ~GLPlatformSurface();
59
60     const IntRect& geometry() const;
61
62     // Get the underlying platform specific buffer handle.
63     // The handle will be null if surface doesn't support
64     // buffer sharing.
65     PlatformBufferHandle handle() const;
66
67     PlatformDrawable drawable() const;
68
69     PlatformDisplay sharedDisplay() const;
70
71     virtual SurfaceAttributes attributes() const;
72
73     virtual void swapBuffers();
74
75     // Convenience Function to update surface backbuffer with texture contents.
76     // Note that the function doesn't track or restore any GL states.
77     // Function does the following(in order):
78     // a) Blits texture contents to back buffer.
79     // b) Calls Swap Buffers.
80     virtual void updateContents(const uint32_t texture);
81
82     virtual void setGeometry(const IntRect& newRect);
83
84     virtual PlatformSurfaceConfig configuration();
85
86     virtual void destroy();
87
88 protected:
89     GLPlatformSurface(SurfaceAttributes);
90     IntRect m_rect;
91     GLuint m_fboId;
92     PlatformDisplay m_sharedDisplay;
93     PlatformDrawable m_drawable;
94     PlatformBufferHandle m_bufferHandle;
95 };
96
97 }
98
99 #endif
100
101 #endif