Welcome to vkdispatch’s documentation!

[WARNING: This site is still under heavy development, and has many missing sections]

Welcome to the vkdispatch documentation website!

To learn how to install vkdispatch, go to the Getting Started Section. To understand the internals and module layout, start with Code Structure and Execution Flow.

Additionally, below are a set of tutorials on vkdispatch usage and a full API reference.

• Tutorials
  • Code Structure and Execution Flow
  • Initialization and Context Creation
  • Buffer Creation and Usage
  • Shader Authoring and Dispatch
  • Command Graph Recording
  • Data Types Overview
  • Reductions and FFT Workflows
  • Images and Sampling
  • Logging Overview
  • Building from Source

• Special
  • Shader Playground

• Full Internal Documentation
  • Python API Reference
  • C++/Cython API Reference

Indices and tables

• Index

• Module Index

• Search Page