44cc36f6bfe24ac04fe91de68c88104b49d0763a
[WebKit-https.git] / Source / WebCore / html / canvas / WebGLObject.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 WebGLObject_h
27 #define WebGLObject_h
28
29 #include "GraphicsContext3D.h"
30
31 #include <wtf/PassRefPtr.h>
32 #include <wtf/RefCounted.h>
33
34 namespace WebCore {
35
36 class WebGLRenderingContext;
37
38 class WebGLObject : public RefCounted<WebGLObject> {
39 public:
40     virtual ~WebGLObject();
41
42     Platform3DObject object() const { return m_object; }
43
44     // deleteObject may not always delete the OpenGL resource.  For programs and
45     // shaders, deletion is delayed until they are no longer attached.
46     // FIXME: revisit this when resource sharing between contexts are implemented.
47     void deleteObject();
48
49     void detachContext();
50
51     WebGLRenderingContext* context() const { return m_context; }
52
53     virtual bool isBuffer() const { return false; }
54     virtual bool isFramebuffer() const { return false; }
55     virtual bool isProgram() const { return false; }
56     virtual bool isRenderbuffer() const { return false; }
57     virtual bool isShader() const { return false; }
58     virtual bool isTexture() const { return false; }
59
60     void onAttached() { ++m_attachmentCount; }
61     void onDetached()
62     {
63         if (m_attachmentCount)
64             --m_attachmentCount;
65         if (m_deleted)
66             deleteObject();
67     }
68
69     // This indicates whether the client side issue a delete call already, not
70     // whether the OpenGL resource is deleted.
71     // object()==0 indicates the OpenGL resource is deleted.
72     bool isDeleted() { return m_deleted; }
73
74 protected:
75     WebGLObject(WebGLRenderingContext*);
76
77     // setObject should be only called once right after creating a WebGLObject.
78     void setObject(Platform3DObject);
79
80     // deleteObjectImpl should be only called once to delete the OpenGL resource.
81     virtual void deleteObjectImpl(Platform3DObject) = 0;
82
83 private:
84     Platform3DObject m_object;
85     WebGLRenderingContext* m_context;
86     unsigned m_attachmentCount;
87     bool m_deleted;
88 };
89
90 } // namespace WebCore
91
92 #endif // WebGLObject_h