b0ced02957c687acca2458185102b511fe73b632
[WebKit-https.git] / Source / WebCore / html / canvas / WebGLBuffer.h
1 /*
2  * Copyright (C) 2009-2017 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 "WebGLSharedObject.h"
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     static Ref<WebGLBuffer> create(WebGLRenderingContextBase&);
43     virtual ~WebGLBuffer();
44
45     bool associateBufferData(GC3Dsizeiptr size);
46     bool associateBufferData(JSC::ArrayBuffer*);
47     bool associateBufferData(JSC::ArrayBufferView*);
48     bool associateBufferSubData(GC3Dintptr offset, JSC::ArrayBuffer*);
49     bool associateBufferSubData(GC3Dintptr offset, JSC::ArrayBufferView*);
50     bool associateCopyBufferSubData(const WebGLBuffer& readBuffer, GC3Dintptr readOffset, GC3Dintptr writeOffset, GC3Dsizeiptr);
51
52     void disassociateBufferData();
53
54     GC3Dsizeiptr byteLength() const;
55     const RefPtr<JSC::ArrayBuffer> elementArrayBuffer() const { return m_elementArrayBuffer; }
56
57     // Gets the cached max index for the given type if one has been set.
58     Optional<unsigned> getCachedMaxIndex(GC3Denum type);
59     // Sets the cached max index for the given type.
60     void setCachedMaxIndex(GC3Denum type, unsigned value);
61
62     GC3Denum getTarget() const { return m_target; }
63     void setTarget(GC3Denum, bool forWebGL2);
64
65     bool hasEverBeenBound() const { return object() && m_target; }
66
67 protected:
68     WebGLBuffer(WebGLRenderingContextBase&);
69
70     void deleteObjectImpl(GraphicsContext3D*, Platform3DObject) override;
71
72 private:
73     GC3Denum m_target { 0 };
74
75     RefPtr<JSC::ArrayBuffer> m_elementArrayBuffer;
76     GC3Dsizeiptr m_byteLength { 0 };
77
78     // Optimization for index validation. For each type of index
79     // (i.e., UNSIGNED_SHORT), cache the maximum index in the
80     // entire buffer.
81     //
82     // This is sufficient to eliminate a lot of work upon each
83     // draw call as long as all bound array buffers are at least
84     // that size.
85     struct MaxIndexCacheEntry {
86         GC3Denum type;
87         unsigned maxIndex;
88     };
89     // OpenGL ES 2.0 only has two valid index types (UNSIGNED_BYTE
90     // and UNSIGNED_SHORT) plus one extension (UNSIGNED_INT).
91     MaxIndexCacheEntry m_maxIndexCache[4];
92     unsigned m_nextAvailableCacheEntry { 0 };
93
94     // Clears all of the cached max indices.
95     void clearCachedMaxIndices();
96
97     // Helper function called by the three associateBufferData().
98     bool associateBufferDataImpl(const void* data, GC3Dsizeiptr byteLength);
99     // Helper function called by the two associateBufferSubData().
100     bool associateBufferSubDataImpl(GC3Dintptr offset, const void* data, GC3Dsizeiptr byteLength);
101 };
102
103 } // namespace WebCore
104
105 #endif