初めに
はじめまして！
今年度から新卒として社会人になったnakakeというものです。
大学でGPUに興味を持ち、GPGPUで卒論を書きました。
その延長で現在WebGPUに興味を持っています。
その備忘録的な意味でこの日記を残していこうと考え記事を作成しています。
アウトプットの練習も兼ねているので拙い文章になっていると思いますが、誰かの役に立てれば嬉しいです！
何か意見や間違ったとこがあれば教えていただきたいです。よろしくお願いします！
前提
npmがインストールされていることが前提です。
コマンドプロンプトで以下のコマンドを実行することでインストールがされているか確認できます。
npm -v
9.6.4
このように数値が表示されればインストールされています。
コマンドを認識しなかった場合はnpmをインストールしてください。
この記事の執筆時点でのnpmのバージョンは9.6.4でした。
プロジェクトの構築
npmでプロジェクトを作成します。
npm init -y
これで現在のフォルダにnpmのプロジェクトが作られます。
-y のオプションは npm init を実行したときに指定するオプションのをすべて有効にするものです。
すべて有効でいいので -y を付けています。
実行するとフォルダ内に package.json が生成されていると思います。
このpackage.jsonは簡単に説明するとnpmのパッケージの管理やコマンドの記述などができるファイルです。
サーバーのインストール
次にローカルサーバーを立ち上げるためにlive-serverというパッケージを以下のコマンドでインストールします。
npm i live-server -g
live-serverはコードの修正を立ち上げた状態でも更新してくれるサーバーです。ただWebGPUのコードは更新してくれるものとしてくれないものがあるようです。
それでもhttp-serverよりも使い勝手がよかったのでこちらを使います。
-gオプションはグローバルにインストールするものです。あまり良くないのかもしれませんがローカルでの開発であることとサーバーの立ち上げコマンドなのでいいかなと思って今回は付けました。
気になる方はなしにする方法を調べてやってください。
パッケージの構築
次にこれから必要になるパッケージのインストールと設定を行っていきます。
まずはwebpackとwebpack-cliをインストールします。
npm i webpack webpack-cli
npm i の後ろに空白で複数のパッケージを指定すると複数のインストールを同時に行ってくれます。
webpackはjsのモジュールをまとめてくれるものです。それ以外にもいろいろあるみたいなのですがあまり調べれてませんw
またwebpack-cliはwebpackをコマンドライン上で実行するために必要なものです。
次にTypeScript(以下TS)のインストールをします。
npm i typescript ts-loader
その後TSのコンパイラーを初期化します。
この状態ではTSがグローバルにインストールされているわけではないのでコマンドから操作はできません。
そこでnpxコマンドを使ってローカルのTSのコンパイラーのコマンドを動かします
npx tsc -init
これが終わるとtsconfig.jsonというファイルが生成されていると思います。TSの設定を行うファイルです。後で設定を少しいじります。
次に＠typesのパッケージをインストールします
＠typesはTSの型定義を管理してくれるパッケージです。
まずは@types/nodeをインストールします。
npm i @types/node
名前の通りnodeの型を管理してくれるパッケージです。
次に本命のWebGPUをインストールします。
npm i @webgpu/types
これもTSでのWebGPUの型定義の管理ファイルです。
次はts-shader-loaderをインストールします。
npm i ts-shader-loader
これはグラフィックスAPIにはshaderというものを使ってGPUの命令を書くという方法が一般的でWebGPUもこの方式を取っています。しかしshaderはTSとは異なる言語でコンパイルが必要です。
そのコンパイラーがこのts-shader-loaderです！
とりあえず必要なものはインストールできました。
次にそれぞれのconfigファイルを設定していきます。
まずはルートディレクトリにwebpack.config.jsというファイルを作ります。
これはwebpackの動作を設定するためのファイルです。
今回は以下のように記述しました。
webpack.config.js
const path = require("path");
module.exports = {
context: __dirname,
entry: "./src/main.ts",
output: {
filename: "main.js",
path: path.resolve(__dirname, "dist"),
publicPath: "/dist/"
},
module: {
rules: [
{
test: /\.ts$/,
exclude: /node_modules/,
use: {
loader: "ts-loader"
}
},
{
test: /\.wgsl$/,
use: {
loader: "ts-shader-loader"
}
}
]
},
resolve: {
extensions: [".ts"]
}
}
次にnpx tsc -initを行った際に生成されたtsconfig.jsを以下のように変更していきます。
tsconfig.js
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig to read more about this file */
/* Projects */
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
/* Language and Environment */
"target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
/* Modules */
"module": "commonjs", /* Specify what module code is generated. */
// "rootDir": "./", /* Specify the root folder within your source files. */
// "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
"typeRoots": [
"./node_modules/@webgpu/types",
"./node_modules/@types"
], /* Specify multiple folders that act like './node_modules/@types'. */
// "types": ["node", "@webgpu/types"], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
// "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
// "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */
// "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */
// "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
// "resolveJsonModule": true, /* Enable importing .json files. */
// "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
/* Emit */
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
// "outDir": "./", /* Specify an output folder for all emitted files. */
// "removeComments": true, /* Disable emitting comments. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
/* Type Checking */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
}
}
自分の環境では34行目のtypeRootsと35行目にあったtypesのコメントを外して以下のようにしました。
tsconfig.js 一部抜粋
"typeRoots": [
"./node_modules/@webgpu/types",
"./node_modules/@types"
], './node_modules/@types'. */
// 2023/07/17 変更
// "types": ["node", "@webgpu/types"],
2023/07/17 追記
型定義が読み込めない問題が発生しました。
35行目のtypesをコメントアウトすることで解決することができます。
次にsrcフォルダーを作りその中にmain.tsファイルとtypesフォルダー、index.htmlを作成します。
typesフォルダーにはshader.d.tsファイルを作成します。
ここまで設定をした場合、フォルダ構成は以下のようになっていると思います
root/
├ node_modules/
├ src/
│ ├ types/
│ │ └ shader.d.ts
│ └ main.ts
├ index.html
├ package-lock.js
├ pakage.json
├ tsconfig.json
└ webpack.config.js
shader.d.tsファイルには以下の記述をします。
shader.d.ts
declare module "*.wgsl"
これはshaderを扱うための型定義です。
ここまで設定が終われば環境構築が完了です。
実際に動くかどうかを確認しましょう。
まずはindex.htmlに以下の記述をします。
index.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
</head>
<body>
<h1 id="webgpu-check"></h1>
<script src="dist/main.js"></script>
</body>
</html>
main.tsに以下の記述をします。
src/main.ts
const outputLabel : HTMLElement = <HTMLElement> document.getElementById("webgpu-check");
if(navigator.gpu){
outputLabel.innerText = "このブラウザーはwebgpuに対応しています"
}else{
outputLabel.innerText = "このブラウザーはwebgpuに対応していません"
}
次にサーバーを起動して動いているか確認します。
サーバー確認のためにpackage.jsonのscriptをいじって起動を簡単にしましょう。
pacage.json
{
"name": "webgpu",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"start": "npm run install-missing-dependencies && npm run build && npm run serve",
"install-missing-dependencies": "npm i",
"build": "webpack --config webpack.config.js",
"serve": "live-server --cors"
},
"keywords": [],
"author": "",
"license": "ISC",
"dependencies": {
"@types/node": "^20.1.2",
"@webgpu/types": "^0.1.32",
"ts-loader": "^9.4.2",
"ts-shader-loader": "^2.0.2",
"typescript": "^5.0.4",
"webpack": "^5.82.0",
"webpack-cli": "^5.1.1"
}
}
自分はこのように設定してnpm run startでinstallやwebpack、サーバーを動かすようにしました。
色々あると思うのでそこらへんは自分がやりやすいのでやってもらうといいと思います。
ではサーバーを起動しましょう。
npm run start
サーバーが起動するとブラウザーが開いてindex.htmlの表示がされるはずです。
自分はchromeのバージョン113(webgpu対応バージョン)ではこのようになってました。
ちなみに対応していないブラウザーであるFirefoxはこのようになっていました。
以上で環境構築は終わりです。
次回があればグラフィックスAPI定番のポリゴンの表示についての記事を書く予定です。
長文、駄文でしたがここまでの閲覧ありがとうございました！
補足
package-lock.jsonファイルとnode_modulesフォルダーはモジュールやパッケージのいろいろが詰まった物なので編集はしてはいけません。
また、package.jsonは必要なパッケージやそのバージョンについて記載されたファイルなのでgitに挙げる必要がありますが、node_modulesフォルダーやpackage-lock.jsonは前者があれば生成できるのでgitに上げる必要はないです。容量も大きいので.gitignoreを作ってgitに上げないように設定をしておきます。
.gitignore
node_modules/
package-lock.json
参考