ed0c9cb97a5091dbd2411061b20709ab286def80
[WebKit-https.git] / Source / WebCore / platform / graphics / gpu / DrawingBuffer.h
1 /*
2  * Copyright (c) 2010, Google Inc. 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef DrawingBuffer_h
32 #define DrawingBuffer_h
33
34 #include "GraphicsContext3D.h"
35 #include "GraphicsLayer.h"
36 #include "IntSize.h"
37
38 #include <wtf/Noncopyable.h>
39 #include <wtf/OwnPtr.h>
40 #include <wtf/PassOwnPtr.h>
41 #if PLATFORM(MAC)
42 #include <wtf/RetainPtr.h>
43 #endif
44
45 #if ENABLE(SKIA_GPU)
46 class GrContext;
47 #endif
48
49 namespace WebCore {
50
51 #if PLATFORM(CHROMIUM)
52 struct DrawingBufferInternal;
53 #endif
54
55 // Manages a rendering target (framebuffer + attachment) for a canvas.  Can publish its rendering
56 // results to a PlatformLayer for compositing.
57 class DrawingBuffer : public RefCounted<DrawingBuffer> {
58 public:
59     friend class GraphicsContext3D;
60     
61     ~DrawingBuffer();
62
63     // Returns true if the buffer was successfully resized.
64     bool reset(const IntSize&);
65     void bind();
66     IntSize size() const { return m_size; }
67     Platform3DObject colorBuffer() const { return m_colorBuffer; }
68
69     // Clear all resources from this object, as well as context. Called when context is destroyed
70     // to prevent invalid accesses to the resources.
71     void clear();
72
73     // Create the depth/stencil and multisample buffers, if needed.
74     void createSecondaryBuffers();
75     
76     void resizeDepthStencil(int sampleCount);
77
78     // Copies the multisample color buffer to the normal color buffer and leaves m_fbo bound
79     void commit(long x = 0, long y = 0, long width = -1, long height = -1);
80     
81     bool multisample() const { return m_context && m_context->getContextAttributes().antialias && m_multisampleExtensionSupported; }
82     
83     Platform3DObject platformColorBuffer() const;
84
85 #if USE(ACCELERATED_COMPOSITING)
86     PlatformLayer* platformLayer();
87     void publishToPlatformLayer();
88 #endif
89
90 #if PLATFORM(CHROMIUM)
91     class WillPublishCallback {
92         WTF_MAKE_NONCOPYABLE(WillPublishCallback);
93     public:
94         WillPublishCallback() { }
95         virtual ~WillPublishCallback() { }
96         
97         virtual void willPublish() = 0;
98     };
99
100     void setWillPublishCallback(PassOwnPtr<WillPublishCallback> callback) { m_callback = callback; }
101 #endif
102
103 #if ENABLE(SKIA_GPU)
104     void setGrContext(GrContext* ctx);
105 #endif
106
107     PassRefPtr<GraphicsContext3D> graphicsContext3D() const { return m_context; }
108
109 private:
110     static PassRefPtr<DrawingBuffer> create(GraphicsContext3D*, const IntSize&);
111     
112     DrawingBuffer(GraphicsContext3D*, const IntSize&, bool multisampleExtensionSupported, bool packedDepthStencilExtensionSupported);
113     
114     // Platform specific function called after reset() so each platform can do extra work if needed
115     void didReset();
116
117     RefPtr<GraphicsContext3D> m_context;
118     IntSize m_size;
119     bool m_multisampleExtensionSupported;
120     bool m_packedDepthStencilExtensionSupported;
121     Platform3DObject m_fbo;
122     Platform3DObject m_colorBuffer;
123
124     // This is used when we have OES_packed_depth_stencil.
125     Platform3DObject m_depthStencilBuffer;
126
127     // These are used when we don't.
128     Platform3DObject m_depthBuffer;
129     Platform3DObject m_stencilBuffer;
130
131     // For multisampling
132     Platform3DObject m_multisampleFBO;
133     Platform3DObject m_multisampleColorBuffer;
134
135 #if PLATFORM(CHROMIUM)
136     OwnPtr<WillPublishCallback> m_callback;
137     OwnPtr<DrawingBufferInternal> m_internal;
138 #endif
139
140 #if PLATFORM(MAC)
141     RetainPtr<WebGLLayer> m_platformLayer;
142 #endif
143
144 #if ENABLE(SKIA_GPU)
145     GrContext* m_grContext;
146 #endif
147 };
148
149 } // namespace WebCore
150
151 #endif // DrawingBuffer_h