gpu-curtains/dist/esm/core/bindings/SamplerBinding.mjs

gpu-curtains is a 3D WebGPU rendering engine. It can be used as a standalone 3D engine, but also includes extra classes focused on mapping 3d objects to DOM elements; It allows users to synchronize values such as position, sizing, or scale between them.

import { Binding } from './Binding.mjs';

class SamplerBinding extends Binding {
  /**
   * SamplerBinding constructor
   * @param parameters - {@link SamplerBindingParams | parameters} used to create our SamplerBindings
   */
  constructor({
    label = "Sampler",
    name = "sampler",
    bindingType,
    visibility,
    sampler,
    type = "filtering"
  }) {
    bindingType = bindingType ?? "sampler";
    super({ label, name, bindingType, visibility });
    this.cacheKey += `${type},`;
    this.options = {
      ...this.options,
      sampler,
      type
    };
    this.resource = sampler;
    this.setWGSLFragment();
  }
  /**
   * Get {@link GPUDevice.createBindGroupLayout().sampler | GPUBindGroupLayout entry resource}.
   * @readonly
   */
  get resourceLayout() {
    return {
      sampler: {
        type: this.options.type
        // TODO set shouldResetBindGroupLayout to true if it changes afterwards
      }
    };
  }
  /**
   * Get the resource cache key
   * @readonly
   */
  get resourceLayoutCacheKey() {
    return `sampler,${this.options.type},${this.visibility},`;
  }
  /**
   * Get the {@link GPUDevice.createBindGroup().entries.resource | GPUBindGroup entry resource}.
   */
  get resource() {
    return this.sampler;
  }
  /**
   * Set the {@link GPUDevice.createBindGroup().entries.resource | GPUBindGroup entry resource}.
   * @param value - new bind group resource
   */
  set resource(value) {
    if (value && this.sampler) this.shouldResetBindGroup = true;
    this.sampler = value;
  }
  /**
   * Set the correct WGSL code snippet.
   */
  setWGSLFragment() {
    this.wgslGroupFragment = [
      `var ${this.name}: ${this.options.type === "comparison" ? `${this.bindingType}_comparison` : this.bindingType};`
    ];
  }
}

export { SamplerBinding };