[Web GPU] Indexed drawing and GPUCommandEncoder crash prevention
[WebKit-https.git] / Source / WebCore / platform / graphics / gpu / GPURenderPassEncoder.h
1 /*
2  * Copyright (C) 2018 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #if ENABLE(WEBGPU)
29
30 #include "GPUProgrammablePassEncoder.h"
31 #include "GPURenderPipeline.h"
32
33 #include <wtf/RefCounted.h>
34 #include <wtf/RefPtr.h>
35 #include <wtf/RetainPtr.h>
36 #include <wtf/Vector.h>
37
38 OBJC_PROTOCOL(MTLRenderCommandEncoder);
39
40 namespace WebCore {
41
42 class GPUBuffer;
43 class GPUCommandBuffer;
44
45 struct GPUColor;
46 struct GPURenderPassDescriptor;
47
48 using PlatformRenderPassEncoder = MTLRenderCommandEncoder;
49 using PlatformRenderPassEncoderSmartPtr = RetainPtr<MTLRenderCommandEncoder>;
50
51 class GPURenderPassEncoder : public GPUProgrammablePassEncoder {
52 public:
53     static RefPtr<GPURenderPassEncoder> tryCreate(Ref<GPUCommandBuffer>&&, GPURenderPassDescriptor&&);
54
55     void setPipeline(Ref<const GPURenderPipeline>&&);
56     void setBlendColor(const GPUColor&);
57     void setViewport(float x, float y, float width, float height, float minDepth, float maxDepth);
58     void setScissorRect(unsigned x, unsigned y, unsigned width, unsigned height);
59     void setIndexBuffer(GPUBuffer&, uint64_t offset);
60     void setVertexBuffers(unsigned index, const Vector<Ref<GPUBuffer>>&, const Vector<uint64_t>& offsets);
61     void draw(unsigned vertexCount, unsigned instanceCount, unsigned firstVertex, unsigned firstInstance);
62     void drawIndexed(unsigned indexCount, unsigned instanceCount, unsigned firstIndex, int baseVertex, unsigned firstInstance);
63
64 private:
65     GPURenderPassEncoder(Ref<GPUCommandBuffer>&&, PlatformRenderPassEncoderSmartPtr&&);
66     ~GPURenderPassEncoder() { endPass(); }
67
68     // GPUProgrammablePassEncoder
69     const PlatformProgrammablePassEncoder* platformPassEncoder() const final;
70     void invalidateEncoder() final { m_platformRenderPassEncoder = nullptr; }
71 #if USE(METAL)
72     void useResource(const MTLResource *, unsigned usage) final;
73     void setVertexBuffer(const MTLBuffer *, unsigned offset, unsigned index) final;
74     void setFragmentBuffer(const MTLBuffer *, unsigned offset, unsigned index) final;
75
76     RefPtr<GPUBuffer> m_indexBuffer;
77     uint64_t m_indexBufferOffset;
78 #endif // USE(METAL)
79
80     PlatformRenderPassEncoderSmartPtr m_platformRenderPassEncoder;
81     RefPtr<const GPURenderPipeline> m_pipeline;
82 };
83
84 } // namespace WebCore
85
86 #endif // ENABLE(WEBGPU)