/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 * vim: sw=2 ts=8 et :
 */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

using layers::RGBDescriptor from "mozilla/layers/LayersSurfaces.h";
using wr::ExternalImageId from "mozilla/webrender/WebRenderAPI.h";
using RawId from "mozilla/webgpu/WebGPUTypes.h";
using BufferAddress from "mozilla/webgpu/WebGPUTypes.h";
using SerialBindGroupLayoutDescriptor from "mozilla/webgpu/WebGPUTypes.h";
using SerialPipelineLayoutDescriptor from "mozilla/webgpu/WebGPUTypes.h";
using SerialBindGroupDescriptor from "mozilla/webgpu/WebGPUTypes.h";
using SerialComputePipelineDescriptor from "mozilla/webgpu/WebGPUTypes.h";
using SerialRenderPipelineDescriptor from "mozilla/webgpu/WebGPUTypes.h";
using SerialTextureDescriptor from "mozilla/webgpu/WebGPUTypes.h";
using dom::GPURequestAdapterOptions from "mozilla/dom/WebGPUBinding.h";
using dom::GPUDeviceDescriptor from "mozilla/dom/WebGPUBinding.h";
using dom::GPUBufferDescriptor from "mozilla/dom/WebGPUBinding.h";
using dom::GPUCommandEncoderDescriptor from "mozilla/dom/WebGPUBinding.h";
using dom::GPUCommandBufferDescriptor from "mozilla/dom/WebGPUBinding.h";
using dom::GPUPipelineLayoutDescriptor from "mozilla/dom/WebGPUBinding.h";
using webgpu::ffi::WGPUSamplerDescriptor from "mozilla/webgpu/ffi/wgpu.h";
using webgpu::ffi::WGPUTextureViewDescriptor from "mozilla/webgpu/ffi/wgpu.h";
using webgpu::ffi::WGPUBufferCopyView from "mozilla/webgpu/ffi/wgpu.h";
using webgpu::ffi::WGPUTextureCopyView from "mozilla/webgpu/ffi/wgpu.h";
using webgpu::ffi::WGPUExtent3d from "mozilla/webgpu/ffi/wgpu.h";

include "mozilla/webgpu/WebGPUSerialize.h";
include protocol PCompositorBridge;

namespace mozilla {
namespace webgpu {

/**
 * Represents the connection between a WebGPUChild actor that issues WebGPU
 * command from the content process, and a WebGPUParent in the compositor
 * process that runs the commands.
 */
async protocol PWebGPU
{
  manager PCompositorBridge;

parent:
  async InstanceRequestAdapter(GPURequestAdapterOptions options, RawId[] ids) returns (RawId adapterId);
  async AdapterRequestDevice(RawId selfId, GPUDeviceDescriptor desc, RawId newId);
  async AdapterDestroy(RawId selfId);
  async DeviceCreateBuffer(RawId selfId, GPUBufferDescriptor desc, RawId newId);
  async DeviceDestroy(RawId selfId);
  async DeviceUnmapBuffer(RawId selfId, RawId bufferId, Shmem shmem, bool flush);
  async BufferMapRead(RawId selfId, Shmem shmem) returns (Shmem sm);
  async BufferDestroy(RawId selfId);
  async DeviceCreateTexture(RawId selfId, SerialTextureDescriptor desc, RawId newId);
  async TextureCreateView(RawId selfId, WGPUTextureViewDescriptor desc, RawId newId);
  async TextureDestroy(RawId selfId);
  async TextureViewDestroy(RawId selfId);
  async DeviceCreateSampler(RawId selfId, WGPUSamplerDescriptor desc, RawId newId);
  async SamplerDestroy(RawId selfId);
  async DeviceCreateCommandEncoder(RawId selfId, GPUCommandEncoderDescriptor desc, RawId newId);
  async CommandEncoderCopyBufferToBuffer(RawId selfId, RawId sourceId, BufferAddress sourceOffset, RawId destinationId, BufferAddress destinationOffset, BufferAddress size);
  async CommandEncoderCopyBufferToTexture(RawId selfId, WGPUBufferCopyView source, WGPUTextureCopyView destination, WGPUExtent3d extent);
  async CommandEncoderCopyTextureToBuffer(RawId selfId, WGPUTextureCopyView source, WGPUBufferCopyView destination, WGPUExtent3d extent);
  async CommandEncoderCopyTextureToTexture(RawId selfId, WGPUTextureCopyView source, WGPUTextureCopyView destination, WGPUExtent3d extent);
  async CommandEncoderRunComputePass(RawId selfId, Shmem shmem);
  async CommandEncoderRunRenderPass(RawId selfId, Shmem shmem);
  async CommandEncoderFinish(RawId selfId, GPUCommandBufferDescriptor desc);
  async CommandEncoderDestroy(RawId selfId);
  async CommandBufferDestroy(RawId selfId);
  async QueueSubmit(RawId selfId, RawId[] commandBuffers);
  async DeviceCreateBindGroupLayout(RawId selfId, SerialBindGroupLayoutDescriptor desc, RawId newId);
  async BindGroupLayoutDestroy(RawId selfId);
  async DeviceCreatePipelineLayout(RawId selfId, SerialPipelineLayoutDescriptor desc, RawId newId);
  async PipelineLayoutDestroy(RawId selfId);
  async DeviceCreateBindGroup(RawId selfId, SerialBindGroupDescriptor desc, RawId newId);
  async BindGroupDestroy(RawId selfId);
  async DeviceCreateShaderModule(RawId selfId, uint32_t[] data, RawId newId);
  async ShaderModuleDestroy(RawId selfId);
  async DeviceCreateComputePipeline(RawId selfId, SerialComputePipelineDescriptor desc, RawId newId);
  async ComputePipelineDestroy(RawId selfId);
  async DeviceCreateRenderPipeline(RawId selfId, SerialRenderPipelineDescriptor desc, RawId newId);
  async RenderPipelineDestroy(RawId selfId);
  async DeviceCreateSwapChain(RawId selfId, RawId queueId, RGBDescriptor desc, RawId[] bufferIds, ExternalImageId externalId);
  async SwapChainPresent(ExternalImageId externalId, RawId textureId, RawId commandEncoderId);
  async SwapChainDestroy(ExternalImageId externalId);
  async Shutdown();

child:
  async FreeAdapter(RawId id);
  async FreeDevice(RawId id);
  async FreePipelineLayout(RawId id);
  async FreeShaderModule(RawId id);
  async FreeBindGroupLayout(RawId id);
  async FreeBindGroup(RawId id);
  async FreeCommandBuffer(RawId id);
  async FreeRenderPipeline(RawId id);
  async FreeComputePipeline(RawId id);
  async FreeBuffer(RawId id);
  async FreeTexture(RawId id);
  async FreeTextureView(RawId id);
  async FreeSampler(RawId id);
  async __delete__();
};

} // webgpu
} // mozilla