Crate vulkano [] [src]

Safe and rich Rust wrapper around the Vulkan API.

Brief summary of Vulkan

  • The Instance object is the API entry point. It is the first object you must create before starting to use Vulkan.

  • The PhysicalDevice object represents an implementation of Vulkan available on the system (eg. a graphics card, a CPU implementation, multiple graphics card working together, etc.). Physical devices can be enumerated from an instance with PhysicalDevice::enumerate().

  • Once you have chosen a physical device to use, you can a Device object from it. The Device is the most important object of Vulkan, as it represents an open channel of communicaton with a physical device.

  • Buffers and Images can be used to store data on memory accessible from the GPU (or Vulkan implementation). Buffers are usually used to store vertices, lights, etc. or arbitrary data, while images are used to store textures or multi-dimensional data.

  • In order to show something on the screen, you need a Swapchain. A Swapchain contains special Images that correspond to the content of the window or the monitor. When you present a swapchain, the content of one of these special images is shown on the screen.

  • ComputePipelines and GraphicsPipelines describe the way the GPU must perform a certain operation. Shaders are programs that the GPU will execute as part of a pipeline. Descriptors can be used to access the content of buffers or images from within shaders.

  • For graphical operations, RenderPasses and Framebuffers describe on which images the implementation must draw upon.

  • In order to ask the GPU to do something, you must create a CommandBuffer. A CommandBuffer contains a list of commands that the GPU must perform. This can include copies between buffers, compute operations, or graphics operations. For the work to start, the CommandBuffer must then be submitted to a Queue, which is obtained when you create the Device.



Location in memory that contains data.


Commands that the GPU will execute (includes draw commands).


Provides a way for shaders to access the content of buffers and images, or read arbitrary data.


Communication channel with a physical device.


Declares all the formats of data and images supported by Vulkan.


Targets on which your draw commands are executed.


Images storage (1D, 2D, 3D, arrays, etc.).


API entry point.


Device memory allocation and memory pools.


Describes a graphical or compute operation.


This module provides support for query pools.


How to retrieve data from an image within a shader.


Link between Vulkan and a window and/or the screen.


Synchronization primitives for Vulkan objects.



Takes a BufferSlice that points to a struct, and returns a BufferSlice that points to a specific field of that struct.


Implements the Vertex trait on a struct.


Builds a CustomRenderPass object that provides a safe wrapper around UnsafeRenderPass.


Call this macro with the layout of a pipeline to generate some helper structs that wrap around vulkano's unsafe APIs.


Builds a CustomRenderPass object that provides a safe wrapper around UnsafeRenderPass.



Error type returned by most Vulkan functions.



Alternative to the Deref trait. Contrary to Deref, must always return the same object.


Gives access to the internal identifier of an object.


Gives access to the internal identifier of an object.