Skip to content

README.md

Latest commit

 

History

History
50 lines (39 loc) · 2.03 KB

README.md

File metadata and controls

50 lines (39 loc) · 2.03 KB
Raw

Vello compute renderer research

This directory contains Vello's original compute-centric renderer and the code, examples, tests, and design history dedicated to it. The renderer performs most of its work in GPU compute shaders and requires a compute-capable GPU.

For the CPU and broadly compatible GPU renderers at the repository root, start with the project README. See ARCHITECTURE.md for a comparison of the renderer families.

Packages

The research packages are organized as follows:

Contents

  • vello_research/ — public vello rendering API and wgpu backend.
  • vello_encoding/ — scene encoding shared with the compute pipeline.
  • vello_shaders/ — compute shaders, shader preprocessing, and CPU reference kernels.
  • vello_research_tests/ — integration tests, snapshots, and comparison helpers.
  • examples/ — standalone examples, including winit and headless applications.
  • xtask/ — snapshot and comparison maintenance commands.
  • doc/ — historical design documents, roadmaps, and development notes.
  • CHANGELOG.md — release history for the vello package.

Getting started

Run the main windowed example from the repository root:

cargo run -p with_winit --release

Other entry points include the simple, simple_sdl2, and headless example packages under examples/. The package README in vello_research/ has API setup, features, WebAssembly instructions, integrations, current limitations, and additional examples.