wgpu 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bbbaca4a43bec5b75eef13a782fd6effed0764d28c236918f21423ceab570c3c
+  data.tar.gz: e3d50d0335f0195fde48d9cbb157da88c399ddbc6a53ca52f60b2526436cced4
+SHA512:
+  metadata.gz: 30330a5b4071440c99efc0f33feda10ef375a8905bd67997b586e655cd0c7bcddda1f74e1f023efc7050756a2e6a0639f6dc2df83ecb8c9136a9b9e9fb8b7a88
+  data.tar.gz: d950a6fac08c63226ef07a659f99b80deaf522722a6bc5790e948548f42cc74e6e7b3d3d715d03332adab72b914127afde44776c1df1709f049903942d91bcdf

data/LICENSE-APACHE

@@ -0,0 +1,190 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to the Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2025 Yudai Takada
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Yudai Takada
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,213 @@
+# WGPU Ruby
+
+Ruby bindings for [WebGPU](https://www.w3.org/TR/webgpu/) via [wgpu-native](https://github.com/gfx-rs/wgpu-native).
+
+## Features
+
+- Complete WebGPU API bindings using Ruby-FFI
+- GPU compute shaders (GPGPU)
+- Cross-platform support (macOS, Linux, Windows)
+- Automatic wgpu-native library download on gem install
+
+## Requirements
+
+- Ruby 3.0+
+- Supported platforms:
+  - macOS (x86_64, arm64)
+  - Linux (x86_64, aarch64)
+  - Windows (x86_64)
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'wgpu'
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+Or install directly:
+
+```bash
+gem install wgpu
+```
+
+The wgpu-native library is automatically downloaded from GitHub Releases during installation.
+
+### Custom wgpu-native Build
+
+To use a custom build of wgpu-native:
+
+```bash
+export WGPU_LIB_PATH=/path/to/libwgpu_native.so
+```
+
+## Usage
+
+### Basic Setup
+
+```ruby
+require 'wgpu'
+
+instance = WGPU::Instance.new
+adapter = instance.request_adapter(power_preference: :high_performance)
+device = adapter.request_device
+queue = device.queue
+
+puts "Using: #{adapter.info[:device]} (#{adapter.info[:backend_type]})"
+```
+
+### Compute Shader Example
+
+```ruby
+require 'wgpu'
+
+shader_code = <<~WGSL
+  @group(0) @binding(0) var<storage, read_write> data: array<f32>;
+
+  @compute @workgroup_size(64)
+  fn main(@builtin(global_invocation_id) id: vec3<u32>) {
+    data[id.x] = data[id.x] * 2.0;
+  }
+WGSL
+
+instance = WGPU::Instance.new
+adapter = instance.request_adapter
+device = adapter.request_device
+queue = device.queue
+
+# Create buffer with initial data
+input_data = (0...256).map(&:to_f)
+buffer = device.create_buffer(
+  size: input_data.size * 4,
+  usage: [:storage, :copy_src, :copy_dst],
+  mapped_at_creation: true
+)
+buffer.mapped_range.write_floats(input_data)
+buffer.unmap
+
+# Create shader and pipeline
+shader = device.create_shader_module(code: shader_code)
+
+bind_group_layout = device.create_bind_group_layout(
+  entries: [{ binding: 0, visibility: :compute, buffer: { type: :storage } }]
+)
+
+bind_group = device.create_bind_group(
+  layout: bind_group_layout,
+  entries: [{ binding: 0, buffer: buffer, offset: 0, size: buffer.size }]
+)
+
+pipeline_layout = device.create_pipeline_layout(bind_group_layouts: [bind_group_layout])
+pipeline = device.create_compute_pipeline(
+  layout: pipeline_layout,
+  compute: { module: shader, entry_point: "main" }
+)
+
+# Execute compute pass
+encoder = device.create_command_encoder
+pass = encoder.begin_compute_pass
+pass.set_pipeline(pipeline)
+pass.set_bind_group(0, bind_group)
+pass.dispatch_workgroups(input_data.size / 64)
+pass.end_pass
+queue.submit([encoder.finish])
+
+# Read results
+result = queue.read_buffer(buffer, device: device)
+output_data = result.unpack("f*")
+
+puts output_data[0, 10].inspect
+# => [0.0, 2.0, 4.0, 6.0, 8.0, 10.0, 12.0, 14.0, 16.0, 18.0]
+```
+
+## Examples
+
+See the `examples/` directory for more complete examples:
+
+- `01_adapter_info.rb` - Query GPU adapter information
+- `02_compute_basic.rb` - Basic compute shader
+- `03_buffer_operations.rb` - Buffer read/write operations
+- `04_matrix_multiply.rb` - GPU matrix multiplication
+- `05_image_blur.rb` - Image processing with box filter
+- `06_parallel_reduction.rb` - Parallel sum reduction
+
+Run an example:
+
+```bash
+bundle exec ruby examples/02_compute_basic.rb
+```
+
+## API Overview
+
+### Core Objects
+
+| Class | Description |
+|-------|-------------|
+| `WGPU::Instance` | Entry point for WebGPU |
+| `WGPU::Adapter` | Represents a GPU adapter |
+| `WGPU::Device` | Logical device for GPU operations |
+| `WGPU::Queue` | Command submission queue |
+
+### Resources
+
+| Class | Description |
+|-------|-------------|
+| `WGPU::Buffer` | GPU buffer for data storage |
+| `WGPU::Texture` | GPU texture |
+| `WGPU::TextureView` | View into a texture |
+| `WGPU::Sampler` | Texture sampling configuration |
+
+### Pipeline
+
+| Class | Description |
+|-------|-------------|
+| `WGPU::ShaderModule` | Compiled WGSL shader |
+| `WGPU::ComputePipeline` | Compute shader pipeline |
+| `WGPU::RenderPipeline` | Render pipeline |
+| `WGPU::BindGroup` | Resource bindings for shaders |
+| `WGPU::BindGroupLayout` | Layout definition for bind groups |
+| `WGPU::PipelineLayout` | Pipeline layout definition |
+
+### Commands
+
+| Class | Description |
+|-------|-------------|
+| `WGPU::CommandEncoder` | Records GPU commands |
+| `WGPU::CommandBuffer` | Encoded commands ready to submit |
+| `WGPU::ComputePass` | Compute pass encoder |
+| `WGPU::RenderPass` | Render pass encoder |
+
+## Development
+
+```bash
+git clone https://github.com/ydah/wgpu-ruby.git
+cd wgpu-ruby
+bundle install
+bundle exec rake spec
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ydah/wgpu-ruby.
+
+## License
+
+Licensed under either of
+
+- [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
+- [MIT License](http://opensource.org/licenses/MIT)
+
+at your option.
+
+## References
+
+- [WebGPU Specification](https://www.w3.org/TR/webgpu/)
+- [WGSL Specification](https://www.w3.org/TR/WGSL/)
+- [wgpu-native](https://github.com/gfx-rs/wgpu-native)
+- [wgpu (Rust)](https://github.com/gfx-rs/wgpu)

data/ext/wgpu/Makefile

@@ -0,0 +1,7 @@
+.PHONY: install clean
+
+install:
+	@echo "wgpu-native is ready"
+
+clean:
+	@echo "Nothing to clean"

data/ext/wgpu/extconf.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "net/http"
+require "uri"
+
+WGPU_VERSION = "v27.0.4.0"
+GITHUB_RELEASE_URL = "https://github.com/gfx-rs/wgpu-native/releases/download/#{WGPU_VERSION}"
+
+PLATFORM_MAP = {
+  /x86_64-linux/ => { file: "wgpu-linux-x86_64-release.zip", lib: "libwgpu_native.so" },
+  /aarch64-linux/ => { file: "wgpu-linux-aarch64-release.zip", lib: "libwgpu_native.so" },
+  /x86_64-darwin/ => { file: "wgpu-macos-x86_64-release.zip", lib: "libwgpu_native.dylib" },
+  /arm64-darwin/ => { file: "wgpu-macos-aarch64-release.zip", lib: "libwgpu_native.dylib" },
+  /mingw|mswin/ => { file: "wgpu-windows-x86_64-msvc-release.zip", lib: "wgpu_native.dll" }
+}.freeze
+
+def detect_platform
+  PLATFORM_MAP.each do |pattern, info|
+    return info if RUBY_PLATFORM =~ pattern
+  end
+  abort "Unsupported platform: #{RUBY_PLATFORM}\nSupported: #{PLATFORM_MAP.keys.map(&:inspect).join(", ")}"
+end
+
+def cache_dir
+  File.join(Dir.home, ".cache", "wgpu-ruby", WGPU_VERSION)
+end
+
+def windows?
+  RUBY_PLATFORM =~ /mingw|mswin/
+end
+
+def curl_available?
+  if windows?
+    system("where curl >nul 2>&1")
+  else
+    system("which curl >/dev/null 2>&1")
+  end
+end
+
+def download_with_curl(url, dest)
+  system("curl", "-fsSL", "-o", dest, url)
+end
+
+def download_with_ruby(url, dest, redirects = 5)
+  raise "Too many redirects" if redirects == 0
+
+  uri = URI.parse(url)
+  http = Net::HTTP.new(uri.host, uri.port)
+  http.use_ssl = (uri.scheme == "https")
+  http.open_timeout = 10
+  http.read_timeout = 120
+
+  request = Net::HTTP::Get.new(uri.request_uri)
+
+  http.request(request) do |response|
+    case response
+    when Net::HTTPRedirection
+      download_with_ruby(response["location"], dest, redirects - 1)
+    when Net::HTTPSuccess
+      File.open(dest, "wb") do |file|
+        response.read_body { |chunk| file.write(chunk) }
+      end
+    else
+      return false
+    end
+  end
+  true
+end
+
+def download_file(url, dest)
+  return if curl_available? && download_with_curl(url, dest)
+  return if download_with_ruby(url, dest)
+
+  abort "Download failed: #{url}"
+end
+
+def extract_with_rubyzip(zip_path, dest_dir)
+  require "zip"
+  Zip::File.open(zip_path) do |zip_file|
+    zip_file.each do |entry|
+      dest_path = File.join(dest_dir, entry.name)
+      FileUtils.mkdir_p(File.dirname(dest_path))
+      entry.extract(dest_path) { true }
+    end
+  end
+  true
+rescue LoadError
+  false
+end
+
+def extract_with_powershell(zip_path, dest_dir)
+  return false unless windows?
+
+  system("powershell", "-Command", "Expand-Archive -Force -Path '#{zip_path}' -DestinationPath '#{dest_dir}'")
+end
+
+def extract_with_unzip(zip_path, dest_dir)
+  system("unzip", "-o", "-q", zip_path, "-d", dest_dir)
+end
+
+def extract_zip(zip_path, dest_dir)
+  return if extract_with_rubyzip(zip_path, dest_dir)
+  return if windows? && extract_with_powershell(zip_path, dest_dir)
+  return if extract_with_unzip(zip_path, dest_dir)
+
+  abort "Failed to extract zip. Please install 'rubyzip' gem."
+end
+
+def lib_dir
+  File.join(cache_dir, "lib")
+end
+
+def download_wgpu_native
+  platform = detect_platform
+  lib_path = File.join(lib_dir, platform[:lib])
+
+  if File.exist?(lib_path)
+    puts "wgpu-native already cached at #{lib_path}"
+    return lib_path
+  end
+
+  FileUtils.mkdir_p(cache_dir)
+
+  url = "#{GITHUB_RELEASE_URL}/#{platform[:file]}"
+  zip_path = File.join(cache_dir, platform[:file])
+
+  puts "Downloading wgpu-native #{WGPU_VERSION} from GitHub..."
+  puts "  URL: #{url}"
+  download_file(url, zip_path)
+
+  puts "Extracting to #{cache_dir}..."
+  extract_zip(zip_path, cache_dir)
+
+  FileUtils.rm_f(zip_path)
+
+  unless File.exist?(lib_path)
+    abort "Failed to find #{platform[:lib]} after extraction"
+  end
+
+  puts "wgpu-native installed successfully!"
+  lib_path
+end
+
+if ENV["WGPU_LIB_PATH"]
+  puts "Using custom wgpu-native from WGPU_LIB_PATH: #{ENV["WGPU_LIB_PATH"]}"
+else
+  download_wgpu_native
+end
+
+File.write("Makefile", <<~MAKEFILE)
+  .PHONY: install clean
+
+  install:
+  \t@echo "wgpu-native is ready"
+
+  clean:
+  \t@echo "Nothing to clean"
+MAKEFILE
+
+puts "Done!"

data/lib/wgpu/commands/command_buffer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module WGPU
+  class CommandBuffer
+    attr_reader :handle
+
+    def initialize(handle)
+      @handle = handle
+    end
+
+    def release
+      return if @handle.null?
+      Native.wgpuCommandBufferRelease(@handle)
+      @handle = FFI::Pointer::NULL
+    end
+  end
+end