glslkit-webgl 0.1.0.pre → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ae64d28127a6a9f72c2c3017ba1b7e11739e7f374634be7e2a6a6eecbf663a7
-  data.tar.gz: 152a82f8f5be95b90b2d15a8c9b5976d55737164e7d6b69060b89433cfcb56da
+  metadata.gz: 18dde294abf04720f5ff6bf189c482bce2bb960b1ee538ddbae9e3de8f1bd974
+  data.tar.gz: 615c0d0e5c142b4fe7061e5508fb7f6c2fb9b5deb2bdd5bf8c9102f534b7828a
 SHA512:
-  metadata.gz: c97c9dcbd8d95bd2257241915974ee053994659281f49da8e78df7a4a2b594e377587410d31a7008f6ec994a3ee0b8c91be93a05339e93aecce6ad881409053b
-  data.tar.gz: 16c71ae9f9f16e146c5d82b4e4e8fbdab1af3ca6e584ab263576c87a929d88503d02d729758ff5ae18ead15a67dcdb75a627e40fb0ea68e5c0675b0e971ea5a1
+  metadata.gz: 6ee0a2fdc0131b5ea1e3a8d2a2066af9624c07ccb787aced1a27cd9a4d2e009ee546fba4e7079458bea4bc619e898bed98799c88a69ed34f1f21042f2cd04f5d
+  data.tar.gz: d2db73d0147589a1e58cbf84bee2d68469c791e882fb3bc1bbeaf7bba2f1747a2b4db9b9a059226a59c54f3b0d97aae5480457f1a04e1d569aabcc0e44eb4cea

data/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Changelog
 
-## [Unreleased]
+## [0.1.0] - 2026-08-24
 
 初回リリース (v0.1)。**ruby.wasm 環境専用。** 通常の CRuby/JRuby/TruffleRuby
 にはインストールできるが、`require "js"` に依存するため実行できない。

data/README.md

@@ -1,20 +1,42 @@
 # glslkit-webgl
 
-`glslkit-webgl` is a WebGL2 runtime for Ruby programs running in a browser with
-ruby.wasm. It consumes a `glslkit` reflection manifest, caches WebGL references,
-and reports shader compiler errors as Ruby exceptions.
+`glslkit-webgl` は、ruby.wasmでブラウザ上で動くRubyプログラム向けのWebGL2
+ランタイム。`glslkit`のリフレクションマニフェストを読み込み、WebGLの参照を
+キャッシュし、シェーダのコンパイルエラーをRubyの例外として報告する。
+
+## HTTP経由で開くこと
+
+**`glslkit-webgl`を使うページは`file://`ではなくHTTP経由で開くこと。**
+ruby.wasmはRubyのエントリファイルを`fetch()`で読み込むため、ブラウザは
+`file://`オリジンに対してこれを制限する:
+
+```
+Cross origin requests are only supported for HTTP.
+Fetch API cannot load file:///.../neon.rb due to access control checks.
+```
+
+Safariはこのエラーで確実に失敗する。Chromeは現状`file://`でも動くが、
+将来にわたって保証されているわけではない。ローカルでディレクトリを配信し、
+`http://`として開くこと:
+
+```
+python3 -m http.server 8000
+```
+
+`http://localhost:8000/webgl/sample/index.html`として開く。
+`glslkit-webgl.js`自身も`file://`オリジンを検出し、同じ警告をページ上に表示する。
 
 ## Quick start
 
-Serve this repository over HTTP and open `webgl/sample/index.html`. The sample
-draws a rotating, textured cube without application JavaScript, built from
-`webgl/sample/shaders/cube.{vert,frag}` via `rake glslkit:embed`.
-`webgl/sample/neon.html` is an animated fragment-shader raymarching demo, built
-from `webgl/sample/shaders/neon.*` the same way.
-`webgl/sample/neon-error.html` intentionally breaks `common/sdf.glsl` (an
-`#include`d file, not the top-level shader) to demonstrate that `CompileError`
-reports the original included file and line, with a button to switch back to
-the working shaders and start rendering.
+このリポジトリをHTTP経由で配信し(上記参照)、`webgl/sample/index.html`を開く。
+このサンプルは、`webgl/sample/shaders/cube.{vert,frag}`から`rake glslkit:embed`
+で生成された、アプリケーション側のJavaScriptを使わない回転するテクスチャ付き
+キューブを描画する。`webgl/sample/neon.html`は同じ方法で生成された、
+アニメーションするフラグメントシェーダのレイマーチングデモ。
+`webgl/sample/neon-error.html`は`common/sdf.glsl`(`#include`されるファイルで
+あり、トップレベルのシェーダではない)を意図的に壊し、`CompileError`が
+元のincludeされたファイルと行番号を報告することを実演する。正常なシェーダに
+戻して描画を開始するボタンも付いている。
 
 ```html
 <canvas id="canvas" width="640" height="480"></canvas>
@@ -22,11 +44,42 @@ the working shaders and start rendering.
         data-ruby-version="4.0" data-wasm-wasi-version="2.10.1"></script>
 ```
 
