From 5233860220020e42809e9c06ef05c857abe7d659 Mon Sep 17 00:00:00 2001
From: Corentin Wallez <corentin@wallez.net>
Date: Tue, 13 Feb 2018 18:00:21 -0500
Subject: [PATCH 1/2] Create sketch.webidl

---
 design/sketch.webidl | 532 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 532 insertions(+)
 create mode 100644 design/sketch.webidl

diff --git a/design/sketch.webidl b/design/sketch.webidl
new file mode 100644
index 0000000000..bc3383b70d
--- /dev/null
+++ b/design/sketch.webidl
@@ -0,0 +1,532 @@
+typedef long u32;
+
+// ****************************************************************************
+// SHADER RESOURCES (buffer, textures, texture views, samples)
+// ****************************************************************************
+
+// Buffer
+typedef u32 WebGPUBufferUsageFlags;
+interface WebGPUBufferUsage {
+    const u32 NONE = 0;
+    const u32 MAP_READ = 1;
+    const u32 MAP_WRITE = 2;
+    const u32 TRANSFER_SRC = 4;
+    const u32 TRANSFER_DST = 8;
+    const u32 INDEX = 16;
+    const u32 VERTEX = 32;
+    const u32 UNIFORM = 64;
+    const u32 STORAGE = 128;
+};
+
+dictionary WebGPUBufferDescriptor {
+    u32 size;
+    WebGPUBufferUsageFlags usage;
+};
+
+interface WebGPUBuffer {
+    void setSubData(ArrayBuffer data, u32 offset);
+    Promise<ArrayBuffer> readbackAsync(u32 offset, u32 size);
+};
+
+// Texture view
+dictionary WebGPUTextureViewDescriptor {
+    // TODO Investigate what goes in there.
+};
+
+interface WebGPUTextureView {
+};
+
+// Texture
+typedef u32 WebGPUTextureDimensionEnum;
+interface WebGPUTextureDimension {
+    const u32 e1D = 0;
+    const u32 e2D = 1;
+    const u32 e3D = 2;
+    // TODO other dimensions (cube, arrays)
+};
+
+typedef u32 WebGPUTextureFormatEnum;
+interface WebGPUTextureFormat {
+    const u32 R8_G8_B8_A8_UNORM = 0;
+    const u32 R8_G8_B8_A8_UINT = 1;
+    const u32 B8_G8_R8_A8_UNORM = 2;
+    const u32 D32_FLOAT_S8_UINT = 3;
+    // TODO other formats
+};
+
+typedef u32 WebGPUTextureUsageFlags;
+interface WebGPUTextureUsage {
+    const u32 NONE = 0;
+    const u32 TRANSFER_SRC = 1;
+    const u32 TRANSFER_DST = 2;
+    const u32 SAMPLED = 4;
+    const u32 STORAGE = 8;
+    const u32 OUTPUT_ATTACHMENT = 16;
+    const u32 PRESENT = 32;
+};
+
+dictionary WebGPUTextureDescriptor {
+    u32 width;
+    u32 height;
+    u32 depth;
+    u32 arraySize;
+    WebGPUTextureDimensionEnum dimension;
+    WebGPUTextureFormatEnum format;
+    WebGPUTextureUsageFlags usage;
+};
+
+interface WebGPUTexture {
+    WebGPUTextureView createTextureView(WebGPUTextureViewDescriptor desc);
+};
+
+// Sampler
+typedef u32 WebGPUFilterModeEnum;
+interface WebGPUFilterMode {
+    const u32 NEAREST = 0;
+    const u32 LINEAR = 1;
+};
+
+dictionary WebGPUSamplerDescriptor {
+    WebGPUFilterModeEnum magFilter;
+    WebGPUFilterModeEnum minFilter;
+    WebGPUFilterModeEnum mipmapFilter;
+};
+
+interface WebGPUSampler {
+};
+
+// ****************************************************************************
+// BINDING MODEL (bindgroup layout, bindgroup)
+// ****************************************************************************
+
+// BindGroupLayout
+typedef u32 WebGPUShaderStageFlags;
+interface WebGPUShaderStageBit {
+    const u32 NONE = 0;
+    const u32 VERTEX = 1;
+    const u32 FRAGMENT = 2;
+    const u32 COMPUTE = 4;
+};
+
+typedef u32 WebGPUBindingTypeEnum;
+interface WebGPUBindingType {
+    const u32 UNIFORM_BUFFER = 0;
+    const u32 SAMPLER = 1;
+    const u32 SAMPLED_TEXTURE = 2;
+    const u32 STORAGE_BUFFER = 3;
+    // TODO other binding types (storage images, ...)
+};
+
+dictionary WebGPUBindGroupBinding {
+    WebGPUShaderStageFlags visibility;
+    WebGPUBindingType type;
+    u32 start;
+    u32 count;
+};
+
+dictionary WebGPUBindGroupLayoutDescriptor {
+    sequence<WebGPUBindGroupBinding> bindingTypes;
+};
+
+interface WebGPUBindGroupLayout {
+};
+
+// PipelineLayout
+dictionary WebGPUPipelineLayoutDescriptor {
+    sequence<WebGPUBindGroupLayout> bindGroupLayouts;
+};
+
+interface WebGPUPipelineLayout {
+};
+
+// BindGroup
+dictionary WebGPUBufferBinding {
+    WebGPUBuffer buffer;
+    u32 offset;
+    u32 size;
+};
+
+typedef (WebGPUSampler or WebGPUTextureView or WebGPUBufferBinding) WebGPUBindingResource;
+
+dictionary WebGPUBinding {
+    sequence<WebGPUBindingResource> resources;
+    u32 start;
+    u32 count;
+};
+
+dictionary WebGPUBindGroupDescriptor {
+    WebGPUBindGroupLayout layout;
+    sequence<WebGPUBinding> bindings; 
+};
+
+interface WebGPUBindGroup {
+};
+
+// ****************************************************************************
+// PIPELINE CREATION (blend state, DS state, ..., pipelines)
+// ****************************************************************************
+
+// BlendState
+typedef u32 WebGPUBlendFactorEnum;
+interface WebGPUBlendFactor {
+    const u32 ZERO = 0;
+    const u32 ONE = 1;
+    const u32 SRC_COLOR = 2;
+    const u32 ONE_MINUS_SRC_COLOR = 3;
+    const u32 SRC_ALPHA = 4;
+    const u32 ONE_MINUS_SRC_ALPHA = 5;
+    const u32 DST_COLOR = 6;
+    const u32 ONE_MINUS_DST_COLOR = 7;
+    const u32 DST_ALPHA = 8;
+    const u32 ONE_MINUS_DST_ALPHA = 9;
+    const u32 SRC_ALPHA_SATURATED = 10;
+    const u32 BLEND_COLOR = 11;
+    const u32 ONE_MINUS_BLEND_COLOR = 12;
+};
+
+typedef u32 WebGPUBlendOperationEnum;
+interface WebGPUBlendOperation {
+    const u32 ADD = 0;
+    const u32 SUBTRACT = 1;
+    const u32 REVERSE_SUBTRACT = 2;
+    const u32 MIN = 3;
+    const u32 MAX = 4;
+};
+
+typedef u32 WebGPUColorWriteFlags;
+interface WebGPUColorWriteBits {
+    const u32 NONE = 0;
+    const u32 RED = 1;
+    const u32 GREEN = 2;
+    const u32 BLUE = 4;
+    const u32 ALPHA = 8;
+    const u32 ALL = 15;
+};
+
+dictionary WebGPUBlendDescriptor {
+    WebGPUBlendFactorEnum srcFactor;
+    WebGPUBlendFactorEnum dstFactor;
+    WebGPUBlendOperationEnum operation;
+};
+
+dictionary WebGPUBlendStateDescriptor {
+    bool blendEnabled;
+    WebGPUBlendDescriptor alpha;
+    WebGPUBlendDescriptor color;
+    WebGPUColorWriteFlags writeMask;
+};
+
+interface WebGPUBlendState {
+};
+
+// DepthStencilState
+typedef u32 WebGPUCompareFunctionEnum;
+interface WebGPUCompareFunction {
+    const u32 NEVER = 0;
+    const u32 LESS = 1;
+    const u32 LESS_EQUAL = 2;
+    const u32 GREATER = 3;
+    const u32 GREATER_EQUAL = 4;
+    const u32 EQUAL = 5;
+    const u32 NOT_EQUAL = 6;
+    const u32 ALWAYS = 7;
+};
+
+typedef u32 WebGPUStencilOperationEnum;
+interface WebGPUStencilOperation {
+    const u32 KEEP = 0;
+    const u32 ZERO = 1;
+    const u32 REPLACE = 2;
+    const u32 INVERT = 3;
+    const u32 INCREMENT_CLAMP = 4;
+    const u32 DECREMENT_CLAMP = 5;
+    const u32 INCREMENT_WRAP = 6;
+    const u32 DECREMENT_WRAP = 7;
+};
+
+dictionary WebGPUStencilStateFaceDescriptor {
+    WebGPUCompareFunctionEnum compare;
+    WebGPUStencilOperationEnum stencilFailOp;
+    WebGPUStencilOperationEnum depthFailOp;
+    WebGPUStencilOperationEnum passFailOp;
+};
+
+dictionary WebGPUDepthStencilStateDescriptor {
+    bool depthWriteEnabled;
+    WebGPUCompareFunctionEnum depthCompare;
+
+    WebGPUStencilStateFaceDescriptor front;
+    WebGPUStencilStateFaceDescriptor back;
+    
+    u32 stencilReadMask;
+    u32 stencilWriteMask;
+};
+
+interface WebGPUDepthStencilState {
+};
+
+// InputState
+typedef u32 WebGPUIndexFormatEnum;
+interface WebGPUIndexFormat {
+    const u32 UINT16 = 0;
+    const u32 UINT32 = 1;
+};
+
+typedef u32 WebGPUVertexFormatEnum;
+interface WebGPUVertexFormat {
+    const u32 FLOAT_R32_G32_B32_A32 = 0;
+    const u32 FLOAT_R32_G32_B32 = 1;
+    const u32 FLOAT_R32_G32 = 2;
+    const u32 FLOAT_R32 = 3;
+    // TODO other vertex formats
+};
+
+typedef u32 WebGPUInputStepModeEnum;
+interface WebGPUInputStepMode {
+    const u32 VERTEX = 0;
+    const u32 INSTANCE = 1;
+};
+
+dictionary WebGPUVertexAttributeDescriptor {
+    u32 shaderLocation;
+    u32 inputSlot;
+    u32 offset;
+    WebGPUVertexFormatEnum format;
+};
+
+dictionary WebGPUVertexInputDescriptor {
+    u32 inputSlot;
+    u32 stride;
+    WebGPUInputStepModeEnum stepMode;
+};
+
+dictionary WebGPUInputStateDescriptor {
+    WebGPUIndexFormatEnum indexFormat;
+
+    sequence<WebGPUVertexAttributeDescriptor> attributes;
+    sequence<WebGPUVertexInputDescriptor> inputs;
+};
+
+interface WebGPUInputState {
+};
+
+// ShaderModule
+dictionary WebGPUShaderModuleDescriptor {
+    ArrayBuffer code;
+};
+
+interface WebGPUShaderModule {
+};
+
+// AttachmentState
+dictionary WebGPUAttachmentStateDescriptor {
+    sequence<WebGPUTextureFormatEnum> formats;
+    // TODO other stuff like sample count etc.
+};
+
+interface WebGPUAttachmentState {
+};
+
+// Common stuff for ComputePipeline and RenderPipeline
+typedef u32 WebGPUShaderStageEnum;
+interface WebGPUShaderStage {
+    const u32 VERTEX = 0;
+    const u32 FRAGMENT = 1;
+    const u32 COMPUTE = 2;
+};
+
+dictionary WebGPUPipelineStageDescriptor {
+    WebGPUShaderModule module;
+    WebGPUShaderStageEnum stage;
+    DOMString entryPoint;
+    // TODO other stuff like specialization constants?
+};
+
+dictionary WebGPUPipelineDescriptorBase {
+    WebGPUPipelineLayout layout;
+    sequence<WebGPUPipelineStageDescriptor> stages;
+};
+
+// ComputePipeline
+dictionary WebGPUComputePipelineDescriptor : WebGPUPipelineDescriptorBase{
+};
+
+interface WebGPUComputePipeline {
+};
+
+// WebGPURenderPipeline
+typedef u32 WebGPUPrimitiveTopologyEnum;
+interface WebGPUPrimitiveTopology {
+    const u32 POINT_LIST = 0;
+    const u32 LINE_LIST = 1;
+    const u32 LINE_STRIP = 2;
+    const u32 TRIANGLE_LIST = 3;
+    const u32 TRIANGLE_STRIP = 4;
+};
+
+dictionary WebGPURenderPipelineDescriptor : WebGPUPipelineDescriptorBase{
+    WebGPUPrimitiveTopologyEnum primitiveTopology;
+    sequence<WebGPUBlendState> blendState;
+    WebGPUDepthStencilState depthStencilState;
+    WebGPUInputState inputState;
+    WebGPUAttachmentState attachmentState;
+    // TODO other properties
+};
+
+interface WebGPURenderPipeline {
+};
+// ****************************************************************************
+// COMMAND RECORDING (Command buffer and all relevant structures)
+// ****************************************************************************
+
+typedef u32 WebGPULoadOpEnum;
+interface WebGPULoadOp {
+    const u32 CLEAR = 0;
+    const u32 LOAD = 1;
+};
+
+typedef u32 WebGPUStoreOpEnum;
+interface WebGPUStoreOp {
+    const u32 STORE = 0;
+};
+
+dictionary WebGPURenderPassAttachmentDescriptor {
+    WebGPUTextureView attachment;
+    WebGPULoadOp loadOp;
+    WebGPUStoreOp storeOp;
+}
+
+dictionary WebGPURenderPassDescriptor {
+    sequence<WebGPURenderPassAttachmentDescriptor> colorAttachments;
+    WebGPURenderPassAttachmentDescriptor depthStencilAttachmaent;
+};
+
+interface WebGPUCommandBuffer {
+};
+
+interface WebGPUCommandEncoder {
+    WebGPUCommandBuffer finishEncoding();
+
+    // Commands allowed outside of "passes"
+    void copyBufferToBuffer(WebGPUBuffer src,
+                            u32 srcOffset,
+                            WebGPUBuffer dst,
+                            u32 dstOffset,
+                            u32 size);
+    // TODO figure out all the arguments required for these
+    void copyBufferToTexture();
+    void copyTextureToBuffer();
+    void copyTextureToTexture();
+    void blit();
+
+    // Allowed in both compute and render passes
+    void setPushConstants(WebGPUShaderStageFlags stage,
+                          u32 offset,
+                          u32 count,
+                          ArrayBuffer data);
+    void setBindGroup(u32 index, WebGPUBindGroup bindGroup);
+    void setPipeline((WebGPUComputePipeline or WebGPURenderPipeline) pipeline);
+
+    // Compute pass commands
+    void beginComputePass();
+    void endComputePass();
+
+    void dispatch(u32 x, u32 y, u32 z);
+
+    // Render pass commands
+    void beginRenderPass(WebGPURenderPassDescriptor descriptor);
+    void endRenderPass();
+
+    void setBlendColor(float r, float g, float b, float a);
+    void setIndexBuffer(WebGPUBuffer buffer, u32 offset);
+    void setVertexBuffers(u32 startSlot, sequence<WebGPUBuffer> buffers, sequence<u32> offsets);
+
+    void draw(u32 vertexCount, u32 instanceCount, u32 firstVertex, u32 firstInstance);
+    void drawIndexed(u32 indexCount, u32 instanceCount, u32 firstIndex, u32 firstInstance);
+
+    // TODO add missing commands
+};
+
+// ****************************************************************************
+// OTHER (Fence, Queue SwapChain, Device)
+// ****************************************************************************
+
+// Fence
+interface WebGPUFence {
+    u32 getValue();
+};
+
+// Queue
+interface WebGPUQueue {
+    void submit(sequence<WebGPUCommandBuffer> buffers);
+    void updateFence(WebGPUFence fence, u32 value);
+};
+
+// SwapChain / RenderingContext
+dictionary WebGPUSwapChainDescriptor {
+    WebGPUTextureUsageFlags usage;
+    WebGPUTextureFormatEnum format;
+    u32 width;
+    u32 height;
+};
+
+interface WebGPUSwapChain {
+    void configure(WebGPUSwapChainDescriptor descriptor);
+    WebGPUTexture getNextTexture();
+    void present();
+};
+
+interface WebGPURenderingContext : WebGPUSwapChain {
+};
+
+// Device
+interface WebGPUDevice {
+    WebGPUBuffer createBuffer(WebGPUBufferDescriptor descriptor);
+    WebGPUTexture createTexture(WebGPUTextureDescriptor descriptor);
+    WebGPUSampler createSampler(WebGPUSamplerDescriptor descriptor);
+
+    WebGPUBindGroupLayout createBindGroupLayout(WebGPUBindGroupLayoutDescriptor descriptor);
+    WebGPUPipelineLayout createPipelineLayout(WebGPUPipelineLayoutDescriptor descriptor);
+    WebGPUBindGroup createBindGroup(WebGPUBindGroupDescriptor descriptor);
+
+    WebGPUBlendState createBlendState(WebGPUBlendStateDescriptor descriptor);
+    WebGPUDepthStencilState createDepthStencilState(WebGPUDepthStencilStateDescriptor descriptor);
+    WebGPUInputState createInputState(WebGPUInputStateDescriptor descriptor);
+    WebGPUShaderModule createShaderModule(WebGPUShaderModuleDescriptor descriptor);
+    WebGPUAttachmentState createAttachmentState(WebGPUAttachmentStateDescriptor descriptor);
+    WebGPUComputePipeline createComputePipeline(WebGPUComputePipelineDescriptor descriptor);
+    WebGPURenderPipeline createRenderPipeline(WebGPURenderPipelineDescriptor descriptor);
+
+    WebGPUCommandEncoder createCommandEncoder(WebGPUCommandEncoderDescriptor descriptor);
+    WebGPUFence createFence(WebGPUFenceDescriptor descriptor);
+
+    WebGPUQueue getQueue();
+};
+
+// WebGPU "namespace" used for device creation
+dictionary WebGPUExtensions {
+    bool anisotropicFiltering;
+};
+
+dictionary WebGPUFeatures {
+    bool logicOp;
+};
+
+dictionary WebGPULimits {
+    u32 maxBindGroups;
+};
+
+dictionary WebGPUDeviceDescriptor {
+    WebGPUExtensions extensions;
+    WebGPULimits limits;
+    WebGPUFeatures features;
+    // TODO are other things configurable like queues?
+};
+
+interface WebGPU {
+    static WebGPUExtensions getExtensions();
+    static WebGPUFeatures getFeatures();
+    static WebGPULimits getLimits();
+
+    static WebGPUDevice createDevice(WebGPUDeviceDescriptor descriptor);
+};

