a6e819a3736f84b18d803dd9c179f9dc8ae82831
[WebKit-https.git] / Source / WebCore / Modules / webgpu / WebGPURenderPassEncoder.idl
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 // https://github.com/gpuweb/gpuweb/blob/master/design/sketch.webidl
26
27 typedef unsigned long u32;
28 typedef unsigned long long u64;
29
30 [
31     Conditional=WEBGPU,
32     EnabledAtRuntime=WebGPU,
33     JSGenerateToJSObject
34 ] interface WebGPURenderPassEncoder : WebGPUProgrammablePassEncoder {
35     void setPipeline(WebGPURenderPipeline pipeline);
36     void setBlendColor(GPUColor color);
37
38     // The default viewport is (0.0, 0.0, w, h, 0.0, 1.0), where w and h are the dimensions of back buffer
39     void setViewport(float x, float y, float width, float height, float minDepth, float maxDepth);
40
41     // The default scissor rectangle is (0, 0, w, h), where w and h are the dimensions of back buffer.
42     // Width and height must be greater than 0. Otherwise, an error will be generated.
43     void setScissorRect(u32 x, u32 y, u32 width, u32 height);
44
45     void setVertexBuffers(u32 startSlot, sequence<WebGPUBuffer> buffers, sequence<u64> offsets);
46
47     void draw(u32 vertexCount, u32 instanceCount, u32 firstVertex, u32 firstInstance);
48
49 /* Not Yet Implemented
50     void setIndexBuffer(WebGPUBuffer buffer, u64 offset);
51
52     void drawIndexed(u32 indexCount, u32 instanceCount, u32 firstIndex, i32 baseVertex, u32 firstInstance);
53
54     // TODO add missing commands
55 */
56 };