-The shim only starts ruby.wasm. `JS::RequireRemote` fetches Ruby files and all
-rendering logic remains in Ruby. `window.glslkitWebGLReady` settles when the entry
-file finishes loading. Packaged wasm builds should install both gems normally.
+このシムはruby.wasmを起動するだけ。`JS::RequireRemote`がRubyファイルを
+fetchし、描画ロジックはすべてRuby側に残る。`window.glslkitWebGLReady`は
+エントリファイルの読み込みが終わった時点で確定する。パッケージ化したwasm
+ビルドでは、両方のgemを通常通りインストールすればよい。
+
+## 単体のruby.wasmビルドへのパッケージング(rbwasm)
+
+上記のQuick Startは`DefaultRubyVM`/`JS::RequireRemote`を使っており、実行時に
+HTTP経由で`.rb`ソースファイルをfetchするためビルド手順は不要。代わりに
+`glslkit-webgl`(と依存する`glslkit`)を単一の`.wasm`バイナリに事前にバンドル
+したい場合、想定している経路は[`ruby_wasm`][ruby_wasm] gemの`rbwasm build`
+CLIを使う方法:
+
+```
+gem install ruby_wasm
+# Gemfile: gem "glslkit-webgl"
+bundle exec rbwasm build -o app.wasm
+```
+
+これは`ruby_wasm`/`rbwasm`の標準的な手順であり、`glslkit-webgl`固有の追加の
+パッケージング要件は無い。通常の`bundle install`だけで`glslkit-webgl`と
+依存する`glslkit`がRubyGemsから正しく解決される。
+
+**このリリースを準備したサンドボックス環境では、著者は`rbwasm build`を最後
+まで実行できなかった。** ただしこの障害は`glslkit-webgl`とは無関係:
+`rbwasm build`は最初にネイティブの「baseruby」ツールチェーンをビルドするが、
+このサンドボックスのカーネル拡張へのアクセスが制限されていたため、CRuby
+自身の`dtrace`/`probes.d`のコンパイルで失敗した(`Failed to query kext info
+(MAC policy error 0x1)`、`error: unable to open output file '/dev/fd/7':
+'Operation not permitted'`)。これはどのgemのコードにも到達する遥か手前で
+起きており、この環境でバンドルするどんなgemでも同様に失敗するはず。
+制約の無いマシンで成功した場合は報告してもらえるとありがたい。
+
+[ruby_wasm]: https://github.com/ruby/ruby.wasm
 
-## Runtime API
+## ランタイムAPI
 
 ```ruby
 require "glslkit/webgl"
@@ -52,47 +105,47 @@ ctx.loop do |seconds|
 end
 ```
 
-Unknown uniforms and incorrect `element_count` values raise immediately.
-Locations optimized away by GLSL are silently ignored. Geometry data is uploaded
-once with typed-array `from`; there is intentionally no mutation API.
+未知のuniformや不正な`element_count`は即座に例外を投げる。GLSLの最適化で
+削除されたlocationは黙って無視される。ジオメトリデータは型付き配列の`from`で
+一度だけアップロードされ、意図的にミューテーションAPIは無い。
 
-## Shader errors and source maps
+## シェーダエラーとソースマップ
 
-Pass each stage's `Glslkit::SourceMap` through `source_maps:`. Recognized driver
-line numbers are resolved to the original included file. `CompileError` exposes
-`stage`, `file`, `line`, and `raw_log`. Unknown log formats still raise, with
-`file` and `line` set to `nil`. Link failures raise `LinkError`. JS log values are
-converted with `#to_s` before parsing.
+各ステージの`Glslkit::SourceMap`を`source_maps:`に渡す。認識できたドライバの
+行番号は元のincludeされたファイルに解決される。`CompileError`は`stage`・
+`file`・`line`・`raw_log`を公開する。未知のログ形式でも例外は投げるが、
+`file`と`line`は`nil`になる。リンク失敗は`LinkError`を投げる。JSのログの値は
+パース前に`#to_s`で変換する。
 
-## Debug mode
+## デバッグモード
 
-Set `Glslkit::WebGL.debug = true` to call `getError` once at each frame end. It
-defaults to `false` and should not remain enabled because `getError` synchronizes
-the WebGL command queue.
+`Glslkit::WebGL.debug = true`にすると、各フレームの終わりに`getError`を
+1回呼ぶ。デフォルトは`false`で、`getError`はWebGLのコマンドキューを同期
+させるため、有効なままにしないこと。
 
-## Performance and scope limits
+## 性能とスコープの制限
 