From 37792e17ba4736c10f2358c11e311bfbb0bda0c4 Mon Sep 17 00:00:00 2001
From: Corentin Wallez <corentin@wallez.net>
Date: Wed, 14 Feb 2018 13:00:06 -0500
Subject: [PATCH 2/2] Update sketch.webidl

---
 design/sketch.webidl | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/design/sketch.webidl b/design/sketch.webidl
index bc3383b70d..57b81b5c8e 100644
--- a/design/sketch.webidl
+++ b/design/sketch.webidl
@@ -248,7 +248,7 @@ dictionary WebGPUStencilStateFaceDescriptor {
     WebGPUCompareFunctionEnum compare;
     WebGPUStencilOperationEnum stencilFailOp;
     WebGPUStencilOperationEnum depthFailOp;
-    WebGPUStencilOperationEnum passFailOp;
+    WebGPUStencilOperationEnum passOp;
 };
 
 dictionary WebGPUDepthStencilStateDescriptor {
@@ -442,7 +442,7 @@ interface WebGPUCommandEncoder {
     void setVertexBuffers(u32 startSlot, sequence<WebGPUBuffer> buffers, sequence<u32> offsets);
 
     void draw(u32 vertexCount, u32 instanceCount, u32 firstVertex, u32 firstInstance);
-    void drawIndexed(u32 indexCount, u32 instanceCount, u32 firstIndex, u32 firstInstance);
+    void drawIndexed(u32 indexCount, u32 instanceCount, u32 firstIndex, u32 firstInstance, u32 firstVertex);
 
     // TODO add missing commands
 };