How to set up a basic rendering pipeline with nvk?

Follow the README example by creating Vulkan instances and structures using the C-like API or syntactic sugar. Install via npm, ensure Vulkan SDK is set up, and use Node.js to run scripts—similar to C++ but in JavaScript.

nvk vs WebGPU: which is better for JavaScript graphics?

nvk provides direct Vulkan access for native high-performance applications, while WebGPU is a web standard for cross-browser graphics. Choose nvk for desktop tools needing Vulkan features like ray tracing, and WebGPU for browser-based projects.

Can I use nvk for real-time ray tracing?

Yes, nvk supports Vulkan's ray tracing extensions, as shown in the RTX ray tracer example. You'll need compatible hardware and drivers, and follow Vulkan ray tracing tutorials adapted to nvk's API.

What Node.js version is required for nvk?

Node.js >=10.9.0 is recommended, especially for BigInt support used in memory address handling. Check the project structure section for details on JavaScript type requirements.

How to reduce garbage collection pressure in nvk?

Use cached structures with the provided rollup plugin to mimic stack allocation, as described in the syntactic sugar section. This minimizes heap allocations in performance-critical loops.

Is nvk compatible with Electron or desktop apps?

Yes, since it uses N-API and pre-built binaries for major OSes, it can integrate into Electron apps for cross-platform desktop graphics, but you'll need to handle Vulkan driver dependencies.

nvk — Vulkan API Binding for JavaScript

What is nvk?

nvk is a low-level Vulkan API binding for JavaScript and TypeScript that provides direct access to Vulkan's graphics and compute capabilities. It allows developers to write high-performance GPU applications, such as real-time ray tracers and advanced rendering engines, using JavaScript/TypeScript with minimal abstraction overhead. The project solves the problem of accessing modern GPU features (like ray tracing and mesh shaders) from JavaScript, which are not fully available in WebGL/OpenGL.

Target Audience

JavaScript and TypeScript developers working on high-performance graphics applications, game engines, GPU compute projects, or tools requiring low-level GPU access beyond WebGL's capabilities.

Value Proposition

Developers choose nvk for its minimal overhead, direct Vulkan API mapping, and support for cutting-edge GPU features like ray tracing and mesh shaders. It offers better performance and more control than WebGL/OpenGL while providing ergonomic improvements and TypeScript support for a smoother development experience.

Vulkan API for JavaScript/TypeScript

Use Cases

Best For

Building real-time ray tracing applications in JavaScript/TypeScript
Developing high-performance game engines with Vulkan backend
Creating GPU compute applications using Vulkan compute shaders
Porting existing C/C++ Vulkan tutorials and code to JavaScript
Experimenting with advanced GPU features like mesh and geometry shaders
Building cross-platform desktop graphics tools with Node.js

Not Ideal For

Web-based graphics applications requiring browser compatibility, as nvk relies on native Vulkan and Node.js rather than web APIs.
Rapid prototyping or simple 2D/3D graphics where higher-level libraries like Three.js or WebGL offer faster development with less boilerplate.
Teams without prior Vulkan experience, due to the minimal abstraction and need to manage low-level details like memory and pipeline states.

Pros & Cons

Pros

Minimal Overhead

Hybrid bindings construct Vulkan memory entirely in JavaScript, reducing context switching and trampolining for near-native performance, as highlighted in the binding generator section.

Direct C Compatibility

API closely matches Vulkan's C99 style, allowing developers to directly port C/C++ tutorials and code with minimal changes, as shown in the example comparison.

TypeScript Support

Full TypeScript definitions enable type-safe development and better IDE integration, with recommendations to use strict mode for robust code.

Ergonomic Syntax Sugar

Optional shortcuts like sType auto-filling, nested structures, and cached structures reduce boilerplate and GC pressure, improving developer experience without sacrificing control.

Cons

Vulkan Complexity Exposure

Requires deep understanding of Vulkan's verbose and error-prone API, with minimal hand-holding—validation checks can be disabled, but mistakes are easy without prior expertise.

Cumbersome Custom Builds

Generating and compiling bindings from source involves a two-pass process, Vulkan SDK setup, and platform-specific tools, making it daunting for casual use despite pre-built binaries.

Niche Ecosystem Limitations

As a JavaScript Vulkan binding, it lacks the extensive community, libraries, and learning resources of established options like WebGL or C++ Vulkan, limiting support for complex projects.

What is nvk?

Target Audience

JavaScript and TypeScript developers working on high-performance graphics applications, game engines, GPU compute projects, or tools requiring low-level GPU access beyond WebGL's capabilities.

Value Proposition

Use Cases

Best For

Building real-time ray tracing applications in JavaScript/TypeScript
Developing high-performance game engines with Vulkan backend
Creating GPU compute applications using Vulkan compute shaders
Porting existing C/C++ Vulkan tutorials and code to JavaScript
Experimenting with advanced GPU features like mesh and geometry shaders
Building cross-platform desktop graphics tools with Node.js

Not Ideal For

Web-based graphics applications requiring browser compatibility, as nvk relies on native Vulkan and Node.js rather than web APIs.
Rapid prototyping or simple 2D/3D graphics where higher-level libraries like Three.js or WebGL offer faster development with less boilerplate.
Teams without prior Vulkan experience, due to the minimal abstraction and need to manage low-level details like memory and pipeline states.

Pros & Cons

Pros

Minimal Overhead

Hybrid bindings construct Vulkan memory entirely in JavaScript, reducing context switching and trampolining for near-native performance, as highlighted in the binding generator section.

Direct C Compatibility

API closely matches Vulkan's C99 style, allowing developers to directly port C/C++ tutorials and code with minimal changes, as shown in the example comparison.

TypeScript Support

Full TypeScript definitions enable type-safe development and better IDE integration, with recommendations to use strict mode for robust code.

Ergonomic Syntax Sugar

Optional shortcuts like sType auto-filling, nested structures, and cached structures reduce boilerplate and GC pressure, improving developer experience without sacrificing control.

Cons

Vulkan Complexity Exposure

Requires deep understanding of Vulkan's verbose and error-prone API, with minimal hand-holding—validation checks can be disabled, but mistakes are easy without prior expertise.

Cumbersome Custom Builds

Generating and compiling bindings from source involves a two-pass process, Vulkan SDK setup, and platform-specific tools, making it daunting for casual use despite pre-built binaries.

Niche Ecosystem Limitations

As a JavaScript Vulkan binding, it lacks the extensive community, libraries, and learning resources of established options like WebGL or C++ Vulkan, limiting support for complex projects.

nvk

What is nvk?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

nvk

What is nvk?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?