-The following CPU-side workloads are unsupported in v0.1:
+以下のCPU側のワークロードはv0.1では未対応:
 
-- replacing vertex data every frame;
-- CPU skinning;
-- CPU morph-target interpolation;
-- CPU-updated particle geometry.
+- 毎フレームの頂点データ差し替え
+- CPUスキニング
+- モーフターゲットのCPU補間
+- パーティクル(CPU側で毎フレーム更新するもの)
 
-Transferring 100,000 floats took 18.8 ms in the design measurements, exceeding a
-60 fps frame budget. Keep geometry static, deform vertices in shaders, and send
-only matrices and weights through uniforms. Per-frame bone-matrix calculation
-cost remains unmeasured.
+設計時の計測では、100,000要素のfloatの転送だけで18.8msかかり、60fpsの
+フレーム予算を超える。ジオメトリは静的に保ち、頂点の変形はシェーダ側で行い、
+行列とウェイトだけをuniformとして送ること。フレームごとのボーン行列計算の
+コストは未計測。
 
-The runtime is WebGL2-only. It has no WebGL1 fallback, scene graph, material
-system, or glTF/VRM loader.
+このランタイムはWebGL2専用。WebGL1へのフォールバック、シーングラフ、
+マテリアルシステム、glTF/VRMローダーは無い。
 
-## JS value safety (R6)
+## JSの値の安全な扱い(R6)
 
-Never call `#class` on a value that may be a `JS::Object`; JavaScript primitives
-can fail in `Reflect.has`. Use `is_a?(JS::Object)` for checks and `#inspect`,
-`#typeof`, or `#to_s` for display. A test scans implementation Ruby files for
-accidental `.class` calls.
+`JS::Object`かもしれない値に対して`#class`を呼ばないこと。JavaScriptの
+プリミティブは`Reflect.has`で例外になることがある。判定には`is_a?(JS::Object)`
+を、表示には`#inspect`・`#typeof`・`#to_s`を使う。実装のRubyファイルに対して
+意図しない`.class`呼び出しをスキャンするテストがある。
 
-Normal CRuby fails immediately with a clear message because ruby.wasm's `js`
-library is required.
+通常のCRubyでは、ruby.wasmの`js`ライブラリが必要なため、即座に明確な
+メッセージ付きで失敗する。

data/glslkit-webgl.gemspec

@@ -25,13 +25,16 @@ Gem::Specification.new do |spec|
   spec.metadata["source_code_uri"] = "#{spec.homepage}/tree/main/webgl"
   spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/webgl/CHANGELOG.md"
 
+  # M12c: sample/ を丸ごと同梱する(README のQuick Startが
+  # `webgl/sample/index.html` を開く前提になっており、gem展開後もそのまま
+  # 動く一次資料として扱うため)。sample/shaders-broken/・
+  # sample/generated-broken/ を含む点は当初 `Dir.glob("sample/**/*")` の
+  # 幅広さによる偶然の同梱だったが、これらはneon-error.htmlの動作に必須
+  # (CompileErrorが元ファイル名・行番号を指すという中核機能の実演)であり、
+  # ディレクトリ名も自明なので、除外せず同梱を意図的な判断とする。
   spec.files = Dir.glob("lib/**/*.rb") + Dir.glob("shim/**/*.js") + Dir.glob("sample/**/*") +
     ["glslkit-webgl.gemspec", "README.md", "CHANGELOG.md", "LICENSE.txt"]
   spec.require_paths = ["lib"]
 
-  # M12c: `~> 0.1.0` は `Gem::Requirement` の仕様上プレリリース版を一切
-  # 満たさない(`"~> 0.1.0".satisfied_by?("0.1.0.pre")` は常にfalse)。
-  # 0.1.0.pre のリリース期間中だけこの範囲にし、正式な0.1.0を切ったら
-  # `~> 0.1.0` に戻すこと。
-  spec.add_dependency "glslkit", ">= 0.1.0.pre", "< 0.2.0"
+  spec.add_dependency "glslkit", "~> 0.1.0"
 end

data/lib/glslkit/webgl/version.rb

@@ -2,6 +2,6 @@
 
 module Glslkit
   module WebGL
-    VERSION = "0.1.0.pre"
+    VERSION = "0.1.0"
   end
 end

data/lib/glslkit/webgl.rb

@@ -20,8 +20,29 @@ begin
 rescue LoadError => error
   raise unless error.path == "glslkit/runtime"
 
