Remove "virtual" from all lines that have both "virtual" and "override".
[WebKit-https.git] / Source / WebCore / html / canvas / WebGLBuffer.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 #ifndef WebGLBuffer_h
27 #define WebGLBuffer_h
28
29 #include "WebGLSharedObject.h"
30
31 #include <wtf/Forward.h>
32
33 namespace JSC {
34 class ArrayBuffer;
35 class ArrayBufferView;
36 }
37
38 namespace WebCore {
39
40 class WebGLBuffer final : public WebGLSharedObject {
41 public:
42     virtual ~WebGLBuffer();
43
44     static Ref<WebGLBuffer> create(WebGLRenderingContextBase*);
45
46     bool associateBufferData(GC3Dsizeiptr size);
47     bool associateBufferData(JSC::ArrayBuffer*);
48     bool associateBufferData(JSC::ArrayBufferView*);
49     bool associateBufferSubData(GC3Dintptr offset, JSC::ArrayBuffer*);
50     bool associateBufferSubData(GC3Dintptr offset, JSC::ArrayBufferView*);
51
52     void disassociateBufferData();
53
54     GC3Dsizeiptr byteLength() const;
55     const JSC::ArrayBuffer* elementArrayBuffer() const { return m_elementArrayBuffer.get(); }
56
57     // Gets the cached max index for the given type. Returns -1 if
58     // none has been set.
59     int getCachedMaxIndex(GC3Denum type);
60     // Sets the cached max index for the given type.
61     void setCachedMaxIndex(GC3Denum type, int value);
62
63     GC3Denum getTarget() const { return m_target; }
64     void setTarget(GC3Denum);
65
66     bool hasEverBeenBound() const { return object() && m_target; }
67
68 protected:
69     WebGLBuffer(WebGLRenderingContextBase*);
70
71     void deleteObjectImpl(GraphicsContext3D*, Platform3DObject) override;
72
73 private:
74     bool isBuffer() const override { return true; }
75
76     GC3Denum m_target;
77
78     RefPtr<JSC::ArrayBuffer> m_elementArrayBuffer;
79     GC3Dsizeiptr m_byteLength;
80
81     // Optimization for index validation. For each type of index
82     // (i.e., UNSIGNED_SHORT), cache the maximum index in the
83     // entire buffer.
84     //
85     // This is sufficient to eliminate a lot of work upon each
86     // draw call as long as all bound array buffers are at least
87     // that size.
88     struct MaxIndexCacheEntry {
89         GC3Denum type;
90         int maxIndex;
91     };
92     // OpenGL ES 2.0 only has two valid index types (UNSIGNED_BYTE
93     // and UNSIGNED_SHORT), but might as well leave open the
94     // possibility of adding others.
95     MaxIndexCacheEntry m_maxIndexCache[4];
96     unsigned int m_nextAvailableCacheEntry;
97
98     // Clears all of the cached max indices.
99     void clearCachedMaxIndices();
100
101     // Helper function called by the three associateBufferData().
102     bool associateBufferDataImpl(const void* data, GC3Dsizeiptr byteLength);
103     // Helper function called by the two associateBufferSubData().
104     bool associateBufferSubDataImpl(GC3Dintptr offset, const void* data, GC3Dsizeiptr byteLength);
105 };
106
107 } // namespace WebCore
108
109 #endif // WebGLBuffer_h