110f51395f9b78441b819d934559603281d0b4fd
[WebKit-https.git] / Source / WebCore / html / canvas / WebGLFramebuffer.h
1 /*
2  * Copyright (C) 2009 Apple 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
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 COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef WebGLFramebuffer_h
27 #define WebGLFramebuffer_h
28
29 #include "WebGLObject.h"
30
31 #include <wtf/PassRefPtr.h>
32 #include <wtf/RefCounted.h>
33
34 namespace WebCore {
35
36 class WebGLRenderbuffer;
37 class WebGLTexture;
38
39 class WebGLFramebuffer : public WebGLObject {
40 public:
41     virtual ~WebGLFramebuffer() { deleteObject(); }
42
43     static PassRefPtr<WebGLFramebuffer> create(WebGLRenderingContext*);
44
45     void setAttachmentForBoundFramebuffer(GC3Denum attachment, GC3Denum texTarget, WebGLTexture*, GC3Dint level);
46     void setAttachmentForBoundFramebuffer(GC3Denum attachment, WebGLRenderbuffer*);
47     // If an object is attached to the currently bound framebuffer, remove it.
48     void removeAttachmentFromBoundFramebuffer(WebGLObject*);
49     // If a given attachment point for the currently bound framebuffer is not null, remove the attached object.
50     void removeAttachmentFromBoundFramebuffer(GC3Denum);
51     WebGLObject* getAttachment(GC3Denum) const;
52
53     GC3Denum getColorBufferFormat() const;
54     GC3Dsizei getColorBufferWidth() const;
55     GC3Dsizei getColorBufferHeight() const;
56
57     // This should always be called before drawArray, drawElements, clear,
58     // readPixels, copyTexImage2D, copyTexSubImage2D if this framebuffer is
59     // currently bound.
60     // Return false if the framebuffer is incomplete; otherwise initialize
61     // the buffers if they haven't been initialized and
62     // needToInitializeRenderbuffers is true.
63     bool onAccess(bool needToInitializeRenderbuffers);
64
65     // Software version of glCheckFramebufferStatus(), except that when
66     // FRAMEBUFFER_COMPLETE is returned, it is still possible for
67     // glCheckFramebufferStatus() to return FRAMEBUFFER_UNSUPPORTED,
68     // depending on hardware implementation.
69     GC3Denum checkStatus() const;
70
71     bool hasEverBeenBound() const { return object() && m_hasEverBeenBound; }
72
73     void setHasEverBeenBound() { m_hasEverBeenBound = true; }
74
75 protected:
76     WebGLFramebuffer(WebGLRenderingContext*);
77
78     virtual void deleteObjectImpl(Platform3DObject);
79
80 private:
81     virtual bool isFramebuffer() const { return true; }
82
83     // Return false if framebuffer is incomplete.
84     bool initializeRenderbuffers();
85
86     // Check if the framebuffer is currently bound.
87     bool isBound() const;
88
89     bool isColorAttached() const { return (m_colorAttachment && m_colorAttachment->object()); }
90     bool isDepthAttached() const { return (m_depthAttachment && m_depthAttachment->object()); }
91     bool isStencilAttached() const { return (m_stencilAttachment && m_stencilAttachment->object()); }
92     bool isDepthStencilAttached() const { return (m_depthStencilAttachment && m_depthStencilAttachment->object()); }
93
94     RefPtr<WebGLObject> m_colorAttachment;
95     RefPtr<WebGLObject> m_depthAttachment;
96     RefPtr<WebGLObject> m_stencilAttachment;
97     RefPtr<WebGLObject> m_depthStencilAttachment;
98
99     bool m_hasEverBeenBound;
100
101     GC3Denum m_texTarget;
102     GC3Dint m_texLevel;
103 };
104
105 } // namespace WebCore
106
107 #endif // WebGLFramebuffer_h