2011-04-13 Brian Salomon <bsalomon@google.com>
[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 struct GrPlatformSurfaceDesc;
48 #endif
49
50 namespace WebCore {
51
52 #if PLATFORM(CHROMIUM)
53 struct DrawingBufferInternal;
54 #endif
55
56 // Manages a rendering target (framebuffer + attachment) for a canvas.  Can publish its rendering
57 // results to a PlatformLayer for compositing.
58 class DrawingBuffer : public RefCounted<DrawingBuffer> {
59 public:
60     friend class GraphicsContext3D;
61     
62     ~DrawingBuffer();
63
64     // Returns true if the buffer was successfully resized.
65     bool reset(const IntSize&);
66     void bind();
67     IntSize size() const { return m_size; }
68     Platform3DObject colorBuffer() const { return m_colorBuffer; }
69
70     // Clear all resources from this object, as well as context. Called when context is destroyed
71     // to prevent invalid accesses to the resources.
72     void clear();
73
74     // Create the depth/stencil and multisample buffers, if needed.
75     void createSecondaryBuffers();
76     
77     void resizeDepthStencil(int sampleCount);
78
79     // Copies the multisample color buffer to the normal color buffer and leaves m_fbo bound
80     void commit(long x = 0, long y = 0, long width = -1, long height = -1);
81     
82     bool multisample() const { return m_context && m_context->getContextAttributes().antialias && m_multisampleExtensionSupported; }
83     
84     Platform3DObject platformColorBuffer() const;
85
86 #if USE(ACCELERATED_COMPOSITING)
87     PlatformLayer* platformLayer();
88     void publishToPlatformLayer();
89 #endif
90
91 #if PLATFORM(CHROMIUM)
92     class WillPublishCallback {
93         WTF_MAKE_NONCOPYABLE(WillPublishCallback);
94     public:
95         WillPublishCallback() { }
96         virtual ~WillPublishCallback() { }
97         
98         virtual void willPublish() = 0;
99     };
100
101     void setWillPublishCallback(PassOwnPtr<WillPublishCallback> callback) { m_callback = callback; }
102 #endif
103
104 #if ENABLE(SKIA_GPU)
105     void setGrContext(GrContext* ctx);
106     void getGrPlatformSurfaceDesc(GrPlatformSurfaceDesc*);
107 #endif
108
109     PassRefPtr<GraphicsContext3D> graphicsContext3D() const { return m_context; }
110
111 private:
112     static PassRefPtr<DrawingBuffer> create(GraphicsContext3D*, const IntSize&);
113     
114     DrawingBuffer(GraphicsContext3D*, const IntSize&, bool multisampleExtensionSupported, bool packedDepthStencilExtensionSupported);
115     
116     // Platform specific function called after reset() so each platform can do extra work if needed
117     void didReset();
118
119     RefPtr<GraphicsContext3D> m_context;
120     IntSize m_size;
121     bool m_multisampleExtensionSupported;
122     bool m_packedDepthStencilExtensionSupported;
123     Platform3DObject m_fbo;
124     Platform3DObject m_colorBuffer;
125
126     // This is used when we have OES_packed_depth_stencil.
127     Platform3DObject m_depthStencilBuffer;
128
129     // These are used when we don't.
130     Platform3DObject m_depthBuffer;
131     Platform3DObject m_stencilBuffer;
132
133     // For multisampling
134     Platform3DObject m_multisampleFBO;
135     Platform3DObject m_multisampleColorBuffer;
136
137 #if PLATFORM(CHROMIUM)
138     OwnPtr<WillPublishCallback> m_callback;
139     OwnPtr<DrawingBufferInternal> m_internal;
140 #endif
141
142 #if PLATFORM(MAC)
143     RetainPtr<WebGLLayer> m_platformLayer;
144 #endif
145
146 #if ENABLE(SKIA_GPU)
147     GrContext* m_grContext;
148 #endif
149 };
150
151 } // namespace WebCore
152
153 #endif // DrawingBuffer_h