Merge pull request #5 from jspanchu/update-cpp-docs

Update C++ docs

- Added getting started and building VTK sections.

Author: jspanchu

docs/.vitepress/config.mjs

@@ -58,9 +58,11 @@ export default defineConfig({
         {
           text: 'For C++ developers',
           items: [
-            // { text: 'Getting started', link: '/guide/cpp/index' },
-            // { text: 'Tools', link: '/guide/cpp/tools' },
-            // { text: 'Building an application', link: '/guide/cpp/app' },
+            { text: 'Getting started', link: '/guide/cpp/' },
+            { text: 'Building VTK', link: '/guide/cpp/setup' },
+            { text: 'Embind Simple', link: '/guide/cpp/app-1' },
+            { text: 'Embind Advanced', link: '/guide/cpp/app-2' },
+            { text: 'Plain JavaScript', link: '/guide/cpp/app-3' },
           ]
         },
         {

docs/guide/cpp/app-1.md

@@ -0,0 +1 @@
+Write the business logic of your application in C++ and wrap a simple interface to JavaScript with Embind.

docs/guide/cpp/app-2.md

@@ -0,0 +1 @@
+only wrap what you need from VTK.

docs/guide/cpp/app-3.md

@@ -0,0 +1 @@
+Enable code gen for serdes of C++ classes and initialize a standalone VTK session with your module's serdes registrar functions.

docs/guide/cpp/index.md

@@ -1 +1,14 @@
-C++
+# VTK.wasm for C++ developers
+
+This guide shows you how to compile VTK for WebAssembly, extend the functionality of VTK with your own C++ code and ultimately leverage your
+extensions to build 3D web visualization apps.
+
+## Usage patterns
+
+Writing parts of your application in C/C++ allows you to optimize data processing, IO, and rendering. In addition, you can integrate highly
+efficient third-party C++ libraries that were traditionally used only outside the browser. There are three approaches when choosing the C/C++
+approach for web apps in VTK.
+
+1. [__Embind Simple__](./app-1.md): Write the business logic of your application in C++ and wrap a simple interface to JavaScript with Embind.
+2. [__Embind Advanced__](./app-2.md): Audit the VTK classes and only wrap what you need from VTK.
+3. [__Plain JavaScript__](./app-3.md): Enable code gen for serdes of C++ classes and initialize a standalone VTK session with your module's serdes registrar functions.

docs/guide/cpp/setup.md

@@ -0,0 +1,126 @@
+# Building VTK
+
+## Tools
+
+We will use the Emscripten SDK to compile C++ for wasm architecture. NodeJS will be used as a cross compiling emulator. CMake and Ninja are required to
+setup the project.
+
+### Install requirements
+
+First, clone VTK and checkout a release version.
+
+```sh
+git clone https://gitlab.kitware.com/vtk/vtk.git
+```
+
+Now, install NodeJS and EMSDK. Go to https://nodejs.org/en/download and follow the instructions for your platform.
+
+::: code-group
+```sh [macOS/Linux]
+# Download and install fnm:
+curl -o- https://fnm.vercel.app/install | bash
+# Download and install Node.js
+fnm install 24.0.1
+fnm use 24.0.1
+
+# Download and install EMSDK
+git clone https://github.com/emscripten-core/emsdk.git
+./emsdk/emsdk install 4.0.9
+export PATH=$PWD/emsdk/upstream/bin:$PWD/emsdk/upstream/emscripten:$PATH
+```
+```sh [Windows]
+# In Powershell
+# Download and install fnm:
+winget install Schniz.fnm
+# Download and install Node.js
+fnm install 24.0.1
+fnm env --use-on-cd --shell power-shell | Out-String | Invoke-Expression
+fnm use 24.0.1
+
+git clone https://github.com/emscripten-core/emsdk.git
+.\emsdk\emsdk install 4.0.9
+$env:PATH="$PWD\emsdk\upstream\bin;$PWD\emsdk\upstream\emscripten;$env:PATH"
+```
+:::
+
+Finally, download prebuilt webgpu static libraries and headers for `emdawnwebgpu`.
+
+::: code-group
+```sh [wasm32:macOS/Linux]
+cd vtk
+CMAKE_CONFIGURATION="wasm32" cmake -P ./.gitlab/ci/download_dawn.cmake
+```
+```sh [wasm64:macOS/Linux]
+cd vtk
+CMAKE_CONFIGURATION="wasm64" cmake -P ./.gitlab/ci/download_dawn.cmake
+```
+```sh [wasm32:Windows]
+# In Powershell
+cd vtk
+$env:CMAKE_CONFIGURATION="wasm32"
+cmake -P .\.gitlab\ci\download_dawn.cmake
+```
+```sh [wasm64:Windows]
+# In Powershell
+cd vtk
+$env:CMAKE_CONFIGURATION="wasm64"
+cmake -P .\.gitlab\ci\download_dawn.cmake
+```
+:::
+
+## Building VTK
+
+:::code-group
+```sh [wasm32:macOS/Linux]
+emcmake cmake \
+-S . \
+-B buildRelease \
+-G "Ninja" \
+-DCMAKE_BUILD_TYPE=Release \
+-DBUILD_SHARED_LIBS:BOOL=OFF \
+-DVTK_ENABLE_WEBGPU:BOOL=ON \
+-Demdawnwebgpu_DIR="$PWD/.gitlab/dawn/lib/cmake/emdawnwebgpu"
+cmake --build ./buildRelease
+cmake --install ./buildRelease --prefix ./installRelease
+```
+```sh [wasm64:macOS/Linux]
+emcmake cmake \
+-S . \
+-B buildRelease \
+-G "Ninja" \
+-DCMAKE_BUILD_TYPE=Release \
+-DBUILD_SHARED_LIBS:BOOL=OFF \
+-DVTK_ENABLE_WEBGPU:BOOL=ON \
+-DVTK_WEBASSEMBLY_64_BIT:BOOL=ON \
+-Demdawnwebgpu_DIR="$PWD/.gitlab/dawn/lib/cmake/emdawnwebgpu"
+cmake --build ./buildRelease
+cmake --install ./buildRelease --prefix ./installRelease
+```
+```sh [wasm32:Windows]
+# In Powershell
+emcmake cmake `
+-S . `
+-B buildRelease `
+-G "Ninja" `
+-DCMAKE_BUILD_TYPE=Release `
+-DBUILD_SHARED_LIBS:BOOL=OFF `
+-DVTK_ENABLE_WEBGPU:BOOL=ON `
+-Demdawnwebgpu_DIR="$PWD\.gitlab\dawn\lib\cmake\emdawnwebgpu"
+cmake --build .\buildRelease
+cmake --install .\buildRelease --prefix .\installRelease
+```
+```sh [wasm64:Windows]
+# In Powershell
+emcmake cmake `
+-S . `
+-B buildRelease `
+-G "Ninja" `
+-DCMAKE_BUILD_TYPE=Release `
+-DBUILD_SHARED_LIBS:BOOL=OFF `
+-DVTK_ENABLE_WEBGPU:BOOL=ON `
+-DVTK_WEBASSEMBLY_64_BIT:BOOL=ON `
+-Demdawnwebgpu_DIR="$PWD\.gitlab\dawn\lib\cmake\emdawnwebgpu"
+cmake --build .\buildRelease
+cmake --install .\buildRelease --prefix .\installRelease
+```
+:::