Unreviewed. Restabilize non-unified build.
[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 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 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 #pragma once
27
28 #if ENABLE(WEBGL)
29
30 #include "WebGLContextObject.h"
31 #include "WebGLSharedObject.h"
32 #include <wtf/HashMap.h>
33 #include <wtf/RefCounted.h>
34 #include <wtf/Vector.h>
35
36 namespace WebCore {
37
38 class WebGLRenderbuffer;
39 class WebGLTexture;
40
41 class WebGLFramebuffer final : public WebGLContextObject {
42 public:
43     class WebGLAttachment : public RefCounted<WebGLAttachment> {
44     public:
45         virtual ~WebGLAttachment();
46
47         virtual GC3Dsizei getWidth() const = 0;
48         virtual GC3Dsizei getHeight() const = 0;
49         virtual GC3Denum getFormat() const = 0;
50         virtual WebGLSharedObject* getObject() const = 0;
51         virtual bool isSharedObject(WebGLSharedObject*) const = 0;
52         virtual bool isValid() const = 0;
53         virtual bool isInitialized() const = 0;
54         virtual void setInitialized() = 0;
55         virtual void onDetached(GraphicsContext3D*) = 0;
56         virtual void attach(GraphicsContext3D*, GC3Denum attachment) = 0;
57         virtual void unattach(GraphicsContext3D*, GC3Denum attachment) = 0;
58
59     protected:
60         WebGLAttachment();
61     };
62
63     virtual ~WebGLFramebuffer();
64
65     static Ref<WebGLFramebuffer> create(WebGLRenderingContextBase&);
66
67     void setAttachmentForBoundFramebuffer(GC3Denum attachment, GC3Denum texTarget, WebGLTexture*, GC3Dint level);
68     void setAttachmentForBoundFramebuffer(GC3Denum attachment, WebGLRenderbuffer*);
69     // If an object is attached to the currently bound framebuffer, remove it.
70     void removeAttachmentFromBoundFramebuffer(WebGLSharedObject*);
71     // If a given attachment point for the currently bound framebuffer is not null, remove the attached object.
72     void removeAttachmentFromBoundFramebuffer(GC3Denum);
73     WebGLSharedObject* getAttachmentObject(GC3Denum) const;
74
75     GC3Denum getColorBufferFormat() const;
76     GC3Dsizei getColorBufferWidth() const;
77     GC3Dsizei getColorBufferHeight() const;
78
79     // This should always be called before drawArray, drawElements, clear,
80     // readPixels, copyTexImage2D, copyTexSubImage2D if this framebuffer is
81     // currently bound.
82     // Return false if the framebuffer is incomplete; otherwise initialize
83     // the buffers if they haven't been initialized and
84     // needToInitializeAttachments is true.
85     bool onAccess(GraphicsContext3D*, const char** reason);
86
87     // Software version of glCheckFramebufferStatus(), except that when
88     // FRAMEBUFFER_COMPLETE is returned, it is still possible for
89     // glCheckFramebufferStatus() to return FRAMEBUFFER_UNSUPPORTED,
90     // depending on hardware implementation.
91     GC3Denum checkStatus(const char** reason) const;
92
93     bool hasEverBeenBound() const { return object() && m_hasEverBeenBound; }
94
95     void setHasEverBeenBound() { m_hasEverBeenBound = true; }
96
97     bool hasStencilBuffer() const;
98
99     // Wrapper for drawBuffersEXT/drawBuffersARB to work around a driver bug.
100     void drawBuffers(const Vector<GC3Denum>& bufs);
101
102     GC3Denum getDrawBuffer(GC3Denum);
103
104 protected:
105     WebGLFramebuffer(WebGLRenderingContextBase&);
106
107     void deleteObjectImpl(GraphicsContext3D*, Platform3DObject) override;
108
109 private:
110     WebGLAttachment* getAttachment(GC3Denum) const;
111
112     // Return false if framebuffer is incomplete.
113     bool initializeAttachments(GraphicsContext3D*, const char** reason);
114
115     // Check if the framebuffer is currently bound.
116     bool isBound() const;
117
118     // attach 'attachment' at 'attachmentPoint'.
119     void attach(GC3Denum attachment, GC3Denum attachmentPoint);
120
121     // Check if a new drawBuffers call should be issued. This is called when we add or remove an attachment.
122     void drawBuffersIfNecessary(bool force);
123
124     typedef WTF::HashMap<GC3Denum, RefPtr<WebGLAttachment>> AttachmentMap;
125
126     AttachmentMap m_attachments;
127
128     bool m_hasEverBeenBound;
129
130     Vector<GC3Denum> m_drawBuffers;
131     Vector<GC3Denum> m_filteredDrawBuffers;
132 };
133
134 } // namespace WebCore
135
136 #endif