-  # Source-tree browser samples are loaded by JS::RequireRemote rather than an
-  # installed gem. Packaged users take the normal require path above.
+  # M12d: このフォールバックは、このリポジトリ(webgl/sample/*)を
+  # チェックアウトしたまま `JS::RequireRemote` でブラウザから直接読んだ
+  # 場合専用(`glslkit`がgemとしてインストールされていないため上のrequireが
+  # 必ず失敗する)。パスは `webgl/lib/glslkit/webgl.rb` から見て
+  # `core/lib/glslkit/runtime.rb` への3階層上がりの相対パスで、
+  # このリポジトリのディレクトリ構成に固定的に依存する。
+  #
+  # gemとして正しくインストールされた環境(rbwasmでのバンドル含む)では
+  # 通常のrequireが必ず成功するため、この分岐には絶対に入らないはず。
+  # `Glslkit::WebGL.debug`はまだ定義される前(このファイルの読み込み中)
+  # なので、フラグに関わらず無条件でログを出す。ただし `webgl/sample/*` や
+  # `examples/rails-demo/` を開くたびに毎回このログが出るのは正常な動作
+  # なので、`console.warn`(黄色い警告アイコン)ではなく`console.info`に
+  # している — 動画・スクリーンショットに映っても「エラーが起きている」
+  # ように見えないようにするため。
+  JS.global[:console].call(:info,
+    "glslkit-webgl: using the repository-relative core fallback " \
+    "(require_relative ../../../core/lib/glslkit/runtime) instead of " \
+    "\"require 'glslkit/runtime'\" (LoadError: #{error.message}). This is " \
+    "expected and normal when running this repository's own samples " \
+    "(webgl/sample, examples/rails-demo) via JS::RequireRemote — glslkit " \
+    "is not installed as a real gem there. If you see this message while " \
+    "using an installed glslkit-webgl gem, that IS a bug — please report it.")
   require_relative "../../../core/lib/glslkit/runtime"
 end
 

data/sample/generated/cube_shaders.rb

@@ -34,7 +34,7 @@ GLSLKIT_FRAGMENT_SRC
 
   MANIFEST = {"schema_version"=>1,
  "generated_at"=>"1970-01-01T00:00:00Z",
- "generator"=>"glslkit/0.1.0.pre",
+ "generator"=>"glslkit/0.1.0",
  "programs"=>
   {"cube"=>
     {"digest"=>

data/sample/generated/neon_shaders.rb

@@ -113,7 +113,7 @@ GLSLKIT_FRAGMENT_SRC
 
   MANIFEST = {"schema_version"=>1,
  "generated_at"=>"1970-01-01T00:00:00Z",
- "generator"=>"glslkit/0.1.0.pre",
+ "generator"=>"glslkit/0.1.0",
  "programs"=>
   {"neon"=>
     {"digest"=>

data/sample/generated-broken/neon-broken_shaders.rb

@@ -113,7 +113,7 @@ GLSLKIT_FRAGMENT_SRC
 
   MANIFEST = {"schema_version"=>1,
  "generated_at"=>"1970-01-01T00:00:00Z",
- "generator"=>"glslkit/0.1.0.pre",
+ "generator"=>"glslkit/0.1.0",
  "programs"=>
   {"neon-broken"=>
     {"digest"=>

data/shim/glslkit-webgl.js

@@ -1,6 +1,27 @@
 (function () {
   "use strict";
 
+  if (location.protocol === "file:") {
+    const message =
+      "glslkit-webgl: this page was opened as a file:// URL. ruby.wasm loads " +
+      "its Ruby entry file via fetch(), which browsers restrict for file:// " +
+      'origins (Safari fails outright: "Fetch API cannot load file:///... due ' +
+      'to access control checks."; Chrome currently tolerates it but may stop). ' +
+      "Serve this directory over HTTP instead, e.g.:\n" +
+      "  python3 -m http.server 8000\n" +
+      "and open it as http://localhost:8000/... instead of file://.";
+    const banner = document.createElement("pre");
+    banner.textContent = message;
+    banner.style.cssText =
+      "position:fixed;inset:0;z-index:2147483647;margin:0;padding:24px;" +
+      "background:#1a0d0d;color:#ffb4b4;font:14px/1.6 monospace;" +
+      "white-space:pre-wrap;overflow:auto;";
+    (document.body || document.documentElement).appendChild(banner);
+    console.error(message);
+    window.glslkitWebGLReady = Promise.reject(new Error(message));
+    return;
+  }
+
   const script = document.currentScript;
   const entry = script && script.dataset.entry;
   const rubyVersion = (script && script.dataset.rubyVersion) || "4.0";

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glslkit-webgl
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre
+  version: 0.1.0
 platform: ruby
 authors:
 - kyubey1228
@@ -13,22 +13,16 @@ dependencies:
   name: glslkit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0.pre
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.0.pre
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.1.0
 description: Lets you write WebGL2 rendering code entirely in Ruby, running under
   ruby.wasm in the browser. Resolves uniform/attribute locations from a glslkit reflection
   manifest instead of calling getActiveUniform, and surfaces shader compile errors