https://github.com/webgpu/webgpu-debugger

https://github.com/webgpu/webgpu-debugger

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/webgpu/webgpu-debugger
• Owner: webgpu
• License: mit
• Created: 2022-10-17T13:56:48.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-20T14:40:53.000Z (12 months ago)
• Last Synced: 2024-11-07T16:52:28.799Z (2 months ago)
• Language: JavaScript
• Size: 958 KB
• Stars: 69
• Watchers: 14
• Forks: 8
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-webgpu - webgpu-debugger - Early stage debugger. (Debuggers and Profilers / Safari)

README

        
# webgpu-debugger

# Note: This is still **ALPHA** code. See issues and other random TODO comments for things that need work

## Development

* Install [node](https://nodejs.org). Note: I recommend using [nvm](https://github.com/nvm-sh/nvm)(mac/linux) or [nvm-windows](https://github.com/coreybutler/nvm-windows)(windows).

* run these commands:

  ```bash

  git clone https://github.com/webgpu/webgpu-debugger.git

  cd webgpu-debugger

  npm ci

  ```

### Live development

```

npm start

```

It should open a browser to `http://localhost:3000/example/`. Edits to the code *should* end up showing up live in the browser.

## Building

```

npm run build

```

This builds 3 libraries.

1. the `capture` library `dist/capture.js`

   usage:

   

   ```js

   import { webgpuDebugger } from 'dist/capture.js

   

   ...

     const trace = await webgpuDebugger.traceFrame();

   ```

2. the `replay` library `dist/replay.js`

   stand alone usage:

   

   ```js

   TBD

   ```

   usage with capture

   

   ```js

   TBD

   ```

   

3. the 'debugger' in `dist/webgpu-debugger.js`

   usage:

   

   ```js

   import `dist/webgpu-debugger.js`;

   ```

   

   or

   

   ```html

   

   ```

## Pushing changes

Before you push a change please run `npm run check` or, better yet, make it

automatic by putting 

```

npm run check

```

In `.git/hooks/pre-push` and then set the executable bit `chmod u+x .git/hooks/pre-push`

We use `prettier` to format code so if you find errors, some of them may be able to be

fixed with `npm run fix`.