deno/ext/webgpu/compute_pipeline.rs

// Copyright 2018-2025 the Deno authors. MIT license.

use deno_core::GarbageCollected;
use deno_core::WebIDL;
use deno_core::cppgc::Ref;
use deno_core::op2;
use deno_core::webidl::WebIdlInterfaceConverter;
use indexmap::IndexMap;

use crate::Instance;
use crate::bind_group_layout::GPUBindGroupLayout;
use crate::error::GPUGenericError;
use crate::shader::GPUShaderModule;
use crate::webidl::GPUPipelineLayoutOrGPUAutoLayoutMode;

pub struct GPUComputePipeline {
  pub instance: Instance,
  pub error_handler: super::error::ErrorHandler,

  pub id: wgpu_core::id::ComputePipelineId,
  pub label: String,
}

impl Drop for GPUComputePipeline {
  fn drop(&mut self) {
    self.instance.compute_pipeline_drop(self.id);
  }
}

impl WebIdlInterfaceConverter for GPUComputePipeline {
  const NAME: &'static str = "GPUComputePipeline";
}

// SAFETY: we're sure this can be GCed
unsafe impl GarbageCollected for GPUComputePipeline {
  fn trace(&self, _visitor: &mut deno_core::v8::cppgc::Visitor) {}

  fn get_name(&self) -> &'static std::ffi::CStr {
    c"GPUComputePipeline"
  }
}

#[op2]
impl GPUComputePipeline {
  #[constructor]
  #[cppgc]
  fn constructor(_: bool) -> Result<GPUComputePipeline, GPUGenericError> {
    Err(GPUGenericError::InvalidConstructor)
  }

  #[getter]
  #[string]
  fn label(&self) -> String {
    self.label.clone()
  }
  #[setter]
  #[string]
  fn label(&self, #[webidl] _label: String) {
    // TODO(@crowlKats): no-op, needs wpgu to implement changing the label
  }

  #[cppgc]
  fn get_bind_group_layout(&self, #[webidl] index: u32) -> GPUBindGroupLayout {
    let (id, err) = self
      .instance
      .compute_pipeline_get_bind_group_layout(self.id, index, None);

    self.error_handler.push_error(err);

    // TODO(wgpu): needs to support retrieving the label
    GPUBindGroupLayout {
      instance: self.instance.clone(),
      id,
      label: "".to_string(),
    }
  }
}

#[derive(WebIDL)]
#[webidl(dictionary)]
pub(crate) struct GPUComputePipelineDescriptor {
  #[webidl(default = String::new())]
  pub label: String,

  pub compute: GPUProgrammableStage,
  pub layout: GPUPipelineLayoutOrGPUAutoLayoutMode,
}

#[derive(WebIDL)]
#[webidl(dictionary)]
pub(crate) struct GPUProgrammableStage {
  pub module: Ref<GPUShaderModule>,
  pub entry_point: Option<String>,
  #[webidl(default = Default::default())]
  pub constants: IndexMap<String, f64>,
}